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

#include <CardSecuritySettingAdapter.h>

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

Public Member Functions

 CardSecuritySettingAdapter ()
 
CardSecuritySetting & setSamResource (const std::shared_ptr< CardReader > samReader, const std::shared_ptr< CalypsoSam > calypsoSam) override
 
CardSecuritySettingAdapterenableMultipleSession () override
 
CardSecuritySettingAdapterenableRatificationMechanism () override
 
CardSecuritySettingAdapterenablePinPlainTransmission () override
 
CardSecuritySettingAdapterenableTransactionAudit () override
 
CardSecuritySettingAdapterenableSvLoadAndDebitLog () override
 
CardSecuritySettingAdapterauthorizeSvNegativeBalance () override
 
CardSecuritySettingAdapterassignKif (const WriteAccessLevel writeAccessLevel, const uint8_t kvc, const uint8_t kif) override
 
CardSecuritySettingAdapterassignDefaultKif (const WriteAccessLevel writeAccessLevel, const uint8_t kif) override
 
CardSecuritySettingAdapterassignDefaultKvc (const WriteAccessLevel writeAccessLevel, const uint8_t kvc) override
 
CardSecuritySettingAdapteraddAuthorizedSessionKey (const uint8_t kif, const uint8_t kvc) override
 
CardSecuritySettingAdapteraddAuthorizedSvKey (const uint8_t kif, const uint8_t kvc) override
 
CardSecuritySettingAdaptersetPinVerificationCipheringKey (const uint8_t kif, const uint8_t kvc) override
 
CardSecuritySettingAdaptersetPinModificationCipheringKey (const uint8_t kif, const uint8_t kvc) override
 
std::shared_ptr< CardReader > getSamReader () const
 
std::shared_ptr< CalypsoSam > getCalypsoSam () const
 
bool isMultipleSessionEnabled () const
 
bool isRatificationMechanismEnabled () const
 
bool isPinPlainTransmissionEnabled () const
 
bool isTransactionAuditEnabled () const
 
bool isSvLoadAndDebitLogEnabled () const
 
bool isSvNegativeBalanceAuthorized () const
 
const std::shared_ptr< uint8_t > getKif (const WriteAccessLevel writeAccessLevel, const uint8_t kvc) const
 
const std::shared_ptr< uint8_t > getDefaultKif (const WriteAccessLevel writeAccessLevel) const
 
const std::shared_ptr< uint8_t > getDefaultKvc (const WriteAccessLevel writeAccessLevel) const
 
bool isSessionKeyAuthorized (const std::shared_ptr< uint8_t > kif, const std::shared_ptr< uint8_t > kvc) const
 
bool isSvKeyAuthorized (const std::shared_ptr< uint8_t > kif, const std::shared_ptr< uint8_t > kvc) const
 
const std::shared_ptr< uint8_t > getPinVerificationCipheringKif () const
 
const std::shared_ptr< uint8_t > getPinVerificationCipheringKvc () const
 
const std::shared_ptr< uint8_t > getPinModificationCipheringKif () const
 
const std::shared_ptr< uint8_t > getPinModificationCipheringKvc () const
 

Detailed Description

(package-private)
Implementation of CardSecuritySetting.

Since
2.0.0

Definition at line 45 of file CardSecuritySettingAdapter.h.

Constructor & Destructor Documentation

◆ CardSecuritySettingAdapter()

keyple::card::calypso::CardSecuritySettingAdapter::CardSecuritySettingAdapter ( )

(package-private)
Constructor.

Definition at line 30 of file CardSecuritySettingAdapter.cpp.

Member Function Documentation

◆ addAuthorizedSessionKey()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::addAuthorizedSessionKey ( const uint8_t  kif,
const uint8_t  kvc 
)
override
Since
2.0.0

Definition at line 119 of file CardSecuritySettingAdapter.cpp.

◆ addAuthorizedSvKey()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::addAuthorizedSvKey ( const uint8_t  kif,
const uint8_t  kvc 
)
override
Since
2.0.0

Definition at line 127 of file CardSecuritySettingAdapter.cpp.

◆ assignDefaultKif()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::assignDefaultKif ( const WriteAccessLevel  writeAccessLevel,
const uint8_t  kif 
)
override
Since
2.0.0

Definition at line 103 of file CardSecuritySettingAdapter.cpp.

◆ assignDefaultKvc()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::assignDefaultKvc ( const WriteAccessLevel  writeAccessLevel,
const uint8_t  kvc 
)
override
Since
2.0.0

Definition at line 111 of file CardSecuritySettingAdapter.cpp.

◆ assignKif()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::assignKif ( const WriteAccessLevel  writeAccessLevel,
const uint8_t  kvc,
const uint8_t  kif 
)
override
Since
2.0.0

