U ڲgː@sdZddlZddlZddlmZddlmZddlmZddlmZddlmZddlmZdd lm Z dd lm Z Gd d d Z dS) z Firebase auth client sub module.N)_auth_providers) _auth_utils) _http_client) _token_gen)_user_identifier) _user_import) _user_mgt)_utilsc@s0eZdZdZdAddZeddZdBddZdCd d Zd dZ ddZ ddZ ddZ ddZ dejfddZddZddZddZdd Zd!d"ZdDd#d$ZdEd%d&ZdFd'd(Zd)d*Zd+d,ZdGd-d.ZdHd/d0Zd1d2Zdejfd3d4Z d5d6Z!dId7d8Z"dJd9d:Z#d;d<Z$dejfd=d>Z%d?d@Z&dS)KClientz;Firebase Authentication client scoped to a specific tenant.Nc Cs|jstdd}dtj}|jdtj}i}d|_ t }|rvd|}|d|d<|d|d <t }d |_ n |j}tj|d |i|d } ||_tj|| |dd |_t||_tj| |j||dd |_tj| |j||d d |_dS)NaA project ID is required to access the auth service. 1. Use a service account credential, or 2. set the project ID explicitly via Firebase App options, or 3. set the project ID via the GOOGLE_CLOUD_PROJECT environment variable.zPython/Admin/{0}Z httpTimeoutFz)http://{0}/identitytoolkit.googleapis.comz/v1Zv1z/v2Zv2TzX-Client-Version) credentialheaderstimeout)Z url_override)Z project_id ValueErrorformatfirebase_admin __version__optionsgetrZDEFAULT_TIMEOUT_SECONDSZemulatedrZget_emulator_hostr ZEmulatorAdminCredentialsr get_credentialZJsonHttpClient _tenant_idrZTokenGenerator_token_generatorZ TokenVerifier_token_verifierrZ UserManager _user_managerrZProviderConfigClient_provider_manager) selfZapp tenant_idr Zversion_headerr Z endpoint_urlsZ emulator_hostbase_url http_clientr?/tmp/pip-unpacked-wheel-p0r7i5ii/firebase_admin/_auth_client.py__init__!sN      zClient.__init__cCs|jS)z&Tenant ID associated with this client.)rrrrrrHszClient.tenant_idcCs|jj|||jdS)aBuilds and signs a Firebase custom auth token. Args: uid: ID of the user for whom the token is created. developer_claims: A dictionary of claims to be included in the token (optional). Returns: bytes: A token minted from the input parameters. Raises: ValueError: If input parameters are invalid. TokenSignError: If an error occurs while signing the token using the remote IAM service. )r)rcreate_custom_tokenr)ruidZdeveloper_claimsrrrr"Ms zClient.create_custom_tokenFrcCstt|tstdt||j||}|jr\|did}|j|kr\t d||rp| |t j d|S)aVerifies the signature and data for the provided JWT. Accepts a signed token string, verifies that it is current, was issued to this project, and that it was correctly signed by Google. Args: id_token: A string of the encoded JWT. check_revoked: Boolean, If true, checks whether the token has been revoked or the user disabled (optional). clock_skew_seconds: The number of seconds to tolerate when checking the token. Must be between 0-60. Defaults to 0. Returns: dict: A dictionary of key-value pairs parsed from the decoded JWT. Raises: ValueError: If ``id_token`` is a not a string or is empty. InvalidIdTokenError: If ``id_token`` is not a valid Firebase ID token. ExpiredIdTokenError: If the specified ID token has expired. RevokedIdTokenError: If ``check_revoked`` is ``True`` and the ID token has been revoked. TenantIdMismatchError: If ``id_token`` belongs to a tenant that is different than this ``Client`` instance. CertificateFetchError: If an error occurs while fetching the public key certificates required to verify the ID token. UserDisabledError: If ``check_revoked`` is ``True`` and the corresponding user record is disabled. zPIllegal check_revoked argument. Argument must be of type bool, but given "{0}".ZfirebaseZtenantzInvalid tenant ID: {0}zID token) isinstanceboolrrtyperverify_id_tokenrrrZTenantIdMismatchError_check_jwt_revoked_or_disabledrZRevokedIdTokenError)rZid_tokenZ check_revokedZclock_skew_secondsverified_claimsZtoken_tenant_idrrrr'_s$  zClient.verify_id_tokencCs|jj|ttddS)aJRevokes all refresh tokens for an existing user. This method updates the user's ``tokens_valid_after_timestamp`` to the current UTC in seconds since the epoch. It is important that the server on which this is called has its clock set correctly and synchronized. While this revokes all sessions for a specified user and disables any new ID tokens for existing sessions from getting minted, existing ID tokens may remain active until their natural expiration (one hour). To verify that ID tokens are revoked, use ``verify_id_token(idToken, check_revoked=True)``. Args: uid: A user ID string. Raises: ValueError: If the user ID is None, empty or malformed. FirebaseError: If an error occurs while revoking the refresh token. )Z valid_sinceN)r update_userinttimerr#rrrrevoke_refresh_tokensszClient.revoke_refresh_tokenscCs|jj|d}t|S)aGets the user data corresponding to the specified user ID. Args: uid: A user ID string. Returns: UserRecord: A user record instance. Raises: ValueError: If the user ID is None, empty or malformed. UserNotFoundError: If the specified user ID does not exist. FirebaseError: If an error occurs while retrieving the user. r#rget_userr UserRecord)rr#responserrrr1szClient.get_usercCs|jj|d}t|S)aGets the user data corresponding to the specified user email. Args: email: A user email address string. Returns: UserRecord: A user record instance. Raises: ValueError: If the email is None, empty or malformed. UserNotFoundError: If no user exists for the specified email address. FirebaseError: If an error occurs while retrieving the user. )emailr0)rr4r3rrrget_user_by_emailszClient.get_user_by_emailcCs|jj|d}t|S)aGets the user data corresponding to the specified phone number. Args: phone_number: A phone number string. Returns: UserRecord: A user record instance. Raises: ValueError: If the phone number is ``None``, empty or malformed. UserNotFoundError: If no user exists for the specified phone number. FirebaseError: If an error occurs while retrieving the user. ) phone_numberr0)rr6r3rrrget_user_by_phone_numberszClient.get_user_by_phone_numbercsR|jj|d}ddfdddd|Dfdd|D}tj|d S) apGets the user data corresponding to the specified identifiers. There are no ordering guarantees; in particular, the nth entry in the result list is not guaranteed to correspond to the nth entry in the input parameters list. A maximum of 100 identifiers may be supplied. If more than 100 identifiers are supplied, this method raises a `ValueError`. Args: identifiers (list[Identifier]): A list of ``Identifier`` instances used to indicate which user records should be returned. Must have <= 100 entries. Returns: GetUsersResult: A ``GetUsersResult`` instance corresponding to the specified identifiers. Raises: ValueError: If any of the identifiers are invalid or if more than 100 identifiers are specified. ) identifierscsttjrj|jkSttjr0j|jkSttjrHj|jkSttjrnt fdd|j DdSt d t dS)Nc3s*|]"}j|jkrj|jkrdVqdS)TN) provider_idZ provider_uidr#).0Z user_info identifierrr s  z5Client.get_users.._matches..FzUnexpected type: {})r$rZ UidIdentifierr#ZEmailIdentifierr4ZPhoneIdentifierr6ZProviderIdentifiernextZ provider_data TypeErrorrr&)r< user_recordrr;r_matchess        z"Client.get_users.._matchescstfdd|DS)Nc3s|]}|VqdSNr)r:r@)rAr<rrr=sz;Client.get_users.._is_user_found..)any)r<Z user_records)rAr;r_is_user_foundsz(Client.get_users.._is_user_foundcSsg|]}t|qSr)rr2)r:userrrr sz$Client.get_users..csg|]}|s|qSrr)r:r<)rDusersrrrFs )rG not_found)r get_usersrZGetUsersResult)rr8r3rHr)rDrArGrrIs  zClient.get_userscsfdd}t|||S)a/Retrieves a page of user accounts from a Firebase project. The ``page_token`` argument governs the starting point of the page. The ``max_results`` argument governs the maximum number of user accounts that may be included in the returned page. This function never returns ``None``. If there are no user accounts in the Firebase project, this returns an empty page. Args: page_token: A non-empty page token string, which indicates the starting point of the page (optional). Defaults to ``None``, which will retrieve the first page of users. max_results: A positive integer indicating the maximum number of users to include in the returned page (optional). Defaults to 1000, which is also the maximum number allowed. Returns: ListUsersPage: A page of user accounts. Raises: ValueError: If max_results or page_token are invalid. FirebaseError: If an error occurs while retrieving the user accounts. csj||SrB)r list_users) page_token max_resultsr!rrdownloadsz#Client.list_users..download)rZ ListUsersPage)rrKrLrMrr!rrJs zClient.list_userscKs|jjf|}|j|dS)aCreates a new user account with the specified properties. Args: **kwargs: A series of keyword arguments (optional). Keyword Args: uid: User ID to assign to the newly created user (optional). display_name: The user's display name (optional). email: The user's primary email (optional). email_verified: A boolean indicating whether or not the user's primary email is verified (optional). phone_number: The user's primary phone number (optional). photo_url: The user's photo URL (optional). password: The user's raw, unhashed password. (optional). disabled: A boolean indicating whether or not the user account is disabled (optional). Returns: UserRecord: A UserRecord instance for the newly created user. Raises: ValueError: If the specified user properties are invalid. FirebaseError: If an error occurs while creating the user account. r/)r create_userr1)rkwargsr#rrrrN!szClient.create_usercKs|jj|f||j|dS)a Updates an existing user account with the specified properties. Args: uid: A user ID string. **kwargs: A series of keyword arguments (optional). Keyword Args: display_name: The user's display name (optional). Can be removed by explicitly passing ``auth.DELETE_ATTRIBUTE``. email: The user's primary email (optional). email_verified: A boolean indicating whether or not the user's primary email is verified (optional). phone_number: The user's primary phone number (optional). Can be removed by explicitly passing ``auth.DELETE_ATTRIBUTE``. photo_url: The user's photo URL (optional). Can be removed by explicitly passing ``auth.DELETE_ATTRIBUTE``. password: The user's raw, unhashed password. (optional). disabled: A boolean indicating whether or not the user account is disabled (optional). custom_claims: A dictionary or a JSON string contining the custom claims to be set on the user account (optional). To remove all custom claims, pass ``auth.DELETE_ATTRIBUTE``. valid_since: An integer signifying the seconds since the epoch (optional). This field is set by ``revoke_refresh_tokens`` and it is discouraged to set this field directly. providers_to_delete: The list of provider IDs to unlink, eg: 'google.com', 'password', etc. Returns: UserRecord: An updated UserRecord instance for the user. Raises: ValueError: If the specified user ID or properties are invalid. FirebaseError: If an error occurs while updating the user account. r/)rr*r1)rr#rOrrrr*<s#zClient.update_usercCs"|dkrtj}|jj||ddS)aSets additional claims on an existing user account. Custom claims set via this function can be used to define user roles and privilege levels. These claims propagate to all the devices where the user is already signed in (after token expiration or when token refresh is forced), and next time the user signs in. The claims can be accessed via the user's ID token JWT. If a reserved OIDC claim is specified (sub, iat, iss, etc), an error is thrown. Claims payload must also not be larger then 1000 characters when serialized into a JSON string. Args: uid: A user ID string. custom_claims: A dictionary or a JSON string of custom claims. Pass None to unset any claims set previously. Raises: ValueError: If the specified user ID or the custom claims are invalid. FirebaseError: If an error occurs while updating the user account. N) custom_claims)rZDELETE_ATTRIBUTErr*)rr#rPrrrset_custom_user_claimsbszClient.set_custom_user_claimscCs|j|dS)aDeletes the user identified by the specified user ID. Args: uid: A user ID string. Raises: ValueError: If the user ID is None, empty or malformed. FirebaseError: If an error occurs while deleting the user account. N)r delete_userr-rrrrRys zClient.delete_usercCs |jj|dd}t|t|S)aDeletes the users specified by the given identifiers. Deleting a non-existing user does not generate an error (the method is idempotent.) Non-existing users are considered to be successfully deleted and are therefore included in the `DeleteUserResult.success_count` value. A maximum of 1000 identifiers may be supplied. If more than 1000 identifiers are supplied, this method raises a `ValueError`. Args: uids: A list of strings indicating the uids of the users to be deleted. Must have <= 1000 entries. Returns: DeleteUsersResult: The total number of successful/failed deletions, as well as the array of errors that correspond to the failed deletions. Raises: ValueError: If any of the identifiers are invalid or if more than 1000 identifiers are specified. T)Z force_delete)r delete_usersrZDeleteUsersResultlen)rZuidsresultrrrrSszClient.delete_userscCs|j||}t|t|S)aImports the specified list of users into Firebase Auth. At most 1000 users can be imported at a time. This operation is optimized for bulk imports and ignores checks on identifier uniqueness, which could result in duplications. The ``hash_alg`` parameter must be specified when importing users with passwords. Refer to the ``UserImportHash`` class for supported hash algorithms. Args: users: A list of ``ImportUserRecord`` instances to import. Length of the list must not exceed 1000. hash_alg: A ``UserImportHash`` object (optional). Required when importing users with passwords. Returns: UserImportResult: An object summarizing the result of the import operation. Raises: ValueError: If the provided arguments are invalid. FirebaseError: If an error occurs while importing users. )r import_usersrZUserImportResultrT)rrGZhash_algrUrrrrVszClient.import_userscCs|jjd||dS)aGenerates the out-of-band email action link for password reset flows for the specified email address. Args: email: The email of the user whose password is to be reset. action_code_settings: ``ActionCodeSettings`` instance (optional). Defines whether the link is to be handled by a mobile app and the additional state information to be passed in the deep link. Returns: link: The password reset link created by the API Raises: ValueError: If the provided arguments are invalid EmailNotFoundError: If no user exists for the specified email address. FirebaseError: If an error occurs while generating the link ZPASSWORD_RESETaction_code_settingsrZgenerate_email_action_linkrr4rXrrrgenerate_password_reset_links z#Client.generate_password_reset_linkcCs|jjd||dS)aGenerates the out-of-band email action link for email verification flows for the specified email address. Args: email: The email of the user to be verified. action_code_settings: ``ActionCodeSettings`` instance (optional). Defines whether the link is to be handled by a mobile app and the additional state information to be passed in the deep link. Returns: link: The email verification link created by the API Raises: ValueError: If the provided arguments are invalid UserNotFoundError: If no user exists for the specified email address. FirebaseError: If an error occurs while generating the link Z VERIFY_EMAILrWrYrZrrr generate_email_verification_links z'Client.generate_email_verification_linkcCs|jjd||dS)aGenerates the out-of-band email action link for email link sign-in flows, using the action code settings provided. Args: email: The email of the user signing in. action_code_settings: ``ActionCodeSettings`` instance. Defines whether the link is to be handled by a mobile app and the additional state information to be passed in the deep link. Returns: link: The email sign-in link created by the API Raises: ValueError: If the provided arguments are invalid FirebaseError: If an error occurs while generating the link Z EMAIL_SIGNINrWrYrZrrr generate_sign_in_with_email_links z'Client.generate_sign_in_with_email_linkcCs |j|S)aReturns the ``OIDCProviderConfig`` with the given ID. Args: provider_id: Provider ID string. Returns: SAMLProviderConfig: An OIDC provider config instance. Raises: ValueError: If the provider ID is invalid, empty or does not have ``oidc.`` prefix. ConfigurationNotFoundError: If no OIDC provider is available with the given identifier. FirebaseError: If an error occurs while retrieving the OIDC provider. )rget_oidc_provider_configrr9rrrr^szClient.get_oidc_provider_configc Cs|jj||||||||dS)aCreates a new OIDC provider config from the given parameters. OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see https://cloud.google.com/identity-platform. Args: provider_id: Provider ID string. Must have the prefix ``oidc.``. client_id: Client ID of the new config. issuer: Issuer of the new config. Must be a valid URL. display_name: The user-friendly display name to the current configuration (optional). This name is also used as the provider label in the Cloud Console. enabled: A boolean indicating whether the provider configuration is enabled or disabled (optional). A user cannot sign in using a disabled provider. client_secret: A string which sets the client secret for the new provider. This is required for the code flow. code_response_type: A boolean which sets whether to enable the code response flow for the new provider. By default, this is not enabled if no response type is specified. A client secret must be set for this response type. Having both the code and ID token response flows is currently not supported. id_token_response_type: A boolean which sets whether to enable the ID token response flow for the new provider. By default, this is enabled if no response type is specified. Having both the code and ID token response flows is currently not supported. Returns: OIDCProviderConfig: The newly created OIDC provider config instance. Raises: ValueError: If any of the specified input parameters are invalid. FirebaseError: If an error occurs while creating the new OIDC provider config.  client_idissuer display_nameenabled client_secretid_token_response_typecode_response_type)rcreate_oidc_provider_config rr9rarbrcrdrerfrgrrrrhs"z"Client.create_oidc_provider_configc Cs|jj||||||||dS)aUpdates an existing OIDC provider config with the given parameters. Args: provider_id: Provider ID string. Must have the prefix ``oidc.``. client_id: Client ID of the new config (optional). issuer: Issuer of the new config (optional). Must be a valid URL. display_name: The user-friendly display name to the current configuration (optional). Pass ``auth.DELETE_ATTRIBUTE`` to delete the current display name. enabled: A boolean indicating whether the provider configuration is enabled or disabled (optional). client_secret: A string which sets the client secret for the new provider. This is required for the code flow. code_response_type: A boolean which sets whether to enable the code response flow for the new provider. By default, this is not enabled if no response type is specified. A client secret must be set for this response type. Having both the code and ID token response flows is currently not supported. id_token_response_type: A boolean which sets whether to enable the ID token response flow for the new provider. By default, this is enabled if no response type is specified. Having both the code and ID token response flows is currently not supported. Returns: OIDCProviderConfig: The updated OIDC provider config instance. Raises: ValueError: If any of the specified input parameters are invalid. FirebaseError: If an error occurs while updating the OIDC provider config. r`)rupdate_oidc_provider_configrirrrrj-sz"Client.update_oidc_provider_configcCs|j|dS)aDeletes the ``OIDCProviderConfig`` with the given ID. Args: provider_id: Provider ID string. Raises: ValueError: If the provider ID is invalid, empty or does not have ``oidc.`` prefix. ConfigurationNotFoundError: If no OIDC provider is available with the given identifier. FirebaseError: If an error occurs while deleting the OIDC provider. N)rdelete_oidc_provider_configr_rrrrkQs z"Client.delete_oidc_provider_configcCs|j||S)aZRetrieves a page of OIDC provider configs from a Firebase project. The ``page_token`` argument governs the starting point of the page. The ``max_results`` argument governs the maximum number of configs that may be included in the returned page. This function never returns ``None``. If there are no OIDC configs in the Firebase project, this returns an empty page. Args: page_token: A non-empty page token string, which indicates the starting point of the page (optional). Defaults to ``None``, which will retrieve the first page of users. max_results: A positive integer indicating the maximum number of users to include in the returned page (optional). Defaults to 100, which is also the maximum number allowed. Returns: ListProviderConfigsPage: A page of OIDC provider config instances. Raises: ValueError: If ``max_results`` or ``page_token`` are invalid. FirebaseError: If an error occurs while retrieving the OIDC provider configs. )rlist_oidc_provider_configsrrKrLrrrrl^sz!Client.list_oidc_provider_configscCs |j|S)aReturns the ``SAMLProviderConfig`` with the given ID. Args: provider_id: Provider ID string. Returns: SAMLProviderConfig: A SAML provider config instance. Raises: ValueError: If the provider ID is invalid, empty or does not have ``saml.`` prefix. ConfigurationNotFoundError: If no SAML provider is available with the given identifier. FirebaseError: If an error occurs while retrieving the SAML provider. )rget_saml_provider_configr_rrrrnwszClient.get_saml_provider_configc Cs|jj||||||||dS)aCreates a new SAML provider config from the given parameters. SAML provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see https://cloud.google.com/identity-platform. Args: provider_id: Provider ID string. Must have the prefix ``saml.``. idp_entity_id: The SAML IdP entity identifier. sso_url: The SAML IdP SSO URL. Must be a valid URL. x509_certificates: The list of SAML IdP X.509 certificates issued by CA for this provider. Multiple certificates are accepted to prevent outages during IdP key rotation (for example ADFS rotates every 10 days). When the Auth server receives a SAML response, it will match the SAML response with the certificate on record. Otherwise the response is rejected. Developers are expected to manage the certificate updates as keys are rotated. rp_entity_id: The SAML relying party (service provider) entity ID. This is defined by the developer but needs to be provided to the SAML IdP. callback_url: Callback URL string. This is fixed and must always be the same as the OAuth redirect URL provisioned by Firebase Auth, unless a custom authDomain is used. display_name: The user-friendly display name to the current configuration (optional). This name is also used as the provider label in the Cloud Console. enabled: A boolean indicating whether the provider configuration is enabled or disabled (optional). A user cannot sign in using a disabled provider. Returns: SAMLProviderConfig: The newly created SAML provider config instance. Raises: ValueError: If any of the specified input parameters are invalid. FirebaseError: If an error occurs while creating the new SAML provider config.  idp_entity_idsso_urlx509_certificates rp_entity_id callback_urlrcrd)rcreate_saml_provider_config rr9rprqrrrsrtrcrdrrrrus#z"Client.create_saml_provider_configc Cs|jj||||||||dS)aUpdates an existing SAML provider config with the given parameters. Args: provider_id: Provider ID string. Must have the prefix ``saml.``. idp_entity_id: The SAML IdP entity identifier (optional). sso_url: The SAML IdP SSO URL. Must be a valid URL (optional). x509_certificates: The list of SAML IdP X.509 certificates issued by CA for this provider (optional). rp_entity_id: The SAML relying party entity ID (optional). callback_url: Callback URL string (optional). display_name: The user-friendly display name of the current configuration (optional). Pass ``auth.DELETE_ATTRIBUTE`` to delete the current display name. enabled: A boolean indicating whether the provider configuration is enabled or disabled (optional). Returns: SAMLProviderConfig: The updated SAML provider config instance. Raises: ValueError: If any of the specified input parameters are invalid. FirebaseError: If an error occurs while updating the SAML provider config. ro)rupdate_saml_provider_configrvrrrrwsz"Client.update_saml_provider_configcCs|j|dS)aDeletes the ``SAMLProviderConfig`` with the given ID. Args: provider_id: Provider ID string. Raises: ValueError: If the provider ID is invalid, empty or does not have ``saml.`` prefix. ConfigurationNotFoundError: If no SAML provider is available with the given identifier. FirebaseError: If an error occurs while deleting the SAML provider. N)rdelete_saml_provider_configr_rrrrxs z"Client.delete_saml_provider_configcCs|j||S)aZRetrieves a page of SAML provider configs from a Firebase project. The ``page_token`` argument governs the starting point of the page. The ``max_results`` argument governs the maximum number of configs that may be included in the returned page. This function never returns ``None``. If there are no SAML configs in the Firebase project, this returns an empty page. Args: page_token: A non-empty page token string, which indicates the starting point of the page (optional). Defaults to ``None``, which will retrieve the first page of users. max_results: A positive integer indicating the maximum number of users to include in the returned page (optional). Defaults to 100, which is also the maximum number allowed. Returns: ListProviderConfigsPage: A page of SAML provider config instances. Raises: ValueError: If ``max_results`` or ``page_token`` are invalid. FirebaseError: If an error occurs while retrieving the SAML provider configs. )rlist_saml_provider_configsrmrrrrysz!Client.list_saml_provider_configscCsF||d}|jr td|dd|jkrB|d|dS)Nr#zThe user record is disabled.Ziatiz"The Firebase {0} has been revoked.)r1rdisabledrZUserDisabledErrorZtokens_valid_after_timestampr)rr)exc_typelabelrErrrr(s  z%Client._check_jwt_revoked_or_disabled)N)N)Fr)N)N)N)NNNNN)NNNNNNN)NN)NNNNNNN)'__name__ __module__ __qualname____doc__r propertyrr"r'r.r1r5r7rIrZMAX_LIST_USERS_RESULTSrJrNr*rQrRrSrVr[r\r]r^rhrjrkrZMAX_LIST_CONFIGS_RESULTSrlrnrurwrxryr(rrrrr sr '   .2&     ( $  )  r ) rr,rrrrrrrrr r rrrrs