The Omnikey XX21 reader unit configuration base class. More...

#include <omnikeyxx21readerunitconfiguration.hpp>

Inheritance diagram for logicalaccess::OmnikeyXX21ReaderUnitConfiguration:

Public Member Functions
	OmnikeyXX21ReaderUnitConfiguration ()
	Constructor.

virtual	~OmnikeyXX21ReaderUnitConfiguration ()
	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.

PCSCReaderUnitType	getPCSCType () const override
	Get the PC/SC reader unit configuration type.

bool	getUseSecureMode () const
	Get if the secure mode is used.

void	setUseSecureMode (bool use_sm)
	Set if the secure mode is used.

HIDEncryptionMode	getEncryptionMode () const
	Get the encryption mode.

void	setEncryptionMode (HIDEncryptionMode encryption_mode)
	Set the encryption mode.

std::shared_ptr< TripleDESKey >	getSecureReadKey () const
	Get the read key used in secure mode.

void	setSecureReadKey (std::shared_ptr< TripleDESKey > key)
	Set the read key used in secure mode.

std::shared_ptr< TripleDESKey >	getSecureWriteKey () const
	Get the write key used in secure mode.

void	setSecureWriteKey (std::shared_ptr< TripleDESKey > key)
	Set the read key used in secure mode.

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

virtual	~PCSCReaderUnitConfiguration ()
	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 int	getTransmissionProtocol () const
	Get the transmission protocol.

void	setTransmissionProtocol (unsigned int protocol)
	Set the transmission protocol.

PCSCShareMode	getShareMode () const
	Get the share mode.

void	setShareMode (PCSCShareMode share_mode)
	Set the share mode.

virtual PCSCReaderUnitType	getPCSCType () const
	Get the PC/SC reader unit configuration type.

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
bool	d_useSecureMode
	Set if use secure mode.

std::shared_ptr< TripleDESKey >	d_secureReadKey
	The custom read key secure mode HID iClass (optional).

std::shared_ptr< TripleDESKey >	d_secureWriteKey
	The custom write key secure mode HID iClass (optional).

HIDEncryptionMode	d_encryptionMode
	The encryption mode.

Protected Attributes inherited from logicalaccess::PCSCReaderUnitConfiguration
unsigned int	d_protocol
	The transmission protocol.

PCSCShareMode	d_share_mode
	The share mode used when connecting to a card.

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 Omnikey XX21 reader unit configuration base class.

Constructor & Destructor Documentation

◆ OmnikeyXX21ReaderUnitConfiguration()

logicalaccess::OmnikeyXX21ReaderUnitConfiguration::OmnikeyXX21ReaderUnitConfiguration ( )

Constructor.

◆ ~OmnikeyXX21ReaderUnitConfiguration()

logicalaccess::OmnikeyXX21ReaderUnitConfiguration::~OmnikeyXX21ReaderUnitConfiguration ( )

virtual

Destructor.

Member Function Documentation

◆ getDefaultXmlNodeName()

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

overridevirtual

Get the default Xml Node name for this object.

Returns: The Xml node name.

Reimplemented from logicalaccess::PCSCReaderUnitConfiguration.

◆ getEncryptionMode()

HIDEncryptionMode logicalaccess::OmnikeyXX21ReaderUnitConfiguration::getEncryptionMode ( ) const

Get the encryption mode.

Returns: The encryption mode.

◆ getPCSCType()

PCSCReaderUnitType logicalaccess::OmnikeyXX21ReaderUnitConfiguration::getPCSCType ( ) const

inlineoverridevirtual

Get the PC/SC reader unit configuration type.

Returns: The PC/SC reader unit configuration type.

Reimplemented from logicalaccess::PCSCReaderUnitConfiguration.

◆ getSecureReadKey()

std::shared_ptr< TripleDESKey > logicalaccess::OmnikeyXX21ReaderUnitConfiguration::getSecureReadKey ( ) const

