Keyple Card Calypso C++ Library 2.2.5.6
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 std::shared_ptr< CalypsoCardAdapter > calypsoCard, const bool encryptPinTransmission, const std::vector< uint8_t > &pin)
 
 CmdCardVerifyPin (const std::shared_ptr< CalypsoCardAdapter > calypsoCard)
 
void parseApduResponse (const std::shared_ptr< ApduResponseApi > apduResponse) override
 
bool isSessionBufferUsed () const override
 
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 int expectedResponseLength, const std::shared_ptr< CalypsoCardAdapter > calypsoCard)
 
const CalypsoCardCommandgetCommandRef () const override
 
const CalypsoApduCommandException buildCommandException (const std::type_info &exceptionClass, const std::string &message) const final
 
const CalypsoApduCommandException buildUnexpectedResponseLengthException (const std::string &message) const final
 
std::shared_ptr< CalypsoCardAdaptergetCalypsoCard () const
 
void parseApduResponse (const std::shared_ptr< ApduResponseApi > apduResponse, const std::shared_ptr< CalypsoCardAdapter > calypsoCard)
 
- Public Member Functions inherited from keyple::card::calypso::AbstractApduCommand
 AbstractApduCommand (const CardCommand &commandRef, const int expectedResponseLength)
 
virtual void addSubName (const std::string &subName) final
 
virtual const std::string & getName () const final
 
virtual void setExpectedResponseLength (const int expectedResponseLength) final
 
virtual void setApduRequest (const std::shared_ptr< ApduRequestAdapter > apduRequest) final
 
virtual const std::shared_ptr< ApduRequestAdaptergetApduRequest () 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 50 of file CmdCardVerifyPin.h.

Constructor & Destructor Documentation

◆ CmdCardVerifyPin() [1/2]

keyple::card::calypso::CmdCardVerifyPin::CmdCardVerifyPin ( const std::shared_ptr< CalypsoCardAdapter calypsoCard,
const bool  encryptPinTransmission,
const std::vector< uint8_t > &  pin 
)

(package-private)
Verify the PIN

Parameters
calypsoCardThe Calypso card.
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 std::shared_ptr< CalypsoCardAdapter calypsoCard)

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

Parameters
calypsoCardThe Calypso card.
Since
2.0.1

Definition at line 70 of file CmdCardVerifyPin.cpp.

Member Function Documentation

◆ 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 167 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 124 of file CmdCardVerifyPin.cpp.

◆ parseApduResponse()

void keyple::card::calypso::CmdCardVerifyPin::parseApduResponse ( const std::shared_ptr< ApduResponseApi >  apduResponse)
overridevirtual

(package-private)
Parses the response ApduResponseApi and check the status word.

Parameters
apduResponseThe APDU response.
Exceptions
CalypsoApduCommandExceptionif status is not successful or if the length of the response is not equal to the LE field in the request.
Since
2.0.1
Since
2.0.1

Since
2.2.3

Reimplemented from keyple::card::calypso::AbstractCardCommand.

Definition at line 85 of file CmdCardVerifyPin.cpp.


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