Definition at line 94 of file CardSecuritySettingAdapter.cpp.

◆ authorizeSvNegativeBalance()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::authorizeSvNegativeBalance ( )
override
Since
2.0.0

Definition at line 87 of file CardSecuritySettingAdapter.cpp.

◆ enableMultipleSession()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::enableMultipleSession ( )
override
Since
2.0.0

Definition at line 52 of file CardSecuritySettingAdapter.cpp.

◆ enablePinPlainTransmission()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::enablePinPlainTransmission ( )
override
Since
2.0.0

Definition at line 66 of file CardSecuritySettingAdapter.cpp.

◆ enableRatificationMechanism()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::enableRatificationMechanism ( )
override
Since
2.0.0

Definition at line 59 of file CardSecuritySettingAdapter.cpp.

◆ enableSvLoadAndDebitLog()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::enableSvLoadAndDebitLog ( )
override
Since
2.0.0

Definition at line 80 of file CardSecuritySettingAdapter.cpp.

◆ enableTransactionAudit()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::enableTransactionAudit ( )
override
Since
2.0.0

Definition at line 73 of file CardSecuritySettingAdapter.cpp.

◆ getCalypsoSam()

std::shared_ptr< CalypsoSam > keyple::card::calypso::CardSecuritySettingAdapter::getCalypsoSam ( ) const

(package-private)
Gets the SAM used for secured operations.

Returns
Null if no SAM is set or a CalypsoSam having a CalypsoSam::ProductType different from CalypsoSam::ProductType::UNKNOWN.
Since
2.0.0

Definition at line 158 of file CardSecuritySettingAdapter.cpp.

◆ getDefaultKif()

const std::shared_ptr< uint8_t > keyple::card::calypso::CardSecuritySettingAdapter::getDefaultKif ( const WriteAccessLevel  writeAccessLevel) const

(package-private)
Gets the default KIF value for the provided write access level.

Parameters
writeAccessLevelThe write access level.
Returns
Null if no KIF is available.
Exceptions
IllegalArgumentExceptionIf the provided argument is null.
Since
2.0.0

Definition at line 209 of file CardSecuritySettingAdapter.cpp.

◆ getDefaultKvc()

const std::shared_ptr< uint8_t > keyple::card::calypso::CardSecuritySettingAdapter::getDefaultKvc ( const WriteAccessLevel  writeAccessLevel) const

(package-private)
Gets the default KVC value for the provided write access level.

Parameters
writeAccessLevelThe write access level.
Returns
Null if no KVC is available.
Exceptions
IllegalArgumentExceptionIf the provided argument is null.
Since
2.0.0

Definition at line 220 of file CardSecuritySettingAdapter.cpp.

◆ getKif()

const std::shared_ptr< uint8_t > keyple::card::calypso::CardSecuritySettingAdapter::getKif ( const WriteAccessLevel  writeAccessLevel,
const uint8_t  kvc 
) const

(package-private)
Gets the KIF value to use for the provided write access level and KVC value.

Parameters
writeAccessLevelThe write access level.
kvcThe KVC value.
Returns
Null if no KIF is available.
Exceptions
IllegalArgumentExceptionIf the provided writeAccessLevel is null.
Since
2.0.0

Definition at line 193 of file CardSecuritySettingAdapter.cpp.

◆ getPinModificationCipheringKif()

const std::shared_ptr< uint8_t > keyple::card::calypso::CardSecuritySettingAdapter::getPinModificationCipheringKif ( ) const

(package-private)
Gets the KIF value of the PIN modification ciphering key.

Returns
Null if no KIF is available.
Since
2.0.0

Definition at line 271 of file CardSecuritySettingAdapter.cpp.

◆ getPinModificationCipheringKvc()

const std::shared_ptr< uint8_t > keyple::card::calypso::CardSecuritySettingAdapter::getPinModificationCipheringKvc ( ) const

(package-private)
Gets the KVC value of the PIN modification ciphering key.

Returns
Null if no KVC is available.
Since
2.0.0

Definition at line 276 of file CardSecuritySettingAdapter.cpp.

◆ getPinVerificationCipheringKif()

const std::shared_ptr< uint8_t > keyple::card::calypso::CardSecuritySettingAdapter::getPinVerificationCipheringKif ( ) const

(package-private)
Gets the KIF value of the PIN verification ciphering key.

Returns
Null if no KIF is available.
Since
2.0.0

Definition at line 261 of file CardSecuritySettingAdapter.cpp.

◆ getPinVerificationCipheringKvc()

const std::shared_ptr< uint8_t > keyple::card::calypso::CardSecuritySettingAdapter::getPinVerificationCipheringKvc ( ) const

(package-private)
Gets the KVC value of the PIN verification ciphering key.

Returns
Null if no KVC is available.
Since
2.0.0