Get the read key used in secure mode.

Returns: The read key.

◆ getSecureWriteKey()

std::shared_ptr< TripleDESKey > logicalaccess::OmnikeyXX21ReaderUnitConfiguration::getSecureWriteKey ( ) const

Get the write key used in secure mode.

Returns: The write key.

◆ getUseSecureMode()

bool logicalaccess::OmnikeyXX21ReaderUnitConfiguration::getUseSecureMode ( ) const

Get if the secure mode is used.

Returns: The secure mode value, true if used, false otherwise.

◆ resetConfiguration()

void logicalaccess::OmnikeyXX21ReaderUnitConfiguration::resetConfiguration ( )

overridevirtual

Reset the configuration to default values.

Reimplemented from logicalaccess::PCSCReaderUnitConfiguration.

◆ serialize()

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

overridevirtual

Serialize the current object to XML.

Parameters

parentNode The parent node.

Reimplemented from logicalaccess::PCSCReaderUnitConfiguration.

◆ setEncryptionMode()

void logicalaccess::OmnikeyXX21ReaderUnitConfiguration::setEncryptionMode ( HIDEncryptionMode encryption_mode )

Set the encryption mode.

Parameters

encryption_mode The encryption mode.

◆ setSecureReadKey()

void logicalaccess::OmnikeyXX21ReaderUnitConfiguration::setSecureReadKey ( std::shared_ptr< TripleDESKey > key )

Set the read key used in secure mode.

Parameters

key	The read key.

◆ setSecureWriteKey()

void logicalaccess::OmnikeyXX21ReaderUnitConfiguration::setSecureWriteKey ( std::shared_ptr< TripleDESKey > key )

Set the read key used in secure mode.

Parameters

key	The read key.

◆ setUseSecureMode()

void logicalaccess::OmnikeyXX21ReaderUnitConfiguration::setUseSecureMode ( bool use_sm )

Set if the secure mode is used.

Parameters

use_sm The secure mode value, true if used, false otherwise.

◆ unSerialize()

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

overridevirtual

UnSerialize a XML node to the current object.

Parameters

node	The XML node.

Reimplemented from logicalaccess::PCSCReaderUnitConfiguration.

Member Data Documentation

◆ d_encryptionMode

HIDEncryptionMode logicalaccess::OmnikeyXX21ReaderUnitConfiguration::d_encryptionMode

protected

The encryption mode.

◆ d_secureReadKey

std::shared_ptr<TripleDESKey> logicalaccess::OmnikeyXX21ReaderUnitConfiguration::d_secureReadKey

protected

The custom read key secure mode HID iClass (optional).

◆ d_secureWriteKey

std::shared_ptr<TripleDESKey> logicalaccess::OmnikeyXX21ReaderUnitConfiguration::d_secureWriteKey

protected

The custom write key secure mode HID iClass (optional).

◆ d_useSecureMode

bool logicalaccess::OmnikeyXX21ReaderUnitConfiguration::d_useSecureMode

protected

Set if use secure mode.

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

C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/pcsc/readers/omnikeyxx21readerunitconfiguration.hpp
C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/pcsc/readers/omnikeyxx21readerunitconfiguration.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OmnikeyXX21ReaderUnitConfiguration()

◆ ~OmnikeyXX21ReaderUnitConfiguration()

Member Function Documentation

◆ getDefaultXmlNodeName()

◆ getEncryptionMode()

◆ getPCSCType()

◆ getSecureReadKey()

◆ getSecureWriteKey()

◆ getUseSecureMode()

◆ resetConfiguration()

◆ serialize()

◆ setEncryptionMode()

◆ setSecureReadKey()

◆ setSecureWriteKey()

◆ setUseSecureMode()

◆ unSerialize()

Member Data Documentation

◆ d_encryptionMode

◆ d_secureReadKey

◆ d_secureWriteKey

◆ d_useSecureMode