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

#include <omnikey5427readerunitconfiguration.hpp>

Inheritance diagram for logicalaccess::Omnikey5427ReaderUnitConfiguration:
logicalaccess::PCSCReaderUnitConfiguration logicalaccess::ISO7816ReaderUnitConfiguration logicalaccess::ReaderUnitConfiguration logicalaccess::XmlSerializable

Public Member Functions

 Omnikey5427ReaderUnitConfiguration ()
 
bool getUseSecureMode () const
 
void setUseSecureMode (bool use_sm)
 
std::shared_ptr< AES128KeygetSecureMasterKey () const
 
void setSecureMasterKey (std::shared_ptr< AES128Key >)
 
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.
 
PCSCReaderUnitType getPCSCType () const override
 Get the PC/SC reader unit configuration type.
 
- 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< 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.
 

Private Attributes

bool useSecureMode_
 
std::shared_ptr< AES128KeymasterKey_
 

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::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< 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.
 

Detailed Description

The Omnikey 5427 reader unit configuration class.

Constructor & Destructor Documentation

◆ Omnikey5427ReaderUnitConfiguration()

Omnikey5427ReaderUnitConfiguration::Omnikey5427ReaderUnitConfiguration ( )

Member Function Documentation

◆ getPCSCType()

PCSCReaderUnitType Omnikey5427ReaderUnitConfiguration::getPCSCType ( ) const
overridevirtual

Get the PC/SC reader unit configuration type.

Returns
The PC/SC reader unit configuration type.

Reimplemented from logicalaccess::PCSCReaderUnitConfiguration.

◆ getSecureMasterKey()

std::shared_ptr< AES128Key > Omnikey5427ReaderUnitConfiguration::getSecureMasterKey ( ) const

Return the 128 bits AES key used to establish a secure session with the reader.

◆ getUseSecureMode()

bool Omnikey5427ReaderUnitConfiguration::getUseSecureMode ( ) const

Are we using secure mode?

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

◆ resetConfiguration()

void Omnikey5427ReaderUnitConfiguration::resetConfiguration ( )
overridevirtual

Reset the configuration to default values.

Reimplemented from logicalaccess::PCSCReaderUnitConfiguration.

◆ serialize()

void Omnikey5427ReaderUnitConfiguration::serialize ( boost::property_tree::ptree &  parentNode)
overridevirtual

Serialize the current object to XML.

Parameters
parentNodeThe parent node.

Reimplemented from logicalaccess::PCSCReaderUnitConfiguration.

◆ setSecureMasterKey()

void Omnikey5427ReaderUnitConfiguration::setSecureMasterKey ( std::shared_ptr< AES128Key ptr)

Set a 128 bits AES key that will be used as the master key when enabling a secure session with the reader.

◆ setUseSecureMode()

void Omnikey5427ReaderUnitConfiguration::setUseSecureMode ( bool  use_sm)

Enabled or disable secure mode use.

Parameters
use_smThe secure mode value, true if used, false otherwise.

◆ unSerialize()

void Omnikey5427ReaderUnitConfiguration::unSerialize ( boost::property_tree::ptree &  node)
overridevirtual

UnSerialize a XML node to the current object.

Parameters
nodeThe XML node.

Reimplemented from logicalaccess::PCSCReaderUnitConfiguration.

Member Data Documentation

◆ masterKey_

std::shared_ptr<AES128Key> logicalaccess::Omnikey5427ReaderUnitConfiguration::masterKey_
private

◆ useSecureMode_

bool logicalaccess::Omnikey5427ReaderUnitConfiguration::useSecureMode_
private

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