File manager - Edit - /usr/local/CyberPanel/lib/python3.10/site-packages/oauthlib/oauth2/rfc6749/clients/__pycache__/base.cpython-310.pyc
Back
o �h h � @ s� d Z ddlZddlZddlZddlZddlZddlZddlmZ ddl m Z ddl m Z m Z ddlmZmZmZ ddlmZ dZd Zd Zd d iZG d d� d�ZdS )z� oauthlib.oauth2.rfc6749 ~~~~~~~~~~~~~~~~~~~~~~~ This module is an implementation of various logic needed for consuming OAuth 2.0 RFC6749. � N)�generate_token)�tokens)�InsecureTransportError�TokenExpiredError)�parse_token_response�prepare_token_request� prepare_token_revocation_request)�is_secure_transport� auth_header�query�bodyz Content-Typez!application/x-www-form-urlencodedc @ s e Zd ZdZdZedddddddddedddfdd�Zedd� �Z d d � Z d d � Z d d� Z d.dd�Z d/dd�Z d0dd�Z d1dd�Z d2dd�Zd3d d �Zd4d d �Z d.d d!�Zd"d#� Zd3d$d%�Zdddedfd&d'�Zd(d)� Zd*d+� Zd,d-� ZdS )5�Clienta� Base OAuth2 client responsible for access token management. This class also acts as a generic interface providing methods common to all client types such as ``prepare_authorization_request`` and ``prepare_token_revocation_request``. The ``prepare_x_request`` methods are the recommended way of interacting with clients (as opposed to the abstract prepare uri/body/etc methods). They are recommended over the older set because they are easier to use (more consistent) and add a few additional security checks, such as HTTPS and state checking. Some of these methods require further implementation only provided by the specific purpose clients such as :py:class:`oauthlib.oauth2.MobileApplicationClient` and thus you should always seek to use the client class matching the OAuth workflow you need. For Python, this is usually :py:class:`oauthlib.oauth2.WebApplicationClient`. � refresh_token�BearerNc K s� || _ || _|| _|| _|| _|| _|| _|pi | _| | _| | _ | | _ | | _ | | _ || _ || _d| _d| _d| _| �| j� dS )ae Initialize a client with commonly used attributes. :param client_id: Client identifier given by the OAuth provider upon registration. :param default_token_placement: Tokens can be supplied in the Authorization header (default), the URL query component (``query``) or the request body (``body``). :param token_type: OAuth 2 token type. Defaults to Bearer. Change this if you specify the ``access_token`` parameter and know it is of a different token type, such as a MAC, JWT or SAML token. Can also be supplied as ``token_type`` inside the ``token`` dict parameter. :param access_token: An access token (string) used to authenticate requests to protected resources. Can also be supplied inside the ``token`` dict parameter. :param refresh_token: A refresh token (string) used to refresh expired tokens. Can also be supplied inside the ``token`` dict parameter. :param mac_key: Encryption key used with MAC tokens. :param mac_algorithm: Hashing algorithm for MAC tokens. :param token: A dict of token attributes such as ``access_token``, ``token_type`` and ``expires_at``. :param scope: A list of default scopes to request authorization for. :param state: A CSRF protection string used during authorization. :param redirect_url: The redirection endpoint on the client side to which the user returns after authorization. :param state_generator: A no argument state generation callable. Defaults to :py:meth:`oauthlib.common.generate_token`. :param code_verifier: PKCE parameter. A cryptographically random string that is used to correlate the authorization request to the token request. :param code_challenge: PKCE parameter. A challenge derived from the code verifier that is sent in the authorization request, to be verified against later. :param code_challenge_method: PKCE parameter. A method that was used to derive code challenge. Defaults to "plain" if not present in the request. N)� client_id�default_token_placement� token_type� access_tokenr �mac_key� mac_algorithm�token�scope�state_generator�state� redirect_url� code_verifier�code_challenge�code_challenge_method�code� expires_in� _expires_at�populate_token_attributes)�selfr r r r r r r r r r r r r r r �kwargs� r$ �Z/usr/local/CyberPanel/lib/python3.10/site-packages/oauthlib/oauth2/rfc6749/clients/base.py�__init__8 s& @ zClient.__init__c C s | j | jd�S )aO Supported token types and their respective methods Additional tokens can be supported by extending this dictionary. The Bearer token spec is stable and safe to use. The MAC token spec is not yet stable and support for MAC tokens is experimental and currently matching version 00 of the spec. )r �MAC)�_add_bearer_token�_add_mac_token)r" r$ r$ r% � token_types� s �zClient.token_typesc O � t d��)z,Abstract method used to create request URIs.�*Must be implemented by inheriting classes.��NotImplementedError�r" �argsr# r$ r$ r% �prepare_request_uri� � zClient.prepare_request_uric O r+ )z.Abstract method used to create request bodies.r, r- r/ r$ r$ r% �prepare_request_body� r2 zClient.prepare_request_bodyc O r+ )z4Abstract method used to parse redirection responses.r, r- r/ r$ r$ r% �parse_request_uri_response� r2 z!Client.parse_request_uri_response�GETc K s� t |�st� �|p | j}dd� | j�� D �}| j�� |vr$td| j ��| js1| j � d�s1td��| j r>| j t � � k r>t � �|| j�� |||||fi |��S )ac Add token to the request uri, body or authorization header. The access token type provides the client with the information required to successfully utilize the access token to make a protected resource request (along with type-specific attributes). The client MUST NOT use an access token if it does not understand the token type. For example, the "bearer" token type defined in [`I-D.ietf-oauth-v2-bearer`_] is utilized by simply including the access token string in the request: .. code-block:: http GET /resource/1 HTTP/1.1 Host: example.com Authorization: Bearer mF_9.B5f-4.1JqM while the "mac" token type defined in [`I-D.ietf-oauth-v2-http-mac`_] is utilized by issuing a MAC key together with the access token which is used to sign certain components of the HTTP requests: .. code-block:: http GET /resource/1 HTTP/1.1 Host: example.com Authorization: MAC id="h480djs93hd8", nonce="274312:dj83hs9s", mac="kDZvddkndxvhGRXZhvuDjEWhGeE=" .. _`I-D.ietf-oauth-v2-bearer`: https://tools.ietf.org/html/rfc6749#section-12.2 .. _`I-D.ietf-oauth-v2-http-mac`: https://tools.ietf.org/html/rfc6749#section-12.2 c S s i | ] \}}|� � |�qS r$ )�lower)�.0�k�vr$ r$ r% � <dictcomp>� s �z$Client.add_token.<locals>.<dictcomp>zUnsupported token type: %sr zMissing access token.)r r r r* �itemsr r6 � ValueErrorr r �getr �timer )r" �uri� http_methodr �headers�token_placementr# � case_insensitive_token_typesr$ r$ r% � add_token� s" # ���zClient.add_tokenc K sb t |�st� �|p | �� | _|p| j| _|du r| jn|}| j|f| j|| jd�|��}|tdfS )ae Prepare the authorization request. This is the first step in many OAuth flows in which the user is redirected to a certain authorization URL. This method adds required parameters to the authorization URL. :param authorization_url: Provider authorization endpoint URL. :param state: CSRF protection string. Will be automatically created if not provided. The generated state is available via the ``state`` attribute. Clients should verify that the state is unchanged and present in the authorization response. This verification is done automatically if using the ``authorization_response`` parameter with ``prepare_token_request``. :param redirect_url: Redirect URL to which the user will be returned after authorization. Must be provided unless previously setup with the provider. If provided then it must also be provided in the token request. :param scope: List of scopes to request. Must be equal to or a subset of the scopes granted when obtaining the refresh token. If none is provided, the ones provided in the constructor are used. :param kwargs: Additional parameters to included in the request. :returns: The prepared request tuple with (url, headers, body). N)� redirect_urir r � )r r r r r r r1 �FORM_ENC_HEADERS)r" �authorization_urlr r r r# �auth_urlr$ r$ r% � prepare_authorization_request� s ��� z$Client.prepare_authorization_requestrF c K sX t |�st� �|p | j}|r| j||d� |p| j| _| jd|| jd�|��}|t|fS )a� Prepare a token creation request. Note that these requests usually require client authentication, either by including client_id or a set of provider specific authentication credentials. :param token_url: Provider token creation endpoint URL. :param authorization_response: The full redirection URL string, i.e. the location to which the user was redirected after successful authorization. Used to mine credentials needed to obtain a token in this step, such as authorization code. :param redirect_url: The redirect_url supplied with the authorization request (if there was one). :param state: :param body: Existing request body (URL encoded string) to embed parameters into. This may contain extra parameters. Default ''. :param kwargs: Additional parameters to included in the request. :returns: The prepared request tuple with (url, headers, body). )r )r rE Nr$ )r r r r4 r r3 rG )r" � token_url�authorization_responser r r r# r$ r$ r% r s � �� z Client.prepare_token_requestc K sB t |�st� �|du r| jn|}| jd|||d�|��}|t|fS )a� Prepare an access token refresh request. Expired access tokens can be replaced by new access tokens without going through the OAuth dance if the client obtained a refresh token. This refresh token and authentication credentials can be used to obtain a new access token, and possibly a new refresh token. :param token_url: Provider token refresh endpoint URL. :param refresh_token: Refresh token string. :param body: Existing request body (URL encoded string) to embed parameters into. This may contain extra parameters. Default ''. :param scope: List of scopes to request. Must be equal to or a subset of the scopes granted when obtaining the refresh token. If none is provided, the ones provided in the constructor are used. :param kwargs: Additional parameters to included in the request. :returns: The prepared request tuple with (url, headers, body). N)r r r r$ )r r r �prepare_refresh_bodyrG )r" rK r r r r# r$ r$ r% � prepare_refresh_token_request& s �� z$Client.prepare_refresh_token_requestr c K s( t |�st� �t||f|||d�|��S )aU Prepare a token revocation request. :param revocation_url: Provider token revocation endpoint URL. :param token: The access or refresh token to be revoked (string). :param token_type_hint: ``"access_token"`` (default) or ``"refresh_token"``. This is optional and if you wish to not pass it you must provide ``token_type_hint=None``. :param body: :param callback: A jsonp callback such as ``package.callback`` to be invoked upon receiving the response. Not that it should not include a () suffix. :param kwargs: Additional parameters to included in the request. :returns: The prepared request tuple with (url, headers, body). Note that JSONP request may use GET requests as the parameters will be added to the request URL query as opposed to the request body. An example of a revocation request .. code-block:: http POST /revoke HTTP/1.1 Host: server.example.com Content-Type: application/x-www-form-urlencoded Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW token=45ghiukldjahdnhzdauz&token_type_hint=refresh_token An example of a jsonp revocation request .. code-block:: http GET /revoke?token=agabcdefddddafdd&callback=package.myCallback HTTP/1.1 Host: server.example.com Content-Type: application/x-www-form-urlencoded Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW and an error response .. code-block:: javascript package.myCallback({"error":"unsupported_token_type"}); Note that these requests usually require client credentials, client_id in the case for public clients and provider specific authentication credentials for confidential clients. )�token_type_hintr �callback)r r r )r" �revocation_urlr rO r rP r# r$ r$ r% r C s 0��z'Client.prepare_token_revocation_requestc K s2 |du r| j n|}t||d�| _| �| j� | jS )a� Parse the JSON response body. If the access token request is valid and authorized, the authorization server issues an access token as described in `Section 5.1`_. A refresh token SHOULD NOT be included. If the request failed client authentication or is invalid, the authorization server returns an error response as described in `Section 5.2`_. :param body: The response body from the token request. :param scope: Scopes originally requested. If none is provided, the ones provided in the constructor are used. :return: Dictionary of token parameters. :raises: Warning if scope has changed. :py:class:`oauthlib.oauth2.errors.OAuth2Error` if response is invalid. These response are json encoded and could easily be parsed without the assistance of OAuthLib. However, there are a few subtle issues to be aware of regarding the response which are helpfully addressed through the raising of various errors. A successful response should always contain **access_token** The access token issued by the authorization server. Often a random string. **token_type** The type of the token issued as described in `Section 7.1`_. Commonly ``Bearer``. While it is not mandated it is recommended that the provider include **expires_in** The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated. If omitted, the authorization server SHOULD provide the expiration time via other means or document the default value. **scope** Providers may supply this in all responses but are required to only if it has changed since the authorization request. .. _`Section 5.1`: https://tools.ietf.org/html/rfc6749#section-5.1 .. _`Section 5.2`: https://tools.ietf.org/html/rfc6749#section-5.2 .. _`Section 7.1`: https://tools.ietf.org/html/rfc6749#section-7.1 N)r )r r r r! )r" r r r# r$ r$ r% �parse_request_body_responsez s 0 z"Client.parse_request_body_responsec K s6 |p| j }|du r | jn|}t| jf|||d�|��S )aO Prepare an access token request, using a refresh token. If the authorization server issued a refresh token to the client, the client makes a refresh request to the token endpoint by adding the following parameters using the `application/x-www-form-urlencoded` format in the HTTP request entity-body: :param refresh_token: REQUIRED. The refresh token issued to the client. :param scope: OPTIONAL. The scope of the access request as described by Section 3.3. The requested scope MUST NOT include any scope not originally granted by the resource owner, and if omitted is treated as equal to the scope originally granted by the resource owner. Note that if none is provided, the ones provided in the constructor are used if any. N)r r r )r r r �refresh_token_key)r" r r r r# r$ r$ r% rM � s ��zClient.prepare_refresh_bodyc C sZ |t kr t�| j|�}n |tkrt�| j|�}n|tkr$t�| j|�}ntd��|||fS )zDAdd a bearer token to the request uri, body or authorization header.�Invalid token placement.) � AUTH_HEADERr �prepare_bearer_headersr � URI_QUERY�prepare_bearer_uri�BODY�prepare_bearer_bodyr< )r" r? r@ r rA rB r$ r$ r% r( � s zClient._add_bearer_tokenc C sV d}|dks t d��|dkst d��t�d�}t�|�}t�||�s&t d��|| _|S )a� Create PKCE **code_verifier** used in computing **code_challenge**. See `RFC7636 Section 4.1`_ :param length: REQUIRED. The length of the code_verifier. The client first creates a code verifier, "code_verifier", for each OAuth 2.0 [RFC6749] Authorization Request, in the following manner: .. code-block:: text code_verifier = high-entropy cryptographic random STRING using the unreserved characters [A-Z] / [a-z] / [0-9] / "-" / "." / "_" / "~" from Section 2.3 of [RFC3986], with a minimum length of 43 characters and a maximum length of 128 characters. .. _`RFC7636 Section 4.1`: https://tools.ietf.org/html/rfc7636#section-4.1 N�+ z*Length must be greater than or equal to 43� z(Length must be less than or equal to 128z^[A-Zaa-z0-9-._~]z)code_verifier contains invalid characters)r< �re�compile�secrets� token_urlsafe�searchr )r" �lengthr �allowed_charactersr$ r$ r% �create_code_verifier� s zClient.create_code_verifierc C s� d}|dkr t d��|dkrd}|| _|}|| _|dkrFt�� }|�|jdd�� |�� }t� t � |��}|� dd�� d d �� d d �}|| _|S ) aZ Create PKCE **code_challenge** derived from the **code_verifier**. See `RFC7636 Section 4.2`_ :param code_verifier: REQUIRED. The **code_verifier** generated from `create_code_verifier()`. :param code_challenge_method: OPTIONAL. The method used to derive the **code_challenge**. Acceptable values include `S256`. DEFAULT is `plain`. The client then creates a code challenge derived from the code verifier by using one of the following transformations on the code verifier:: plain code_challenge = code_verifier S256 code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) If the client is capable of using `S256`, it MUST use `S256`, as `S256` is Mandatory To Implement (MTI) on the server. Clients are permitted to use `plain` only if they cannot support `S256` for some technical reason and know via out-of-band configuration that the server supports `plain`. The plain transformation is for compatibility with existing deployments and for constrained environments that can't use the S256 transformation. .. _`RFC7636 Section 4.2`: https://tools.ietf.org/html/rfc7636#section-4.2 NzInvalid code_verifier�plain�S256�ascii)�encoding�+�-�/�_�=rF ) r< r r �hashlib�sha256�update�encode�digest�bytes�decode�base64�urlsafe_b64encode�replace)r" r r r �h� sha256_valr$ r$ r% �create_code_challenge� s z Client.create_code_challengec K sB |t krtd��tj| j|| j|f|||| jd�|��}|||fS )z�Add a MAC token to the request authorization header. Warning: MAC token support is experimental as the spec is not yet stable. rT )rA r �ext�hash_algorithm)rU r< r �prepare_mac_headerr r r )r" r? r@ r rA rB r{ r# r$ r$ r% r) ) s ��� zClient._add_mac_tokenc C s t �dt� | �|�S )Nz=Please switch to the public method populate_token_attributes.)�warnings�warn�DeprecationWarningr! �r" �responser$ r$ r% �_populate_attributes7 s � zClient._populate_attributesc C s d|v r |� d�| _dS dS )z2Add attributes from an auth code response to self.r N)r= r r� r$ r$ r% �populate_code_attributes< s �z Client.populate_code_attributesc C s� d|v r |� d�| _d|v r|� d�| _d|v r |� d�| _d|v r2|� d�| _t�� t| j� | _d|v rHz t|� d��| _W n d| _Y d|v rR|� d�| _d|v r^|� d�| _ dS dS ) z6Add attributes from a token exchange response to self.r r r r � expires_atNr r ) r= r r r r r> �intr r r r� r$ r$ r% r! B s& �z Client.populate_token_attributes)r5 NNN)NNN)NNNrF )NrF N)r rF N)N)rF NN)�__name__� __module__� __qualname__�__doc__rS rU r r& �propertyr* r1 r3 r4 rD rJ r rN r rR rM r( rd rz r) r� r� r! r$ r$ r$ r% r $ sd �T �6 �& �" � � 7 5 � $1 � r )r� ru rn r] r_ r> r~ �oauthlib.commonr �oauthlib.oauth2.rfc6749r � oauthlib.oauth2.rfc6749.errorsr r �"oauthlib.oauth2.rfc6749.parametersr r r � oauthlib.oauth2.rfc6749.utilsr rU rW rY rG r r$ r$ r$ r% �<module> s$ �
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.02 |
proxy
|
phpinfo
|
Settings