U ڲgC@srdZddlZddlZddlmZddZGdddZGdd d ZGd d d ZGd d d Z GdddZ dS)z Firebase user import sub module.N) _auth_utilscCst|SN)base64urlsafe_b64encodedecode)Z bytes_valuer?/tmp/pip-unpacked-wheel-p0r7i5ii/firebase_admin/_user_import.py b64_encodesr c@seZdZdZdddZeddZejddZedd Zejd d Zed d Z e jd d Z eddZ e jddZ eddZ e jddZ ddZ dS) UserProvideraDRepresents a user identity provider that can be associated with a Firebase user. One or more providers can be specified in an ``ImportUserRecord`` when importing users via ``auth.import_users()``. Args: uid: User's unique ID assigned by the identity provider. provider_id: ID of the identity provider. This can be a short domain name or the identifier of an OpenID identity provider. email: User's email address (optional). display_name: User's display name (optional). photo_url: User's photo URL (optional). NcCs"||_||_||_||_||_dSr)uid provider_idemail display_name photo_url)selfr r r rrrrr__init__*s zUserProvider.__init__cCs|jSr_uidrrrrr 1szUserProvider.uidcCstj|dd|_dSNTrequiredrZ validate_uidrrr rrrr 5scCs|jSr) _provider_idrrrrr 9szUserProvider.provider_idcCstj|dd|_dSr)rZvalidate_provider_idr)rr rrrr =scCs|jSr_emailrrrrr AszUserProvider.emailcCst||_dSrrZvalidate_emailrrr rrrr EscCs|jSr _display_namerrrrrIszUserProvider.display_namecCst||_dSrrZvalidate_display_namer rrrrrrMscCs|jSr _photo_urlrrrrrQszUserProvider.photo_urlcCst||_dSrrZvalidate_photo_urlr$rrrrrrUscCs,|j|j|j|j|jd}dd|DS)N)ZrawIdZ providerId displayNamer photoUrlcSsi|]\}}|dk r||qSrr.0kvrrr asz(UserProvider.to_dict..)r r rr ritemsrpayloadrrrto_dictYszUserProvider.to_dict)NNN) __name__ __module__ __qualname____doc__rpropertyr setterr r rrr1rrrrr s.           r c @s&eZdZdZd%ddZeddZejddZedd Zejd d Zed d Z e jd d Z eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZeddZejddZed d!Zejd"d!Zd#d$ZdS)&ImportUserRecordarRepresents a user account to be imported to Firebase Auth. Must specify the ``uid`` field at a minimum. A sequence of ``ImportUserRecord`` objects can be passed to the ``auth.import_users()`` function, in order to import those users into Firebase Auth in bulk. If the ``password_hash`` is set on a user, a hash configuration must be specified when calling ``import_users()``. Args: uid: User's unique ID. Must be a non-empty string not longer than 128 characters. email: User's email address (optional). email_verified: A boolean indicating whether the user's email has been verified (optional). display_name: User's display name (optional). phone_number: User's phone number (optional). photo_url: User's photo URL (optional). disabled: A boolean indicating whether this user account has been disabled (optional). user_metadata: An ``auth.UserMetadata`` instance with additional user metadata (optional). provider_data: A list of ``auth.UserProvider`` instances (optional). custom_claims: A ``dict`` of custom claims to be set on the user account (optional). password_hash: User's password hash as a ``bytes`` sequence (optional). password_salt: User's password salt as a ``bytes`` sequence (optional). Raises: ValueError: If provided arguments are invalid. Nc CsL||_||_||_||_||_| |_| |_||_||_||_ | |_ | |_ dSr) r r r phone_numberr password_hash password_saltemail_verifieddisabled user_metadata provider_data custom_claims) rr r r<rr9rr=r>r?r@r:r;rrrr~szImportUserRecord.__init__cCs|jSrrrrrrr szImportUserRecord.uidcCstj|dd|_dSrrrrrrr scCs|jSrrrrrrr szImportUserRecord.emailcCst||_dSrrrrrrr scCs|jSrrrrrrrszImportUserRecord.display_namecCst||_dSrr!r"rrrrscCs|jSr) _phone_numberrrrrr9szImportUserRecord.phone_numbercCst||_dSr)rZvalidate_phonerA)rr9rrrr9scCs|jSrr#rrrrrszImportUserRecord.photo_urlcCst||_dSrr%r&rrrrscCs|jSr)_password_hashrrrrr:szImportUserRecord.password_hashcCst|d|_dS)Nr:)rvalidate_bytesrB)rr:rrrr:scCs|jSr)_password_saltrrrrr;szImportUserRecord.password_saltcCst|d|_dS)Nr;)rrCrD)rr;rrrr;scCs|jSr)_user_metadatarrrrr>szImportUserRecord.user_metadatacCsJ|dk r|jnd}|dk r |jnd}t|d|_t|d|_||_dS)Ncreation_timestamplast_sign_in_timestamp)rFrGrZvalidate_timestamp _created_at_last_login_atrE)rr>Z created_atZ last_login_atrrrr>scCs|jSr)_provider_datarrrrr?szImportUserRecord.provider_datacCsN|dk rDztdd|Dr$tdWntk rBtdYnX||_dS)NcSsg|]}t|t qSr) isinstancer r*prrr sz2ImportUserRecord.provider_data..z0One or more provider data instances are invalid.zprovider_data must be iterable.)any ValueError TypeErrorrJ)rr?rrrr?s cCs|jSr)_custom_claimsrrrrr@szImportUserRecord.custom_claimscCs.t|trt|n|}t||_||_dSr)rKdictjsondumpsrZvalidate_custom_claims_custom_claims_strrR)rr@Z json_claimsrrrr@s c Cs|j|j|j|j|j|jdk r(t|jnd|jdk r>t|jnd|j|j |j |j r\t |j nd|j rnt |j ndd }|jrdd|jD|d<dd|DS)zAReturns a dict representation of the user. For internal use only.N) ZlocalIdr r'Z phoneNumberr(Z emailVerifiedr=ZcustomAttributesZ createdAtZ lastLoginAtZ passwordHashZsaltcSsg|] }|qSr)r1rLrrrrNsz,ImportUserRecord.to_dict..ZproviderUserInfocSsi|]\}}|dk r||qSrrr)rrrr-sz,ImportUserRecord.to_dict..)r r rr9rr<boolr=rVrHrIr:r r;r?r.r/rrrr1s$ zImportUserRecord.to_dict) NNNNNNNNNNN)r2r3r4r5rr6r r7r rr9rr:r;r>r?r@r1rrrrr8dsf                     r8c@seZdZdZd#ddZddZeddZed d Zed d Z ed dZ eddZ eddZ eddZ eddZeddZeddZeddZed$ddZedd Zed!d"ZdS)%UserImportHashaRepresents a hash algorithm used to hash user passwords. An instance of this class must be specified when importing users with passwords via the ``auth.import_users()`` API. Use one of the provided class methods to obtain new instances when required. Refer to `documentation`_ for more details. .. _documentation: https://firebase.google.com/docs/auth/admin/import-users NcCs||_||_dSr)_name_data)rnamedatarrrr szUserImportHash.__init__cCs d|ji}|jr||j|S)NZ hashAlgorithm)rYrZupdater/rrrr1s  zUserImportHash.to_dictcCs"dttj|dddi}t||S)N signerKeykeyTr)r rrCrX)clsr[r_r\rrr_hmacszUserImportHash._hmaccCs |d|S)zCreates a new HMAC SHA512 algorithm instance. Args: key: Signer key as a byte sequence. Returns: UserImportHash: A new ``UserImportHash``. Z HMAC_SHA512rar`r_rrr hmac_sha512s zUserImportHash.hmac_sha512cCs |d|S)zCreates a new HMAC SHA256 algorithm instance. Args: key: Signer key as a byte sequence. Returns: UserImportHash: A new ``UserImportHash``. Z HMAC_SHA256rbrcrrr hmac_sha256)s zUserImportHash.hmac_sha256cCs |d|S)zCreates a new HMAC SHA1 algorithm instance. Args: key: Signer key as a byte sequence. Returns: UserImportHash: A new ``UserImportHash``. Z HMAC_SHA1rbrcrrr hmac_sha15s zUserImportHash.hmac_sha1cCs |d|S)zCreates a new HMAC MD5 algorithm instance. Args: key: Signer key as a byte sequence. Returns: UserImportHash: A new ``UserImportHash``. ZHMAC_MD5rbrcrrrhmac_md5As zUserImportHash.hmac_md5c Cstddt|dddiS)zCreates a new MD5 algorithm instance. Args: rounds: Number of rounds. Must be an integer between 0 and 8192. Returns: UserImportHash: A new ``UserImportHash``. MD5roundsr rXr validate_intr`rirrrmd5Ms zUserImportHash.md5c Cstddt|dddiS)zCreates a new SHA1 algorithm instance. Args: rounds: Number of rounds. Must be an integer between 1 and 8192. Returns: UserImportHash: A new ``UserImportHash``. SHA1rirjrkrmrrrsha1[s zUserImportHash.sha1c Cstddt|dddiS)zCreates a new SHA256 algorithm instance. Args: rounds: Number of rounds. Must be an integer between 1 and 8192. Returns: UserImportHash: A new ``UserImportHash``. SHA256rirprjrkrmrrrsha256is zUserImportHash.sha256c Cstddt|dddiS)zCreates a new SHA512 algorithm instance. Args: rounds: Number of rounds. Must be an integer between 1 and 8192. Returns: UserImportHash: A new ``UserImportHash``. SHA512rirprjrkrmrrrsha512ws zUserImportHash.sha512c Cstddt|dddiS)zCreates a new PBKDF SHA1 algorithm instance. Args: rounds: Number of rounds. Must be an integer between 0 and 120000. Returns: UserImportHash: A new ``UserImportHash``. Z PBKDF_SHA1rirrkrmrrr pbkdf_sha1s zUserImportHash.pbkdf_sha1c Cstddt|dddiS)zCreates a new PBKDF2 SHA256 algorithm instance. Args: rounds: Number of rounds. Must be an integer between 0 and 120000. Returns: UserImportHash: A new ``UserImportHash``. Z PBKDF2_SHA256rirrvrkrmrrr pbkdf2_sha256s zUserImportHash.pbkdf2_sha256cCsVttj|dddt|dddt|dddd }|rLtt|d |d <td |S) a$Creates a new Scrypt algorithm instance. This is the modified Scrypt algorithm used by Firebase Auth. See ``standard_scrypt()`` function for the standard Scrypt algorith, Args: key: Signer key as a byte sequence. rounds: Number of rounds. Must be an integer between 1 and 8. memory_cost: Memory cost as an integer between 1 and 14. salt_separator: Salt separator as a byte sequence (optional). Returns: UserImportHash: A new ``UserImportHash``. r_Trrirp memory_cost)r^riZ memoryCostsalt_separatorZ saltSeparatorZSCRYPT)r rrCrlrX)r`r_rirzr|r\rrrscrypts zUserImportHash.scryptcCstdS)zyCreates a new Bcrypt algorithm instance. Returns: UserImportHash: A new ``UserImportHash``. ZBCRYPT)rX)r`rrrbcryptszUserImportHash.bcryptcCsHtj|dddtj|dddtj|dddtj|dddd}td|S) aCreates a new standard Scrypt algorithm instance. Args: memory_cost: CPU Memory cost as a non-negative integer. parallelization: Parallelization as a non-negative integer. block_size: Block size as a non-negative integer. derived_key_length: Derived key length as a non-negative integer. Returns: UserImportHash: A new ``UserImportHash``. rzr)lowparallelization block_sizederived_key_length)Z cpuMemCostrZ blockSizeZdkLenZSTANDARD_SCRYPT)rrlrX)r`rzrrrr\rrrstandard_scrypts zUserImportHash.standard_scrypt)N)N)r2r3r4r5rr1 classmethodrardrerfrgrnrqrsrurwrxr}r~rrrrrrXs>              rXc@s0eZdZdZddZeddZeddZdS) ErrorInfozRepresents an error encountered while performing a batch operation such as importing users or deleting multiple user accounts. cCs|d|_|d|_dS)Nindexmessage)_index_reason)rerrorrrrrs zErrorInfo.__init__cCs|jSr)rrrrrrszErrorInfo.indexcCs|jSr)rrrrrreasonszErrorInfo.reasonN)r2r3r4r5rr6rrrrrrrs  rc@s<eZdZdZddZeddZeddZedd Zd S) UserImportResultzrRepresents the result of a bulk user import operation. See ``auth.import_users()`` API for more details. cCs8|dg}|t||_t||_dd|D|_dS)NrcSsg|] }t|qSr)r)r*errrrrrNsz-UserImportResult.__init__..)getlen_success_count_failure_count_errors)rresulttotalerrorsrrrrs  zUserImportResult.__init__cCs|jS)z2Returns the number of users successfully imported.)rrrrr success_countszUserImportResult.success_countcCs|jS)z7Returns the number of users that failed to be imported.)rrrrr failure_countszUserImportResult.failure_countcCs|jS)zQReturns a list of ``auth.ErrorInfo`` instances describing the errors encountered.)rrrrrrszUserImportResult.errorsN) r2r3r4r5rr6rrrrrrrrs  r) r5rrTZfirebase_adminrr r r8rXrrrrrrs IY