
    ([fN                     d    d Z ddlmZ  G d d          Z G d d          Z G d d          Zd	S )
z
    authlib.oauth2.rfc6749.models
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    This module defines how to construct Client, AuthorizationCode and Token.
    )	deprecatec                   H    e Zd ZdZd Zd Zd Zd Zd Zd Z	d Z
d	 Zd
 ZdS )ClientMixina  Implementation of OAuth 2 Client described in `Section 2`_ with
    some methods to help validation. A client has at least these information:

    * client_id: A string represents client identifier.
    * client_secret: A string represents client password.
    * token_endpoint_auth_method: A way to authenticate client at token
                                  endpoint.

    .. _`Section 2`: https://tools.ietf.org/html/rfc6749#section-2
    c                     t                      )zA method to return client_id of the client. For instance, the value
        in database is saved in a column called ``client_id``::

            def get_client_id(self):
                return self.client_id

        :return: string
        NotImplementedErrorselfs    Q/var/www/piapp/venv/lib/python3.11/site-packages/authlib/oauth2/rfc6749/models.pyget_client_idzClientMixin.get_client_id        "###    c                     t                      )a  A method to get client default redirect_uri. For instance, the
        database table for client has a column called ``default_redirect_uri``::

            def get_default_redirect_uri(self):
                return self.default_redirect_uri

        :return: A URL string
        r   r	   s    r   get_default_redirect_uriz$ClientMixin.get_default_redirect_uri!   r   r   c                     t                      )a  A method to return a list of requested scopes which are supported by
        this client. For instance, there is a ``scope`` column::

            def get_allowed_scope(self, scope):
                if not scope:
                    return ''
                allowed = set(scope_to_list(self.scope))
                return list_to_scope([s for s in scope.split() if s in allowed])

        :param scope: the requested scope.
        :return: string of scope
        r   )r
   scopes     r   get_allowed_scopezClientMixin.get_allowed_scope,   s     "###r   c                     t                      )as  Validate redirect_uri parameter in Authorization Endpoints. For
        instance, in the client table, there is an ``allowed_redirect_uris``
        column::

            def check_redirect_uri(self, redirect_uri):
                return redirect_uri in self.allowed_redirect_uris

        :param redirect_uri: A URL string for redirecting.
        :return: bool
        r   )r
   redirect_uris     r   check_redirect_urizClientMixin.check_redirect_uri;        "###r   c                     t                      )a  Check client_secret matching with the client. For instance, in
        the client table, the column is called ``client_secret``::

            import secrets

            def check_client_secret(self, client_secret):
                return secrets.compare_digest(self.client_secret, client_secret)

        :param client_secret: A string of client secret
        :return: bool
        r   )r
   client_secrets     r   check_client_secretzClientMixin.check_client_secretH   s     "###r   c                     t                      )a  Check if client support the given method for the given endpoint.
        There is a ``token_endpoint_auth_method`` defined via `RFC7591`_.
        Developers MAY re-implement this method with::

            def check_endpoint_auth_method(self, method, endpoint):
                if endpoint == 'token':
                    # if client table has ``token_endpoint_auth_method``
                    return self.token_endpoint_auth_method == method
                return True

        Method values defined by this specification are:

        *  "none": The client is a public client as defined in OAuth 2.0,
            and does not have a client secret.

        *  "client_secret_post": The client uses the HTTP POST parameters
            as defined in OAuth 2.0

        *  "client_secret_basic": The client uses HTTP Basic as defined in
            OAuth 2.0

        .. _`RFC7591`: https://tools.ietf.org/html/rfc7591
        r   )r
   methodendpoints      r   check_endpoint_auth_methodz&ClientMixin.check_endpoint_auth_methodV   s    0 "###r   c                 L    t          d           |                     |d          S )Nz8Please implement ``check_endpoint_auth_method`` instead.token)r   r   )r
   r   s     r    check_token_endpoint_auth_methodz,ClientMixin.check_token_endpoint_auth_methodp   s'    LMMM..vw???r   c                     t                      )a  Validate if the client can handle the given response_type. There
        are two response types defined by RFC6749: code and token. For
        instance, there is a ``allowed_response_types`` column in your client::

            def check_response_type(self, response_type):
                return response_type in self.response_types

        :param response_type: the requested response_type string.
        :return: bool
        r   )r
   response_types     r   check_response_typezClientMixin.check_response_typet   r   r   c                     t                      )a  Validate if the client can handle the given grant_type. There are
        four grant types defined by RFC6749:

        * authorization_code
        * implicit
        * client_credentials
        * password

        For instance, there is a ``allowed_grant_types`` column in your client::

            def check_grant_type(self, grant_type):
                return grant_type in self.grant_types

        :param grant_type: the requested grant_type string.
        :return: bool
        r   )r
   