Definition at line 266 of file CardSecuritySettingAdapter.cpp.

◆ getSamReader()

std::shared_ptr< CardReader > keyple::card::calypso::CardSecuritySettingAdapter::getSamReader ( ) const

(package-private)
Gets the associated SAM reader to use for secured operations.

Returns
Null if no SAM reader is set.
Since
2.0.0

Definition at line 153 of file CardSecuritySettingAdapter.cpp.

◆ isMultipleSessionEnabled()

bool keyple::card::calypso::CardSecuritySettingAdapter::isMultipleSessionEnabled ( ) const

(package-private)
Indicates if the multiple session mode is enabled.

Returns
True if the multiple session mode is enabled.
Since
2.0.0

Definition at line 163 of file CardSecuritySettingAdapter.cpp.

◆ isPinPlainTransmissionEnabled()

bool keyple::card::calypso::CardSecuritySettingAdapter::isPinPlainTransmissionEnabled ( ) const

(package-private)
Indicates if the transmission of the PIN in plain text is enabled.

Returns
True if the transmission of the PIN in plain text is enabled.
Since
2.0.0

Definition at line 173 of file CardSecuritySettingAdapter.cpp.

◆ isRatificationMechanismEnabled()

bool keyple::card::calypso::CardSecuritySettingAdapter::isRatificationMechanismEnabled ( ) const

(package-private)
Indicates if the ratification mechanism is enabled.

Returns
True if the ratification mechanism is enabled.
Since
2.0.0

Definition at line 168 of file CardSecuritySettingAdapter.cpp.

◆ isSessionKeyAuthorized()

bool keyple::card::calypso::CardSecuritySettingAdapter::isSessionKeyAuthorized ( const std::shared_ptr< uint8_t >  kif,
const std::shared_ptr< uint8_t >  kvc 
) const

(package-private)
Indicates if the KIF/KVC pair is authorized for a session.

Parameters
kifThe KIF value.
kvcThe KVC value.
Returns
False if KIF or KVC is null or unauthorized.
Since
2.0.0

Definition at line 231 of file CardSecuritySettingAdapter.cpp.

◆ isSvKeyAuthorized()

bool keyple::card::calypso::CardSecuritySettingAdapter::isSvKeyAuthorized ( const std::shared_ptr< uint8_t >  kif,
const std::shared_ptr< uint8_t >  kvc 
) const

(package-private)
Indicates if the KIF/KVC pair is authorized for a SV operation.

Parameters
kifThe KIF value.
kvcThe KVC value.
Returns
False if KIF or KVC is null or unauthorized.
Since
2.0.0

Definition at line 246 of file CardSecuritySettingAdapter.cpp.

◆ isSvLoadAndDebitLogEnabled()

bool keyple::card::calypso::CardSecuritySettingAdapter::isSvLoadAndDebitLogEnabled ( ) const

(package-private)
Indicates if the retrieval of both load and debit log is enabled.

Returns
True if the retrieval of both load and debit log is enabled.
Since
2.0.0

Definition at line 183 of file CardSecuritySettingAdapter.cpp.

◆ isSvNegativeBalanceAuthorized()

bool keyple::card::calypso::CardSecuritySettingAdapter::isSvNegativeBalanceAuthorized ( ) const

(package-private)
Indicates if the SV balance is allowed to become negative.

Returns
True if the retrieval of both load and debit log is enabled.
Since
2.0.0

Definition at line 188 of file CardSecuritySettingAdapter.cpp.

◆ isTransactionAuditEnabled()

bool keyple::card::calypso::CardSecuritySettingAdapter::isTransactionAuditEnabled ( ) const

(package-private)
Indicates if the transaction audit is enabled.

Returns
True if the transaction audit is enabled.
Since
2.0.0

Definition at line 178 of file CardSecuritySettingAdapter.cpp.

◆ setPinModificationCipheringKey()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::setPinModificationCipheringKey ( const uint8_t  kif,
const uint8_t  kvc 
)
override
Since
2.0.0

Definition at line 144 of file CardSecuritySettingAdapter.cpp.

◆ setPinVerificationCipheringKey()

CardSecuritySettingAdapter & keyple::card::calypso::CardSecuritySettingAdapter::setPinVerificationCipheringKey ( const uint8_t  kif,
const uint8_t  kvc 
)
override
Since
2.0.0

Definition at line 135 of file CardSecuritySettingAdapter.cpp.

◆ setSamResource()

CardSecuritySetting & keyple::card::calypso::CardSecuritySettingAdapter::setSamResource ( const std::shared_ptr< CardReader >  samReader,
const std::shared_ptr< CalypsoSam >  calypsoSam 
)
override
Since
2.0.0

Definition at line 38 of file CardSecuritySettingAdapter.cpp.


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