File: //opt/cppython/lib/python3.8/site-packages/google/auth/__pycache__/identity_pool.cpython-38.pyc
U
KD�g.I � @ s� d Z zddlmZ W n ek
r4 ddlmZ Y nX ddlZddlZddlZddlm Z ddl
m Z ddl
m Z ddl
m
Z
ddlmZ G d d
� d
ejd �ZG d d
� d
e �ZG dd� de�ZG dd� de�ZG dd� de�Zddd�ZG dd� de
j�ZdS )a= Identity Pool Credentials.
This module provides credentials to access Google Cloud resources from on-prem
or non-Google Cloud platforms which support external credentials (e.g. OIDC ID
tokens) retrieved from local file locations or local servers. This includes
Microsoft Azure and OIDC identity providers (e.g. K8s workloads registered with
Hub with Hub workload identity enabled).
These credentials are recommended over the use of service account credentials
in on-prem/non-Google Cloud platforms as they do not involve the management of
long-live service account private keys.
Identity Pool Credentials are initialized using external_account
arguments which are typically loaded from an external credentials file or
an external credentials URL.
This module also provides a definition for an abstract subject token supplier.
This supplier can be implemented to return a valid OIDC or SAML2.0 subject token
and used to create Identity Pool credentials. The credentials will then call the
supplier instead of using pre-defined methods such as reading a local file or
calling a URL.
� )�MappingN)�
NamedTuple)�_helpers)�
exceptions)�external_account)� _mtls_helperc @ s e Zd ZdZejdd� �ZdS )�SubjectTokenSupplieraW Base class for subject token suppliers. This can be implemented with custom logic to retrieve
a subject token to exchange for a Google Cloud access token when using Workload or
Workforce Identity Federation. The identity pool credential does not cache the subject token,
so caching logic should be added in the implementation.
c C s t d��dS )a� Returns the requested subject token. The subject token must be valid.
.. warning: This is not cached by the calling Google credential, so caching logic should be implemented in the supplier.
Args:
context (google.auth.externalaccount.SupplierContext): The context object
containing information about the requested audience and subject token type.
request (google.auth.transport.Request): The object used to make
HTTP requests.
Raises:
google.auth.exceptions.RefreshError: If an error is encountered during
subject token retrieval logic.
Returns:
str: The requested subject token string.
� N)�NotImplementedError��self�context�request� r �F/opt/cppython/lib/python3.8/site-packages/google/auth/identity_pool.py�get_subject_token= s z&SubjectTokenSupplier.get_subject_tokenN)�__name__�
__module__� __qualname__�__doc__�abc�abstractmethodr r r r r r 6 s r )� metaclassc @ s" e Zd ZU dZeed< eed< dS )�
_TokenContenta" Models the token content response from file and url internal suppliers.
Attributes:
content (str): The string content of the file or URL response.
location (str): The location the content was retrieved from. This will either be a file location or a URL.
�content�locationN)r r r r �str�__annotations__r r r r r S s
r c @ s* e Zd ZdZdd� Ze�e�dd� �ZdS )�
_FileSupplierzf Internal implementation of subject token supplier which supports reading a subject token from a file.c C s || _ || _|| _d S �N)�_path� _format_type�_subject_token_field_name)r �path� format_type�subject_token_field_namer r r �__init__a s z_FileSupplier.__init__c C s\ t j�| j�s t�d�| j���t| jddd��}t|� � | j�}W 5 Q R X t
|| j | j �S )NzFile '{}' was not found.�r�utf-8)�encoding)
�osr# �existsr r � RefreshError�format�openr �read�_parse_token_datar! r" )r r
r Zfile_obj�
token_contentr r r r f s �z _FileSupplier.get_subject_tokenN� r r r r r& r �copy_docstringr r r r r r r ^ s r c @ s* e Zd ZdZdd� Ze�e�dd� �ZdS )� _UrlSupplierzw Internal implementation of subject token supplier which supports retrieving a subject token by calling a URL endpoint.c C s || _ || _|| _|| _d S r )�_urlr! r" �_headers)r �urlr$ r% �headersr r r r& v s z_UrlSupplier.__init__c C sb || j d| jd�}t|jd�r*|j�d�n|j}|jdkrFt�d|��t|| j �}t || j
| j �S )N�GET)r7 �methodr8 �decoder( �� z.Unable to retrieve Identity Pool subject token) r5 r6 �hasattr�datar; �statusr r, r r0 r! r" )r r
r �responseZ
response_bodyr1 r r r r | s
��
� �z _UrlSupplier.get_subject_tokenNr2 r r r r r4 s s r4 c @ s" e Zd ZdZe�e�dd� �ZdS )�
_X509Supplierz�Internal supplier for X509 workload credentials. This class is used internally and always returns an empty string as the subject token.c C s dS )Nr r r r r r r � s z _X509Supplier.get_subject_tokenN)r r r r r r3 r r r r r r rA � s rA �textc C sh |dkr| j }nFzt�| j �}|| }W n, ttfk
rT t�d�| j|���Y nX |sdt�d��|S )NrB z@Unable to parse subject_token from JSON file '{}' using key '{}'z3Missing subject_token in the credential_source file) r �json�loads�KeyError�
ValueErrorr r, r- r )r1 r$ r% �tokenZ
response_datar r r r0 � s" ��
�r0 c s� e Zd ZdZejddf� fdd� Ze�ej �dd� �Z
dd� Z d d
� Z � fd d �Z
d
d� Z� fdd�Zdd� Zdd� Zdd� Ze� fdd��Ze� fdd��Z� ZS )� Credentialsz9External account credentials sourced from files and URLs.Nc s4 t t| �j|||||d�|�� |dkr:|dkr:t�d��|dk rT|dk rTt�d��|dk rv|| _d| _d| _d| _n�t |t
�s�d| _ t� d��|�
d�| _|�
d�| _|�
d�| _d |kr�t� d
��| �� | jr�| �� n
| �|� | j�rt| j| j| j�| _n*| j�r(t| j| j| j| j�| _nt� | _dS ) u� Instantiates an external account credentials object from a file/URL.
Args:
audience (str): The STS audience field.
subject_token_type (str): The subject token type based on the Oauth2.0 token exchange spec.
Expected values include::
“urn:ietf:params:oauth:token-type:jwt”
“urn:ietf:params:oauth:token-type:id-token”
“urn:ietf:params:oauth:token-type:saml2”
token_url (Optional [str]): The STS endpoint URL. If not provided, will default to "https://sts.googleapis.com/v1/token".
credential_source (Optional [Mapping]): The credential source dictionary used to
provide instructions on how to retrieve external credential to be
exchanged for Google access tokens. Either a credential source or
a subject token supplier must be provided.
Example credential_source for url-sourced credential::
{
"url": "http://www.example.com",
"format": {
"type": "json",
"subject_token_field_name": "access_token",
},
"headers": {"foo": "bar"},
}
Example credential_source for file-sourced credential::
{
"file": "/path/to/token/file.txt"
}
subject_token_supplier (Optional [SubjectTokenSupplier]): Optional subject token supplier.
This will be called to supply a valid subject token which will then
be exchanged for Google access tokens. Either a subject token supplier
or a credential source must be provided.
args (List): Optional positional arguments passed into the underlying :meth:`~external_account.Credentials.__init__` method.
kwargs (Mapping): Optional keyword arguments passed into the underlying :meth:`~external_account.Credentials.__init__` method.
Raises:
google.auth.exceptions.RefreshError: If an error is encountered during
access token retrieval logic.
ValueError: For invalid parameters.
.. note:: Typically one of the helper constructors
:meth:`from_file` or
:meth:`from_info` are used instead of calling the constructor directly.
)�audience�subject_token_type� token_url�credential_sourceNzGA valid credential source or a subject token supplier must be provided.z[Identity pool credential cannot have both a credential source and a subject token supplier.z?Invalid credential_source. The credential_source is not a dict.�filer7 Z certificateZenvironment_idz>Invalid Identity Pool credential_source field 'environment_id')�superrH r& r Z InvalidValue�_subject_token_supplier�_credential_source_file�_credential_source_url� _credential_source_certificate�
isinstancer Z _credential_source_executable�MalformedError�get�_validate_single_source� _validate_certificate_config� _validate_file_or_url_configr � _credential_source_format_type� _credential_source_field_namer4 �_credential_source_headersrA )r rI rJ rK rL �subject_token_supplier�args�kwargs�� __class__r r r& � sh <
�����
� �
��zCredentials.__init__c C s | j �| j|�S r )rO r Z_supplier_context)r r r r r �retrieve_subject_token- s �z"Credentials.retrieve_subject_tokenc C s& | j d krt�d��n t�| j�S d S )Nz�The credential is not configured to use mtls requests. The credential should include a "certificate" section in the credential source.)rR r r, r Z _get_workload_cert_and_key_paths� _certificate_config_location�r r r r � _get_mtls_cert_and_key_paths3 s
��z(Credentials._get_mtls_cert_and_key_pathsc C s
| j d k S r )rR rc r r r �_mtls_required= s zCredentials._mtls_requiredc s\ t t| ��� }t| jt�rP| j�d�r0d|d< qX| j�d�rFd|d< qXd|d< nd|d< |S )NrM �sourcer7 �x509Z programmatic)rN rH � _create_default_metrics_optionsrS �_credential_sourcer rU )r Zmetrics_optionsr_ r r rh @ s
z+Credentials._create_default_metrics_optionsc C s
| j d kS r )ri rc r r r �_has_custom_supplierP s z Credentials._has_custom_supplierc s* t t| ��� }| �� r&|�d| ji� |S )Nr\ )rN rH �_constructor_argsrj �updaterO )r r] r_ r r rk S s z Credentials._constructor_argsc C sF | j �d�| _| j �d�}| jr.|r.t�d��| jsB|sBt�d��d S )NZcertificate_config_locationZ use_default_certificate_configz~Invalid certificate configuration, certificate_config_location cannot be specified when use_default_certificate_config = true.zInvalid certificate configuration, use_default_certificate_config should be true if no certificate_config_location is provided.)rR rU rb r rT )r Z use_defaultr r r rW Z s ��
�
�z(Credentials._validate_certificate_configc C sz |� d�| _|� di �}|� d�p$d| _| jdkrDt�d�| j���| jdkrp|� d�| _| jd krvt�d ��nd | _d S )
Nr8 r- �typerB )rB rC z%Invalid credential_source format '{}'rC r% zBMissing subject_token_field_name for JSON credential_source format)rU r[ rY r rT r- rZ )r rL Zcredential_source_formatr r r rX j s& �
��
�
�z(Credentials._validate_file_or_url_configc C sR | j | j| jg}ttdd� |��}t|�dkr8t�d��t|�dkrNt�d��d S )Nc S s | d k S r r )rf r r r �<lambda>� � z5Credentials._validate_single_source.<locals>.<lambda>� zVAmbiguous credential_source. 'file', 'url', and 'certificate' are mutually exclusive..zNMissing credential_source. A 'file', 'url', or 'certificate' must be provided.)rP rQ rR �list�filter�lenr rT )r Zcredential_sourcesZvalid_credential_sourcesr r r rV � s � � � �z#Credentials._validate_single_sourcec s, |� d�}|�d|i� tt| �j|f|�S )a� Creates an Identity Pool Credentials instance from parsed external account info.
Args:
info (Mapping[str, str]): The Identity Pool external account info in Google
format.
kwargs: Additional arguments to pass to the constructor.
Returns:
google.auth.identity_pool.Credentials: The constructed
credentials.
Raises:
ValueError: For invalid parameters.
r\ )rU rl rN rH � from_info)�cls�infor^ r\ r_ r r rt � s
zCredentials.from_infoc s t t| �j|f|�S )at Creates an IdentityPool Credentials instance from an external account json file.
Args:
filename (str): The path to the IdentityPool external account json file.
kwargs: Additional arguments to pass to the constructor.
Returns:
google.auth.identity_pool.Credentials: The constructed
credentials.
)rN rH � from_file)ru �filenamer^ r_ r r rw � s zCredentials.from_file)r r r r r Z_DEFAULT_TOKEN_URLr& r r3 rH ra rd re rh rj rk rW rX rV � classmethodrt rw �
__classcell__r r r_ r rH � s& �{
rH )rB N)r �collections.abcr � ImportError� collectionsr rC r* �typingr Z google.authr r r Zgoogle.auth.transportr �ABCMetar r r r4 rA r0 rH r r r r �<module> s&