A Mifare OK5553 commands base class. More...

#include <mifareok5553commands.hpp>

Inheritance diagram for logicalaccess::MifareOK5553Commands:

Public Member Functions
	MifareOK5553Commands ()
	Constructor.

	MifareOK5553Commands (std::string)

virtual	~MifareOK5553Commands ()
	Destructor.

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.

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, unsigned char keyno, MifareKeyType keytype) override
	Authenticate a block, given a key number.

void	authenticate (unsigned char blockno, std::shared_ptr< KeyStorage > key_storage, MifareKeyType keytype) override
	Authenticate a block, given a key number.

void	increment (unsigned char blockno, unsigned int value) override
	Increment a block value.

void	decrement (unsigned char blockno, unsigned int value) override
	Decrement a block value.

virtual std::shared_ptr< OK5553ReaderCardAdapter >	getOK5553ReaderCardAdapter ()
	Get the OK5553 reader/card adapter.

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< Chip >	getChip () const override
	Get the chip.

virtual void	setChip (std::shared_ptr< Chip > chip)
	Set the chip.

std::shared_ptr< ReaderCardAdapter >	getReaderCardAdapter () 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< Chip >	getChip () const =0
	Get the chip.

virtual std::shared_ptr< ReaderCardAdapter >	getReaderCardAdapter () const =0
	Get the reader/card adapter.

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 Member Functions inherited from logicalaccess::MifareCommands
std::shared_ptr< MifareChip >	getMifareChip () const

Protected Member Functions inherited from logicalaccess::Commands
	Commands (std::string commandtype)
	Constructor.

Protected Attributes inherited from logicalaccess::Commands
std::shared_ptr< ReaderCardAdapter >	d_readerCardAdapter
	The reader/card adapter.

std::weak_ptr< Chip >	d_chip
	The chip.

std::string	d_commandtype
	The command type.

Detailed Description

A Mifare OK5553 commands base class.

Constructor & Destructor Documentation

◆ MifareOK5553Commands() [1/2]

logicalaccess::MifareOK5553Commands::MifareOK5553Commands ( )

Constructor.

◆ MifareOK5553Commands() [2/2]

logicalaccess::MifareOK5553Commands::MifareOK5553Commands ( std::string ct )

explicit

◆ ~MifareOK5553Commands()

logicalaccess::MifareOK5553Commands::~MifareOK5553Commands ( )

virtual

Destructor.

Member Function Documentation

◆ authenticate() [1/2]

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

overridevirtual

Authenticate a block, given a key number.

Parameters

blockno	The block number.
key_storage	The key storage used for authentication.
keytype	The key type.

Returns: true if authenticated, false otherwise.

Implements logicalaccess::MifareCommands.

◆ authenticate() [2/2]

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

overridevirtual

Authenticate a block, given a key number.

Parameters

blockno	The block number.
keyno	The key number, previously loaded with Mifare::loadKey().
keytype	The key type.

Implements logicalaccess::MifareCommands.

◆ decrement()

void logicalaccess::MifareOK5553Commands::decrement	(	unsigned char	blockno,
		unsigned int	value
	)

override

Decrement a block value.

Parameters

blockno	The block number.
value	The decrement value.

◆ getOK5553ReaderCardAdapter()

virtual std::shared_ptr< OK5553ReaderCardAdapter > logicalaccess::MifareOK5553Commands::getOK5553ReaderCardAdapter ( )

inlinevirtual

Get the OK5553 reader/card adapter.

Returns: The OK5553 reader/card adapter.

◆ increment()

void logicalaccess::MifareOK5553Commands::increment	(	unsigned char	blockno,
		unsigned int	value
	)

override

Increment a block value.

Parameters

blockno	The block number.
value	The increment value.

◆ loadKey() [1/2]

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

overridevirtual

Load a key on a given location.

Parameters

location	The location.
keytype	The mifare key type.
key	The key.

Implements logicalaccess::MifareCommands.

◆ loadKey() [2/2]

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

overridevirtual

Load a key to the reader.

Parameters

keyno	The reader key slot number. Can be anything from 0x00 to 0x1F.
keytype	The key type.
key	The key.
vol	Use volatile memory, not used by this reader.

Returns: true on success, false otherwise.

Implements logicalaccess::MifareCommands.

◆ readBinary()

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

overridevirtual

Read bytes from the card.

Parameters

blockno	The block number.
len	The count of bytes to read. (0 <= len < 16)
buf	The buffer in which to place the data.
buflen	The length of buffer.

Returns: The count of bytes red.

Implements logicalaccess::MifareCommands.

◆ updateBinary()

void logicalaccess::MifareOK5553Commands::updateBinary	(	unsigned char	blockno,
		const ByteVector &	buf
	)

overridevirtual

Write bytes to the card.

Parameters

blockno	The block number.
buf	The buffer containing the data.
buflen	The length of buffer.

Returns: The count of bytes written.

Implements logicalaccess::MifareCommands.

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

C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/ok5553/commands/mifareok5553commands.hpp
C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/ok5553/commands/mifareok5553commands.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MifareOK5553Commands() [1/2]

◆ MifareOK5553Commands() [2/2]

◆ ~MifareOK5553Commands()

Member Function Documentation

◆ authenticate() [1/2]

◆ authenticate() [2/2]

◆ decrement()

◆ getOK5553ReaderCardAdapter()

◆ increment()

◆ loadKey() [1/2]

◆ loadKey() [2/2]

◆ readBinary()

◆ updateBinary()