An encapsulated private key.
More...
#include <key.h>

 CKey () 
 Construct an invalid private key. More...


 ~CKey () 
 Destructor (again necessary because of memlocking). 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 readonly vectorlike 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, uint32_t test_case=0) const 
 Create a DERserialized 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 (CPrivKey &privkey, CPubKey &vchPubKey, bool fSkipCheck) 
 Load private key and check that public key matches. More...



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


An encapsulated private key.
Definition at line 35 of file key.h.
Construct an invalid private key.
Definition at line 53 of file key.h.
Destructor (again necessary because of memlocking).
Definition at line 60 of file key.h.
const unsigned char* CKey::begin 
( 
 ) 
const 

inline 
Definition at line 88 of file key.h.
bool CKey::Check 
( 
const unsigned char * 
vch  ) 


staticprivate 
Check whether the 32byte array pointed to by vch is valid keydata.
Definition at line 122 of file key.cpp.
Derive BIP32 child key.
Definition at line 216 of file key.cpp.
const unsigned char* CKey::end 
( 
 ) 
const 

inline 
Definition at line 89 of file key.h.
Convert the private key to a CPrivKey (serialized OpenSSL private key data).
This is expensive.
Definition at line 134 of file key.cpp.
Compute the public key from a private key.
This is expensive.
Definition at line 147 of file key.cpp.
bool CKey::IsCompressed 
( 
 ) 
const 

inline 
Check whether the public key corresponding to this private key is (to be) compressed.
Definition at line 95 of file key.h.
bool CKey::IsValid 
( 
 ) 
const 

inline 
Check whether this private key is valid.
Definition at line 92 of file key.h.
bool CKey::Load 
( 
CPrivKey & 
privkey, 


CPubKey & 
vchPubKey, 


bool 
fSkipCheck = false 

) 
 
Load private key and check that public key matches.
Definition at line 204 of file key.cpp.
void CKey::MakeNewKey 
( 
bool 
fCompressed  ) 

Generate a new private key using a cryptographic PRNG.
Definition at line 126 of file key.cpp.
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 73 of file key.h.
bool CKey::Sign 
( 
const uint256 & 
hash, 


std::vector< unsigned char > & 
vchSig, 


uint32_t 
test_case = 0 

) 
 const 
Create a DERserialized signature.
The test_case parameter tweaks the deterministic nonce.
Definition at line 160 of file key.cpp.
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 189 of file key.cpp.
unsigned int CKey::size 
( 
 ) 
const 

inline 
Simple readonly vectorlike interface.
Definition at line 87 of file key.h.
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 175 of file key.cpp.
bool operator== 
( 
const CKey & 
a, 


const CKey & 
b 

) 
 

friend 
Definition at line 64 of file key.h.
Whether the public key corresponding to this private key is (to be) compressed.
Definition at line 43 of file key.h.
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.
The actual byte data.
Definition at line 46 of file key.h.
The documentation for this class was generated from the following files: