Information message processing

This article describes the function(s) on which the information message processing functionality is based. It contains information about parameters and possible return codes, as well as a prototype for each function.

The information message processing functionality is applicable:
To software Digipass authenticators compliant with the multi-device two-step activation (in the context of multi-device licensing) and if the Secure Channel feature has been ordered (configured by OneSpan at the time of order).
For more information, refer to the Authentication Suite Server SDK Product Guide.

AAL2ProcMessageInformationICSF

Function prototype

aat_int32 AAL2ProcMessageInformationICSF (
                                  aat_ascii      *PKBlob,
                                  TKernelParms   *CallParms,
                                  aat_ascii      *aStorageKeyNameIn,
                                  aat_ascii      *aInitialVectorIn,
                                  aat_ascii      *InformationMessage,
                                  aat_ascii      *InformationBody,
                                  aat_int32      *InformationBodyLength);

Description

This function is used to extract a clear response body from a information message, using the payload key embedded into the payload key BLOB.

The payload key BLOB, required only if the information message is protected (encrypted and/or signed), must be mandatorily the one corresponding to the Digipass serial number of the client device that generated the information message.

For Digipass client devices supporting the information, the information message will be sent by the device to a server.

The information message processing is only applicable to software Digipass authenticators compliant with the Secure Channel protocol and able to generate Secure Channel information messages.

Parameters

Table: Parameters (AAL2ProcMessageInformationICSF)
Type	Name	Use	Description
aat_ascii *	PKBlob	I	Contains the payload key BLOB that has been generated for the Digipass instances activated with a particular serial number license (in case of the multi-device licensing model) or that has been imported for the Digipass authenticator with a particular serial number license (in case of single-device licensing model). The payload key BLOB parameter is mandatory only if the information message is protected (encrypted and/or signed); can be NULL or empty if the information message is not protected (neither encrypted nor signed).
TKernelParms *	CallParms	I	Structure of runtime parameters to use during this function call.
aat_ascii *	aStorageKeyNameIn	I	String of up to 64+1 characters, left-justified, null-terminated, or right-padded with spaces. This is the label of the ICSF storage key used to encrypt the sensitive Digipass application BLOB data.
aat_ascii *	aInitialVectorIn	I	String of 16 or 32 hexadecimal characters, left-justified, null-terminated. This is the initial vector used to encrypt the sensitive authenticator application BLOB data.
aat_ascii *	InformationMessage	I	Hexadecimal character string containing the information message that has been generated by the Digipass client device.The string length must be a multiple of 2 with a maximum length of 1070 characters.
aat_ascii *	InformationBody	O	String of up to 1024+1 hexadecimal characters, null-terminated. In case of a successful operation, this parameter contains the clear response body extracted from the InformationMessage.
aat_int32 *	InformationBodyLength	I/O	In input, this parameter must indicate the size of the allocated buffer for the InformationBody parameter (recommended are 1025 bytes). In output, this parameter indicates the length of the InformationBody string (without the null-terminated character).

Return codes