My Project
Loading...
Searching...
No Matches
dh.h File Reference

Go to the source code of this file.

Data Structures

struct  DhKey
 

Typedefs

typedef struct DhKey DhKey
 

Functions

WOLFSSL_API const DhParams * wc_Dh_ffdhe2048_Get (void)
 This function returns ... and requires that HAVE_FFDHE_2048 be defined.
 
WOLFSSL_API const DhParams * wc_Dh_ffdhe3072_Get (void)
 This function returns ... and requires that HAVE_FFDHE_3072 be defined.
 
WOLFSSL_API const DhParams * wc_Dh_ffdhe4096_Get (void)
 This function returns ... and requires that HAVE_FFDHE_4096 be defined.
 
WOLFSSL_API const DhParams * wc_Dh_ffdhe6144_Get (void)
 This function returns ... and requires that HAVE_FFDHE_6144 be defined.
 
WOLFSSL_API const DhParams * wc_Dh_ffdhe8192_Get (void)
 This function returns ... and requires that HAVE_FFDHE_8192 be defined.
 
WOLFSSL_API int wc_InitDhKey (DhKey *key)
 This function initializes a Diffie-Hellman key for use in negotiating a secure secret key with the Diffie-Hellman exchange protocol.
 
WOLFSSL_API int wc_InitDhKey_ex (DhKey *key, void *heap, int devId)
 
WOLFSSL_API int wc_FreeDhKey (DhKey *key)
 This function frees a Diffie-Hellman key after it has been used to negotiate a secure secret key with the Diffie-Hellman exchange protocol.
 
WOLFSSL_API int wc_DhGenerateKeyPair (DhKey *key, WC_RNG *rng, byte *priv, word32 *privSz, byte *pub, word32 *pubSz)
 This function generates a public/private key pair based on the Diffie-Hellman public parameters, storing the private key in priv and the public key in pub. It takes an initialized Diffie-Hellman key and an initialized rng structure.
 
WOLFSSL_API int wc_DhAgree (DhKey *key, byte *agree, word32 *agreeSz, const byte *priv, word32 privSz, const byte *otherPub, word32 pubSz)
 This function generates an agreed upon secret key based on a local private key and a received public key. If completed on both sides of an exchange, this function generates an agreed upon secret key for symmetric communication. On successfully generating a shared secret key, the size of the secret key written will be stored in agreeSz.
 
WOLFSSL_API int wc_DhKeyDecode (const byte *input, word32 *inOutIdx, DhKey *key, word32)
 This function decodes a Diffie-Hellman key from the given input buffer containing the key in DER format. It stores the result in the DhKey structure.
 
WOLFSSL_API int wc_DhSetKey (DhKey *key, const byte *p, word32 pSz, const byte *g, word32 gSz)
 This function sets the key for a DhKey structure using the input private key parameters. Unlike wc_DhKeyDecode, this function does not require that the input key be formatted in DER format, and instead simply accepts the parsed input parameters p (prime) and g (base).
 
WOLFSSL_API int wc_DhSetKey_ex (DhKey *key, const byte *p, word32 pSz, const byte *g, word32 gSz, const byte *q, word32 qSz)
 
WOLFSSL_LOCAL int wc_DhSetFullKeys (DhKey *key, const byte *priv_key, word32 privSz, const byte *pub_key, word32 pubSz)
 
WOLFSSL_API int wc_DhSetCheckKey (DhKey *key, const byte *p, word32 pSz, const byte *g, word32 gSz, const byte *q, word32 qSz, int trusted, WC_RNG *rng)
 
WOLFSSL_API int wc_DhParamsLoad (const byte *input, word32 inSz, byte *p, word32 *pInOutSz, byte *g, word32 *gInOutSz)
 This function loads the Diffie-Hellman parameters, p (prime) and g (base) out of the given input buffer, DER formatted.
 
WOLFSSL_API int wc_DhCheckPubKey (DhKey *key, const byte *pub, word32 pubSz)
 
WOLFSSL_API int wc_DhCheckPubKey_ex (DhKey *key, const byte *pub, word32 pubSz, const byte *prime, word32 primeSz)
 
WOLFSSL_API int wc_DhCheckPubValue (const byte *prime, word32 primeSz, const byte *pub, word32 pubSz)
 
WOLFSSL_API int wc_DhCheckPrivKey (DhKey *key, const byte *priv, word32 pubSz)
 Check DH private key for invalid numbers.
 
WOLFSSL_API int wc_DhCheckPrivKey_ex (DhKey *key, const byte *priv, word32 pubSz, const byte *prime, word32 primeSz)
 
WOLFSSL_API int wc_DhCheckKeyPair (DhKey *key, const byte *pub, word32 pubSz, const byte *priv, word32 privSz)
 Checks DH keys for pair-wise consistency per process in SP 800-56Ar3, section 5.6.2.1.4, method (b) for FFC.
 
WOLFSSL_API int wc_DhGenerateParams (WC_RNG *rng, int modSz, DhKey *dh)
 
WOLFSSL_API int wc_DhExportParamsRaw (DhKey *dh, byte *p, word32 *pSz, byte *q, word32 *qSz, byte *g, word32 *gSz)
 

Variables

 C
 

Function Documentation

◆ wc_DhCheckPubValue()

WOLFSSL_API int wc_DhCheckPubValue ( const byte * prime,
word32 primeSz,
const byte * pub,
word32 pubSz )

Quick validity check of public key value against prime. Checks are:

  • Public key not 0 or 1
  • Public key not equal to prime or prime - 1
  • Public key not bigger than prime.

prime Big-endian encoding of prime in bytes. primeSz Size of prime in bytes. pub Big-endian encoding of public key in bytes. pubSz Size of public key in bytes.

Variable Documentation

◆ C

C
extern
Initial value:
{
#endif
#ifdef WOLFSSL_ASYNC_CRYPT
#endif
typedef struct DhParams {
#ifdef HAVE_FFDHE_Q
const byte* q;
word32 q_len;
#endif
const byte* p;
word32 p_len;
const byte* g;
word32 g_len;
} DhParams