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

The Mifare card provider class for PCSC reader. More...

#include <mifarepcsccommands.hpp>

Inheritance diagram for logicalaccess::MifarePCSCCommands:
logicalaccess::MifareCommands logicalaccess::Commands logicalaccess::ICommands logicalaccess::MifareACR1222LCommands logicalaccess::MifareCL1356Commands logicalaccess::MifareCherryCommands logicalaccess::MifareOmnikeyXX21Commands logicalaccess::MifareSCMCommands logicalaccess::MifareSpringCardCommands

Public Member Functions

 MifarePCSCCommands ()
 Constructor.
 
 MifarePCSCCommands (std::string)
 
virtual ~MifarePCSCCommands ()
 Destructor.
 
std::shared_ptr< PCSCReaderCardAdaptergetPCSCReaderCardAdapter () const
 Get the PC/SC reader/card adapter.
 
ByteVector readBinary (unsigned char blockno, size_t len) override
 Read bytes from the card.
 
void updateBinary (unsigned char blockno, const ByteVector &buf) override
 Write bytes to the card.
 
void increment (uint8_t blockno, uint32_t value) override
 
void decrement (uint8_t blockno, uint32_t value) override
 
- Public Member Functions inherited from logicalaccess::MifareCommands
 MifareCommands ()
 
 MifareCommands (std::string ct)
 
virtual ByteVector readSector (int sector, int start_block, std::shared_ptr< MifareKey > keyA, std::shared_ptr< MifareKey > keyB, const MifareAccessInfo::SectorAccessBits &sab, bool readtrailer=false) final
 
virtual void writeSector (int sector, int start_block, const ByteVector &buf, std::shared_ptr< MifareKey > keyA, std::shared_ptr< MifareKey > keyB, const MifareAccessInfo::SectorAccessBits &sab, unsigned char userbyte=0x00, MifareAccessInfo::SectorAccessBits *newsab=nullptr, std::shared_ptr< MifareKey > newkeyA=std::shared_ptr< MifareKey >(), std::shared_ptr< MifareKey > newkeyB=std::shared_ptr< MifareKey >()) final
 
virtual ByteVector readSectors (int start_sector, int stop_sector, int start_block, std::shared_ptr< MifareKey > keyA, std::shared_ptr< MifareKey > keyB, const MifareAccessInfo::SectorAccessBits &sab) final
 
virtual void writeSectors (int start_sector, int stop_sector, int start_block, const ByteVector &buf, std::shared_ptr< MifareKey > keyA, std::shared_ptr< MifareKey > keyB, const MifareAccessInfo::SectorAccessBits &sab, unsigned char userbyte=0x00, MifareAccessInfo::SectorAccessBits *newsab=nullptr, std::shared_ptr< MifareKey > newkeyA=std::shared_ptr< MifareKey >(), std::shared_ptr< MifareKey > newkeyB=std::shared_ptr< MifareKey >()) final
 
unsigned int getSectorFromMAD (long aid, std::shared_ptr< MifareKey > madKeyA)
 Get the sector referenced by the AID from the MAD.
 
void setSectorToMAD (long aid, unsigned int sector, std::shared_ptr< MifareKey > madKeyA, std::shared_ptr< MifareKey > madKeyB)
 Set the sector referenced by the AID to the MAD.
 
void authenticate (std::shared_ptr< Location > location, std::shared_ptr< AccessInfo > ai, bool write=false)
 Authenticate on a given location.
 
void changeKeys (MifareKeyType keytype, std::shared_ptr< MifareKey > key, std::shared_ptr< MifareKey > newkeyA, std::shared_ptr< MifareKey > newkeyB, unsigned int sector, MifareAccessInfo::SectorAccessBits *newsab, unsigned char userbyte=0x00)
 
void changeKeys (std::shared_ptr< MifareKey > newkeyA, std::shared_ptr< MifareKey > newkeyB, unsigned int sector, MifareAccessInfo::SectorAccessBits *newsab, unsigned char userbyte=0x00)
 
void authenticate (MifareKeyType keyType, std::shared_ptr< MifareKey > key, int sector, int block, bool write)
 Authenticate for a targeted block.
 
virtual ByteVector readBinary (unsigned char blockno, size_t len)=0
 Read bytes from the card.
 
virtual void updateBinary (unsigned char blockno, const ByteVector &buf)=0
 Write bytes to the card.
 
