AAL2MigrateBlobICSFEx
  • 22 Jan 2025
  • 1 Minute à lire
  • Sombre
    Lumière
  • PDF

AAL2MigrateBlobICSFEx

  • Sombre
    Lumière
  • PDF

The content is currently unavailable in French. You are viewing the default English version.
Résumé de l’article

Function prototype (aal2sdk.h)

aat_int32 AAL2MigrateBlobICSFEx (
                           TDigipassBlob*   DPBlob,
                           TKernelParms*    CallParms,
                           aat_ascii*       aTransportKeyName,
                           aat_ascii*       aTransportKeyKCV,
                           aat_ascii*       aStorageKeyName,
                           aat_ascii*       aInitialVector);

Description

The extended BLOB migration function allows you to migrate an HSM transport key encrypted BLOB into an HSM storage key encrypted BLOB (i.e. HSM transport key → HSM storage key) ready to be stored in the database.

It is used in conjunction with AAL2DPXInitHSM.

You can retrieve an HSM transport key-encrypted BLOB using the Authentication Suite Server SDK API AAL2DPXGetTokenBlobsEx2(). This function will extract a BLOB but not migrate it.

You only can retrieve this HSM transport key-encrypted BLOB if the relevant DPX file has been created using HSM transport key encryption, also called DPX double encryption.

Parameters

The memory management of the output parameters must be performed by the calling function.

  Table: Parameters (AAL2MigrateBlobICSF)
TypeNameUseDescription
TDigipassBlob *DPBlobI/Oauthenticator application BLOB.
TKernelParms * CallParms IStructure of run time parameters to use during the HSM migrate BLOB function call.
aat_ascii*aTransportKeyNameIString containing the HSM key label used to perform the decryption of the sensitive data of the BLOB in input.
aat_ascii*aTransportKeyKCVIString containing the KCV of the HSM transport key used to perform the DPX decryption of the BLOB in input.
aat_ascii*aStorageKeyNameI

String containing the HSM storage key used to perform the 3DES/AES encryption of the sensitive data of the BLOB in output.

After migration, further usage of the authenticator application BLOB will mandatorily require to use this HSM storage key.

aat_ascii*aInitialVectorI

String of 16 hexadecimal characters, containing the initial vector. This is the initial vector used to encrypt the sensitive authenticator application BLOB data in output.

Can be NULL to encrypt the BLOB without any initial vector.

After migration, further usage of the authenticator application BLOB will mandatorily require to use this initial vector.

COBOL calling convention

Entry point: AA2MGBIX
02   W-BLOB               PIC X(248).
02   W-KERNELPARMS.
     03   W-PARMCOUNT     PIC 9(8) USAGE BINARY.
     03   W-PARM01        PIC 9(8) USAGE BINARY.
     . . .
     03   W-PARM19        PIC 9(8) USAGE BINARY.
02   W-RETURN             PIC S9(8) USAGE BINARY.
02   W-TRANSPORTKEY       PIC X(65).
02   W-TRANSPORTKEYKCV    PIC X(7).
02   W-STORAGEKEY         PIC X(65).
02   W-INITVECTOR         PIC X(17).
02   W-API-NAME           PIC X(8) VALUE 'AA2MGBIx'.
. . .
     CALL W-API-NAME USING
           BY REFERENCE W-BLOB
           BY REFERENCE W-KERNELPARMS
           BY REFERENCE W-TRANSPORTKEY
           BY REFERENCE W-TRANSPORTKEYKCV
           BY REFERENCE W-STORAGEKEY
           BY REFERENCE W-INITVECTOR
           RETURNING W-RETURN

Return codes

  Table: Return codes (AAL2MigrateBlobICSF)
CodeMeaningCodeMeaning
0Success908HSM key not found
412Invalid checksum (software)911HSM invalid key KCV
413Invalid Base64 format950Invalid application for AES HSM encryption
414Invalid checksum (HSM)951Invalid HSM key type for HSM decryption
510Invalid Digipass data pointer1100Function not supported
900Invalid session context handle1118

Unsupported BLOB


Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Ozzy, facilitant la découverte de connaissances grâce à l’intelligence conversationnelle