Bitcoin ABC  0.22.15
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 secp256k1 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 uint8_t * begin () const
 
const uint8_t * 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...
 
bool Negate ()
 Negate private key. 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 SignECDSA (const uint256 &hash, std::vector< uint8_t > &vchSig, bool grind=true, uint32_t test_case=0) const
 Create a DER-serialized ECDSA signature. More...
 
bool SignSchnorr (const uint256 &hash, SchnorrSig &sig, uint32_t test_case=0) const
 Create a Schnorr signature. More...
 
bool SignSchnorr (const uint256 &hash, std::vector< uint8_t > &vchSig, uint32_t test_case=0) const
 
bool SignCompact (const uint256 &hash, std::vector< uint8_t > &vchSig) const
 Create a compact ECDSA 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 SIZE = 279
 secp256k1: More...
 
static const unsigned int COMPRESSED_SIZE = 214
 

Static Private Member Functions

static bool Check (const uint8_t *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< uint8_t, secure_allocator< uint8_t > > keydata
 The actual byte data. More...
 

Friends

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

Detailed Description

An encapsulated secp256k1 private key.

Definition at line 28 of file key.h.

Constructor & Destructor Documentation

◆ CKey()

CKey::CKey ( )
inline

Construct an invalid private key.

Definition at line 60 of file key.h.

Member Function Documentation

◆ begin()

const uint8_t* CKey::begin ( ) const
inline

Definition at line 86 of file key.h.

Here is the caller graph for this function:

◆ Check()

bool CKey::Check ( const uint8_t *  vch)
staticprivate

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

Definition at line 179 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 352 of file key.cpp.

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

◆ end()

const uint8_t* CKey::end ( ) const
inline

Definition at line 87 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 196 of file key.cpp.

Here is the call graph for this function:
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 210 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 94 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 90 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 336 of file key.cpp.

Here is the call graph for this function:
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 183 of file key.cpp.

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

◆ Negate()

bool CKey::Negate ( )

Negate private key.

Definition at line 191 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 72 of file key.h.

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

◆ SignCompact()

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

Create a compact ECDSA 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 316 of file key.cpp.

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

◆ SignECDSA()

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

Create a DER-serialized ECDSA signature.

The test_case parameter tweaks the deterministic nonce.

Definition at line 242 of file key.cpp.

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

◆ SignSchnorr() [1/2]

bool CKey::SignSchnorr ( const uint256 hash,
SchnorrSig sig,
uint32_t  test_case = 0 
) const

Create a Schnorr signature.

The test_case parameter tweaks the deterministic nonce.

Definition at line 288 of file key.cpp.

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

◆ SignSchnorr() [2/2]

bool CKey::SignSchnorr ( const uint256 hash,
std::vector< uint8_t > &  vchSig,
uint32_t  test_case = 0 
) const

Definition at line 293 of file key.cpp.

Here is the call graph for this function:

◆ size()

unsigned int CKey::size ( ) const
inline

Simple read-only vector-like interface.

Definition at line 85 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. (An ECDSA signature is created then verified.)

Definition at line 302 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_SIZE

const unsigned int CKey::COMPRESSED_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 50 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 40 of file key.h.

◆ keydata

std::vector<uint8_t, secure_allocator<uint8_t> > CKey::keydata
private

The actual byte data.

Definition at line 53 of file key.h.

◆ SIZE

const unsigned int CKey::SIZE = 279
static

secp256k1:

Definition at line 33 of file key.h.


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