TDSrSSKrSSKrSSKJr SSKJr SSKrSSKJ r SSK J r SSK J r SSKJr S rS rS rS rS r"SS\5r\"\R.R05rSrSrSrSr"SS\5rg)aUtilities for the Django web framework. Provides Django views and helpers the make using the OAuth2 web server flow easier. It includes an ``oauth_required`` decorator to automatically ensure that user credentials are available, and an ``oauth_enabled`` decorator to check if the user has authorized, and helper shortcuts to create the authorization URL otherwise. There are two basic use cases supported. The first is using Google OAuth as the primary form of authentication, which is the simpler approach recommended for applications without their own user system. The second use case is adding Google OAuth credentials to an existing Django model containing a Django user field. Most of the configuration is the same, except for `GOOGLE_OAUTH_MODEL_STORAGE` in settings.py. See "Adding Credentials To An Existing Django User System" for usage differences. Only Django versions 1.8+ are supported. Configuration =============== To configure, you'll need a set of OAuth2 web application credentials from `Google Developer's Console `. Add the helper to your INSTALLED_APPS: .. code-block:: python :caption: settings.py :name: installed_apps INSTALLED_APPS = ( # other apps "django.contrib.sessions.middleware" "oauth2client.contrib.django_util" ) This helper also requires the Django Session Middleware, so ``django.contrib.sessions.middleware`` should be in INSTALLED_APPS as well. Add the client secrets created earlier to the settings. You can either specify the path to the credentials file in JSON format .. code-block:: python :caption: settings.py :name: secrets_file GOOGLE_OAUTH2_CLIENT_SECRETS_JSON=/path/to/client-secret.json Or, directly configure the client Id and client secret. .. code-block:: python :caption: settings.py :name: secrets_config GOOGLE_OAUTH2_CLIENT_ID=client-id-field GOOGLE_OAUTH2_CLIENT_SECRET=client-secret-field By default, the default scopes for the required decorator only contains the ``email`` scopes. You can change that default in the settings. .. code-block:: python :caption: settings.py :name: scopes GOOGLE_OAUTH2_SCOPES = ('email', 'https://www.googleapis.com/auth/calendar',) By default, the decorators will add an `oauth` object to the Django request object, and include all of its state and helpers inside that object. If the `oauth` name conflicts with another usage, it can be changed .. code-block:: python :caption: settings.py :name: request_prefix # changes request.oauth to request.google_oauth GOOGLE_OAUTH2_REQUEST_ATTRIBUTE = 'google_oauth' Add the oauth2 routes to your application's urls.py urlpatterns. .. code-block:: python :caption: urls.py :name: urls from oauth2client.contrib.django_util.site import urls as oauth2_urls urlpatterns += [url(r'^oauth2/', include(oauth2_urls))] To require OAuth2 credentials for a view, use the `oauth2_required` decorator. This creates a credentials object with an id_token, and allows you to create an `http` object to build service clients with. These are all attached to the request.oauth .. code-block:: python :caption: views.py :name: views_required from oauth2client.contrib.django_util.decorators import oauth_required @oauth_required def requires_default_scopes(request): email = request.oauth.credentials.id_token['email'] service = build(serviceName='calendar', version='v3', http=request.oauth.http, developerKey=API_KEY) events = service.events().list(calendarId='primary').execute()['items'] return HttpResponse("email: {0} , calendar: {1}".format( email,str(events))) return HttpResponse( "email: {0} , calendar: {1}".format(email, str(events))) To make OAuth2 optional and provide an authorization link in your own views. .. code-block:: python :caption: views.py :name: views_enabled2 from oauth2client.contrib.django_util.decorators import oauth_enabled @oauth_enabled def optional_oauth2(request): if request.oauth.has_credentials(): # this could be passed into a view # request.oauth.http is also initialized return HttpResponse("User email: {0}".format( request.oauth.credentials.id_token['email'])) else: return HttpResponse( 'Here is an OAuth Authorize link: Authorize' ''.format(request.oauth.get_authorize_redirect())) If a view needs a scope not included in the default scopes specified in the settings, you can use [incremental auth](https://developers.google.com/identity/sign-in/web/incremental-auth) and specify additional scopes in the decorator arguments. .. code-block:: python :caption: views.py :name: views_required_additional_scopes @oauth_enabled(scopes=['https://www.googleapis.com/auth/drive']) def drive_required(request): if request.oauth.has_credentials(): service = build(serviceName='drive', version='v2', http=request.oauth.http, developerKey=API_KEY) events = service.files().list().execute()['items'] return HttpResponse(str(events)) else: return HttpResponse( 'Here is an OAuth Authorize link: Authorize' ''.format(request.oauth.get_authorize_redirect())) To provide a callback on authorization being completed, use the oauth2_authorized signal: .. code-block:: python :caption: views.py :name: signals from oauth2client.contrib.django_util.signals import oauth2_authorized def test_callback(sender, request, credentials, **kwargs): print("Authorization Signal Received {0}".format( credentials.id_token['email'])) oauth2_authorized.connect(test_callback) Adding Credentials To An Existing Django User System ===================================================== As an alternative to storing the credentials in the session, the helper can be configured to store the fields on a Django model. This might be useful if you need to use the credentials outside the context of a user request. It also prevents the need for a logged in user to repeat the OAuth flow when starting a new session. To use, change ``settings.py`` .. code-block:: python :caption: settings.py :name: storage_model_config GOOGLE_OAUTH2_STORAGE_MODEL = { 'model': 'path.to.model.MyModel', 'user_property': 'user_id', 'credentials_property': 'credential' } Where ``path.to.model`` class is the fully qualified name of a ``django.db.model`` class containing a ``django.contrib.auth.models.User`` field with the name specified by `user_property` and a :class:`oauth2client.contrib.django_util.models.CredentialsField` with the name specified by `credentials_property`. For the sample configuration given, our model would look like .. code-block:: python :caption: models.py :name: storage_model_model from django.contrib.auth.models import User from oauth2client.contrib.django_util.models import CredentialsField class MyModel(models.Model): # ... other fields here ... user = models.OneToOneField(User) credential = CredentialsField() N) exceptions) urlresolvers)parse) clientsecrets)dictionary_storage)storage)emailoauthc[R"U5upU[R:wa[SR U55eUSUS4$)zLoads client secrets from the given filename. Args: filename: The name of the file containing the JSON secret key. Returns: A 2-tuple, the first item containing the client id, and the second item containing a client secret. zPThe flow specified in {} is not supported, only the WEB flow type is supported. client_id client_secret)rloadfileTYPE_WEB ValueErrorformat)filename client_type client_infos + +11=> >rcp[[RRSS5nUbUSUSUS4$g)aThis configures whether the credentials will be stored in the session or the Django ORM based on the settings. By default, the credentials will be stored in the session, unless `GOOGLE_OAUTH2_STORAGE_MODEL` is found in the settings. Usually, the ORM storage is used to integrate credentials into an existing Django user system. Returns: A tuple containing three strings, or None. If ``GOOGLE_OAUTH2_STORAGE_MODEL`` is configured, the tuple will contain the fully qualifed path of the `django.db.model`, the name of the ``django.contrib.auth.models.User`` field on the model, and the name of the :class:`oauth2client.contrib.django_util.models.CredentialsField` field on the model. If Django ORM storage is not configured, this function returns None. GOOGLE_OAUTH2_STORAGE_MODELNmodel user_propertycredentials_property)NNN)rdjangoconfsettings)storage_model_settingss r_get_storage_modelr*!sQ"%V[[%9%9%BDJ)&w/&7&'=>@ @ rc\rSrSrSrSrSrg)OAuth2Settingsi<aInitializes Django OAuth2 Helper Settings This class loads the OAuth2 Settings from the Django settings, and then provides those settings as attributes to the rest of the views and decorators in the module. Attributes: scopes: A list of OAuth2 scopes that the decorators and views will use as defaults. request_prefix: The name of the attribute that the decorators use to attach the UserOAuth2 object to the Django request object. client_id: The OAuth2 Client ID. client_secret: The OAuth2 Client Secret. c[US[5Ul[US[5Ul[ U5uUlUlSUR;a[R"S5e[5uUl Ul Ulg)NGOOGLE_OAUTH2_SCOPESGOOGLE_OAUTH2_REQUEST_ATTRIBUTEz4django.contrib.sessions.middleware.SessionMiddlewarezThe Google OAuth2 Helper requires session middleware to be installed. Edit your MIDDLEWARE_CLASSES setting to include 'django.contrib.sessions.middleware.SessionMiddleware'.)rGOOGLE_OAUTH2_DEFAULT_SCOPESscopesr/request_prefixr r r MIDDLEWARE_CLASSESrrr* storage_modelstorage_model_user_property"storage_model_credentials_property)selfrs r__init__OAuth2Settings.__init__Ls/1G:< %&7&G&EG --> ? +* C#66 711)* * 5G4H 2 T= 0r)r r r2r1r4r6r5N)__name__ __module__ __qualname____firstlineno____doc__r8__static_attributes__rrr,r,<s  Irr,google_oauth2_credentialscf[Rn[Rn[RnU(aXUR SS5upE[ R "U5n[Xe5n[R"UUURU5$[R"UR[S9$)zGets a Credentials storage object provided by the Django OAuth2 Helper object. Args: request: Reference to the current request object. Returns: An :class:`oauth2.client.Storage` object. .)key)oauth2_settingsr4r5r6rsplit importlib import_modulerrDjangoORMStorageuserrDictionaryStoragesession_CREDENTIALS_KEY)requestr4r$r% module_name class_namemodulestorage_model_classs r get_storagerTes$11M#??M*MM"/"6"6sA"> ((5%f9''(;(5(/ (<> > "33 OO!13 3rcz[R"XS9n[R"US5nSR X45$)a1Helper method to create a redirect response with URL params. This builds a redirect string that converts kwargs into a query string. Args: url_name: The name of the url to redirect to. kwargs: the query string param and their values to build. Returns: A properly formatted redirect string. )argsTz{0}?{1})rreverser urlencoder)url_namerVkwargsurlparamss r_redirect_with_paramsr]s5   x 3C __VT *F   C ((rc[RbURR5(a[ U5R 5$g)=Gets the authorized credentials for this flow, if they exist.N)rFr4rKis_authenticatedrTget)rOs r_credentials_from_requestrbs: %%- LL ) ) + +7#''))rcd\rSrSrSrS SjrSrSrSr\ S5r \ S 5r \ S 5r S r g) UserOAuth2izdClass to create oauth2 objects on Django request objects containing credentials and helper methods. NcXlU=(d UR5UlU(a+[[R 5[U5-Ulg[[R 5Ulg)zInitialize the Oauth2 Object. Args: request: Django request object. scopes: Scopes desired for this OAuth2 flow. return_url: The url to return to after the OAuth flow is complete, defaults to the request's current URL path. N)rO get_full_path return_urlsetrFr1_scopes)r7rOr1rgs rr8UserOAuth2.__init__sN $?(=(=(? 556VDDL556DLrcRURUR5S.n[S0UD6$)z5Creates a URl to start the OAuth2 authorization flow.)rgr1)zgoogle_oauth:authorize)rg _get_scopesr])r7 get_paramss rget_authorize_redirect!UserOAuth2.get_authorize_redirects.//&&( %LLLrc[UR5nU=(a7 UR(+=(a URUR 55$)zUReturns True if there are valid credentials for the current user and required scopes.)rbrOinvalid has_scopesrl)r7 credentialss rhas_credentialsUserOAuth2.has_credentialssF0 = ;K$7$7 7;&&t'7'7'9: >r)rirOrg)NN)r:r;r<r=r>r8rnrtrlpropertyr1rsrr?r@rrrdrdsX7 M< "" 77rrd)r>rH django.confr& django.corerrrsix.moves.urllibr oauth2clientroauth2client.contribr oauth2client.contrib.django_utilrr0r/rr r*objectr,r'r(rFrNrTr]rbrdr@rrrsQf"$"&34)")B&>8 6!IV!IH!!5!56.38)$@@r