desfirecommands.hpp

Go to the documentation of this file.

 
#ifndef LOGICALACCESS_DESFIRECOMMANDS_HPP
#define LOGICALACCESS_DESFIRECOMMANDS_HPP
 
#include <logicalaccess/plugins/cards/desfire/desfireaccessinfo.hpp>
#include <logicalaccess/plugins/cards/desfire/desfirelocation.hpp>
#include <logicalaccess/cards/commands.hpp>
#include <vector>
#include <logicalaccess/iks/RemoteCrypto.hpp>
 
namespace logicalaccess
{
#define EXCEPTION_MSG_SELECTAPPLICATION                                                  \
    "Select application failed." 
#ifndef DF_INS
#define DF_INS
 
#define DF_INS_AUTHENTICATE 0x0A
#define DF_INS_CHANGE_KEY_SETTINGS 0x54
#define DF_INS_GET_KEY_SETTINGS 0x45
#define DF_INS_CHANGE_KEY 0xC4
#define DF_INS_GET_KEY_VERSION 0x64
 
#define DF_INS_CREATE_APPLICATION 0xCA
#define DF_INS_DELETE_APPLICATION 0xDA
#define DF_INS_GET_APPLICATION_IDS 0x6A
#define DF_INS_SELECT_APPLICATION 0x5A
#define DF_INS_FORMAT_PICC 0xFC
#define DF_INS_GET_VERSION 0x60
 
#define DF_INS_GET_FILE_IDS 0x6F
#define DF_INS_GET_FILE_SETTINGS 0xF5
#define DF_INS_CHANGE_FILE_SETTINGS 0x5F
#define DF_INS_CREATE_STD_DATA_FILE 0xCD
#define DF_INS_CREATE_BACKUP_DATA_FILE 0xCB
#define DF_INS_CREATE_VALUE_FILE 0xCC
#define DF_INS_CREATE_LINEAR_RECORD_FILE 0xC1
#define DF_INS_CREATE_CYCLIC_RECORD_FILE 0xC0
#define DF_INS_DELETE_FILE 0xDF
 
#define DF_INS_READ_DATA 0xBD
#define DF_INS_WRITE_DATA 0x3D
#define DF_INS_GET_VALUE 0x6C
#define DF_INS_CREDIT 0x0C
#define DF_INS_DEBIT 0xDC
#define DF_INS_LIMITED_CREDIT 0x1C
#define DF_INS_WRITE_RECORD 0x3B
#define DF_INS_READ_RECORDS 0xBB
#define DF_INS_CLEAR_RECORD_FILE 0xEB
#define DF_COMMIT_TRANSACTION 0xC7
#define DF_INS_ABORT_TRANSACTION 0xA7
 
#define DF_INS_ADDITIONAL_FRAME 0xAF
 
#define DF_CLA_ISO_WRAP 0x90
#endif
 
#define CMD_DESFIRE "DESFire"
 
typedef enum {
    KS_ALLOW_CHANGE_MK                = 0x01,
    KS_FREE_LISTING_WITHOUT_MK        = 0x02,
    KS_FREE_CREATE_DELETE_WITHOUT_MK  = 0x04,
    KS_CONFIGURATION_CHANGEABLE       = 0x08,
    KS_CHANGE_KEY_WITH_MK             = 0x00,
    KS_CHANGE_KEY_WITH_TARGETED_KEYNO = 0xE0,
    KS_CHANGE_KEY_FROZEN              = 0xF0,
    KS_DEFAULT                        = 0x0B
} DESFireKeySettings;
 
typedef enum {
    AR_KEY0  = 0x00,
    AR_KEY1  = 0x01,
    AR_KEY2  = 0x02,
    AR_KEY3  = 0x03,
    AR_KEY4  = 0x04,
    AR_KEY5  = 0x05,
    AR_KEY6  = 0x06,
    AR_KEY7  = 0x07,
    AR_KEY8  = 0x08,
    AR_KEY9  = 0x09,
    AR_KEY10 = 0x0A,
    AR_KEY11 = 0x0B,
    AR_KEY12 = 0x0C,
    AR_KEY13 = 0x0D,
    AR_FREE  = 0x0E,
    AR_NEVER = 0x0F
} TaskAccessRights;
 
struct DESFireAccessRights
{
    TaskAccessRights readAccess;         
    TaskAccessRights writeAccess;        
    TaskAccessRights readAndWriteAccess; 
    TaskAccessRights changeAccess;       
};
 
inline short AccessRightsInMemory(const DESFireAccessRights &rights)
{
    return static_cast<short>((rights.readAccess << 12) | (rights.writeAccess << 8) |
                              (rights.readAndWriteAccess << 4) | rights.changeAccess);
}
 
class DESFireChip;
 
class LLA_CARDS_DESFIRE_API DESFireCommands : public Commands
{
  public:
    DESFireCommands()
        : Commands(CMD_DESFIRE)
    {
    }
 
