Google Cloud Recaptcha Enterprise V1 Client - Class PrivatePasswordLeakVerification (1.3.2)

Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class PrivatePasswordLeakVerification.

Private password leak verification info.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ lookup_hash_prefix string

Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized username. It is used to look up password leaks associated with that hash prefix.

↳ encrypted_user_credentials_hash string

Optional. Encrypted Scrypt hash of the canonicalized username+password. It is re-encrypted by the server and returned through reencrypted_user_credentials_hash.

↳ encrypted_leak_match_prefixes array

Output only. List of prefixes of the encrypted potential password leaks that matched the given parameters. They must be compared with the client-side decryption prefix of reencrypted_user_credentials_hash

↳ reencrypted_user_credentials_hash string

Output only. Corresponds to the re-encryption of the encrypted_user_credentials_hash field. It is used to match potential password leaks within encrypted_leak_match_prefixes.

getLookupHashPrefix

Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized username. It is used to look up password leaks associated with that hash prefix.

Returns
TypeDescription
string

setLookupHashPrefix

Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized username. It is used to look up password leaks associated with that hash prefix.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEncryptedUserCredentialsHash

Optional. Encrypted Scrypt hash of the canonicalized username+password. It is re-encrypted by the server and returned through reencrypted_user_credentials_hash.

Returns
TypeDescription
string

setEncryptedUserCredentialsHash

Optional. Encrypted Scrypt hash of the canonicalized username+password. It is re-encrypted by the server and returned through reencrypted_user_credentials_hash.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEncryptedLeakMatchPrefixes

Output only. List of prefixes of the encrypted potential password leaks that matched the given parameters. They must be compared with the client-side decryption prefix of reencrypted_user_credentials_hash

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEncryptedLeakMatchPrefixes

Output only. List of prefixes of the encrypted potential password leaks that matched the given parameters. They must be compared with the client-side decryption prefix of reencrypted_user_credentials_hash

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getReencryptedUserCredentialsHash

Output only. Corresponds to the re-encryption of the encrypted_user_credentials_hash field. It is used to match potential password leaks within encrypted_leak_match_prefixes.

Returns
TypeDescription
string

setReencryptedUserCredentialsHash

Output only. Corresponds to the re-encryption of the encrypted_user_credentials_hash field. It is used to match potential password leaks within encrypted_leak_match_prefixes.

Parameter
NameDescription
var string
Returns
TypeDescription
$this