dh.h

Go to the documentation of this file.

/*
 * dh.h
 *
 * Diffie-Hellman Key Exchange
 *
 * Copyright 2019-2024 DigiCert, Inc. All Rights Reserved.
 * Proprietary and Confidential Material.
 *
 */

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

#ifndef __KEYEX_DH_HEADER__
#define __KEYEX_DH_HEADER__

#include "../cap/capdecl.h"

#ifdef __ENABLE_MOCANA_CRYPTO_INTERFACE__
#include "../crypto_interface/crypto_interface_dh_priv.h"
#endif

#include "../cap/capasym.h"
#include "../crypto/ffc.h"

#ifdef __cplusplus
extern "C" {
#endif

#define DH_GROUP_TBD                    0
#define DH_GROUP_1                      1
#define DH_GROUP_2                      2
#define DH_GROUP_5                      5
#define DH_GROUP_14                     14
#define DH_GROUP_15                     15
#define DH_GROUP_16                     16
#define DH_GROUP_17                     17
#define DH_GROUP_18                     18
#define DH_GROUP_24                     24

#define DH_GROUP_19                     19
#define DH_GROUP_20                     20
#define DH_GROUP_21                     21
#define DH_GROUP_25                     25
#define DH_GROUP_26                     26
#define DH_GROUP_31                     31
#define DH_GROUP_32                     32

#define DH_GROUP_FFDHE2048           0x100
#define DH_GROUP_FFDHE3072           0x101
#define DH_GROUP_FFDHE4096           0x102
#define DH_GROUP_FFDHE6144           0x103
#define DH_GROUP_FFDHE8192           0x104
    
#define COMPUTED_VLONG_G(X)             (X)->dh_g
#define COMPUTED_VLONG_Y(X)             (X)->dh_y
#define COMPUTED_VLONG_F(X)             (X)->dh_f
#define COMPUTED_VLONG_E(X)             (X)->dh_e
#define COMPUTED_VLONG_K(X)             (X)->dh_k
#define COMPUTED_VLONG_P(X)             (X)->dh_p
#define COMPUTED_VLONG_Q(X)             (X)->dh_q

#ifndef __DISABLE_MOCANA_DH_BLINDING__
#define COMPUTED_VLONG_VF(X)             (X)->dh_vf
#define COMPUTED_VLONG_VI(X)             (X)->dh_vi
#define COMPUTED_VLONG_PY(X)             (X)->dh_py
#endif
    
/* for SSH context */
#define DIFFIEHELLMAN_CONTEXT(X)        (X)->p_dhContext

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

typedef struct diffieHellmanContext
{
    vlong*  dh_g;           /* generator */
    vlong*  dh_p;           /* big prime */
    vlong*  dh_q;         /* prime divisor */
    vlong*  dh_y;           /* random number - private key */
    vlong*  dh_f;           /* sent by the server - public key */
    vlong*  dh_e;           /* sent by the client - public key */
    vlong*  dh_k;           /* shared secret */

    MocAsymKey pPrivateKey;
    MocAsymKey pPublicKey;
    ubyte4     enabled;

#ifndef __DISABLE_MOCANA_DH_BLINDING__
    
    vlong* dh_vi;     /* the blinding value */
    vlong* dh_vf;     /* the unblinding value */
    vlong* dh_py;     /* the previous value of y */
    
#endif

} diffieHellmanContext;

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

MOC_EXTERN MSTATUS DH_getG(ubyte4 groupNum, vlong **ppRetG);


MOC_EXTERN MSTATUS DH_getP(ubyte4 groupNum, vlong **ppRetP);


MOC_EXTERN MSTATUS DH_getPByteString(ubyte4 groupNum, const ubyte** ppBytes, sbyte4* pLen);


MOC_EXTERN MSTATUS DH_allocate(diffieHellmanContext **pp_dhContext);


MOC_EXTERN MSTATUS DH_allocateServer(MOC_DH(hwAccelDescr hwAccelCtx) randomContext *pRandomContext, diffieHellmanContext **pp_dhContext, ubyte4 groupNum);


MOC_EXTERN MSTATUS DH_allocateClient(MOC_DH(hwAccelDescr hwAccelCtx) randomContext *pRandomContext, diffieHellmanContext **pp_dhContext, ubyte4 groupNum);


MOC_EXTERN MSTATUS DH_allocateClientAux(MOC_DH(hwAccelDescr hwAccelCtx) randomContext *pRandomContext, diffieHellmanContext **pp_dhContext, ubyte4 groupNum);


MOC_EXTERN MSTATUS DH_setPG(MOC_DH(hwAccelDescr hwAccelCtx) randomContext *pRandomContext, ubyte4 lengthY, diffieHellmanContext *p_dhContext, const vlong *P, const vlong *G);


MOC_EXTERN MSTATUS DH_setPGQ(MOC_DH(hwAccelDescr hwAccelCtx) randomContext *pRandomContext, ubyte4 lengthY, diffieHellmanContext *p_dhContext, const vlong *P, const vlong *G, const vlong *Q);


MOC_EXTERN MSTATUS DH_freeDhContext(diffieHellmanContext **pp_dhContext, vlong **ppVlongQueue);


MOC_EXTERN MSTATUS DH_computeKeyExchange(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *p_dhContext, vlong** ppVlongQueue);


MOC_EXTERN MSTATUS DH_setKeyParameters(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *pTargetCtx, MDhKeyTemplate *pSrcTemplate);


MOC_EXTERN MSTATUS DH_getKeyParametersAlloc(MOC_DH(hwAccelDescr hwAccelCtx) MDhKeyTemplate *pTargetTemplate, diffieHellmanContext *pSrcCtx, ubyte keyType);


MOC_EXTERN MSTATUS DH_freeKeyTemplate(diffieHellmanContext *pCtx, MDhKeyTemplate *pTemplate);


MOC_EXTERN MSTATUS DH_generateKeyPair(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *pCtx, randomContext *pRandomContext, ubyte4 numBytes);


MOC_EXTERN MSTATUS DH_getPublicKey(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *pCtx, ubyte **ppPublicKey, ubyte4 *pPublicKeyLen);


MOC_EXTERN MSTATUS DH_computeKeyExchangeEx(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *pCtx, randomContext *pRandomContext, ubyte *pOtherPartysPublicKey, ubyte4 publicKeyLen,
                                           ubyte **ppSharedSecret, ubyte4 *pSharedSecretLen);


/* mode macros for DH Key Agreement Schemes */
#define DH_HYBRID1           0
#define MQV2                 1
#define DH_EPHEMERAL         2
#define DH_HYBRID_ONE_FLOW_U 3
#define DH_HYBRID_ONE_FLOW_V 4
#define MQV1_U               5
#define MQV1_V               6
#define DH_ONE_FLOW_U        7
#define DH_ONE_FLOW_V        8
#define DH_STATIC            9

MOC_EXTERN MSTATUS DH_keyAgreementScheme(
    MOC_DH(hwAccelDescr hwAccelCtx)
    ubyte4 mode,
    randomContext *pRandomContext,
    diffieHellmanContext *pStatic, 
    diffieHellmanContext *pEphemeral, 
    ubyte *pOtherPartysStatic, 
    ubyte4 otherStaticLen,
    ubyte *pOtherPartysEphemeral,
    ubyte4 otherEphemeralLen,
    ubyte **ppSharedSecret,
    ubyte4 *pSharedSecretLen);


MOC_EXTERN MSTATUS DH_validateDomainParams(MOC_DH(hwAccelDescr hwAccelCtx) randomContext* pFipsRngCtx,
                                           diffieHellmanContext *pCtx, FFCHashType hashType, ubyte4 C,
                                           ubyte *pSeed, ubyte4 seedSize, intBoolean *pIsValid, ubyte4 *pPriKeyLen, vlong **ppVlongQueue);

MOC_EXTERN MSTATUS DH_verifySafePG(diffieHellmanContext *pCtx, intBoolean *pIsValid, ubyte4 *pPriKeyLen, vlong **ppVlongQueue);

MOC_EXTERN MSTATUS DH_verifyPQ_FIPS1864(MOC_DH(hwAccelDescr hwAccelCtx) randomContext* pFipsRngCtx,
                                        diffieHellmanContext *pCtx, FFCHashType hashType, ubyte4 C,
                                        ubyte *pSeed, ubyte4 seedSize, intBoolean *pIsValid, vlong **ppVlongQueue);

MOC_EXTERN MSTATUS DH_verifyG(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *pCtx, intBoolean *pIsValid, vlong **ppVlongQueue);
    

/* Ext versions of all the above methods that will be used in crypto interface */
    
MOC_EXTERN MSTATUS DH_allocateExt(diffieHellmanContext **pp_dhContext, void *pExtCtx);
MOC_EXTERN MSTATUS DH_allocateServerExt(MOC_DH(hwAccelDescr hwAccelCtx) randomContext *pRandomContext, diffieHellmanContext **pp_dhContext, ubyte4 groupNum, void *pExtCtx);
MOC_EXTERN MSTATUS DH_allocateClientAuxExt(MOC_DH(hwAccelDescr hwAccelCtx) randomContext *pRandomContext, diffieHellmanContext **pp_dhContext, ubyte4 groupNum, void *pExtCtx);
MOC_EXTERN MSTATUS DH_freeDhContextExt(diffieHellmanContext **pp_dhContext, vlong **ppVlongQueue, void *pExtCtx);
MOC_EXTERN MSTATUS DH_setKeyParametersExt(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *pTargetCtx, MDhKeyTemplate *pSrcTemplate, void *pExtCtx);
MOC_EXTERN MSTATUS DH_getKeyParametersAllocExt(MOC_DH(hwAccelDescr hwAccelCtx) MDhKeyTemplate *pTargetTemplate, diffieHellmanContext *pSrcCtx, ubyte keyType, void *pExtCtx);
MOC_EXTERN MSTATUS DH_freeKeyTemplateExt(diffieHellmanContext *pCtx, MDhKeyTemplate *pTemplate, void *pExtCtx);
MOC_EXTERN MSTATUS DH_generateKeyPairExt(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *pCtx, randomContext *pRandomContext, ubyte4 numBytes, void *pExtCtx);
MOC_EXTERN MSTATUS DH_getPublicKeyExt(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *pCtx, ubyte **ppPublicKey, ubyte4 *pPublicKeyLen, void *pExtCtx);
MOC_EXTERN MSTATUS DH_computeKeyExchangeExExt(MOC_DH(hwAccelDescr hwAccelCtx) diffieHellmanContext *pCtx, randomContext *pRandomContext, ubyte *pOtherPartysPublicKey,
                                              ubyte4 publicKeyLen, ubyte **ppSharedSecret, ubyte4 *pSharedSecretLen, void *pExtCtx);

#ifdef __cplusplus
}
#endif

#endif /* __KEYEX_DH_HEADER__ */