    explicit DESFireCommands(std::string cmdtype)
        : Commands(cmdtype)
    {
    }
 
    virtual ~DESFireCommands();
 
    virtual void erase() = 0;
 
    struct LLA_CARDS_DESFIRE_API DataFileSetting
    {
        unsigned char fileSize[3]; 
    };
 
    struct LLA_CARDS_DESFIRE_API ValueFileSetting
    {
        int32_t lowerLimit;         
        int32_t upperLimit;         
        int32_t limitedCreditValue; 
        bool limitedCreditEnabled;   
    };
 
    struct LLA_CARDS_DESFIRE_API RecordFileSetting
    {
        unsigned char recordSize[3];       
        unsigned char maxNumberRecords[3]; 
        unsigned char
            currentNumberRecords[3]; 
    };
 
    struct LLA_CARDS_DESFIRE_API FileSetting
    {
        unsigned char fileType;        
        unsigned char comSett;         
        unsigned char accessRights[2]; 
        union {
            DataFileSetting dataFile;
            ValueFileSetting valueFile;
            RecordFileSetting recordFile;
        } type; 
        DataFileSetting getDataFile() const;
        void setDataFile(const DataFileSetting &);
        ValueFileSetting getValueFile() const;
        void setValueFile(const ValueFileSetting &);
        RecordFileSetting getRecordFile() const;
        void setRecordFile(const RecordFileSetting &);
    };
 
    struct LLA_CARDS_DESFIRE_API DESFireCardVersion
    {
        unsigned char hardwareVendor;      
        unsigned char hardwareType;        
        unsigned char hardwareSubType;     
        unsigned char hardwareMjVersion;   
        unsigned char hardwareMnVersion;   
        unsigned char hardwareStorageSize; 
        unsigned char hardwareProtocol;    
        unsigned char softwareVendor;      
        unsigned char softwareType;        
        unsigned char softwareSubType;     
        unsigned char softwareMjVersion;   
        unsigned char softwareMnVersion;   
        unsigned char softwareStorageSize; 
        unsigned char softwareProtocol;    
        unsigned char uid[7];     
        unsigned char batchNo[5]; 
        unsigned char cwProd;     
        unsigned char yearProd;   
    };
 
    virtual void selectApplication(std::shared_ptr<DESFireLocation> location);
 
    virtual void createApplication(std::shared_ptr<DESFireLocation> location,
                                   DESFireKeySettings settings, unsigned char maxNbKeys);
 
    virtual void createStdDataFile(std::shared_ptr<DESFireLocation> location,
                                   const DESFireAccessRights &accessRights,
                                   unsigned int fileSize);
 
    virtual EncryptionMode getEncryptionMode(unsigned char fileno, bool isReadMode,
                                             bool *needLoadKey = nullptr);
 
    virtual EncryptionMode getEncryptionMode(const FileSetting &fileSetting,
                                             bool isReadMode,
                                             bool *needLoadKey = nullptr);
 
