AAL2ProcVerifyPasswordEsRpl

  • Published on Jul 9, 2025
  • 2 minute(s) read
Prev Next

Function prototype

aat_int32 AAL2ProcVerifyPasswordEsRpl(
                                      aat_byte       *InReply,
                                      aat_int32      *ReplySize,
                                      TDigipassBlob  *DPData,
                                      aat_ascii      *aReturnHostCodeOut,
                                      aat_int32      *ReturnHostCodeLenOut);

Description

This function processes a reply from the HSM to a password validation command which has been generated with AAL2GenVerifyPasswordEsCmd.

The password validation with enhanced security on the HSM is identical to the functionality available with the Authentication Suite Server SDK Software Dynamic Authentication Service. For information on the associated functions, refer to the Authentication Suite Server SDK C-C++ Programmer's Guide.

Parameters

  Table: Parameters (AAL2ProcVerifyPasswordEsRpl)
TypeNameUseDescription
aat_byte *InReplyI

Up to 235 bytes that contain the VERIFY PASSWORD command type and the output data from the verify password function on the HSM:

  • Command type - 2 bytes
  • An authenticator application BLOB - 192 bytes
  • Return code - 4 bytes
  • Return host code length - 4 bytes
  • Return host code - up to 17 characters

Plus 16 bytes for Authentication Suite Server SDK internal use.

aat_int32 *ReplySizeIThe length of the InReply message.
TDigipassBlob *DPDataOauthenticator application description data block. Upon return from the function call, this BLOB must be rewritten to the application database to reflect changes.
aat_ascii * aReturn HostCode Out O

String of up to 17 numeric characters, left-justified, null-terminated, or right-padded with spaces. This is the code generated by Authentication Suite Server SDK. Leave NULL if not required.

aat_ascii * ReturnHost CodeLen Out I/O

Pointer to a long integer that in input contains the size of the ReturnHostCodeOut buffer, and in output contains the real length of the generated return host code. Leave NULL if not required.

Return codes

  Table:  Return codes (AAL2ProcVerifyPasswordEsRpl)
CodeMeaningCodeMeaning
0Success912HSM invalid BLOB status
10001Success with context warning[1]913Invalid HSM key property
10002Success with user warning[1]951Invalid HSM key type for HSM decryption
10003Success with user & context warning[1]1009Invalid TLV total length
10004Success with platform warning[1]1018Invalid TLV item pointer
10005Success with platform & context warning[1]1019Missing mandatory TLV item
10006Success with platform & user warning[1]1025Data buffer too small
10007Success with platform & user & context warning[1]1039Invalid response length with DP algorithm
1Code not verified1040Invalid host code length with DP algorithm
2Static password validation failed1103Unlock Version 2 not supported
131Missing required challenge1116Response check digit not allowed
140Challenge corrupted1117Challenge check digit not allowed
201Code replay attempt1118Unsupported BLOB
202Identification error threshold reached-101Challenge too short
205Inactive days reached-102Challenge too long
208Application disabled-103Challenge check digit wrong
272Invalid wrapped key-105Challenge minimum length not allowed
412Invalid checksum (software)-106Challenge maximum length not allowed
413Invalid Base64 format-107Challenge number wrong
414Invalid checksum (HSM)-108Challenge character invalid
510Invalid Digipass data pointer-153Server public key too long
600Invalid Gordian root information-201Response length out of bounds
601Invalid Gordian today information-202Response too short
602Invalid Gordian tomorrow information-203Response too long
603Invalid Gordian stimulus information-204Response check digit wrong
701Invalid input buffer pointer-205Response character not decimal
802Change password mandatory-206Response character not hexadecimal
803New password too short-207Response character set not specified
804New password too long-1501Memory allocation failed
910Invalid HSM command in reply  
  1. Specific score-based authentication code (see Score-based DIGIPASS)