Keyple Card Calypso C++ Library 2.1.0
Reference Terminal Reader API for C++
Public Member Functions | List of all members
keyple::card::calypso::CmdCardVerifyPin Class Referencefinal

#include <CmdCardVerifyPin.h>

Inheritance diagram for keyple::card::calypso::CmdCardVerifyPin:
Inheritance graph
[legend]
Collaboration diagram for keyple::card::calypso::CmdCardVerifyPin:
Collaboration graph
[legend]

Public Member Functions

 CmdCardVerifyPin (const CalypsoCardClass calypsoCardClass, const bool encryptPinTransmission, const std::vector< uint8_t > &pin)
 
 CmdCardVerifyPin (const CalypsoCardClass calypsoCardClass)
 
bool isSessionBufferUsed () const override
 
bool isReadCounterOnly () const
 
int getRemainingAttemptCounter () const
 
const std::map< const int, const std::shared_ptr< StatusProperties > > & getStatusTable () const override
 
- Public Member Functions inherited from keyple::card::calypso::AbstractCardCommand
 AbstractCardCommand (const CalypsoCardCommand &commandRef)
 
const CalypsoCardCommand & getCommandRef () const override
 
const CalypsoApduCommandException buildCommandException (const std::type_info &exceptionClass, const std::string &message, const CardCommand &commandRef, const int statusWord) const final
 
AbstractCardCommand & setApduResponse (const std::shared_ptr< ApduResponseApi > apduResponse) override
 
void checkStatus () override
 
- Public Member Functions inherited from keyple::card::calypso::AbstractApduCommand
 AbstractApduCommand (const CardCommand &commandRef)
 
virtual void addSubName (const std::string &subName) final
 
virtual const std::string & getName () const final
 
virtual void setApduRequest (const std::shared_ptr< ApduRequestAdapter > apduRequest) final
 
virtual const std::shared_ptr< ApduRequestAdapter > getApduRequest () const final
 
virtual const std::shared_ptr< ApduResponseApi > getApduResponse () const final
 
virtual bool isSuccessful () const final
 
virtual const std::string getStatusInformation () const final
 

Additional Inherited Members

- Static Public Attributes inherited from keyple::card::calypso::AbstractApduCommand
static const std::map< const int, const std::shared_ptr< StatusProperties > > STATUS_TABLE
 

Detailed Description

(package-private)
Builds the "Verify PIN" command.

Since
2.0.1

Definition at line 46 of file CmdCardVerifyPin.h.

Constructor & Destructor Documentation

◆ CmdCardVerifyPin() [1/2]

keyple::card::calypso::CmdCardVerifyPin::CmdCardVerifyPin ( const CalypsoCardClass  calypsoCardClass,
const bool  encryptPinTransmission,
const std::vector< uint8_t > &  pin 
)

(package-private)
Verify the PIN

Parameters
calypsoCardClassindicates which CLA byte should be used for the Apdu.
encryptPinTransmissiontrue if the PIN transmission has to be encrypted.
pinthe PIN data. The PIN is always 4-byte long here, even in the case of an encrypted transmission (
See also
setCipheredPinData).
Since
2.0.1

Definition at line 43 of file CmdCardVerifyPin.cpp.

◆ CmdCardVerifyPin() [2/2]

keyple::card::calypso::CmdCardVerifyPin::CmdCardVerifyPin ( const CalypsoCardClass  calypsoCardClass)

(package-private)
Alternate command dedicated to the reading of the wrong presentation counter

Parameters
calypsoCardClassindicates which CLA byte should be used for the Apdu.
Since
2.0.1

Definition at line 68 of file CmdCardVerifyPin.cpp.

Member Function Documentation

◆ getRemainingAttemptCounter()

int keyple::card::calypso::CmdCardVerifyPin::getRemainingAttemptCounter ( ) const

(package-private)
Determine the value of the attempt counter from the status word

Returns
The remaining attempt counter value (0, 1, 2 or 3)
Since
2.0.1

Definition at line 93 of file CmdCardVerifyPin.cpp.

◆ getStatusTable()

const std::map< const int, const std::shared_ptr< StatusProperties > > & keyple::card::calypso::CmdCardVerifyPin::getStatusTable ( ) const
overridevirtual

(package-private)
Returns the internal status table

Returns
A not null reference
Since
2.0.1

Since
2.0.1

Reimplemented from keyple::card::calypso::AbstractApduCommand.

Definition at line 157 of file CmdCardVerifyPin.cpp.

◆ isReadCounterOnly()

bool keyple::card::calypso::CmdCardVerifyPin::isReadCounterOnly ( ) const

(package-private)
Indicates if the command is used to read the attempt counter only

Returns
True if the command is used to read the attempt counter
Since
2.0.1

Definition at line 88 of file CmdCardVerifyPin.cpp.

◆ isSessionBufferUsed()

bool keyple::card::calypso::CmdCardVerifyPin::isSessionBufferUsed ( ) const
overridevirtual

(package-private)
Indicates if the session buffer is used when executing this command.Allows the management of the overflow of this buffer.

Returns
True if this command uses the session buffer
Since
2.0.1

Returns
false
Since
2.0.1

Implements keyple::card::calypso::AbstractCardCommand.

Definition at line 83 of file CmdCardVerifyPin.cpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.2