]jdqUdZddlZddlmZddlZddlZddlmZmZm Z m Z ddl m Z ddl Z ddlmZmZddlmZddlmZdd lmZdd lmZdd lmZe rddlZd ZgZeeed <dZej>dZ GddeZ!Gdde!Z"Gdde!Z#Gdde!Z$Gdde!Z%Gdde!Z&GddejNZ(Gdd e(Z)d(d!Z*Gd"d#ejNZ+Gd$d%eZ,Gd&d'e%Z-y))zInterfaces for credentials.N)Enum)DictListOptional TYPE_CHECKING)urlparse)_helpersenvironment_vars)_regional_access_boundary_utils) exceptions)metrics)_BaseCredentials)RefreshThreadManagerzgoogleapis.comNO_OP_TRUST_BOUNDARY_LOCATIONS0x0zgoogle.auth._defaultceZdZdZfdZedZedZedZedZ edZ dZ e jd Zd Zdd Zd Zd ZdZdZxZS) CredentialsaQBase class for all credentials. All credentials have a :attr:`token` that is used for authentication and may also optionally set an :attr:`expiry` to indicate when the token will no longer be valid. Most credentials will be :attr:`invalid` until :meth:`refresh` is called. Credentials can do this automatically before the first HTTP request in :meth:`before_request`. Although the token and expiration will change as the credentials are :meth:`refreshed ` and used, credentials should be considered immutable. Various credentials will accept configuration such as private keys, scopes, and other options. These options are not changeable after construction. Some classes will provide mechanisms to copy the credentials with modifications such as :meth:`ScopedCredentials.with_scopes`. ctt| d|_ d|_ d|_ t |_ d|_t|_ yNF) superr__init__expiry_quota_project_id_trust_boundaryDEFAULT_UNIVERSE_DOMAIN_universe_domain_use_non_blocking_refreshr_refresh_workerself __class__s A/root/env/lib/python3.12/site-packages/google/auth/credentials.pyrzCredentials.__init__BsY k4)+  B!%K# !8 */&35c|jsy|jtjz }tj|k\S)a(Checks if the credentials are expired. Note that credentials can be invalid but not expired because Credentials with :attr:`expiry` set to None is considered to never expire. .. deprecated:: v2.24.0 Prefer checking :attr:`token_state` instead. F)rr REFRESH_THRESHOLDutcnow)r skewed_expirys r"expiredzCredentials.expiredUs6{{ h&@&@@  M11r#c<|jduxr |j S)zChecks the validity of the credentials. This is True if the credentials have a :attr:`token` and the token is not :attr:`expired`. .. deprecated:: v2.24.0 Prefer checking :attr:`token_state` instead. N)tokenr(r s r"validzCredentials.validgszz%:dll*::r#c|jtjS|jtjSt j |jk\}|rtjSt j |jt jz k\}|rtjStjS)z( See `:obj:`TokenState` ) r* TokenStateINVALIDrFRESHr r&r%STALE)r r(is_stales r" token_statezCredentials.token_statess :: %% % ;; ## #//#t{{2 %% %??$x7Q7Q)QR ## #r#c|jS)z.Project to use for quota and billing purposes.)rr+s r"quota_project_idzCredentials.quota_project_ids%%%r#c|jS)zThe universe domain value.)rr+s r"universe_domainzCredentials.universe_domains$$$r#cy)zThe credential information JSON. The credential information will be added to auth related error messages by client library. Returns: Mapping[str, str]: The credential information JSON. Nr+s r" get_cred_infozCredentials.get_cred_infosr#ctd)Refreshes the access token. Args: request (google.auth.transport.Request): The object used to make HTTP requests. Raises: google.auth.exceptions.RefreshError: If the credentials could not be refreshed. zRefresh must be implementedNotImplementedErrorr requests r"refreshzCredentials.refreshs""?@@r#cy)a The x-goog-api-client header for token usage metric. This header will be added to the API service requests in before_request method. For example, "cred-type/sa-jwt" means service account self signed jwt access token is used in the API service request authorization header. Children credentials classes need to override this method to provide the header value, if the token usage metric is needed. Returns: str: The x-goog-api-client header value. Nr9r+s r"_metric_header_for_usagez$Credentials._metric_header_for_usagesr#c`|j|||jr|j|d<yy)zApply the token to the authentication header. Args: headers (Mapping): The HTTP request headers. token (Optional[str]): If specified, overrides the current access token. zx-goog-user-projectN)_applyr5r headersr*s r"applyzCredentials.applys1 GU#  -1-B-BG) * !r#c@|js|j|yyN)r,rAr?s r"_blocking_refreshzCredentials._blocking_refreshszz LL !r#cd}|jtjk(r|jj || }|jtj k(s|r,|j ||jjyyr)r3r.r1r start_refreshr/rA clear_error)r r@use_blocking_refresh_fallbacks r"_non_blocking_refreshz!Credentials._non_blocking_refreshs|(-%   z// /040D0D0R0Rg1- )   z11 15R LL !  , , . 6Sr#c|jr|j|n|j|tj||j |j |y)aPerforms credential-specific before request logic. Refreshes the credentials if necessary, then calls :meth:`apply` to apply the token to the authentication header. Args: request (google.auth.transport.Request): The object used to make HTTP requests. method (str): The request's HTTP method or the RPC method being invoked. url (str): The request's URI or the RPC service's URI. headers (Mapping): The request's headers. N)rrPrKr add_metric_headerrCrHr r@methodurlrGs r"before_requestzCredentials.before_requestsN"  ) )  & &w /  " "7 +!!'4+H+H+JK 7r#cd|_y)NT)rr+s r"with_non_blocking_refreshz%Credentials.with_non_blocking_refreshs )-&r#rJ)__name__ __module__ __qualname____doc__rpropertyr(r,r3r5r7r:abcabstractmethodrArCrHrKrPrVrX __classcell__r!s@r"rr/s$6&22" ; ;  *&&%%   A A  C" /2.r#rceZdZdZdZdZy)CredentialsWithQuotaProjectzGAbstract base for credentials supporting ``with_quota_project`` factoryctd)aReturns a copy of these credentials with a modified quota project. Args: quota_project_id (str): The project to use for quota and billing purposes Returns: google.auth.credentials.Credentials: A new credentials instance. z/This credential does not support quota project.r=)r r5s r"with_quota_projectz.CredentialsWithQuotaProject.with_quota_projects""STTr#ctjjtj}|r|j |S|SrJ)osenvirongetr GOOGLE_CLOUD_QUOTA_PROJECTre)r quota_from_envs r"#with_quota_project_from_environmentz?CredentialsWithQuotaProject.with_quota_project_from_environments4(8(S(ST **>: : r#N)rYrZr[r\rerlr9r#r"rcrcsQ Ur#rcceZdZdZdZy)CredentialsWithTokenUrizCAbstract base for credentials supporting ``with_token_uri`` factoryctd)aReturns a copy of these credentials with a modified token uri. Args: token_uri (str): The uri to use for fetching/exchanging tokens Returns: google.auth.credentials.Credentials: A new credentials instance. z'This credential does not use token uri.r=)r token_uris r"with_token_uriz&CredentialsWithTokenUri.with_token_uris""KLLr#N)rYrZr[r\rqr9r#r"rnrns M Mr#rnceZdZdZdZy)CredentialsWithUniverseDomainzIAbstract base for credentials supporting ``with_universe_domain`` factoryctd)zReturns a copy of these credentials with a modified universe domain. Args: universe_domain (str): The universe domain to use Returns: google.auth.credentials.Credentials: A new credentials instance. z6This credential does not support with_universe_domain.r=)r r7s r"with_universe_domainz2CredentialsWithUniverseDomain.with_universe_domain!s" D  r#N)rYrZr[r\rur9r#r"rsrss S  r#rsceZdZdZfdZedZedZejdZ dZ dZ dZ d Zd Zd Zdfd Zd ZdZ ddddeddfdZej d ddZxZS)%CredentialsWithRegionalAccessBoundaryzPAbstract base for credentials supporting regional access boundary configuration.cTt|tj|_yrJ)rrr _RegionalAccessBoundaryManager _rab_managerrs r"rz.CredentialsWithRegionalAccessBoundary.__init__2s"  + J J L r#cB|jjjS)z>Optional[str]: The encoded Regional Access Boundary locations.)rz_dataencoded_locationsr+s r"regional_access_boundaryz>CredentialsWithRegionalAccessBoundary.regional_access_boundary8s  &&888r#cB|jjjS)zQOptional[datetime.datetime]: The expiration time of the Regional Access Boundary.)rzr|rr+s r"regional_access_boundary_expiryzECredentialsWithRegionalAccessBoundary.regional_access_boundary_expiry=s  &&---r#ctd)r<z*_perform_refresh_token must be implementedr=r?s r"_perform_refresh_tokenz)r trust_boundaryr make_copys r"with_trust_boundaryz9CredentialsWithRegionalAccessBoundary.with_trust_boundaryPsI  B  D,5 ; %D r#cptj}|jj|_||_y)z@Copies the regional access boundary manager to another instance.N)r ryrzr|)r target new_managers r"&_copy_regional_access_boundary_managerzLCredentialsWithRegionalAccessBoundary._copy_regional_access_boundary_managerns.6TTV  --33 )r#c|jj|jdd|jdd|S)a0Applies the regional_access_boundary provided via the seed on these credentials. This is intended for internal use only as invalid seeds would produce unexpected results until automatic recovery is supported. Currently this is used by the gcloud CLI and therefore changes to the contract MUST be backwards compatible (e.g. the method signature must be unchanged and the credentials with the RAB set must be returned). Returns: google.auth.credentials.Credentials: The credentials instance. encodedLocationsNr)r}r)rz$set_initial_regional_access_boundaryri)r seeds r"_set_regional_access_boundaryzCCredentialsWithRegionalAccessBoundary._set_regional_access_boundaryvsA >>"hh'94@88Hd+ ?  r#c:|jj|S)aEnables the blocking lookup mode on these credentials. This is intended for internal use only as blocking lookup requires additional care and consideration. Currently this is used by the gcloud CLI and therefore changes to the contract MUST be backwards compatible (e.g. the method signature must be unchanged and the credentials with the blocking lookup flag set to true must be returned). Returns: google.auth.credentials.Credentials: The credentials instance. )rzenable_blocking_lookupr+s r"-_set_blocking_regional_access_boundary_lookupzSCredentialsWithRegionalAccessBoundary._set_blocking_regional_access_boundary_lookups 002 r#c t|j}|r#|jds|jdry|j sy|j j||y#ttf$rY?wxYw)a Starts a background thread to refresh the Regional Access Boundary if needed. This method checks if a refresh is necessary and if one is not already in progress or in a cooldown period. If so, it starts a background thread to perform the lookup. Args: request (google.auth.transport.Request): The object used to make HTTP requests. url (str): The URL of the request. z.rep.googleapis.comz.rep.sandbox.googleapis.comN)rhostnameendswith ValueError TypeError,_is_regional_access_boundary_lookup_requiredrzmaybe_start_refresh)r r@rUrs r"-_maybe_start_regional_access_boundary_refreshzSCredentialsWithRegionalAccessBoundary._maybe_start_regional_access_boundary_refreshs| }--H!!"78$$%BC @@B  --dG<I&   s9A**A<;A<cVtjsy|jtk7ryy)a/Checks if a Regional Access Boundary lookup is required. A lookup is required if the feature is enabled via an environment variable and the universe domain is supported. Returns: bool: True if a Regional Access Boundary lookup is required, False otherwise. FT)r #is_regional_access_boundary_enabledr7rr+s r"rzRCredentialsWithRegionalAccessBoundary._is_regional_access_boundary_lookup_requireds*/RRT   #: :r#c\t||||jj|y)z-Apply the token to the authentication header.N)rrHrz apply_headers)r rGr*r!s r"rHz+CredentialsWithRegionalAccessBoundary.applys%  gu% ''0r#c|jr|j|n|j||j||t j ||j |j|y)zjRefreshes the access token and triggers the Regional Access Boundary lookup if necessary. N)rrPrKrr rRrCrHrSs r"rVz4CredentialsWithRegionalAccessBoundary.before_requests^  ) )  & &w /  " "7 + ::7CH!!'4+H+H+JK 7r#c&|j|y)zRefreshes the access token. This method calls the subclass's token refresh logic. The Regional Access Boundary is refreshed separately in a non-blocking way. N)rr?s r"rAz-CredentialsWithRegionalAccessBoundary.refreshs ##G,r#r@zgoogle.auth.transport.Request fail_fastreturnzOptional[Dict[str, str]]cddlm}|j|}|stj dyi}|j ||j j||j||||S)aCalls the Regional Access Boundary lookup API to retrieve the Regional Access Boundary information. Args: request (google.auth.transport.Request): The object used to make HTTP requests. fail_fast (bool): Whether the lookup should fail fast (short timeout, no retries). Returns: Optional[Dict[str, str]]: The Regional Access Boundary information returned by the lookup API, or None if the lookup failed. r)_client)r@z4Failed to build Regional Access Boundary lookup URL.N)rGr) google.oauth2r*_build_regional_access_boundary_lookup_url_LOGGERerrorrErzr _lookup_regional_access_boundary)r r@rrrUrGs r"rzFCredentialsWithRegionalAccessBoundary._lookup_regional_access_boundaryss *==g=N MMP Q"$ G ''077 S'Y8  r#ctd)a Builds and returns the URL for the Regional Access Boundary lookup API. This method should be implemented by subclasses to provide the specific URL based on the credential type and its properties. Args: request (Optional[google.auth.transport.Request]): The object used to make HTTP requests. In some subclasses, this may be used to make an initial network call to resolve required metadata for the URL. Returns: str: The URL for the Regional Access Boundary lookup endpoint, or None if lookup should be skipped (e.g., for non-applicable universe domains). z>_build_regional_access_boundary_lookup_url must be implementedr=r?s r"rzPCredentialsWithRegionalAccessBoundary._build_regional_access_boundary_lookup_urls(" L  r#rJ)F)r@z'Optional[google.auth.transport.Request])rYrZr[r\rr]r~rr^r_rrrrrrrrHrVrAboolrrr`ras@r"rwrw/sZ 99..  P P<*$ =@&1 -  0   $  : CG @  r#rwcDeZdZdZedZedZdZddZdZ y) AnonymousCredentialszCredentials that do not provide any authentication information. These are useful in the case of services that support anonymous access or local service emulators that do not use credentials. cy)z4Returns `False`, anonymous credentials never expire.Fr9r+s r"r(zAnonymousCredentials.expired!r#cy)z7Returns `True`, anonymous credentials are always valid.Tr9r+s r"r,zAnonymousCredentials.valid&sr#c,tjd)zVRaises :class:``InvalidOperation``, anonymous credentials cannot be refreshed.z*Anonymous credentials cannot be refreshed.)r InvalidOperationr?s r"rAzAnonymousCredentials.refresh+s))*VWWr#Nc2|tjdy)zAnonymous credentials do nothing to the request. The optional ``token`` argument is not supported. Raises: google.auth.exceptions.InvalidValue: If a token was specified. Nz+Anonymous credentials don't support tokens.)r InvalidValuerFs r"rHzAnonymousCredentials.apply0s!  ))*WX X r#cy)z0Anonymous credentials do nothing to the request.Nr9rSs r"rVz#AnonymousCredentials.before_request;sr#rJ) rYrZr[r\r]r(r,rArHrVr9r#r"rrs@ X Y?r#rcleZdZdZfdZedZedZejdZ dZ xZ S)ReadOnlyScopeda+Interface for credentials whose scopes can be queried. OAuth 2.0-based credentials allow limiting access using scopes as described in `RFC6749 Section 3.3`_. If a credential class implements this interface then the credentials either use scopes in their implementation. Some credentials require scopes in order to obtain a token. You can check if scoping is necessary with :attr:`requires_scopes`:: if credentials.requires_scopes: # Scoping is required. credentials = credentials.with_scopes(scopes=['one', 'two']) Credentials that require scopes must either be constructed with scopes:: credentials = SomeScopedCredentials(scopes=['one', 'two']) Or must copy an existing instance using :meth:`with_scopes`:: scoped_credentials = credentials.with_scopes(scopes=['one', 'two']) Some credentials have scopes but do not allow or require scopes to be set, these credentials can be used as-is. .. _RFC6749 Section 3.3: https://tools.ietf.org/html/rfc6749#section-3.3 cFtt| d|_d|_yrJ)rrr_scopes_default_scopesrs r"rzReadOnlyScoped.__init__\s nd,. #r#c|jS)z6Sequence[str]: the credentials' current set of scopes.)rr+s r"scopeszReadOnlyScoped.scopesas||r#c|jS)z>Sequence[str]: the credentials' current set of default scopes.)rr+s r"default_scopeszReadOnlyScoped.default_scopesfs###r#cy)zCTrue if these credentials require scopes to obtain an access token.Fr9r+s r"requires_scopeszReadOnlyScoped.requires_scopeskrr#c|j |jn |j}t|jt|xsgS)a_Checks if the credentials have the given scopes. .. warning: This method is not guaranteed to be accurate if the credentials are :attr:`~Credentials.invalid`. Args: scopes (Sequence[str]): The list of scopes to check. Returns: bool: True if the credentials have the given scopes. )rrsetissubset)r rcredential_scopess r" has_scopeszReadOnlyScoped.has_scopespsC!LL4DLL$:N:N 6{##C(9(?R$@AAr#) rYrZr[r\rr]rrr^abstractpropertyrrr`ras@r"rr?sU8$ $$ Br#r) metaclassc6eZdZdZej ddZy)Scopeda5Interface for credentials whose scopes can be replaced while copying. OAuth 2.0-based credentials allow limiting access using scopes as described in `RFC6749 Section 3.3`_. If a credential class implements this interface then the credentials either use scopes in their implementation. Some credentials require scopes in order to obtain a token. You can check if scoping is necessary with :attr:`requires_scopes`:: if credentials.requires_scopes: # Scoping is required. credentials = credentials.create_scoped(['one', 'two']) Credentials that require scopes must either be constructed with scopes:: credentials = SomeScopedCredentials(scopes=['one', 'two']) Or must copy an existing instance using :meth:`with_scopes`:: scoped_credentials = credentials.with_scopes(scopes=['one', 'two']) Some credentials have scopes but do not allow or require scopes to be set, these credentials can be used as-is. .. _RFC6749 Section 3.3: https://tools.ietf.org/html/rfc6749#section-3.3 Nctd)aCreate a copy of these credentials with the specified scopes. Args: scopes (Sequence[str]): The list of scopes to attach to the current credentials. Raises: NotImplementedError: If the credentials' scopes can not be changed. This can be avoided by checking :attr:`requires_scopes` before calling this method. z$This class does not require scoping.r=)r rrs r" with_scopeszScoped.with_scopess""HIIr#rJ)rYrZr[r\r^r_rr9r#r"rrs#8  J Jr#rcdt|tr|jr|j||S|S)aCreates a copy of the credentials with scopes if scoping is required. This helper function is useful when you do not know (or care to know) the specific type of credentials you are using (such as when you use :func:`google.auth.default`). This function will call :meth:`Scoped.with_scopes` if the credentials are scoped credentials and if the credentials require scoping. Otherwise, it will return the credentials as-is. Args: credentials (google.auth.credentials.Credentials): The credentials to scope if necessary. scopes (Sequence[str]): The list of scopes to use. default_scopes (Sequence[str]): Default scopes passed by a Google client library. Use 'scopes' for user-defined scopes. Returns: google.auth.credentials.Credentials: Either a new set of scoped credentials, or the passed in credentials instance if no scoping was required. )r) isinstancerrr) credentialsrrs r"with_scopes_if_requiredrs2,+v&;+F+F&&vn&MMr#c|eZdZdZej dZejdZejdZ y)SigningzCInterface for credentials that can cryptographically sign messages.ctd)zSigns the given message. Args: message (bytes): The message to sign. Returns: bytes: The message's cryptographic signature. zSign bytes must be implemented.r=)r messages r" sign_byteszSigning.sign_bytess""CDDr#ctd)z;Optional[str]: An email address that identifies the signer.z!Signer email must be implemented.r=r+s r" signer_emailzSigning.signer_emails ""EFFr#ctd)z8google.auth.crypt.Signer: The signer used to sign bytes.zSigner must be implemented.r=r+s r"signerzSigning.signers ""?@@r#N) rYrZr[r\r^r_rrrrr9r#r"rrsWM E E GG  AAr#rceZdZdZdZdZdZy)r.aJ Tracks the state of a token. FRESH: The token is valid. It is not expired or close to expired, or the token has no expiry. STALE: The token is close to expired, and should be refreshed. The token can be used normally. INVALID: The token is expired or invalid. The token cannot be used for a normal operation. rN)rYrZr[r\r0r1r/r9r#r"r.r.s E EGr#r.cNeZdZdZfdZej dZddZxZ S)CredentialsWithTrustBoundaryzAbstract base for credentials supporting legacy trust boundary configuration. .. deprecated:: Use :class:`~google.auth.credentials.CredentialsWithRegionalAccessBoundary` instead. cZt|tjdtdyNzVCredentialsWithTrustBoundary is deprecated. Use CredentialsWithRegionalAccessBoundary.rr)rrrrrrs r"rz%CredentialsWithTrustBoundary.__init__s#  d  r#ct)zIDeprecated: Implement _build_regional_access_boundary_lookup_url instead.r=r+s r" _build_trust_boundary_lookup_urlz=CredentialsWithTrustBoundary._build_trust_boundary_lookup_urls "##r#cZtjdtd|jSr)rrrrr?s r"rzGCredentialsWithTrustBoundary._build_regional_access_boundary_lookup_url s( d  4466r#rJ) rYrZr[r\rr^r_rrr`ras@r"rrs,   $$7r#rrJ).r\r^enumrloggingrgtypingrrrr urllib.parserr google.authr r r r r google.auth._credentials_basergoogle.auth._refresh_workerrgoogle.auth.transportgooglerrstr__annotations__&NO_OP_TRUST_BOUNDARY_ENCODED_LOCATIONS getLoggerrrrcrnrsrwrABCMetarrrrr.rr9r#r"rs "  66!37":< *-/S .).& '  2 3G."G.T+, Mk M K "h Kh V"?;"?J@Bs{{@BF*J^*JZ8A A@  7#H7r#