Gray C++ Libraries  0.0.2
A set of C++ libraries for MSVC, GNU on Windows, WinCE, Linux
GrayLib::cKeyExDHM Class Reference

#include <cKeyExDHM.h>

Inheritance diagram for GrayLib::cKeyExDHM:
GrayLib::cKeyExBase

Public Member Functions

 cKeyExDHM () noexcept
 
 ~cKeyExDHM ()
 
bool isKeyEx () const
 
bool isKeyValid () const
 
virtual HRESULT MakeKeyExParams (BYTE *pOut, size_t nSizeOut, IRandomNoise *pRandom) override
 
virtual HRESULT ReadKeyEx (const BYTE *pBuffer, const BYTE *end) override
 
virtual HRESULT ReadKeyPublic (const BYTE *pInput, size_t nSizeIn) override
 
HRESULT MakePublicDHM (size_t nSizeX, BYTE *pOutput, size_t nOutputSize, IRandomNoise *pRandom)
 
HRESULT MakePrivateDHM (BYTE *pOutput, size_t *nOutputSize, IRandomNoise *pRandom)
 
HRESULT ReadFromBlock (const BYTE *dhmin, size_t dhminlen)
 
HRESULT ReadFromFile (const FILECHAR_t *pszFilePath)
 
 UNITTEST_FRIEND (cKeyExDHM)
 
- Public Member Functions inherited from GrayLib::cKeyExBase
virtual ~cKeyExBase ()
 

Public Attributes

size_t m_len
 size(P) in chars More...
 
cBigUnsigned m_P
 prime modulus. m_dhm_P More...
 
cBigInteger m_G
 generator. m_dhm_G More...
 
cBigInteger m_GX
 self = G^X mod P More...
 
cBigInteger m_GY
 peer = G^Y mod P More...
 
cBigInteger m_K
 key = GY^X mod P More...
 
cBigUnsigned m_RP
 cached R^2 mod P More...
 
cBigInteger m_Vi
 blinding value More...
 
cBigInteger m_Vf
 un-blinding value More...
 
cBigInteger m_XPrev
 previous X More...
 
- Public Attributes inherited from GrayLib::cKeyExBase
cBigUnsigned m_X
 secret value (private key) More...
 

Static Public Attributes

static const char * k_pszPEM = "DH PARAMETERS"
 
static const char * k_default_P
 InitSSL SetKeyExDHMParams default params for RFC5114. More...
 
static const char * k_default_G
 DHM_RFC5114_MODP_1024_G. More...
 

Detailed Description

Key exchange DHM (Diffie-Hellman) (For RSA keys) for: SSL_KeyExchange_DHE_PSK, SSL_KeyExchange_DHE_RSA

RFC 2409 defines a number of standardized Diffie-Hellman groups that can be used. RFC 3526 defines a number of standardized Diffie-Hellman for IKE. RFC 5114 defines a number of standardized Diffie-Hellman groups that can be used.

Some are included here for convenience.

Included are: RFC 2409 6.2. 1024-bit MODP Group (Second Oakley Group) RFC 3526 3. 2048-bit MODP Group RFC 3526 4. 3072-bit MODP Group RFC 5114 2.1. 1024-bit MODP Group with 160-bit Prime Order Subgroup RFC 5114 2.2. 2048-bit MODP Group with 224-bit Prime Order Subgroup

Constructor & Destructor Documentation

◆ cKeyExDHM()

GrayLib::cKeyExDHM::cKeyExDHM ( )
inlinenoexcept

◆ ~cKeyExDHM()

GrayLib::cKeyExDHM::~cKeyExDHM ( )
inline

Free and clear the components of a DHM key

Member Function Documentation

◆ isKeyEx()

bool GrayLib::cKeyExDHM::isKeyEx ( ) const
inline

◆ isKeyValid()

bool GrayLib::cKeyExDHM::isKeyValid ( ) const
inline

◆ MakeKeyExParams()

HRESULT GrayLib::cKeyExDHM::MakeKeyExParams ( BYTE *  pOut,
size_t  nSizeOut,
IRandomNoise pRandom 
)
overridevirtual

Setup and write the ServerKeyExchange parameters

  • pOut = destination buffer
  • nSizeOut = number of chars written
  • pRandom = RNG function
    Note
    This function assumes that this->P and this->G have already been properly set (for example using SetStr or SetBinary).
    Returns
    0 if successful, or <0 = error code

Setup and write the ServerKeyExchange parameters

Implements GrayLib::cKeyExBase.

◆ MakePrivateDHM()

HRESULT GrayLib::cKeyExDHM::MakePrivateDHM ( BYTE *  pOutput,
size_t *  nOutputSize,
IRandomNoise pRandom 
)

Derive and export the shared secret (G^Y)^X mod P

  • pOutput = destination buffer
  • nOutputSize = on entry, must hold the size of the destination buffer on exit, holds the actual number of bytes written
  • pRandom = RNG function, for blinding purposes
    Returns
    0 if successful, or <0 = error code
    Note
    If non-NULL, pRandom is used to blind the input as countermeasure against timing attacks. Blinding is automatically used if and only if our secret value X is re-used and costs nothing otherwise, so it is recommended to always pass a non-NULL pRandom argument.

