Source code for oauth_dropins.dropbox

"""Dropbox OAuth drop-in.

Standard OAuth 2.0 flow. Docs:
import logging
import urllib.parse, urllib.request

from flask import request
from import ndb

from . import views, models
from .webutil import flask_util, util
from .webutil.util import json_dumps, json_loads

logger = logging.getLogger(__name__)

DROPBOX_APP_KEY ='dropbox_app_key')
DROPBOX_APP_SECRET ='dropbox_app_secret')
GET_AUTH_CODE_URL = '&'.join((

[docs]class DropboxAuth(models.BaseAuth): """An authenticated Dropbox user or page. Provides methods that return information about this user (or page) and make OAuth-signed requests to Dropbox's HTTP-based APIs. Stores OAuth credentials in the datastore. See models.BaseAuth for usage details. Implements urlopen() but not api(). """ access_token_str = ndb.StringProperty(required=True)
[docs] def site_name(self): return 'Dropbox'
[docs] def user_display_name(self): """Returns the Dropbox user id. """ return self.key_id()
[docs] def access_token(self): """Returns the OAuth access token string. """ return self.access_token_str
[docs] def urlopen(self, url, **kwargs): """Wraps urlopen() and adds OAuth credentials to the request. """ headers = {'Authorization': f'Bearer {self.access_token_str}'} try: return util.urlopen(urllib.request.Request(url, headers=headers), **kwargs) except BaseException as e: util.interpret_http_exception(e) raise
[docs]class DropboxCsrf(ndb.Model): """Stores a CSRF token for the Dropbox OAuth2 flow.""" token = ndb.StringProperty(required=False) state = ndb.TextProperty(required=False)
[docs]class Start(views.Start): """Starts Dropbox auth. Requests an auth code and expects a redirect back. """ NAME = 'dropbox' LABEL = 'Dropbox'
[docs] def redirect_url(self, state=None): assert DROPBOX_APP_KEY and DROPBOX_APP_SECRET, ( "Please fill in the dropbox_app_key and dropbox_app_secret files in " "your app's root directory.") csrf_key = DropboxCsrf(state=state).put() return GET_AUTH_CODE_URL % { 'client_id': DROPBOX_APP_KEY, 'redirect_uri': urllib.parse.quote_plus(self.to_url(state=state)), 'state': f'{state}|{}', }
[docs] @classmethod def button_html(cls, *args, **kwargs): return super(cls, cls).button_html( *args, input_style='background-color: #EEEEEE; padding: 10px', **kwargs)
[docs]class Callback(views.Callback): """The auth callback. Fetches an access token, stores it, and redirects home. """
[docs] def dispatch_request(self): state = request.values['state'] # handle errors error = request.values.get('error') error_reason = urllib.parse.unquote_plus(request.values.get('error_reason', '')) if error or error_reason: if error == 'access_denied':'User declined: {error_reason}') return self.finish(None, state=state) else: flask_util.error(' '.join((error, error_reason))) # lookup the CSRF token try: csrf_id = int(urllib.parse.unquote_plus(state).split('|')[-1]) except (ValueError, TypeError): flask_util.error(f'Invalid state value {state!r}') csrf = DropboxCsrf.get_by_id(csrf_id) if not csrf: flask_util.error(f'No CSRF token for id {csrf_id}') # request an access token data = { 'client_id': DROPBOX_APP_KEY, 'client_secret': DROPBOX_APP_SECRET, 'code': request.values['code'], 'redirect_uri': request.base_url, } try: resp = util.urlopen(GET_ACCESS_TOKEN_URL % data, data=b'').read() except BaseException as e: util.interpret_http_exception(e) raise try: data = json_loads(resp) except (ValueError, TypeError): logger.error(f'Bad response:\n{resp}', exc_info=True) flask_util.error('Bad Dropbox response to access token request')"Storing new Dropbox account: {data['uid']}") auth = DropboxAuth(id=data['uid'], access_token_str=data['access_token']) auth.put() return self.finish(auth, state=csrf.state)