Function Prototype
aat_int32 AAL2ProcGenMessageDeactivationRpl(
aat_byte *InReply,
aat_int32 ReplySize,
aat_ascii *DeactivationMessage,
aat_int32 DeactivationMessageLength);
Description
This function processes a reply from the HSM to a deactivation message generation command which has been generated with AAL2GenGenMessageDeactivationCmd.
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.
Parameters
Table: Parameters (AAL2ProcGenMessageDeactivationRpl) | Type | Name | Use | Description |
|---|
| aat_byte * | InReply | I | String of up to 72 bytes that contain the REQUEST MESSAGE GENERATION command type and the output data from the request message generation function on the HSM: - Command type - 2 bytes
- Deactivation Message - 50 characters
- Deactivation Message Length - 4 bytes
- Return code - 4 bytes
Plus 12 bytes for Authentication Suite Server SDK internal use. |
| aat_int32 | ReplySize | I | The length of the InReply message. |
| aat_ascii * | DeactivationMessage | O | String of up to 50+1 hexadecimal characters, null-terminated. In case of a successful operation, this parameter contains the generated deactivation message. |
| aat_int32 * | DeactivationMessageLength | I/O | In input, this parameter must indicate the size of the allocated buffer for the DeactivationMessage parameter (recommended 51 bytes). In output, this parameter indicates the length of the DeactivationMessage string (without the null-terminated character). |
Return codes
Table: Return codes (AAL2ProcGenMessageDeactivationRpl) | Code | Meaning | Code | Meaning |
|---|
| 0 | Success | 1274 | Invalid message protocol version |
| 701 | Invalid input buffer pointer | 1275 | Invalid message protection type |
| 910 | Invalid HSM command in reply | 1285 | Master key derivation failed |
| 913 | Invalid HSM key property | 1288 | Invalid serial number prefix |
| 917 | Key type inconsistent | 1289 | Invalid serial number suffix |
| 951 | Invalid HSM key type for HSM decryption | 1293 | Invalid sequence number |
| 1009 | Invalid TLV total length | 1302 | AES CTR encryption failed |
| 1018 | Invalid TLV item pointer | 1307 | Invalid deactivation message pointer |
| 1019 | Missing mandatory TLV item | 1308 | Invalid deactivation message length pointer |
| 1025 | Buffer too small | 1333 | Deactivation not supported |
| 1118 | Unsupported BLOB | 1335 | Invalid payload key type in payload key data |
| 1267 | Invalid message vector length | 1336 | Inconsistent payload key type between payload key data and message vector |
| 1268 | Invalid message vector version | | |