LibLogicalAccess  2.5.0
An Open Source RFID Library
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
logicalaccess::ISO7816ReaderUnitConfiguration Class Reference

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

#include <iso7816readerunitconfiguration.hpp>

Inheritance diagram for logicalaccess::ISO7816ReaderUnitConfiguration:
logicalaccess::ReaderUnitConfiguration logicalaccess::XmlSerializable logicalaccess::PCSCReaderUnitConfiguration logicalaccess::STidSTRReaderUnitConfiguration logicalaccess::ACSACR1222LReaderUnitConfiguration logicalaccess::Omnikey5427ReaderUnitConfiguration logicalaccess::OmnikeyXX21ReaderUnitConfiguration

Public Member Functions

 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< DESFireKeygetSAMUnLockKey () 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

std::string d_sam_type
 The SAM type.
 
std::string d_sam_reader_name
 The SAM reader name.
 
std::shared_ptr< DESFireKeyd_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

◆ ISO7816ReaderUnitConfiguration() [1/2]

logicalaccess::ISO7816ReaderUnitConfiguration::ISO7816ReaderUnitConfiguration ( )

Constructor.

◆ ISO7816ReaderUnitConfiguration() [2/2]

logicalaccess::ISO7816ReaderUnitConfiguration::ISO7816ReaderUnitConfiguration ( std::string  rpt)
explicit

Constructor.

Parameters
rptReader provider type.

◆ ~ISO7816ReaderUnitConfiguration()

logicalaccess::ISO7816ReaderUnitConfiguration::~ISO7816ReaderUnitConfiguration ( )
virtual

Destructor.

Member Function Documentation

◆ getAutoConnectToSAMReader()

bool logicalaccess::ISO7816ReaderUnitConfiguration::getAutoConnectToSAMReader ( ) const
inline

◆ getCheckSAMReaderIsAvailable()

bool logicalaccess::ISO7816ReaderUnitConfiguration::getCheckSAMReaderIsAvailable ( ) const
inline

◆ getDefaultXmlNodeName()

std::string logicalaccess::ISO7816ReaderUnitConfiguration::getDefaultXmlNodeName ( ) const
overridevirtual

Get the default Xml Node name for this object.

Returns
The Xml node name.

Implements logicalaccess::XmlSerializable.

Reimplemented in logicalaccess::PCSCReaderUnitConfiguration, logicalaccess::OmnikeyXX21ReaderUnitConfiguration, and logicalaccess::STidSTRReaderUnitConfiguration.

◆ getSAMReaderName()

std::string logicalaccess::ISO7816ReaderUnitConfiguration::getSAMReaderName ( ) const

get the SAM reader name.

◆ getSAMType()

std::string logicalaccess::ISO7816ReaderUnitConfiguration::getSAMType ( ) const

get the SAM type.

◆ getSAMUnLockKey()

std::shared_ptr< DESFireKey > logicalaccess::ISO7816ReaderUnitConfiguration::getSAMUnLockKey ( ) const
inline

Get SAM Security Check Key.

◆ getSAMUnLockkeyNo()

unsigned char logicalaccess::ISO7816ReaderUnitConfiguration::getSAMUnLockkeyNo ( ) const
inline

Get SAM Security Check KeyNo.

◆ getSkipCSN()

bool logicalaccess::ISO7816ReaderUnitConfiguration::getSkipCSN ( ) const
inline

◆ resetConfiguration()

void logicalaccess::ISO7816ReaderUnitConfiguration::resetConfiguration ( )
overridevirtual

◆ serialize()

void logicalaccess::ISO7816ReaderUnitConfiguration::serialize ( boost::property_tree::ptree &  parentNode)
overridevirtual

◆ setAutoConnectToSAMReader()

void logicalaccess::ISO7816ReaderUnitConfiguration::setAutoConnectToSAMReader ( bool  auto_connect)
inline

◆ setCheckSAMReaderIsAvailable()

void logicalaccess::ISO7816ReaderUnitConfiguration::setCheckSAMReaderIsAvailable ( bool  check)
inline

◆ setSAMReaderName()

void logicalaccess::ISO7816ReaderUnitConfiguration::setSAMReaderName ( std::string  t)

Set the SAM reader name.

Parameters
tThe SAM reader name.

◆ setSAMType()

void logicalaccess::ISO7816ReaderUnitConfiguration::setSAMType ( std::string  t)

Set the SAM type.

Parameters
tThe SAM type.

◆ setSAMUnlockKey()

void logicalaccess::ISO7816ReaderUnitConfiguration::setSAMUnlockKey ( std::shared_ptr< DESFireKey key,
unsigned char  keyno 
)
inline

Set the SAM Key and Keyno for check if the SAM is the SAM we are waiting and for AV2 enable communication.

◆ setSkipCSN()

void logicalaccess::ISO7816ReaderUnitConfiguration::setSkipCSN ( bool  skipCSN)
inline

◆ unSerialize()

void logicalaccess::ISO7816ReaderUnitConfiguration::unSerialize ( boost::property_tree::ptree &  node)
overridevirtual

Member Data Documentation

◆ d_auto_connect_sam_reader

bool logicalaccess::ISO7816ReaderUnitConfiguration::d_auto_connect_sam_reader
protected

Auto-connect to SAM reader at reader connection.

◆ d_check_sam_reader_available

bool logicalaccess::ISO7816ReaderUnitConfiguration::d_check_sam_reader_available
protected

Check associated SAM reader is available before use.

Remarks
This should be disable when using network-based reader today.

◆ d_keyno_unlock

unsigned char logicalaccess::ISO7816ReaderUnitConfiguration::d_keyno_unlock
protected

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

◆ d_sam_key_unlock

std::shared_ptr<DESFireKey> logicalaccess::ISO7816ReaderUnitConfiguration::d_sam_key_unlock
protected

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

◆ d_sam_reader_name

std::string logicalaccess::ISO7816ReaderUnitConfiguration::d_sam_reader_name
protected

The SAM reader name.

◆ d_sam_type

std::string logicalaccess::ISO7816ReaderUnitConfiguration::d_sam_type
protected

The SAM type.

◆ d_skipCSN

bool logicalaccess::ISO7816ReaderUnitConfiguration::d_skipCSN
protected

Skip to get CSN.


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