cert_chain.h

Go to the documentation of this file.

/*
 * cert_chain.h
 *
 * Copyright 2019-2024 DigiCert, Inc. All Rights Reserved.
 * Proprietary and Confidential Material.
 */

#ifndef __CERT_CHAIN_HEADER__
#define __CERT_CHAIN_HEADER__

#ifdef __cplusplus
extern "C" {
#endif

struct certChain;
typedef struct certChain* certChainPtr;

struct certStore;
struct TimeDate;
struct AsymmetricKey;

typedef struct ValidationConfig
{
    struct certStore* pCertStore;
    
    const ubyte* anchorCert;
    
    ubyte4 anchorCertLen;
    
    const struct TimeDate *td;
    
    const sbyte* commonName;
    
    ubyte2 keyUsage;
    
    const ubyte** extendedKeyUsage;
    
} ValidationConfig;
    

/* Note (1): param can be null */


/* build a certificate chain from an SSL Certificate message
 pSSLCertificateMsg starts at the CertificateChainLength field
 and the sslCertificateMsgLen is the value of the medium after the
 message type (11) */

MOC_EXTERN MSTATUS
CERTCHAIN_getCertificateExtensions(certChainPtr pCertChain,
                                   ubyte4 index,
                                   ubyte **ppCertExts,
                                   ubyte4 *pCertExtLen);

MOC_EXTERN MSTATUS
CERTCHAIN_getCertificateExtensionsCertStatus(certChainPtr pCertChain,
                                   ubyte4 index,
                                   ubyte **ppOcspExt,
                                   ubyte4 *pOcspExtLen);

MOC_EXTERN MSTATUS CERTCHAIN_createFromSSLRecord(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                                 certChainPtr* ppNewCertChain,
                                                 const ubyte* pSSLCertificateMsg,
                                                 ubyte4 sslCertificateMsgLen);

MOC_EXTERN MSTATUS CERTCHAIN_createFromSSLRecordEx(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                                 certChainPtr* ppNewCertChain,
                                                 const ubyte* pSSLCertificateMsg,
                                                 ubyte4 sslCertificateMsgLen,
                                                 ubyte sslMinorVersion);

#ifdef __ENABLE_MOCANA_CV_CERT__

MOC_EXTERN MSTATUS CERTCHAIN_CVC_createFromSSLRecordEx(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                                       certChainPtr* ppNewCertChain,
                                                       const ubyte* pSSLCertificateMsg,
                                                       ubyte4 sslCertificateMsgLen,
                                                       ubyte sslMinorVersion,
                                                       byteBoolean *pIsCvc);
#endif

#if (defined(__ENABLE_MOCANA_SSH_CLIENT__) || defined(__ENABLE_MOCANA_SSH_SERVER__))

typedef MSTATUS (*funcPtrWalkStr)(const ubyte *, ubyte4, ubyte4 *);

MOC_EXTERN MSTATUS CERTCHAIN_createFromSSHEx(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                           certChainPtr* ppNewCertChain,
                                           const ubyte* pSSHCertChainBuf,
                                           ubyte4 sshCertChainBufLen,
                                           ubyte4 *pBufIndex,
                                           funcPtrWalkStr walkStrFunc);


#ifndef __DISABLE_MOCANA_CERT_CHAIN_SSH_DEP__

MOC_EXTERN MSTATUS CERTCHAIN_createFromSSH(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                           certChainPtr* ppNewCertChain,
                                           const ubyte* pSSHCertChainBuf,
                                           ubyte4 sshCertChainBufLen,
                                           ubyte4 *pBufIndex);
#endif /* __DISABLE_MOCANA_CERT_CHAIN_SSH_DEP__ */
#endif /* (defined(__ENABLE_MOCANA_SSH_CLIENT__) || defined(__ENABLE_MOCANA_SSH_SERVER__)) */

struct certDescriptor;

MOC_EXTERN MSTATUS CERTCHAIN_createFromIKE(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                           certChainPtr* ppNewCertChain,
                                           struct certDescriptor certiDesc[],
                                           ubyte4 numCertDesc);

#ifdef __ENABLE_MOCANA_CV_CERT__

MOC_EXTERN MSTATUS CERTCHAIN_createFromCVC(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                           certChainPtr* ppNewCertChain,
                                           struct certDescriptor certiDesc[],
                                           ubyte4 numCertDesc);

#endif

MOC_EXTERN MSTATUS CERTCHAIN_numberOfCertificates(certChainPtr pCertChain,
                                                  ubyte4* numCerts);

/* get certificate in the chain, 0 == leaf, last = chain root */

MOC_EXTERN MSTATUS CERTCHAIN_getCertificate(certChainPtr pCertChain,
                                            ubyte4 indexInChain,
                                            const ubyte** certDerData,
                                            ubyte4* certDerDataLen);
MOC_EXTERN MSTATUS CERTCHAIN_getKey(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                    certChainPtr pCertChain,
                                    ubyte4 indexInChain,
                                    struct AsymmetricKey* pubKey);

#ifdef __ENABLE_MOCANA_CERTIFICATE_SEARCH_SUPPORT__

MOC_EXTERN MSTATUS CERTCHAIN_getRSASigAlgo(certChainPtr pCertChain,
                                           ubyte4 indexInChain,
                                           ubyte *sigAlgo);
#endif

MOC_EXTERN MSTATUS CERTCHAIN_isComplete(certChainPtr pCertChain,
                                        intBoolean* complete);

#if !defined(__DISABLE_MOCANA_CERTIFICATE_PARSING__)

MOC_EXTERN MSTATUS CERTCHAIN_validate(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                      certChainPtr pCertChain,
                                      ValidationConfig* validationConfig);

#ifdef __ENABLE_MOCANA_CV_CERT__

MOC_EXTERN MSTATUS CERTCHAIN_CVC_validate(MOC_ASYM(hwAccelDescr hwAccelCtx)
                                      certChainPtr pCertChain,
                                      ValidationConfig* validationConfig);

#endif

MOC_EXTERN MSTATUS CERTCHAIN_validateAll(MOC_ASYM(hwAccelDescr hwAccelCtx)
    ubyte *pCertArr, sbyte4 certArrLen, ValidationConfig *pConfig,
    certChainPtr *ppRetChain);
#endif

MOC_EXTERN MSTATUS CERTCHAIN_delete( certChainPtr* ppCertChain);

#ifdef __cplusplus
}
#endif

#endif /* __CERT_CHAIN_HEADER__ */