Availability: Authentication Suite Server SDK 4.0.2 and later
Service: Digipass Multi-Device Activation
Function Prototype
aat_int32 AAL2ProcGenMessageActivation1Rpl(
aat_byte *InReply,
aat_int32 ReplySize,
TDigipassBlob *DPMAData,
aat_ascii *Activation1Message,
aat_ascii *Activation1MessageLength);
Description
This function processes a reply from the HSM to an Activation Message 1 generation command which has been generated with AAL2GenGenMessageActivation1Cmd.
The Activation Message 1 generation on the HSM is identical to the functionality available with the Software Digipass Multi-Device Activation service.
This function serializes an important amount of data. The InReply buffer must be allocated with a sufficient size. For more information about the allocation of the Cmd and InReply buffers, refer to Cmd and InReply buffers allocation.
Parameters
Table: Parameters (AAL2ProcGenMessageActivation2Rpl) | Type | Name | Use | Description |
|---|
| aat_byte * | InReply | I | Contains the GENERATE ACTIVATION MESSAGE 1 command type and output data to the function on the HSM. |
| aat_int32 | ReplySize | I | The length of the InReply message. |
| TDigipassBlob | DPMAData | O | Digipass master activation application BLOB of the Digipass serial number license that will be used for the activation. Upon return from the function call, this BLOB must be rewritten to the application database to reflect changes. |
| aat_ascii * | Activation1Message | O | String of up to 4234+1 hexadecimal characters, null-terminated. It contains the Activation Message 1 necessary during the activation process of the Digipass instances of a particular license, plus the public key HMAC. |
| aat_int32 * | Activation1MessageLength | I/O | In input, this parameter must indicate the size of the allocated buffer for the Activation1Message parameter (recommended 4235 bytes). In output, this parameter indicates the length of the Activatin1Message string (without the null-terminated character). |
Return codes
Table: Return codes (AAL2ProcGenMessageActivation2Rpl) | Code | Meaning | Code | Meaning |
|---|
| 0 | Success | 1271 | Invalid activation message length pointer |
| 272 | Invalid wrapped key | 1272 | Invalid message body type |
| 412 | Invalid checksum (software) | 1274 | Invalid message protocol version |
| 413 | Invalid Base64 format | 1275 | Invalid message protection type |
| 414 | Invalid checksum (HSM) | 1285 | Master key derivation failed |
| 537 | Invalid static vector pointer | 1288 | Invalid serial number prefix |
| 545 | Invalid static vector length | 1289 | Invalid serial number suffix |
| 570 | Invalid static vector version | 1290 | Invalid sequence number pointer |
| 571 | Invalid application index in static vector | 1291 | Invalid application count pointer |
| 574 | Invalid serial number prefix in SV | 1292 | Sequence number threshold reached |
| 701 | Invalid input buffer pointer | 1293 | Invalid sequence number |
| 807 | Serial number not equal | 1294 | Digipass key derivation failed |
| 910 | Invalid HSM command in reply | 1295 | Invalid Digipass instance SM application in static vector |
| 912 | HSM invalid BLOB status | 1296 | Key wrapping failed |
| 913 | Invalid HSM key property | 1297 | Invalid static vector |
| 917 | Key type inconsistent | 1298 | Invalid Digipass instance application in static vector |
| 951 | Invalid HSM key type for HSM decryption | 1302 | AES CTR encryption failed |
| 1000 | Function does not support EMV-CAP | 1310 | Invalid payload key type |
| 1009 | Invalid TLV total length | 1311 | Null Digipass data |
| 1018 | Invalid TLV item pointer | 1312 | Null serial number |
| 1019 | Missing mandatory TLV item | 1313 | Null authentication mode |
| 1025 | Buffer too small | 1314 | Null token type |
| 1118 | Unsupported BLOB | 1317 | Secure Channel supported. Payload key BLOB is mandatory |
| 1264 | Invalid master application | 1318 | Secure Channel not supported. Payload key BLOB has to be NULL or empty string |
| 1265 | Invalid master application data pointer | 1332 | Activation 2 not supported |
| 1267 | Invalid message vector length | 1335 | Invalid payload key type in payload key data |
| 1268 | Invalid message vector version | 1336 | Inconsistent payload key type between payload key data and message vector |
| 1270 | Invalid activation message pointer | -1501 | Memory allocation failed |