Function Prototype
aat_int32 AAL2GenGenMessageDeactivationCmd(
aat_byte *Cmd,
aat_int32 *CmdSize,
aat_ascii *PKBlob,
TKernelParms *CallParms,
aat_ascii *aStorageKeyNameIn,
aat_ascii *aIVIn,
aat_ascii *MessageVector,
aat_int32 SeqNum);
Description
This function creates a command that directs the HSM to generate a deactivation message using the given data, and to return a result in the form of a reply.
It is only applicable to hardware or software Digipass authenticators compliant with the multi-device two-step activation (in the context of multi-device licensing). For more information, refer to the Authentication Suite Server SDK Product Guide.
The deactivation message generation is only applicable if the Secure Channel feature has been ordered (configured by OneSpan at the time of order).
The deactivation message generation on the HSM is identical to the functionality available with the Authentication Suite Server SDK Software Digipass Secure Channel 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 AAL2ProcGenMessageDeactivationRpl.
Parameters
Table: Parameters (AAL2GenGenMessageDeactivationCmd) | Type | Name | Use | Description |
|---|
| aat_byte * | Cmd | O | Up to 353 bytes thatSERIALIZE THE DEACTIVATION MESSAGE GENERATION command type and the input data to deactivation message generation function on the HSM: - Command type - 2 bytes
- PayloadKey BLOB - 72 characters
- Runtime parameters - 80 bytes
- StorageKeyName - up to 128 characters
- InitialVector - 8 bytes
- MessageVector - up to 27 characters
- Sequence Number - 4 bytes
- 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. |
| aat_ascii * | PKBlob | I | Contains the payload key BLOB that has been generated for the Digipass instances activated with a particular serial number license. |
| TKernelParms * | CallParms | I | Structure of runtime parameters to use during this function call. |
| aat_ascii * | aStorageKey NameIn | 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 * | MessageVector | I | A string of up to 26+1 characters containing the message parameter settings, null-terminated (obtained during import). |
| aat_int32 | SeqNum | I | Integer containing the sequence number of the Digipass instance to deactivate. |
Return codes
Table: Return codes (AAL2GenGenMessageDeactivationCmd) | Code | Meaning | Code | Meaning |
|---|
| 0 | Success | 1000 | Function does not support EMV-CAP |
| 1 | Code not verified | 1018 | Invalid TLV item pointer |
| 149 | Invalid initial vector length | 1025 | Buffer too small |
| 412 | Invalid checksum (software) | 1119 | Unsupported payload key BLOB |
| 413 | Invalid Base64 format | 1266 | Invalid message vector pointer |
| 590 | Invalid command pointer | 1286 | Invalid payload key pointer |
| 706 | Invalid data buffer pointer | | |