virtual bool loadKey (unsigned char keyno, MifareKeyType keytype, std::shared_ptr< MifareKey > key, bool vol=false)=0
 Load a key to the reader.
 
virtual void loadKey (std::shared_ptr< Location > location, MifareKeyType keytype, std::shared_ptr< MifareKey > key)=0
 Load a key on a given location.
 
virtual void authenticate (unsigned char blockno, unsigned char keyno, MifareKeyType keytype)=0
 Authenticate a block, given a key number.
 
virtual void authenticate (unsigned char blockno, std::shared_ptr< KeyStorage > key_storage, MifareKeyType keytype)=0
 Authenticate a block, given a key number.
 
virtual void increment (uint8_t blockno, uint32_t value)=0
 
virtual void decrement (uint8_t blockno, uint32_t value)=0
 
bool writeValueBlock (uint8_t blockno, int32_t value, uint8_t backup_blockno)
 
bool readValueBlock (uint8_t blockno, int32_t &value, uint8_t &backup_block)
 
- Public Member Functions inherited from logicalaccess::Commands
 Commands ()=delete
 Constructor.
 
virtual ~Commands ()
 
std::shared_ptr< ChipgetChip () const override
 Get the chip.
 
virtual void setChip (std::shared_ptr< Chip > chip)
 Set the chip.
 
std::shared_ptr< ReaderCardAdaptergetReaderCardAdapter () const override
 Get the reader/card adapter.
 
virtual void setReaderCardAdapter (std::shared_ptr< ReaderCardAdapter > adapter)
 Set the reader/card adapter.
 
virtual const std::string & getCmdType () const
 Get the cmd name.
 
virtual void setCmdType (const std::string &command_type)
 Set the cmd name.
 
- Public Member Functions inherited from logicalaccess::ICommands
virtual ~ICommands ()=default
 
virtual std::shared_ptr< ChipgetChip () const =0
 Get the chip.
 
virtual std::shared_ptr< ReaderCardAdaptergetReaderCardAdapter () const =0
 Get the reader/card adapter.
 

Protected Member Functions

bool loadKey (unsigned char keyno, MifareKeyType keytype, std::shared_ptr< MifareKey > key, bool vol=false) override
 Load a key to the reader.
 
void loadKey (std::shared_ptr< Location > location, MifareKeyType keytype, std::shared_ptr< MifareKey > key) override
 Load a key on a given location.
 
void authenticate (unsigned char blockno, std::shared_ptr< KeyStorage > key_storage, MifareKeyType keytype) override
 Authenticate a block, given a key number.
 
void authenticate (unsigned char blockno, unsigned char keyno, MifareKeyType keytype) override
 Authenticate a block, given a key number.
 
- Protected Member Functions inherited from logicalaccess::MifareCommands
std::shared_ptr< MifareChipgetMifareChip () const
 
- Protected Member Functions inherited from logicalaccess::Commands
 Commands (std::string commandtype)
 Constructor.
 

Friends

template<typename T , typename T2 >
class MifarePlusSL1Policy
 

Additional Inherited Members

- Static Public Member Functions inherited from logicalaccess::MifareCommands
static unsigned char calculateMADCrc (const unsigned char *madbuf, size_t madbuflen)
 Calculate the MAD crc.
 
static unsigned int findReferencedSector (long aid, unsigned char *madbuf, size_t madbuflen)
 Find the referenced sector in the MAD.
 
static MifareKeyType getKeyType (const MifareAccessInfo::SectorAccessBits &sab, int sector, int block, bool write)
 
static unsigned char getNbBlocks (int sector)
 Get number of data blocks for a sector.
 
static unsigned char getSectorStartBlock (int sector)
 Get the sector start block.
 
- Protected Attributes inherited from logicalaccess::Commands
std::shared_ptr< ReaderCardAdapterd_readerCardAdapter
 The reader/card adapter.
 
std::weak_ptr< Chipd_chip
 The chip.
 
std::string d_commandtype
 The command type.
 

Detailed Description

The Mifare card provider class for PCSC reader.

Constructor & Destructor Documentation

◆ MifarePCSCCommands() [1/2]

logicalaccess::MifarePCSCCommands::MifarePCSCCommands ( )

Constructor.

◆ MifarePCSCCommands() [2/2]

logicalaccess::MifarePCSCCommands::MifarePCSCCommands ( std::string  ct)
explicit

