The STidSTR reader unit configuration base class. More...

#include <stidstrreaderunitconfiguration.hpp>

Inheritance diagram for logicalaccess::STidSTRReaderUnitConfiguration:

Public Member Functions
	STidSTRReaderUnitConfiguration ()
	Constructor.

virtual	~STidSTRReaderUnitConfiguration ()
	Destructor.

void	resetConfiguration () override
	Reset the configuration to default values.

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.

unsigned char	getRS485Address () const
	Get the reader RS485 address.

void	setRS485Address (unsigned char address)
	Set the reader RS485 address.

STidCommunicationType	getCommunicationType () const
	Get communication type.

void	setCommunicationType (STidCommunicationType ctype)
	Set the communication type.

STidCommunicationMode	getCommunicationMode () const
	Get communication mode.

void	setCommunicationMode (STidCommunicationMode cmode)
	Set the communication mode.

std::shared_ptr< HMAC1Key >	getHMACKey () const
	Get the key used for HMAC signature.

void	setHMACKey (std::shared_ptr< HMAC1Key > key)
	Set the key used for HMAC signature.

std::shared_ptr< AES128Key >	getAESKey () const
	Get the key used for AES enciphering.

void	setAESKey (std::shared_ptr< AES128Key > key)
	Set the key used for AES enciphering.

bool	getPN532Direct () const

void	setPN532Direct (bool direct)

Public Member Functions inherited from logicalaccess::ISO7816ReaderUnitConfiguration
	ISO7816ReaderUnitConfiguration ()
	Constructor.

	ISO7816ReaderUnitConfiguration (std::string rpt)
	Constructor.

virtual	~ISO7816ReaderUnitConfiguration ()
	Destructor.

void	resetConfiguration () override
	Reset the configuration to the default one.

void	setSAMType (std::string t)
	Set the SAM type.

std::string	getSAMType () const
	get the SAM type.

void	setSAMReaderName (std::string t)
	Set the SAM reader name.

std::string	getSAMReaderName () const
	get the SAM reader name.

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.

void	setSAMUnlockKey (std::shared_ptr< DESFireKey > key, unsigned char keyno)
	Set the SAM Key and Keyno for check if the SAM is the SAM we are waiting and for AV2 enable communication.

std::shared_ptr< DESFireKey >	getSAMUnLockKey () const
	Get SAM Security Check Key.

unsigned char	getSAMUnLockkeyNo () const
	Get SAM Security Check KeyNo.

bool	getCheckSAMReaderIsAvailable () const

void	setCheckSAMReaderIsAvailable (bool check)

bool	getAutoConnectToSAMReader () const

void	setAutoConnectToSAMReader (bool auto_connect)

bool	getSkipCSN () const

void	setSkipCSN (bool skipCSN)

Public Member Functions inherited from logicalaccess::ReaderUnitConfiguration
	ReaderUnitConfiguration (std::string rpt)
	Constructor.

virtual	~ReaderUnitConfiguration ()
	Destructor.

std::string	getRPType () const
	Get the reader provider type.

virtual void	resetConfiguration ()=0
	Reset the configuration to the default one.

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.

Protected Attributes
unsigned char	d_rs485Address
	The reader RS485 address (if communication type RS485 used).

STidCommunicationType	d_communicationType
	The reader communication type.

STidCommunicationMode	d_communicationMode
	The reader communication mode (security objective).

std::shared_ptr< HMAC1Key >	d_key_hmac
	The key used for HMAC signature.

std::shared_ptr< AES128Key >	d_key_aes
	The key used for AES enciphering.

bool	d_pn532_direct
	Direct communication with the internal PN532 component.

Protected Attributes inherited from logicalaccess::ISO7816ReaderUnitConfiguration
std::string	d_sam_type
	The SAM type.

std::string	d_sam_reader_name
	The SAM reader name.

std::shared_ptr< DESFireKey >	d_sam_key_unlock
	The SAM Key to see if it is the SAM we are waiting.

unsigned char	d_keyno_unlock
	The SAM Key to see if it is the SAM we are waiting.

bool	d_check_sam_reader_available
	Check associated SAM reader is available before use.

bool	d_auto_connect_sam_reader
	Auto-connect to SAM reader at reader connection.

bool	d_skipCSN
	Skip to get CSN.

Protected Attributes inherited from logicalaccess::ReaderUnitConfiguration
std::string	d_readerProviderType
	The associated reader provider type for the reader unit configuration.

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)

Detailed Description

The STidSTR reader unit configuration base class.

Constructor & Destructor Documentation

◆ STidSTRReaderUnitConfiguration()

logicalaccess::STidSTRReaderUnitConfiguration::STidSTRReaderUnitConfiguration ( )

Constructor.

◆ ~STidSTRReaderUnitConfiguration()

logicalaccess::STidSTRReaderUnitConfiguration::~STidSTRReaderUnitConfiguration ( )

virtual

Destructor.

Member Function Documentation

◆ getAESKey()

std::shared_ptr< AES128Key > logicalaccess::STidSTRReaderUnitConfiguration::getAESKey ( ) const

