U 6dJ@sdZddlmZddlZddlZddlZzddlmZWn ek rXddl mZYnXddl m Z m Z ddl Z ddlZddlZddlZddlZddlZeeZGdddeZGdd d eZGd d d ejjZGd d d eZdS)aOAuth 2.0 Authorization Flow This module provides integration with `requests-oauthlib`_ for running the `OAuth 2.0 Authorization Flow`_ and acquiring user credentials. See `Using OAuth 2.0 to Access Google APIs`_ for an overview of OAuth 2.0 authorization scenarios Google APIs support. Here's an example of using :class:`InstalledAppFlow`:: from google_auth_oauthlib.flow import InstalledAppFlow # Create the flow using the client secrets file from the Google API # Console. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', scopes=['profile', 'email']) flow.run_local_server() # You can use flow.credentials, or you can just get a requests session # using flow.authorized_session. session = flow.authorized_session() profile_info = session.get( 'https://www.googleapis.com/userinfo/v2/me').json() print(profile_info) # {'name': '...', 'email': '...', ...} .. _requests-oauthlib: http://requests-oauthlib.readthedocs.io/en/latest/ .. _OAuth 2.0 Authorization Flow: https://tools.ietf.org/html/rfc6749#section-1.2 .. _Using OAuth 2.0 to Access Google APIs: https://developers.google.com/identity/protocols/oauth2 )urlsafe_b64encodeN) SystemRandom) ascii_lettersdigitsc@speZdZdZdddZeddZedd Zed d Z e j d d Z d dZ ddZ eddZ ddZdS)FlowaOAuth 2.0 Authorization Flow This class uses a :class:`requests_oauthlib.OAuth2Session` instance at :attr:`oauth2session` to perform all of the OAuth 2.0 logic. This class just provides convenience methods and sane defaults for doing Google's particular flavors of OAuth 2.0. Typically you'll construct an instance of this flow using :meth:`from_client_secrets_file` and a `client secrets file`_ obtained from the `Google API Console`_. .. _client secrets file: https://developers.google.com/identity/protocols/oauth2/web-server #creatingcred .. _Google API Console: https://console.developers.google.com/apis/credentials NTcCs,||_|||_||_||_||_||_dS)a Args: oauth2session (requests_oauthlib.OAuth2Session): The OAuth 2.0 session from ``requests-oauthlib``. client_type (str): The client type, either ``web`` or ``installed``. client_config (Mapping[str, Any]): The client configuration in the Google `client secrets`_ format. redirect_uri (str): The OAuth 2.0 redirect URI if known at flow creation time. Otherwise, it will need to be set using :attr:`redirect_uri`. code_verifier (str): random string of 43-128 chars used to verify the key exchange.using PKCE. autogenerate_code_verifier (bool): If true, auto-generate a code_verifier. .. _client secrets: https://github.com/googleapis/google-api-python-client/blob /main/docs/client-secrets.md N) client_type client_config oauth2session redirect_uri code_verifierautogenerate_code_verifier)selfr rrr r r r=/tmp/pip-unpacked-wheel-8thlrh5s/google_auth_oauthlib/flow.py__init__]s  z Flow.__init__c Kspd|krd}nd|krd}ntd|dd}|dd}tjj||f|\}}|dd}|||||||S)a(Creates a :class:`requests_oauthlib.OAuth2Session` from client configuration loaded from a Google-format client secrets file. Args: client_config (Mapping[str, Any]): The client configuration in the Google `client secrets`_ format. scopes (Sequence[str]): The list of scopes to request during the flow. kwargs: Any additional parameters passed to :class:`requests_oauthlib.OAuth2Session` Returns: Flow: The constructed Flow instance. Raises: ValueError: If the client configuration is not in the correct format. .. _client secrets: https://github.com/googleapis/google-api-python-client/blob/main/docs/client-secrets.md Zweb installedz2Client secrets must be for a web or installed app.r Nr r ) ValueErrorpopgoogle_auth_oauthlibhelpersZsession_from_client_configget) clsrscopeskwargsrr r sessionr rrrfrom_client_configs2   zFlow.from_client_configc Ks6t|d}t|}W5QRX|j|fd|i|S)aCreates a :class:`Flow` instance from a Google client secrets file. Args: client_secrets_file (str): The path to the client secrets .json file. scopes (Sequence[str]): The list of scopes to request during the flow. kwargs: Any additional parameters passed to :class:`requests_oauthlib.OAuth2Session` Returns: Flow: The constructed Flow instance. rr)openjsonloadr)rZclient_secrets_filerrZ json_filerrrrfrom_client_secrets_files zFlow.from_client_secrets_filecCs|jjS)XThe OAuth 2.0 redirect URI. Pass-through to ``self.oauth2session.redirect_uri``.r r r rrrr szFlow.redirect_uricCs ||j_dS)r!Nr")r valuerrrr sc  s|dd|jrJttdtfddtddD}d||_|jrt }| t |j| }t|}|d d}|d ||d d |jj|jd f|\}}||fS)ahGenerates an authorization URL. This is the first step in the OAuth 2.0 Authorization Flow. The user's browser should be redirected to the returned URL. This method calls :meth:`requests_oauthlib.OAuth2Session.authorization_url` and specifies the client configuration's authorization URI (usually Google's authorization server) and specifies that "offline" access is desired. This is required in order to obtain a refresh token. Args: kwargs: Additional arguments passed through to :meth:`requests_oauthlib.OAuth2Session.authorization_url` Returns: Tuple[str, str]: The generated authorization URL and state. The user must visit the URL to complete the flow. The state is used when completing the flow to verify that the request originated from your application. If your application is using a different :class:`Flow` instance to obtain the token, you will need to specify the ``state`` when constructing the :class:`Flow`. Z access_typeZofflinez-._~csg|]}qSr)choice).0_charsZrndrr sz*Flow.authorization_url..r=code_challengeZcode_challenge_methodZS256Zauth_uri) setdefaultr rrrrangejoinr hashlibsha256updatestrencodedigestrdecodesplitr authorization_urlr) r rZrandom_verifierZ code_hashZunencoded_challengeZ b64_challenger.urlstaterr(rr:s(     zFlow.authorization_urlcKs6|d|jd|d|j|jj|jdf|S)aCompletes the Authorization Flow and obtains an access token. This is the final step in the OAuth 2.0 Authorization Flow. This is called after the user consents. This method calls :meth:`requests_oauthlib.OAuth2Session.fetch_token` and specifies the client configuration's token URI (usually Google's token server). Args: kwargs: Arguments passed through to :meth:`requests_oauthlib.OAuth2Session.fetch_token`. At least one of ``code`` or ``authorization_response`` must be specified. Returns: Mapping[str, str]: The obtained tokens. Typically, you will not use return value of this function and instead and use :meth:`credentials` to obtain a :class:`~google.auth.credentials.Credentials` instance. Z client_secretr Z token_uri)r/rr r fetch_token)r rrrrr=szFlow.fetch_tokencCstj|j|jS)aReturns credentials from the OAuth 2.0 session. :meth:`fetch_token` must be called before accessing this. This method constructs a :class:`google.oauth2.credentials.Credentials` class using the session's token and the client config. Returns: google.oauth2.credentials.Credentials: The constructed credentials. Raises: ValueError: If there is no access token in the session. )rrZcredentials_from_sessionr rr#rrr credentialsszFlow.credentialscCstjjj|jS)aReturns a :class:`requests.Session` authorized with credentials. :meth:`fetch_token` must be called before this method. This method constructs a :class:`google.auth.transport.requests.AuthorizedSession` class using this flow's :attr:`credentials`. Returns: google.auth.transport.requests.AuthorizedSession: The constructed session. )googleauth transportrequestsZAuthorizedSessionr>r#rrrauthorized_session1s zFlow.authorized_session)NNT)__name__ __module__ __qualname____doc__r classmethodrr propertyr setterr:r=r>rCrrrrrJs$ & 3   - rc@s6eZdZdZdZdZdZdddeedddfd d ZdS) InstalledAppFlowa/Authorization flow helper for installed applications. This :class:`Flow` subclass makes it easier to perform the `Installed Application Authorization Flow`_. This flow is useful for local development or applications that are installed on a desktop operating system. This flow uses a local server strategy provided by :meth:`run_local_server`. Example:: from google_auth_oauthlib.flow import InstalledAppFlow flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', scopes=['profile', 'email']) flow.run_local_server() session = flow.authorized_session() profile_info = session.get( 'https://www.googleapis.com/userinfo/v2/me').json() print(profile_info) # {'name': '...', 'email': '...', ...} Note that this isn't the only way to accomplish the installed application flow, just one of the most common. You can use the :class:`Flow` class to perform the same flow with different methods of presenting the authorization URL to the user or obtaining the authorization response, such as using an embedded web view. .. _Installed Application Authorization Flow: https://github.com/googleapis/google-api-python-client/blob/main/docs/oauth-installed.md z:Please visit this URL to authorize this application: {url}zEnter the authorization code: zAThe authentication flow has completed. You may close this window. localhostNiTc Kst|} dtjj_tjj|p||| td} |r2dnd} | || j|_ |j f| \} }|rjt j | ddd|r~t |j| d|| _| | jd d }|j|d | |jS) aRun the flow using the server strategy. The server strategy instructs the user to open the authorization URL in their browser and will attempt to automatically open the URL for them. It will start a local web server to listen for the authorization response. Once authorization is complete the authorization server will redirect the user's browser to the local web server. The web server will get the authorization code from the response and shutdown. The code is then exchanged for a token. Args: host (str): The hostname for the local redirect server. This will be served over http, not https. bind_addr (str): Optionally provide an ip address for the redirect server to listen on when it is not the same as host (e.g. in a container). Default value is None, which means that the redirect server will listen on the ip address specified in the host parameter. port (int): The port for the local redirect server. authorization_prompt_message (str | None): The message to display to tell the user to navigate to the authorization URL. If None or empty, don't display anything. success_message (str): The message to display in the web browser the authorization flow is complete. open_browser (bool): Whether or not to open the authorization URL in the user's browser. redirect_uri_trailing_slash (bool): whether or not to add trailing slash when constructing the redirect_uri. Default value is True. timeout_seconds (int): It will raise an error after the timeout timing if there are no credentials response. The value is in seconds. When set to None there is no timeout. Default value is None. kwargs: Additional keyword arguments passed through to :meth:`authorization_url`. Returns: google.oauth2.credentials.Credentials: The OAuth 2.0 credentials for the user. F)Z handler_classz http://{}:{}/z http://{}:{}T)newZ autoraise)r;httphttps)authorization_response)_RedirectWSGIAppwsgiref simple_serverZ WSGIServerallow_reuse_addressZ make_server_WSGIRequestHandlerformatZ server_portr r: webbrowserrprinttimeouthandle_requestlast_request_urireplacer= server_closer>)r hostZ bind_addrportZauthorization_prompt_messagesuccess_messageZ open_browserZredirect_uri_trailing_slashZtimeout_secondsrZwsgi_appZ local_serverZredirect_uri_formatZauth_urlr'rQrrrrun_local_serverss,3   z!InstalledAppFlow.run_local_server)rDrErFrGZ_DEFAULT_AUTH_PROMPT_MESSAGEZ_DEFAULT_AUTH_CODE_MESSAGEZ_DEFAULT_WEB_SUCCESS_MESSAGErbrrrrrK?s'rKc@seZdZdZddZdS)rVzWCustom WSGIRequestHandler. Uses a named logger instead of printing to stderr. cGstj|f|dS)N)_LOGGERinfo)r rWargsrrr log_messagesz_WSGIRequestHandler.log_messageN)rDrErFrGrfrrrrrVsrVc@s eZdZdZddZddZdS)rRzwWSGI app to handle the authorization redirect. Stores the request URI and displays the given success message. cCsd|_||_dS)z Args: success_message (str): The message to display in the web browser the authorization flow is complete. N)r\_success_message)r rarrrrsz_RedirectWSGIApp.__init__cCs(|ddgtj||_|jdgS)a WSGI Callable. Args: environ (Mapping[str, Any]): The WSGI environment. start_response (Callable[str, list]): The WSGI start_response callable. Returns: Iterable[bytes]: The response body. z200 OK)z Content-typeztext/plain; charset=utf-8zutf-8)rSutil request_urir\rgr6)r environZstart_responserrr__call__s z_RedirectWSGIApp.__call__N)rDrErFrGrrkrrrrrRs rR) rGbase64rr2rloggingZsecretsr ImportErrorrandomstringrrrXZwsgiref.simple_serverrSZ wsgiref.utilZgoogle.auth.transport.requestsr?Zgoogle.oauth2.credentialsZgoogle_auth_oauthlib.helpersr getLoggerrDrcobjectrrKrTZWSGIRequestHandlerrVrRrrrrs,$  v