Class CCryptoKeyBase

src/common/keypair.h:43–105

----------------------------------------------------------------------------- Purpose: Base class to encapsulate an crypto key (RSA, EC, ECDSA). This class cannot be instantiated directly, use one of the subclasses to indicate the intent of the key. -----------------------------------------------------------------------------

//			to indicate the intent of the key.
//-----------------------------------------------------------------------------
class CCryptoKeyBase 
{
public:
	virtual ~CCryptoKeyBase();

	ECryptoKeyType GetKeyType() const { return m_eKeyType; }

	// Return true if we're valid
	virtual bool IsValid() const = 0;

	// Free up memory and wipe any sensitive data
	virtual void Wipe() = 0;

	// Get raw data.  Returns number of bytes populated into the buffer.
	// If you pass NULL, the number of bytes required is returned.
	virtual uint32 GetRawData( void *pData ) const = 0;

	// Set raw data.  Returns true on success.  Regardless of the outcome,
	// your buffer will be wiped.
	bool SetRawDataAndWipeInput( void *pData, size_t cbData );

	// Don't wipe the input.  Use this when you know your key is not valuable,
	// or are going to wipe it yourself
	bool SetRawDataWithoutWipingInput( const void *pData, size_t cbData );

	// Initialize a key object from a hex encoded string of the raw key bytes
	bool SetFromHexEncodedString( const char *pchEncodedKey );
	bool SetFromBase64EncodedString( const char *pchEncodedKey );

	// Get raw data as a std::string
	bool GetRawDataAsStdString( std::string *pResult ) const;

	// Set raw data from a std::string.  (Useful for dealing with protobuf)
	// NOTE: DOES NOT WIPE THE INPUT
	bool SetRawDataFromStdString( const std::string &s ) { return SetRawDataWithoutWipingInput( s.c_str(), s.length() ); }

	// Load from some sort of formatted buffer.  (Not the raw binary key data.)
	virtual bool LoadFromAndWipeBuffer( void *pBuffer, size_t cBytes );

	// Compare keys for equality, by comparing their raw data
	bool operator==( const CCryptoKeyBase &rhs ) const;
	bool operator!=( const CCryptoKeyBase &rhs ) const { return !operator==( rhs ); }

	// Return true if our raw data matches the specified buffer.
	bool BMatchesRawData( const void *pData, size_t cbData ) const;

	// Make a copy of the key, by using the raw data functions
	void CopyFrom( const CCryptoKeyBase &x );

#ifdef DBGFLAG_VALIDATE
	virtual void Validate( CValidator &validator, const char *pchName ) const = 0;		// Validate our internal structures
#endif // DBGFLAG_VALIDATE

protected:
	virtual bool SetRawData( const void *pData, size_t cbData ) = 0;
	CCryptoKeyBase( ECryptoKeyType keyType ) : m_eKeyType( keyType ) {}

	const ECryptoKeyType m_eKeyType;