Get the key used for AES enciphering.

Returns: The key.

◆ getCommunicationMode()

STidCommunicationMode logicalaccess::STidSTRReaderUnitConfiguration::getCommunicationMode ( ) const

Get communication mode.

Returns: The communication mode.

◆ getCommunicationType()

STidCommunicationType logicalaccess::STidSTRReaderUnitConfiguration::getCommunicationType ( ) const

Get communication type.

Returns: The communication type.

◆ getDefaultXmlNodeName()

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

overridevirtual

Get the default Xml Node name for this object.

Returns: The Xml node name.

Reimplemented from logicalaccess::ISO7816ReaderUnitConfiguration.

◆ getHMACKey()

std::shared_ptr< HMAC1Key > logicalaccess::STidSTRReaderUnitConfiguration::getHMACKey ( ) const

Get the key used for HMAC signature.

Returns: The key.

◆ getPN532Direct()

bool logicalaccess::STidSTRReaderUnitConfiguration::getPN532Direct ( ) const

◆ getRS485Address()

unsigned char logicalaccess::STidSTRReaderUnitConfiguration::getRS485Address ( ) const

Get the reader RS485 address.

Returns: The RS485 address.

◆ resetConfiguration()

void logicalaccess::STidSTRReaderUnitConfiguration::resetConfiguration ( )

overridevirtual

Reset the configuration to default values.

Reimplemented from logicalaccess::ISO7816ReaderUnitConfiguration.

◆ serialize()

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

overridevirtual

Serialize the current object to XML.

Parameters

parentNode The parent node.

Reimplemented from logicalaccess::ISO7816ReaderUnitConfiguration.

◆ setAESKey()

void logicalaccess::STidSTRReaderUnitConfiguration::setAESKey ( std::shared_ptr< AES128Key > key )

Set the key used for AES enciphering.

Parameters

key The key.

◆ setCommunicationMode()

void logicalaccess::STidSTRReaderUnitConfiguration::setCommunicationMode ( STidCommunicationMode cmode )

Set the communication mode.

Parameters

cmode The communication mode.

◆ setCommunicationType()

void logicalaccess::STidSTRReaderUnitConfiguration::setCommunicationType ( STidCommunicationType ctype )

Set the communication type.

Parameters

ctype The communication type.

◆ setHMACKey()

void logicalaccess::STidSTRReaderUnitConfiguration::setHMACKey ( std::shared_ptr< HMAC1Key > key )

Set the key used for HMAC signature.

Parameters

key The key.

◆ setPN532Direct()

void logicalaccess::STidSTRReaderUnitConfiguration::setPN532Direct ( bool direct )

◆ setRS485Address()

void logicalaccess::STidSTRReaderUnitConfiguration::setRS485Address ( unsigned char address )

Set the reader RS485 address.

Parameters

address The RS485 address.

◆ unSerialize()

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

overridevirtual

UnSerialize a XML node to the current object.

Parameters

node	The XML node.

Reimplemented from logicalaccess::ISO7816ReaderUnitConfiguration.

Member Data Documentation

◆ d_communicationMode

STidCommunicationMode logicalaccess::STidSTRReaderUnitConfiguration::d_communicationMode

protected

The reader communication mode (security objective).

◆ d_communicationType

STidCommunicationType logicalaccess::STidSTRReaderUnitConfiguration::d_communicationType

protected

The reader communication type.

◆ d_key_aes

std::shared_ptr<AES128Key> logicalaccess::STidSTRReaderUnitConfiguration::d_key_aes

protected

The key used for AES enciphering.

◆ d_key_hmac

std::shared_ptr<HMAC1Key> logicalaccess::STidSTRReaderUnitConfiguration::d_key_hmac

protected

The key used for HMAC signature.

◆ d_pn532_direct

bool logicalaccess::STidSTRReaderUnitConfiguration::d_pn532_direct

protected

Direct communication with the internal PN532 component.

◆ d_rs485Address

unsigned char logicalaccess::STidSTRReaderUnitConfiguration::d_rs485Address

protected

The reader RS485 address (if communication type RS485 used).

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

C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/stidstr/stidstrreaderunitconfiguration.hpp
C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/stidstr/stidstrreaderunitconfiguration.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ STidSTRReaderUnitConfiguration()

◆ ~STidSTRReaderUnitConfiguration()

Member Function Documentation

◆ getAESKey()

◆ getCommunicationMode()

◆ getCommunicationType()

◆ getDefaultXmlNodeName()

◆ getHMACKey()

◆ getPN532Direct()

◆ getRS485Address()

◆ resetConfiguration()

◆ serialize()

◆ setAESKey()

◆ setCommunicationMode()

◆ setCommunicationType()

◆ setHMACKey()

◆ setPN532Direct()

◆ setRS485Address()

◆ unSerialize()

Member Data Documentation

◆ d_communicationMode

◆ d_communicationType

◆ d_key_aes

◆ d_key_hmac

◆ d_pn532_direct

◆ d_rs485Address