    virtual unsigned int getFileLength(unsigned char fileno);
 
    virtual void selectApplication(unsigned int aid) = 0;
 
    virtual void createApplication(unsigned int aid, DESFireKeySettings settings,
                                   unsigned char maxNbKeys) = 0;
 
    virtual void deleteApplication(unsigned int aid) = 0;
 
    virtual std::vector<unsigned int> getApplicationIDs() = 0;
 
    virtual void changeKey(unsigned char keyno, std::shared_ptr<DESFireKey> key) = 0;
 
    virtual void getKeySettings(DESFireKeySettings &settings,
                                unsigned char &maxNbKeys) = 0;
 
    virtual void changeKeySettings(DESFireKeySettings settings) = 0;
 
    virtual ByteVector getFileIDs() = 0;
 
    virtual FileSetting getFileSettings(unsigned char fileno) = 0;
 
    virtual void changeFileSettings(unsigned char fileno, EncryptionMode comSettings,
                                    const DESFireAccessRights &accessRights,
                                    bool plain) = 0;
 
    virtual void createStdDataFile(unsigned char fileno, EncryptionMode comSettings,
                                   const DESFireAccessRights &accessRights,
                                   unsigned int fileSize) = 0;
 
    virtual void createBackupFile(unsigned char fileno, EncryptionMode comSettings,
                                  const DESFireAccessRights &accessRights,
                                  unsigned int fileSize) = 0;
 
    virtual void createValueFile(unsigned char fileno, EncryptionMode comSettings,
                                 const DESFireAccessRights &accessRights,
                                 int32_t lowerLimit, int32_t upperLimit,
                                 int32_t value, bool limitedCreditEnabled) = 0;
 
    virtual void createLinearRecordFile(unsigned char fileno, EncryptionMode comSettings,
                                        const DESFireAccessRights &accessRights,
                                        unsigned int fileSize,
                                        unsigned int maxNumberOfRecords) = 0;
 
    virtual void createCyclicRecordFile(unsigned char fileno, EncryptionMode comSettings,
                                        const DESFireAccessRights &accessRights,
                                        unsigned int fileSize,
                                        unsigned int maxNumberOfRecords) = 0;
 
    virtual void deleteFile(unsigned char fileno) = 0;
 
    virtual ByteVector readData(unsigned char fileno, unsigned int offset,
                                unsigned int length, EncryptionMode mode) = 0;
 
    virtual void writeData(unsigned char fileno, unsigned int offset,
                           const ByteVector &data, EncryptionMode mode) = 0;
 
    virtual int32_t getValue(unsigned char fileno, EncryptionMode mode) = 0;
 
    virtual void credit(unsigned char fileno, unsigned int value,
                        EncryptionMode mode) = 0;
 
    virtual void debit(unsigned char fileno, unsigned int value, EncryptionMode mode) = 0;
 
    virtual void limitedCredit(unsigned char fileno, int32_t value,
                               EncryptionMode mode) = 0;
 
    virtual void writeRecord(unsigned char fileno, unsigned int offset,
                             const ByteVector &data, EncryptionMode mode) = 0;
 
    virtual ByteVector readRecords(unsigned char fileno, unsigned int offset,
                                   unsigned int length, EncryptionMode mode) = 0;
 
    virtual void clearRecordFile(unsigned char fileno) = 0;
 
    virtual void commitTransaction() = 0;
 
    virtual void abortTransaction() = 0;
 
    virtual void authenticate(unsigned char keyno = 0) = 0;
 
    virtual void authenticate(unsigned char keyno, std::shared_ptr<DESFireKey> key) = 0;
 
    virtual DESFireCardVersion getVersion() = 0;
 
    virtual SignatureResult IKS_getLastReadSignature() const
    {
        return SignatureResult{};
    }
 
  protected:
    std::shared_ptr<DESFireChip> getDESFireChip() const;
};
}
 
#endif