The PC/SC reader unit configuration base class. More...

#include <pcscreaderunitconfiguration.hpp>

Inheritance diagram for logicalaccess::PCSCReaderUnitConfiguration:

Public Member Functions
	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
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 PC/SC reader unit configuration base class.

Constructor & Destructor Documentation

◆ PCSCReaderUnitConfiguration()

logicalaccess::PCSCReaderUnitConfiguration::PCSCReaderUnitConfiguration ( )

Constructor.

◆ ~PCSCReaderUnitConfiguration()

logicalaccess::PCSCReaderUnitConfiguration::~PCSCReaderUnitConfiguration ( )

virtual

Destructor.

Member Function Documentation

◆ getDefaultXmlNodeName()

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

overridevirtual

Get the default Xml Node name for this object.

Returns: The Xml node name.

Reimplemented from logicalaccess::ISO7816ReaderUnitConfiguration.

Reimplemented in logicalaccess::OmnikeyXX21ReaderUnitConfiguration.

◆ getPCSCType()

PCSCReaderUnitType logicalaccess::PCSCReaderUnitConfiguration::getPCSCType ( ) const

virtual

Get the PC/SC reader unit configuration type.

Returns: The PC/SC reader unit configuration type.

Reimplemented in logicalaccess::ACSACR1222LReaderUnitConfiguration, logicalaccess::Omnikey5427ReaderUnitConfiguration, and logicalaccess::OmnikeyXX21ReaderUnitConfiguration.

◆ getShareMode()

PCSCShareMode logicalaccess::PCSCReaderUnitConfiguration::getShareMode ( ) const

Get the share mode.

Returns: The share mode.

◆ getTransmissionProtocol()

unsigned int logicalaccess::PCSCReaderUnitConfiguration::getTransmissionProtocol ( ) const

Get the transmission protocol.

Returns: The transmission protocol.

◆ resetConfiguration()

void logicalaccess::PCSCReaderUnitConfiguration::resetConfiguration ( )

overridevirtual

Reset the configuration to default values.

Reimplemented from logicalaccess::ISO7816ReaderUnitConfiguration.

Reimplemented in logicalaccess::ACSACR1222LReaderUnitConfiguration, logicalaccess::Omnikey5427ReaderUnitConfiguration, and logicalaccess::OmnikeyXX21ReaderUnitConfiguration.

◆ serialize()

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

overridevirtual

Serialize the current object to XML.

Parameters

parentNode The parent node.

Reimplemented from logicalaccess::ISO7816ReaderUnitConfiguration.

Reimplemented in logicalaccess::ACSACR1222LReaderUnitConfiguration, logicalaccess::Omnikey5427ReaderUnitConfiguration, and logicalaccess::OmnikeyXX21ReaderUnitConfiguration.

◆ setShareMode()

void logicalaccess::PCSCReaderUnitConfiguration::setShareMode ( PCSCShareMode share_mode )

Set the share mode.

Parameters

share_mode The share mode.

◆ setTransmissionProtocol()

void logicalaccess::PCSCReaderUnitConfiguration::setTransmissionProtocol ( unsigned int protocol )

Set the transmission protocol.

Parameters

protocol The transmission protocol.

◆ unSerialize()

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

overridevirtual

UnSerialize a XML node to the current object.

Parameters

node	The XML node.

Reimplemented from logicalaccess::ISO7816ReaderUnitConfiguration.

Reimplemented in logicalaccess::ACSACR1222LReaderUnitConfiguration, logicalaccess::Omnikey5427ReaderUnitConfiguration, and logicalaccess::OmnikeyXX21ReaderUnitConfiguration.

Member Data Documentation

◆ d_protocol

unsigned int logicalaccess::PCSCReaderUnitConfiguration::d_protocol

protected

The transmission protocol.

◆ d_share_mode

PCSCShareMode logicalaccess::PCSCReaderUnitConfiguration::d_share_mode

protected

The share mode used when connecting to a card.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PCSCReaderUnitConfiguration()

◆ ~PCSCReaderUnitConfiguration()

Member Function Documentation

◆ getDefaultXmlNodeName()

◆ getPCSCType()

◆ getShareMode()

◆ getTransmissionProtocol()

◆ resetConfiguration()

◆ serialize()

◆ setShareMode()

◆ setTransmissionProtocol()

◆ unSerialize()

Member Data Documentation

◆ d_protocol

◆ d_share_mode