grant_types     r   check_grant_typezClientMixin.check_grant_type   s    " "###r   N)__name__
__module____qualname____doc__r   r   r   r   r   r   r!   r$   r'    r   r   r   r   
   s        	 		$ 	$ 	$	$ 	$ 	$$ $ $$ $ $$ $ $$ $ $4@ @ @$ $ $$ $ $ $ $r   r   c                       e Zd Zd Zd ZdS )AuthorizationCodeMixinc                     t                      )a  A method to get authorization code's ``redirect_uri``.
        For instance, the database table for authorization code has a
        column called ``redirect_uri``::

            def get_redirect_uri(self):
                return self.redirect_uri

        :return: A URL string
        r   r	   s    r   get_redirect_uriz'AuthorizationCodeMixin.get_redirect_uri   s     "###r   c                     t                      zA method to get scope of the authorization code. For instance,
        the column is called ``scope``::

            def get_scope(self):
                return self.scope

        :return: scope string
        r   r	   s    r   	get_scopez AuthorizationCodeMixin.get_scope   r   r   N)r(   r)   r*   r0   r3   r,   r   r   r.   r.      s2        
$ 
$ 
$	$ 	$ 	$ 	$ 	$r   r.   c                   ,    e Zd Zd Zd Zd Zd Zd ZdS )
TokenMixinc                     t                      )a  A method to check if this token is issued to the given client.
        For instance, ``client_id`` is saved on token table::

            def check_client(self, client):
                return self.client_id == client.client_id

        :return: bool
        r   )r
   clients     r   check_clientzTokenMixin.check_client   r   r   c                     t                      r2   r   r	   s    r   r3   zTokenMixin.get_scope   r   r   c                     t                      )zA method to get the ``expires_in`` value of the token. e.g.
        the column is called ``expires_in``::

            def get_expires_in(self):
                return self.expires_in

        :return: timestamp int
        r   r	   s    r   get_expires_inzTokenMixin.get_expires_in   r   r   c                     t                      )zA method to define if this token is expired. For instance,
        there is a column ``expired_at`` in the table::

            def is_expired(self):
                return self.expired_at < now

        :return: boolean
        r   r	   s    r   
is_expiredzTokenMixin.is_expired   r   r   c                     t                      )zA method to define if this token is revoked. For instance,
        there is a boolean column ``revoked`` in the table::

            def is_revoked(self):
                return self.revoked

        :return: boolean
        r   r	   s    r   
is_revokedzTokenMixin.is_revoked   r   r   N)r(   r)   r*   r8   r3   r;   r=   r?   r,   r   r   r5   r5      s_        	$ 	$ 	$	$ 	$ 	$	$ 	$ 	$	$ 	$ 	$	$ 	$ 	$ 	$ 	$r   r5   N)r+   authlib.deprecater   r   r.   r5   r,   r   r   <module>rA      s     ( ' ' ' ' 'H$ H$ H$ H$ H$ H$ H$ H$V$ $ $ $ $ $ $ $26$ 6$ 6$ 6$ 6$ 6$ 6$ 6$ 6$ 6$r   