logicalaccess::HMAC1Key Class Reference

A hmac-1 key class. More...

#include <hmac1key.hpp>

Inheritance diagram for logicalaccess::HMAC1Key:

Public Member Functions
	HMAC1Key ()
	Build an empty 10-bytes hmac-1 key.
virtual	~HMAC1Key ()=default
	HMAC1Key (const std::string &str)
	Build a hmac-1 key given a string representation of it.
	HMAC1Key (const void *buf, size_t buflen)
	Build a hmac-1 key given a buffer.
size_t	getLength () const override
	Get the key length.
const unsigned char *	getData () const override
	Get the key data.
unsigned char *	getData () override
	Get the key data.
void	serialize (boost::property_tree::ptree &parentNode) override
	Serialize the current object to XML.
void	unSerialize (boost::property_tree::ptree &node) override
	UnSerialize a XML node to the current object.
std::string	getDefaultXmlNodeName () const override
	Get the default Xml Node name for this object.
Public Member Functions inherited from logicalaccess::Key
	Key ()
	Constructor.
virtual	~Key ()=default
virtual void	clear ()
	Set the key to its default (only 0's).
virtual size_t	getLength () const =0
	Get the key length.
virtual const unsigned char *	getData () const =0
	Get the key data.
virtual unsigned char *	getData ()=0
	Get the key data.
virtual void	setData (const unsigned char *data)
	Set the key data.
virtual void	setData (const ByteVector &data, size_t offset=0)
	Set the key data.
std::string	getString (bool withSpace=true) const
	Get the string representation of the key.
bool	isEmpty () const
	Get if key data are empty.
virtual bool	fromString (const std::string &str)
	Set the key from a string representation of it.
void	setKeyStorage (std::shared_ptr< KeyStorage > key_storage)
	Set the key storage used for this key.
std::shared_ptr< KeyStorage >	getKeyStorage () const
	Get the key storage used for this key.
void	serialize (boost::property_tree::ptree &node) override
	Serialize the current object to XML.
void	unSerialize (boost::property_tree::ptree &node) override
	UnSerialize a XML node to the current object.
virtual bool	operator== (const Key &key) const
	Equality operator.
virtual bool	operator!= (const Key &key) const
	Inequality operator.
void	setCipherKey (const std::string &key)
	Set the cipher key.
void	setStoreCipheredData (bool cipher)
	Set if the data is stored ciphered.
bool	getStoreCipheredData () const
	Get if the data is stored ciphered.
void	setKeyDiversification (std::shared_ptr< KeyDiversification > div)
std::shared_ptr< KeyDiversification >	getKeyDiversification () const
ByteVector	getBytes () const
Public Member Functions inherited from logicalaccess::XmlSerializable
virtual	~XmlSerializable ()=default
virtual std::string	serialize ()
	Serialize object to Xml Node string.
virtual std::string	serializeWithHeaders ()
	Serialize object to Xml Node string, with xml headers.
virtual void	serialize (boost::property_tree::ptree &parentNode)=0
	Serialize object to Xml Node.
virtual void	serializeToFile (const std::string &filename)
	Serialize object to a Xml file.
virtual void	unSerialize (boost::property_tree::ptree &node)=0
	UnSerialize object from a Xml Node.
virtual void	unSerialize (const std::string &xmlstring, const std::string &rootNode)
	UnSerialize object from a Xml Node string.
virtual void	unSerialize (std::istream &is, const std::string &rootNode)
	UnSerialize object from a Xml node.
virtual void	unSerialize (boost::property_tree::ptree &node, const std::string &rootNode)
	UnSerialize object from a Xml node.
virtual void	unSerializeFromFile (const std::string &filename)
	UnSerialize object from a Xml file.
virtual std::string	getDefaultXmlNodeName () const =0
	Get the default Xml Node name for this object.

Private Attributes
unsigned char	d_key [HMAC1_KEY_SIZE]
	The key bytes;.

Additional Inherited Members
Static Public Member Functions inherited from logicalaccess::XmlSerializable
static std::string	removeXmlDeclaration (const std::string &xmlstring)
	Remove Xml declaration from a xml string.
static ByteVector	formatHexString (std::string hexstr)
	Format hex string to hex string with space.
Static Protected Member Functions inherited from logicalaccess::XmlSerializable
static unsigned long long	atoull (const std::string &str)
Protected Attributes inherited from logicalaccess::Key
bool	d_isEmpty
	Checked if key data are empty.
std::shared_ptr< KeyStorage >	d_key_storage
	The key storage used for this key.
std::shared_ptr< KeyDiversification >	d_key_diversification
	The key storage used for this key.
std::string	d_cipherKey
	The cipher key.
bool	d_storeCipheredData
	The data is stored ciphered or not.

Detailed Description

A hmac-1 key class.

Constructor & Destructor Documentation

HMAC1Key() [1/3]

logicalaccess::HMAC1Key::HMAC1Key

(

)

Build an empty 10-bytes hmac-1 key.

~HMAC1Key()

virtual logicalaccess::HMAC1Key::~HMAC1Key ( )

virtualdefault

HMAC1Key() [2/3]

logicalaccess::HMAC1Key::HMAC1Key ( const std::string &  str )

explicit

Build a hmac-1 key given a string representation of it.

Parameters

str	The string representation.

HMAC1Key() [3/3]

logicalaccess::HMAC1Key::HMAC1Key	(	const void *	buf,
		size_t	buflen
	)

Build a hmac-1 key given a buffer.

Parameters

buf	The buffer.
buflen	The buffer length.

Member Function Documentation

getData() [1/2]

const unsigned char * logicalaccess::HMAC1Key::getData ( ) const

inlineoverridevirtual

Get the key data.

Returns

The key data.

Implements logicalaccess::Key.

getData() [2/2]

unsigned char * logicalaccess::HMAC1Key::getData ( )

inlineoverridevirtual

Get the key data.

Returns

The key data.

Implements logicalaccess::Key.

getDefaultXmlNodeName()

std::string logicalaccess::HMAC1Key::getDefaultXmlNodeName ( ) const

overridevirtual

Get the default Xml Node name for this object.

Returns

The Xml node name.

Implements logicalaccess::XmlSerializable.

getLength()

size_t logicalaccess::HMAC1Key::getLength ( ) const

inlineoverridevirtual

Get the key length.

Returns

The key length.

Implements logicalaccess::Key.

serialize()

void logicalaccess::HMAC1Key::serialize ( boost::property_tree::ptree &  parentNode )

overridevirtual

Serialize the current object to XML.

Parameters

parentNode

The parent node.

Returns

The XML string.

Implements logicalaccess::XmlSerializable.

unSerialize()

void logicalaccess::HMAC1Key::unSerialize ( boost::property_tree::ptree &  node )

overridevirtual

UnSerialize a XML node to the current object.

Parameters

node	The XML node.

Implements logicalaccess::XmlSerializable.

Member Data Documentation

d_key

unsigned char logicalaccess::HMAC1Key::d_key[HMAC1_KEY_SIZE]

private

The key bytes;.

---

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

• C:/dev/lla/liblogicalaccess/include/logicalaccess/cards/hmac1key.hpp
• C:/dev/lla/liblogicalaccess/src/cards/hmac1key.cpp