Bitcoin Core  0.15.99
P2P Digital Currency
Public Member Functions | Static Public Attributes | Static Private Member Functions | Private Attributes | Friends | List of all members
CKey Class Reference

An encapsulated private key. More...

#include <key.h>

Public Member Functions

 CKey ()
 Construct an invalid private key. More...
 
template<typename T >
void Set (const T pbegin, const T pend, bool fCompressedIn)
 Initialize using begin and end iterators to byte data. More...
 
unsigned int size () const
 Simple read-only vector-like interface. More...
 
const unsigned char * begin () const
 
const unsigned char * end () const
 
bool IsValid () const
 Check whether this private key is valid. More...
 
bool IsCompressed () const
 Check whether the public key corresponding to this private key is (to be) compressed. More...
 
void MakeNewKey (bool fCompressed)
 Generate a new private key using a cryptographic PRNG. More...
 
CPrivKey GetPrivKey () const
 Convert the private key to a CPrivKey (serialized OpenSSL private key data). More...
 
CPubKey GetPubKey () const
 Compute the public key from a private key. More...
 
bool Sign (const uint256 &hash, std::vector< unsigned char > &vchSig, bool grind=true, uint32_t test_case=0) const
 Create a DER-serialized signature. More...
 
bool SignCompact (const uint256 &hash, std::vector< unsigned char > &vchSig) const
 Create a compact signature (65 bytes), which allows reconstructing the used public key. More...
 
bool Derive (CKey &keyChild, ChainCode &ccChild, unsigned int nChild, const ChainCode &cc) const
 Derive BIP32 child key. More...
 
bool VerifyPubKey (const CPubKey &vchPubKey) const
 Verify thoroughly whether a private key and a public key match. More...
 
bool Load (const CPrivKey &privkey, const CPubKey &vchPubKey, bool fSkipCheck)
 Load private key and check that public key matches. More...
 

Static Public Attributes

static const unsigned int PRIVATE_KEY_SIZE = 279
 secp256k1: More...
 
static const unsigned int COMPRESSED_PRIVATE_KEY_SIZE = 214
 

Static Private Member Functions

static bool Check (const unsigned char *vch)
 Check whether the 32-byte array pointed to by vch is valid keydata. More...
 

Private Attributes

bool fValid
 see www.keylength.com script supports up to 75 for single byte push More...
 
bool fCompressed
 Whether the public key corresponding to this private key is (to be) compressed. More...
 
std::vector< unsigned char, secure_allocator< unsigned char > > keydata
 The actual byte data. More...
 

Friends

bool operator== (const CKey &a, const CKey &b)
 

Detailed Description

An encapsulated private key.

Definition at line 27 of file key.h.

Constructor & Destructor Documentation

◆ CKey()

CKey::CKey ( )
inline

Construct an invalid private key.

Definition at line 59 of file key.h.

Member Function Documentation

◆ begin()

const unsigned char* CKey::begin ( ) const
inline

Definition at line 89 of file key.h.

Here is the caller graph for this function:

◆ Check()

bool CKey::Check ( const unsigned char *  vch)
staticprivate

Check whether the 32-byte array pointed to by vch is valid keydata.

Definition at line 154 of file key.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Derive()

bool CKey::Derive ( CKey keyChild,
ChainCode ccChild,
unsigned int  nChild,
const ChainCode cc 
) const

Derive BIP32 child key.

Definition at line 268 of file key.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ end()

const unsigned char* CKey::end ( ) const
inline

Definition at line 90 of file key.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetPrivKey()

CPrivKey CKey::GetPrivKey ( ) const

Convert the private key to a CPrivKey (serialized OpenSSL private key data).

This is expensive.

Definition at line 166 of file key.cpp.

Here is the caller graph for this function:

◆ GetPubKey()

CPubKey CKey::GetPubKey ( ) const

Compute the public key from a private key.

This is expensive.

Definition at line 179 of file key.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsCompressed()

bool CKey::IsCompressed ( ) const
inline

Check whether the public key corresponding to this private key is (to be) compressed.

Definition at line 96 of file key.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsValid()

bool CKey::IsValid ( ) const
inline

Check whether this private key is valid.

Definition at line 93 of file key.h.

Here is the caller graph for this function:

◆ Load()

bool CKey::Load ( const CPrivKey privkey,
const CPubKey vchPubKey,
bool  fSkipCheck = false 
)

Load private key and check that public key matches.

Definition at line 256 of file key.cpp.

Here is the caller graph for this function:

◆ MakeNewKey()

void CKey::MakeNewKey ( bool  fCompressed)

Generate a new private key using a cryptographic PRNG.

Definition at line 158 of file key.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Set()

template<typename T >
void CKey::Set ( const T  pbegin,
const T  pend,
bool  fCompressedIn 
)
inline

Initialize using begin and end iterators to byte data.

Definition at line 74 of file key.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Sign()

bool CKey::Sign ( const uint256 hash,
std::vector< unsigned char > &  vchSig,
bool  grind = true,
uint32_t  test_case = 0 
) const

Create a DER-serialized signature.

The test_case parameter tweaks the deterministic nonce.

Definition at line 205 of file key.cpp.

Here is the caller graph for this function:

◆ SignCompact()

bool CKey::SignCompact ( const uint256 hash,
std::vector< unsigned char > &  vchSig 
) const

Create a compact signature (65 bytes), which allows reconstructing the used public key.

The format is one header byte, followed by two times 32 bytes for the serialized r and s values. The header byte: 0x1B = first key with even y, 0x1C = first key with odd y, 0x1D = second key with even y, 0x1E = second key with odd y, add 0x04 for compressed keys.

Definition at line 241 of file key.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ size()

unsigned int CKey::size ( ) const
inline

Simple read-only vector-like interface.

Definition at line 88 of file key.h.

Here is the caller graph for this function:

◆ VerifyPubKey()

bool CKey::VerifyPubKey ( const CPubKey vchPubKey) const

Verify thoroughly whether a private key and a public key match.

This is done using a different mechanism than just regenerating it.

Definition at line 227 of file key.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator==

bool operator== ( const CKey a,
const CKey b 
)
friend

Definition at line 65 of file key.h.

Member Data Documentation

◆ COMPRESSED_PRIVATE_KEY_SIZE

const unsigned int CKey::COMPRESSED_PRIVATE_KEY_SIZE = 214
static

Definition at line 34 of file key.h.

◆ fCompressed

bool CKey::fCompressed
private

Whether the public key corresponding to this private key is (to be) compressed.

Definition at line 49 of file key.h.

◆ fValid

bool CKey::fValid
private

see www.keylength.com script supports up to 75 for single byte push

Whether this private key is valid. We check for correctness when modifying the key data, so fValid should always correspond to the actual state.

Definition at line 41 of file key.h.

◆ keydata

std::vector<unsigned char, secure_allocator<unsigned char> > CKey::keydata
private

The actual byte data.

Definition at line 52 of file key.h.

◆ PRIVATE_KEY_SIZE

const unsigned int CKey::PRIVATE_KEY_SIZE = 279
static

secp256k1:

Definition at line 33 of file key.h.


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