◆ ~MifarePCSCCommands()

logicalaccess::MifarePCSCCommands::~MifarePCSCCommands ( )
virtual

Destructor.

Member Function Documentation

◆ authenticate() [1/2]

void logicalaccess::MifarePCSCCommands::authenticate ( unsigned char  blockno,
std::shared_ptr< KeyStorage key_storage,
MifareKeyType  keytype 
)
overrideprotectedvirtual

Authenticate a block, given a key number.

Parameters
blocknoThe block number.
key_storageThe key storage used for authentication.
keytypeThe key type.

Implements logicalaccess::MifareCommands.

Reimplemented in logicalaccess::MifareSpringCardCommands.

◆ authenticate() [2/2]

void logicalaccess::MifarePCSCCommands::authenticate ( unsigned char  blockno,
unsigned char  keyno,
MifareKeyType  keytype 
)
overrideprotectedvirtual

Authenticate a block, given a key number.

Parameters
blocknoThe block number.
keynoThe key number, previously loaded with Mifare::loadKey().
keytypeThe key type.

Implements logicalaccess::MifareCommands.

Reimplemented in logicalaccess::MifareSpringCardCommands, and logicalaccess::MifareSpringCardCommands.

◆ decrement()

void logicalaccess::MifarePCSCCommands::decrement ( uint8_t  blockno,
uint32_t  value 
)
overridevirtual

Decrement (inplace) the value block at address blockno by value unit.

This means that this is the equivalent of also calling transfer.

Warning
While the parameter is unsigned (because negative value causes errors), value superior to 2^31-1 are also rejected.

Implements logicalaccess::MifareCommands.

◆ getPCSCReaderCardAdapter()

std::shared_ptr< PCSCReaderCardAdapter > logicalaccess::MifarePCSCCommands::getPCSCReaderCardAdapter ( ) const
inline

Get the PC/SC reader/card adapter.

Returns
The PC/SC reader/card adapter.

◆ increment()

void logicalaccess::MifarePCSCCommands::increment ( uint8_t  blockno,
uint32_t  value 
)
overridevirtual

Increment (inplace) the value block at address blockno.

This means that this is the equivalent of also calling transfer.

Warning
While the parameter is unsigned (because negative value causes errors), value superior to 2^31-1 are also rejected.

Implements logicalaccess::MifareCommands.

◆ loadKey() [1/2]

void logicalaccess::MifarePCSCCommands::loadKey ( std::shared_ptr< Location location,
MifareKeyType  keytype,
std::shared_ptr< MifareKey key 
)
overrideprotectedvirtual

Load a key on a given location.

Parameters
locationThe location.
keyThe key.
keytypeThe mifare key type.

Implements logicalaccess::MifareCommands.

Reimplemented in logicalaccess::MifareSpringCardCommands.

◆ loadKey() [2/2]

bool logicalaccess::MifarePCSCCommands::loadKey ( unsigned char  keyno,
MifareKeyType  keytype,
std::shared_ptr< MifareKey key,
bool  vol = false 
)
overrideprotectedvirtual

Load a key to the reader.

Parameters
keynoThe key number.
keytypeThe mifare key type.
keyThe key.
volUse volatile memory.
Returns
true on success, false otherwise.

Implements logicalaccess::MifareCommands.

Reimplemented in logicalaccess::MifareSCMCommands, logicalaccess::MifareSpringCardCommands, and logicalaccess::MifareSpringCardCommands.

◆ readBinary()

ByteVector logicalaccess::MifarePCSCCommands::readBinary ( unsigned char  blockno,
size_t  len 
)
overridevirtual

Read bytes from the card.

Parameters
blocknoThe block number.
lenThe count of bytes to read. (0 <= len < 16)
bufThe buffer in which to place the data.
buflenThe length of buffer.
Returns
The count of bytes red.

Implements logicalaccess::MifareCommands.

◆ updateBinary()

void logicalaccess::MifarePCSCCommands::updateBinary ( unsigned char  blockno,
const ByteVector buf 
)
overridevirtual

Write bytes to the card.

Parameters
blocknoThe block number.
bufThe buffer containing the data.
buflenThe length of buffer.
Returns
The count of bytes written.

Implements logicalaccess::MifareCommands.

Friends And Related Function Documentation

◆ MifarePlusSL1Policy

template<typename T , typename T2 >
friend class MifarePlusSL1Policy
friend

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