aes_keywrap.h

Go to the documentation of this file.

/*
 * aes_keywrap.h
 *
 * AES Key Wrap RFC 3394 and 5649 Implementation
 *
 * Copyright 2019-2024 DigiCert, Inc. All Rights Reserved.
 * Proprietary and Confidential Material.
 *
 */

/*------------------------------------------------------------------*/

#ifndef __AESKEYWRAP_HEADER__
#define __AESKEYWRAP_HEADER__

#ifdef __cplusplus
extern "C" {
#endif

MOC_EXTERN MSTATUS AESKWRAP_encrypt3394 (
  MOC_SYM (hwAccelDescr hwAccelCtx)
  ubyte *pKeyMaterial,
  sbyte4 keyLength,
  ubyte *pDataToEncrypt,
  ubyte4 dataToEncryptLen,
  ubyte *pEncryptedData,
  ubyte4 bufferSize,
  ubyte4 *pEncryptedDataLen
  );

MOC_EXTERN MSTATUS AESKWRAP_decrypt3394 (
  MOC_SYM (hwAccelDescr hwAccelCtx)
  ubyte *pKeyMaterial,
  sbyte4 keyLength,
  ubyte *pEncryptedData,
  ubyte4 encryptedDataLen,
  ubyte *pDecryptedData,
  ubyte4 bufferSize,
  ubyte4 *pDecryptedDataLen
  );

MOC_EXTERN MSTATUS AESKWRAP_encrypt5649 (
  MOC_SYM (hwAccelDescr hwAccelCtx)
  ubyte *pKeyMaterial,
  sbyte4 keyLength,
  ubyte *pDataToEncrypt,
  ubyte4 dataToEncryptLen,
  ubyte *pEncryptedData,
  ubyte4 bufferSize,
  ubyte4 *pEncryptedDataLen
  );

MOC_EXTERN MSTATUS AESKWRAP_decrypt5649 (
  MOC_SYM (hwAccelDescr hwAccelCtx)
  ubyte *pKeyMaterial,
  sbyte4 keyLength,
  ubyte *pEncryptedData,
  ubyte4 encryptedDataLen,
  ubyte *pDecryptedData,
  ubyte4 bufferSize,
  ubyte4 *pDecryptedDataLen
  );

/*---------------------------------------------------------------------------*/

/* Follwing APIs are same as above with extra option to specify the transform
 * type used in the operation */

MOC_EXTERN MSTATUS AESKWRAP_encrypt3394Ex (
  MOC_SYM (hwAccelDescr hwAccelCtx)
  ubyte *pKeyMaterial,
  sbyte4 keyLength,
  ubyte *pDataToEncrypt,
  ubyte4 dataToEncryptLen,
  ubyte *pEncryptedData,
  ubyte4 bufferSize,
  ubyte4 *pEncryptedDataLen,
  ubyte transform
  );

MOC_EXTERN MSTATUS AESKWRAP_decrypt3394Ex (
  MOC_SYM (hwAccelDescr hwAccelCtx)
  ubyte *pKeyMaterial,
  sbyte4 keyLength,
  ubyte *pEncryptedData,
  ubyte4 encryptedDataLen,
  ubyte *pDecryptedData,
  ubyte4 bufferSize,
  ubyte4 *pDecryptedDataLen,
  ubyte transform
  );

MOC_EXTERN MSTATUS AESKWRAP_encrypt5649Ex (
  MOC_SYM (hwAccelDescr hwAccelCtx)
  ubyte *pKeyMaterial,
  sbyte4 keyLength,
  ubyte *pDataToEncrypt,
  ubyte4 dataToEncryptLen,
  ubyte *pEncryptedData,
  ubyte4 bufferSize,
  ubyte4 *pEncryptedDataLen,
  ubyte transform
  );

MOC_EXTERN MSTATUS AESKWRAP_decrypt5649Ex (
  MOC_SYM (hwAccelDescr hwAccelCtx)
  ubyte *pKeyMaterial,
  sbyte4 keyLength,
  ubyte *pEncryptedData,
  ubyte4 encryptedDataLen,
  ubyte *pDecryptedData,
  ubyte4 bufferSize,
  ubyte4 *pDecryptedDataLen,
  ubyte transform
  );

/* RFC 3394: length of data must be a multiple of 8 */
MOC_EXTERN MSTATUS
AESKWRAP_encrypt( MOC_SYM(hwAccelDescr hwAccelCtx) ubyte* keyMaterial,
                 sbyte4 keyLength, const ubyte* data, ubyte4 dataLen,
                 ubyte* retData /* Should be dataLen + 8 */);


/* RFC 5649: no restriction on length of data */
MOC_EXTERN MSTATUS
AESKWRAP_encryptEx( MOC_SYM(hwAccelDescr hwAccelCtx) ubyte* keyMaterial,
                   sbyte4 keyLength, const ubyte* data, ubyte4 dataLen,
                   ubyte** retData, ubyte4* retDataLen);


/* legacy API: can only deal with RFC 3394 encoded key wraps */
MOC_EXTERN MSTATUS
AESKWRAP_decrypt(MOC_SYM(hwAccelDescr hwAccelCtx) ubyte* keyMaterial,
                 sbyte4 keyLength, const ubyte* data, ubyte4 dataLen,
                 ubyte* retData /* dataLen - 8 */);


/* preferred API: can deal with RFC 3394 and RFC 5649 encoded key wraps */
MOC_EXTERN MSTATUS
AESKWRAP_decryptEx(MOC_SYM(hwAccelDescr hwAccelCtx) ubyte* keyMaterial,
                   sbyte4 keyLength, const ubyte* data, ubyte4 dataLen,
                   ubyte* retData /* <= dataLen - 8 */, ubyte4* retDataLen);



#ifdef __cplusplus
}
#endif

#endif