pkcs_key.h

Go to the documentation of this file.

/*
 * pkcs_key.h
 *
 * PKCS#1 PKCS#8 Parser and utilities routines
 *
 * Copyright 2019-2024 DigiCert, Inc. All Rights Reserved.
 * Proprietary and Confidential Material.
 *
 */
#ifndef __PKCS_KEY_HEADER__
#define __PKCS_KEY_HEADER__


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

#ifdef __cplusplus
extern "C" {
#endif

/* encryption types --- do not change the values associated with the constants */
enum PKCS8EncryptionType
{
    PCKS8_EncryptionType_undefined = 0,
#if defined(__ENABLE_MOCANA_PKCS5__)
#if defined(__ENABLE_DES_CIPHER__)
    PCKS8_EncryptionType_pkcs5_v1_sha1_des  = 10, /* oid suffix */
#endif

#if defined(__ENABLE_ARC2_CIPHERS__)
    PCKS8_EncryptionType_pkcs5_v1_sha1_rc2  = 11, /* oid suffix */
#endif

#if defined(__ENABLE_DES_CIPHER__) && defined(__ENABLE_MOCANA_MD2__)
    PCKS8_EncryptionType_pkcs5_v1_md2_des   = 1,   /* oid suffix */
#endif

#if defined(__ENABLE_ARC2_CIPHERS__) && defined(__ENABLE_MOCANA_MD2__)
    PCKS8_EncryptionType_pkcs5_v1_md2_rc2   = 4,  /* oid suffix */
#endif

#if defined(__ENABLE_DES_CIPHER__)
    PCKS8_EncryptionType_pkcs5_v1_md5_des   = 3,  /* oid suffix */
#endif

#if defined(__ENABLE_ARC2_CIPHERS__)
    PCKS8_EncryptionType_pkcs5_v1_md5_rc2   = 6, /* oid suffix */
#endif

#if !defined(__DISABLE_3DES_CIPHERS__)
    PCKS8_EncryptionType_pkcs5_v2_3des      = 5000 + 1, /* no signification */
#endif

#if defined(__ENABLE_DES_CIPHER__)
    PCKS8_EncryptionType_pkcs5_v2_des       = 5000 + 2, /* no signification */
#endif

#if defined(__ENABLE_ARC2_CIPHERS__)
    PCKS8_EncryptionType_pkcs5_v2_rc2       = 5000 + 3, /* no signification */
#endif

#if !defined(__DISABLE_AES_CIPHERS__)

#if !defined(__DISABLE_AES128_CIPHER__)
    PCKS8_EncryptionType_pkcs5_v2_aes128    = 5000 + 4, /* no signification */
#endif

#if !defined(__DISABLE_AES192_CIPHER__)
    PCKS8_EncryptionType_pkcs5_v2_aes192    = 5000 + 5, /* no signification */
#endif

#if !defined(__DISABLE_AES256_CIPHER__)
    PCKS8_EncryptionType_pkcs5_v2_aes256    = 5000 + 6, /* no signification */
#endif

#endif /* !defined(__DISABLE_AES_CIPHERS__) */

#endif /*  __ENABLE_MOCANA_PKCS5__  */

    PKCS8_EncryptionType_pkcs12             = 12000,
#if !defined(__DISABLE_3DES_CIPHERS__)
    PCKS8_EncryptionType_pkcs12_sha_2des    = PKCS8_EncryptionType_pkcs12 + 4, /* 12000 + oid suffix */
    PCKS8_EncryptionType_pkcs12_sha_3des    = PKCS8_EncryptionType_pkcs12 + 3, /* 12000 + oid suffix */
#endif

#if defined(__ENABLE_ARC2_CIPHERS__)
    PCKS8_EncryptionType_pkcs12_sha_rc2_40  = PKCS8_EncryptionType_pkcs12 + 6, /* 12000 + oid suffix */
    PCKS8_EncryptionType_pkcs12_sha_rc2_128 = PKCS8_EncryptionType_pkcs12 + 5, /* 12000 + oid suffix */
#endif

#if !defined(__DISABLE_ARC4_CIPHERS__)
    PCKS8_EncryptionType_pkcs12_sha_rc4_40  = PKCS8_EncryptionType_pkcs12 + 2, /* 12000 + oid suffix */
    PCKS8_EncryptionType_pkcs12_sha_rc4_128 = PKCS8_EncryptionType_pkcs12 + 1, /* 12000 + oid suffix */
#endif

};

enum PKCS8PrfType
{
    PKCS8_PrfType_undefined = 0,         /* default to PKCS8_PrfType_pkcs5_v2_hmacSHA1Digest */

    /* suffixes of rsaDSI_OID */
    /* applicable only if PCKS8_EncryptionType_pkcs5_v2_* is chosen */
    PKCS8_PrfType_pkcs5_v2_hmacSHA1Digest = 7,
    PKCS8_PrfType_pkcs5_v2_hmacSHA224Digest = 8,
    PKCS8_PrfType_pkcs5_v2_hmacSHA256Digest = 9,
    PKCS8_PrfType_pkcs5_v2_hmacSHA384Digest = 10,
    PKCS8_PrfType_pkcs5_v2_hmacSHA512Digest = 11
};

#if !defined(__DISABLE_MOCANA_CERTIFICATE_PARSING__)

MOC_EXTERN MSTATUS PKCS_getPKCS1Key(MOC_RSA(hwAccelDescr hwAccelCtx)const ubyte* pPKCS1DER, ubyte4 pkcs1DERLen, AsymmetricKey* pKey);
#if defined(__ENABLE_MOCANA_DSA__)
/* This read an unencrypted raw file like those produced by openssl */
MOC_EXTERN MSTATUS PKCS_getDSAKey(MOC_DSA(hwAccelDescr hwAccelCtx)
                                  const ubyte* pDSAKeyDer, ubyte4 pDSAKeyDerLen, AsymmetricKey* pKey);
#endif

MOC_EXTERN MSTATUS PKCS_getPKCS8Key(MOC_ASYM(hwAccelDescr hwAccelCtx)const ubyte* pPKCS8DER, ubyte4 pkcs8DERLen, AsymmetricKey* pKey);

MOC_EXTERN MSTATUS PKCS_getPKCS8KeyEx(MOC_HW(hwAccelDescr hwAccelCtx) const ubyte* pPKCS8DER, ubyte4 pkcs8DERLen,
                                      const ubyte* password, ubyte4 passwordLen, AsymmetricKey* pKey);

#if defined( __ENABLE_MOCANA_DER_CONVERSION__) || defined(__ENABLE_MOCANA_PEM_CONVERSION__)
MOC_EXTERN MSTATUS PKCS_setPKCS1Key(MOC_RSA(hwAccelDescr hwAccelCtx)
                                    const AsymmetricKey* pKey,
                                    ubyte **ppRetKeyDER, ubyte4 *pRetKeyDERLength);

#ifdef __ENABLE_MOCANA_DSA__
MOC_EXTERN MSTATUS PKCS_setDsaDerKey(MOC_DSA(hwAccelDescr hwAccelCtx) const AsymmetricKey* pKey,
                                     ubyte **ppRetKeyDER, ubyte4 *pRetKeyDERLength);
#endif

#endif

#if defined( __ENABLE_MOCANA_DER_CONVERSION__)
MOC_EXTERN MSTATUS PKCS_setPKCS8Key(MOC_HW(hwAccelDescr hwAccelCtx)
                                    const AsymmetricKey* pKey,
                                    randomContext* pRandomContext,
                                    enum PKCS8EncryptionType encType,
                                    enum PKCS8PrfType prfType,
                                    const ubyte* password, ubyte4 passwordLen,
                                    ubyte **ppRetKeyDER, ubyte4 *pRetKeyDERLength);
#endif

#endif /* !defined(__DISABLE_MOCANA_CERTIFICATE_PARSING__) */

#if defined(__ENABLE_MOCANA_PKCS8__)

#if defined(__ENABLE_MOCANA_PEM_CONVERSION__)

MOC_EXTERN MSTATUS PKCS8_decodePrivateKeyPEMEx(const ubyte* pFilePemPkcs8, ubyte4 fileSizePemPkcs8, ubyte *pPassword, ubyte4 passwordLen, 
                                               ubyte** ppKeyBlob, ubyte4 *pKeyBlobLength);

MOC_EXTERN MSTATUS PKCS8_encodePrivateKeyPEM(
    randomContext *pRandomContext, 
    ubyte* pKeyBlob, 
    ubyte4 keyBlobLen, 
    enum PKCS8EncryptionType encType,
    enum PKCS8PrfType prfType, 
    ubyte *pPassword, 
    ubyte4 passwordLen, 
    ubyte** ppRetFilePemPkcs8, 
    ubyte4 *pRetFileSizePemPkcs8);

#endif /* __ENABLE_MOCANA_PEM_CONVERSION__ */

#if defined(__ENABLE_MOCANA_DER_CONVERSION__)

MOC_EXTERN MSTATUS PKCS8_decodePrivateKeyDEREx(const ubyte* pFileDerPkcs8, ubyte4 fileSizeDerPkcs8, ubyte *pPassword, ubyte4 passwordLen, 
                                               ubyte** ppKeyBlob, ubyte4 *pKeyBlobLength);

MOC_EXTERN MSTATUS PKCS8_encodePrivateKeyDER(
    randomContext *pRandomContext, 
    ubyte* pKeyBlob,
    ubyte4 keyBlobLen, 
    enum PKCS8EncryptionType encType,
    enum PKCS8PrfType prfType, 
    ubyte *pPassword, 
    ubyte4 passwordLen, 
    ubyte** ppRetFileDerPkcs8, 
    ubyte4 *pRetFileSizeDerPkcs8);

#endif /* __ENABLE_MOCANA_DER_CONVERSION__ */

#endif /* __ENABLE_MOCANA_PKCS8__ */

#ifdef __cplusplus
}
#endif

#endif  /* __PKCS_KEY_HEADER__ */