#include <key.h>

Public Member Functions
	CKey ()
	Construct an invalid private key. More...

	CKey (const CKey &secret)
	Copy constructor. This is necessary because of memlocking. 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 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...

bool	SetPrivKey (const CPrivKey &vchPrivKey, bool fCompressed)
	Initialize from a CPrivKey (serialized OpenSSL private key data). More...

void	MakeNewKey (bool fCompressed)
	Generate a new private key using a cryptographic PRNG. More...

CPrivKey	GetPrivKey () const

CPubKey	GetPubKey () const

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

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

bool	Derive (CKey &keyChild, ChainCode &ccChild, unsigned int nChild, const ChainCode &cc) const
	Derive BIP32 child key. More...

bool	VerifyPubKey (const CPubKey &vchPubKey) const

bool	Load (CPrivKey &privkey, CPubKey &vchPubKey, bool fSkipCheck)
	Load private key and check that public key matches. More...

Static Public Member Functions
static bool	CheckSignatureElement (const unsigned char *vch, int len, bool half)
	Check whether an element of a signature (r or s) is valid. More...

Static Private Member Functions
static bool	Check (const unsigned char *vch)
	Check whether the 32-byte array pointed to be vch is valid keydata. More...

Private Attributes
bool	fValid

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

unsigned char	vch [32]
	The actual byte data. More...

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

Detailed Description

An encapsulated private key.

Definition at line 35 of file key.h.

Constructor & Destructor Documentation

◆ CKey() [1/2]

CKey::CKey ( )

inline

Construct an invalid private key.

Definition at line 53 of file key.h.

◆ CKey() [2/2]

CKey::CKey ( const CKey & secret )

inline

Copy constructor. This is necessary because of memlocking.

Definition at line 59 of file key.h.

◆ ~CKey()

CKey::~CKey ( )

inline

Destructor (again necessary because of memlocking).

Definition at line 66 of file key.h.

Member Function Documentation

◆ begin()

const unsigned char* CKey::begin ( ) const

inline

Definition at line 96 of file key.h.

Referenced by Derive(), CExtKey::Encode(), GetPrivKey(), GetPubKey(), Load(), CBitcoinSecret::SetKey(), SetPrivKey(), Sign(), and SignCompact().

◆ Check()

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

staticprivate

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

Definition at line 122 of file key.cpp.

Referenced by MakeNewKey(), and Set().

◆ CheckSignatureElement()

static bool CKey::CheckSignatureElement	(	const unsigned char *	vch,
		int	len,
		bool	half
	)

static

Check whether an element of a signature (r or s) is valid.

◆ Derive()

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

Derive BIP32 child key.

Definition at line 225 of file key.cpp.

Referenced by CExtKey::Derive().

◆ end()

const unsigned char* CKey::end ( ) const

inline

Definition at line 97 of file key.h.

Referenced by Derive().

◆ GetPrivKey()

CPrivKey CKey::GetPrivKey ( ) const

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

Definition at line 143 of file key.cpp.

Referenced by CWallet::AddKeyPubKey().

◆ GetPubKey()

CPubKey CKey::GetPubKey ( ) const

Compute the public key from a private key. This is expensive.

Definition at line 156 of file key.cpp.

Referenced by Derive(), CExtKey::Derive(), CWallet::DeriveNewChildKey(), CWallet::GenerateNewKey(), CMessageSigner::GetKeysFromSecret(), CWallet::GetOutpointAndKeysFromOutput(), and CExtKey::Neuter().

◆ IsCompressed()

bool CKey::IsCompressed ( ) const

inline

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

Definition at line 103 of file key.h.

Referenced by Derive(), and CBitcoinSecret::SetKey().

◆ IsValid()

bool CKey::IsValid ( ) const

inline

Check whether this private key is valid.

Definition at line 100 of file key.h.

Referenced by Derive(), and CBitcoinSecret::SetKey().

◆ Load()

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

Load private key and check that public key matches.

Definition at line 213 of file key.cpp.

◆ MakeNewKey()

void CKey::MakeNewKey ( bool fCompressed )

Generate a new private key using a cryptographic PRNG.

Definition at line 126 of file key.cpp.

Referenced by CWallet::GenerateNewKey(), and masternode().

◆ 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 79 of file key.h.

Referenced by CExtKey::Decode(), CBitcoinSecret::GetKey(), and CExtKey::SetMaster().

◆ SetPrivKey()

bool CKey::SetPrivKey	(	const CPrivKey &	vchPrivKey,
		bool	fCompressed
	)

Initialize from a CPrivKey (serialized OpenSSL private key data).

Definition at line 135 of file key.cpp.

◆ Sign()

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

Create a DER-serialized signature. The test_case parameter tweaks the deterministic nonce.

Definition at line 169 of file key.cpp.

Referenced by VerifyPubKey().

◆ 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 198 of file key.cpp.

◆ size()

unsigned int CKey::size ( ) const

inline

Simple read-only vector-like interface.

Definition at line 95 of file key.h.

Referenced by CExtKey::Encode(), end(), and CBitcoinSecret::SetKey().

◆ 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 184 of file key.cpp.

Referenced by CWallet::DeriveNewChildKey(), CWallet::GenerateNewKey(), and Load().

Friends And Related Function Documentation

◆ operator==

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

friend

Definition at line 71 of file key.h.

Member Data Documentation

◆ fCompressed

bool CKey::fCompressed

private

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

Definition at line 43 of file key.h.

Referenced by Derive(), GetPrivKey(), GetPubKey(), IsCompressed(), Load(), MakeNewKey(), Set(), SetPrivKey(), SignCompact(), and VerifyPubKey().

◆ fValid

bool CKey::fValid

private

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.

Referenced by Derive(), GetPrivKey(), GetPubKey(), IsValid(), Load(), MakeNewKey(), Set(), SetPrivKey(), Sign(), SignCompact(), and size().

◆ vch

unsigned char CKey::vch[32]

private

The actual byte data.

Definition at line 46 of file key.h.

Referenced by begin(), Check(), CKey(), end(), MakeNewKey(), Set(), and ~CKey().

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

src/key.h
src/key.cpp

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CKey() [1/2]

◆ CKey() [2/2]

◆ ~CKey()

Member Function Documentation

◆ begin()

◆ Check()

◆ CheckSignatureElement()

◆ Derive()

◆ end()

◆ GetPrivKey()

◆ GetPubKey()

◆ IsCompressed()

◆ IsValid()

◆ Load()

◆ MakeNewKey()

◆ Set()

◆ SetPrivKey()

◆ Sign()

◆ SignCompact()

◆ size()

◆ VerifyPubKey()

Friends And Related Function Documentation

◆ operator==

Member Data Documentation

◆ fCompressed

◆ fValid

◆ vch