Function prototype
aat_int32 AAL2GenVerifyPasswordCmdEx(
aat_byte *Cmd,
aat_int32 *CmdSize,
TDigipassBlob *DPData,
TKernelParms *CallParms,
aat_ascii *aStorageKeyNameIn,
aat_ascii *aIVIn,
aat_ascii *aResponseIn,
aat_ascii *aChallengeIn);
Description
This function extends AAL2GenVerifyPasswordCmd. With this function, you can address the HSM storage key by name and to specify an initial vector. The initial vector is used during the 3DES/AES encryption of the sensitive authenticator application BLOB data.
The password validation on the HSM is identical to the functionality available with the Authentication Suite Server SDK Software Dynamic Authentication Service. For information on the associated functions, refer to the Authentication Suite Server SDK C-C++ Programmer's Guide.
This function must be used with the post-HSM API AAL2ProcVerifyPasswordRpl.
Parameters
Table: Parameters (AAL2GenVerifyPasswordCmdEx) | Type | Name | Use | Description |
|---|
| aat_byte * | Cmd | O | Up to 500 bytes that serialize the VERIFY PASSWORD command type and the input data to the verify password function on the HSM: - Command type - 2 bytes
- An authenticator application BLOB - 192 bytes
- Runtime parameters - 80 bytes
- StorageKeyName - up to 128 characters
- InitialVector - 8 bytes
- Password - up to 41 characters
- Challenge - up to 17 characters
- Host time - 4 bytes
Plus 28 bytes for Authentication Suite Server SDK internal use. |
| aat_int32 * | CmdSize | I/O | On entry, this parameter contains the size of the Cmd buffer.On exit, this parameter contains the length of the Cmd message. |
| TDigipassBlob * | DPData | I | authenticator application BLOB. |
| TKernelParms * | CallParms | I | Structure of runtime parameters to use during this function call. |
| aat_ascii * | aStorageKeyNameIn | I | String of up to 128+1 characters, left-justified, null-terminated, or right-padded with spaces. This is the label of the HSM storage key used to encrypt the sensitive Digipass application BLOB data. |
| aat_ascii * | aIVIn | I | String of 16 hexadecimal characters, left-justified, null-terminated, or right-padded with spaces. This is the initial vector used to encrypt the sensitive authenticator application BLOB data. |
| aat_ascii * | aResponseIn | I | String of up to 17+24 numeric or hexadecimal characters, left-justified, null-terminated or right-padded with spaces. This is the dynamic password generated by the Digipass authenticator. |
| aat_ascii * | aChallengeIn | I | String of up to 17 numeric characters, left-justified, null-terminated, or right-padded with spaces. This parameter holds the challenge that was proposed to the user to generate CodeToVerify. If no challenge was generated, this parameter should be NULL. |
Return codes
Table: Return codes (AAL2GenVerifyPasswordCmdEx) | Code | Meaning | Code | Meaning |
|---|
| 0 | Success | 510 | Invalid Digipass data pointer |
| 130 | Invalid response pointer | 590 | Invalid command pointer |
| 149 | Invalid initial vector length | 706 | Invalid data buffer pointer |
| 412 | Invalid checksum (software) | 1018 | Invalid TLV item pointer |
| 413 | Invalid Base64 format | 1025 | Data buffer too small |