Premaster secret Derive and export the shared secret (G^Y)^X mod P

◆ MakePublicDHM()

HRESULT GrayLib::cKeyExDHM::MakePublicDHM ( size_t  nSizeX,
BYTE *  pOutput,
size_t  nOutputSize,
IRandomNoise pRandom 
)

Create own private value X and export G^X

  • nSizeX = private value size in bytes
  • pOutput = destination buffer
  • nOutputSize = must be equal to this->P.len
  • pRandom = RNG function
    Returns
    0 if successful, or <0 = error code

Create own private value X and export G^X MakeKeyPublic

◆ ReadFromBlock()

HRESULT GrayLib::cKeyExDHM::ReadFromBlock ( const BYTE *  dhmin,
size_t  dhminlen 
)

Parse DHM parameters

  • dhmin = input buffer
  • dhminlen = size of the buffer
    Returns
    0 if successful, or a specific DHM or PEM error code

Parse DHM parameters

◆ ReadFromFile()

HRESULT GrayLib::cKeyExDHM::ReadFromFile ( const FILECHAR_t pszFilePath)

Load and parse DHM parameters

  • pszFilePath = filename to read the DHM Parameters from
    Returns
    0 if successful, or a specific DHM or PEM error code

◆ ReadKeyEx()

HRESULT GrayLib::cKeyExDHM::ReadKeyEx ( const BYTE *  pBuffer,
const BYTE *  end 
)
overridevirtual

Parse the ServerKeyExchange parameters

  • pBuffer = &(start of input buffer)
  • end = end of buffer
    Returns
    length if successful, or <0 = error code

Parse the ServerKeyExchange parameters

Implements GrayLib::cKeyExBase.

◆ ReadKeyPublic()

HRESULT GrayLib::cKeyExDHM::ReadKeyPublic ( const BYTE *  pInput,
size_t  nSizeIn 
)
overridevirtual

Import the peer's public value G^Y

  • pInput = input buffer
  • nSizeIn = size of buffer
    Returns
    0 if successful, or <0 = error code

Import the peer's public value G^Y

Implements GrayLib::cKeyExBase.

◆ UNITTEST_FRIEND()

GrayLib::cKeyExDHM::UNITTEST_FRIEND ( cKeyExDHM  )

Member Data Documentation

◆ k_default_G

const char * GrayLib::cKeyExDHM::k_default_G
static
Initial value:
=
"A4D1CBD5C3FD34126765A442EFB99905F8104DD258AC507F"
"D6406CFF14266D31266FEA1E5C41564B777E690F5504F213"
"160217B4B01B886A5E91547F9E2749F4D7FBD7D3B9A92EE1"
"909D0D2263F80A76A6A24C087A091F531DBF0A0169B6A28A"
"D662A4D18E73AFA32D779D5918D08BC8858F4DCEF97C2A24"
"855E6EEB22B3B2E5"

DHM_RFC5114_MODP_1024_G.

◆ k_default_P

const char * GrayLib::cKeyExDHM::k_default_P
static
Initial value:
=
"B10B8F96A080E01DDE92DE5EAE5D54EC52C99FBCFB06A3C6"
"9A6A9DCA52D23B616073E28675A23D189838EF1E2EE652C0"
"13ECB4AEA906112324975C3CD49B83BFACCBDD7D90C4BD70"
"98488E9C219A73724EFFD6FAE5644738FAA31A4FF55BCCC0"
"A151AF5F0DC8B4BD45BF37DF365C1A65E68CFDA76D4DA708"
"DF1FB2BC2E4A4371"

InitSSL SetKeyExDHMParams default params for RFC5114.

DHM_RFC5114_MODP_1024_P

◆ k_pszPEM

const char * GrayLib::cKeyExDHM::k_pszPEM = "DH PARAMETERS"
static

◆ m_G

cBigInteger GrayLib::cKeyExDHM::m_G

generator. m_dhm_G

◆ m_GX

cBigInteger GrayLib::cKeyExDHM::m_GX

self = G^X mod P

◆ m_GY

cBigInteger GrayLib::cKeyExDHM::m_GY

peer = G^Y mod P

◆ m_K

cBigInteger GrayLib::cKeyExDHM::m_K

key = GY^X mod P

◆ m_len

size_t GrayLib::cKeyExDHM::m_len

size(P) in chars

◆ m_P

cBigUnsigned GrayLib::cKeyExDHM::m_P

prime modulus. m_dhm_P

◆ m_RP

cBigUnsigned GrayLib::cKeyExDHM::m_RP

cached R^2 mod P

◆ m_Vf

cBigInteger GrayLib::cKeyExDHM::m_Vf

un-blinding value

◆ m_Vi

cBigInteger GrayLib::cKeyExDHM::m_Vi

blinding value

◆ m_XPrev

cBigInteger GrayLib::cKeyExDHM::m_XPrev

previous X


The documentation for this class was generated from the following files: