Documentation Index

Fetch the complete documentation index at: https://docs.onespan.com/llms.txt

Use this file to discover all available pages before exploring further.

AAL2GenGenMessageActivation1Cmd

New
  • Published on May 20, 2026
  • 2 minute(s) read
Prev Next

Availability: Authentication Suite Server SDK 4.0.2 and later

Service: Digipass Multi-Device Activation

Function prototype

aat_int32 AAL2GenGenMessageActivation1Cmd(aat_byte *Cmd,
                                          aat_int32 *CmdSize,
                                          TDigipassBlob *DPMAData,
                                          TKernelParms *CallParms,  
                                          aat_ascii *StorageKeyName,
                                          aat_ascii * StorageIV,
                                          aat_ascii *Challenge,  
                                          aat_ascii *StaticVector,
                                          aat_ascii *MessageVector, 
                                          aat_ascii *ActivationVector, 
                                          aat_byte *Fido2PublicKey,
                                          aat_int32 Fido2PublicKeyLength);

Description

This function creates a command that directs the HSM to generate an Activation Message 1 from the master activation application (the license), the static vector, the message vector, and the activation vector, and to return a result in the form of a reply. The Activation Message 1 allows to activate an authenticator license in the device.

It is only applicable to hardware or software authenticators compliant with the multi-device two-step activation (in context of multi-device licensing).

The Activation Message 1 is used in the multi-device activation process for all authenticator instances of a particular license.

This function must be used with the post-HSM AAL2ProcGenMessageActivation1Rpl() API function.

Parameters

Table: Parameters (AAL2GenGenMessageActivation1Cmd)
TypeNameUseDescription
aat_byte *CmdO

Up to 4924 bytes that serialize the GENERATE ACTIVATION MESSAGE 1 command type and input data to the function on the HSM:

  • Command type – 2 bytes (V_CMD_GEN_MSG_ACTIVATION1)
  • Digipass Master Activation application BLOB – 192 bytes
  • Runtime parameters – 80 bytes
  • StorageKeyName – up to 128 characters
  • InitialVector – 8 bytes
  • Challenge – up to 16 characters
  • StaticVector – up to 4096 characters
  • MessageVector – up to 26 characters
  • ActivationVector – up to 76 characters
  • FidoPulicKey – up to 256 bytes
  • FidoPublicKeyLength – 4 bytes

Plus 40 bytes for Authentication Suite Server SDK internal use.

aat_int32 *CmdSizeI/OOn entry, this parameter contains the size of the Cmd buffer. On exit, this parameter contains the length of the Cmd message.
TDigipassBlobDPMADataI

Digipass master activation application BLOB of the Digipass serial number license to use for the activation.

TKernelParms *CallParmsI

Structure of runtime parameters to use during this function call.

aat_ascii *StorageKey NameI

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 *StorageIVI

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 *ChallengeI

Optional string of 16 numeric or hexadecimal characters, left-justified, null-terminated or right-padded with spaces. This parameter holds the challenge which must be used to generate the Activation Message 1. If no challenge must be used to generate the Activation Message 1, this parameter must be NULL.

aat_ascii *StaticVectorI

Software Digipass parameter settings, up to 4094 characters, null-terminated.

aat_ascii *MessageVectorI

String of up to 26+1 characters containing the message parameter settings , null-terminated (obtained during import).

aat_ascii *ActivationVectorI

String containing the activation vector corresponding to the Digipass serial number to activate (obtained during import).

aat_byte *Fido2PublicKeyIThe public key that was created by the authenticator during the FIDO2 registration ceremony. It is used to bind the authenticator instance with the FIDO2 instance.
aat_int32Fido2PublicKeyLengthIThe size of the allocated buffer for the FIDO2 public key parameter.

Return codes

Table: Return codes (AAL2GenGenMessageActivation1Cmd)
CodeMeaningCodeMeaning
0Success1268Invalid message vector version
412Invalid checksum1269Invalid message vector pointer
413Invalid Base64 format1270Invalid activation message pointer
537Invalid static vector pointer1271Invalid activation message length pointer
545Invalid static vector length1272Invalid message body type
580Static vector light not found1273Invalid activation vector length
1000Function does not support EMV-CAP1274Invalid message protocol version
1118Unsupported BLOB1275Invalid message protection type
1025Buffer too small1288Invalid serial number prefix
1264Invalid master application1289Invalid serial number suffix
1265Invalid master application data pointer1331Activation 1 not supported
1266Invalid message vector pointer-101Challenge too short
1267Invalid message vector length-102Challenge too long