Function prototype
aat_int32 AAL2GenUnlockAuthCodeCmdEx(
aat_byte* Cmd,
aat_int32* CmdSize,
TDigipassBlob* DPData,
TKernelParms* CallParms,
aat_ascii* aStorageKeyNameIn,
aat_ascii* aIVIn,
aat_int32 UnlockAuthIndex);
Description
This function extends AL2GenUnlockAuthCmd. 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.
Unlocking Digipass with the HSM module is identical to the functionality available with the Authentication Suite Server SDK Software Digipass Management 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 AAL2ProcUnlockAuthCodeRpl.
Parameters
Table: Parameters (AAL2GenUnlockAuthCodeCmdEx) | Type | Name | Use | Description |
|---|
| aat_byte * | Cmd | O | 434 bytes that serialize the UNLOCK AUTH CODE command type and the input data to the unlock auth code 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
- Unlock auth index - 4 bytes
Plus 20 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_int32 | UnlockAuthIndex | I | This parameter contains the unlock authentication index value; possible parameter values range from 0 to 5: - 0: current unlock authentication code
- 1: next unlock authentication code
- 2: …
|
Return codes
Table: Return codes (AAL2GenUnlockAuthCodeCmdEx) | Code | Meaning | Code | Meaning |
|---|
| 0 | Success | 590 | Invalid command pointer |
| 149 | Invalid initial vector length | 706 | Invalid data buffer pointer |
| 412 | Invalid checksum (software) | 1000 | Function does not support EMV-CAP |
| 413 | Invalid Base64 format | 1018 | Invalid TLV item pointer |
| 510 | Invalid Digipass data pointer | 1025 | Buffer too small |