desfireev1commands.hpp

Go to the documentation of this file.

 
#ifndef LOGICALACCESS_DESFIREEV1COMMANDS_HPP
#define LOGICALACCESS_DESFIREEV1COMMANDS_HPP
 
#include <logicalaccess/plugins/cards/desfire/desfirecommands.hpp>
#include <logicalaccess/plugins/cards/desfire/desfireev1location.hpp>
#include <logicalaccess/plugins/cards/iso7816/iso7816commands.hpp>
 
namespace logicalaccess
{
#ifndef DFEV1_INS
#define DFEV1_INS
 
#define DFEV1_DESFIRE_AID "\xd2\x76\x00\x00\x85\x01\x00"
 
#define DFEV1_INS_FREE_MEM 0x6E
#define DFEV1_INS_GET_DF_NAMES 0x6D
#define DFEV1_INS_GET_CARD_UID 0x51
#define DFEV1_INS_GET_ISO_FILE_IDS 0x61
#define DFEV1_INS_SET_CONFIGURATION 0x5C
 
#define DFEV1_INS_AUTHENTICATE_ISO 0x1A
#define DFEV1_INS_AUTHENTICATE_AES 0xAA
 
#define SELECT_FILE_BY_AID 0x04
#define SELECT_FILE_BY_FID 0x00
#endif
 
#define CMD_DESFIRE_EV1 "DESFireEV1"
 
struct DFName
{
    unsigned int AID;
    unsigned short FID;
    char DF_Name[64];
};
 
typedef enum { FIDS_NO_ISO_FID = 0x00, FIDS_ISO_FID = 0x20 } FidSupport;
 
typedef enum {
    DFEV1_CMD_PLAIN  = 0x00,
    DFEV1_CMD_NOMACV = 0x01,
    DFEV1_CMD_MACV   = 0x02
} DESFireEV1TransmissionMode;
 
typedef enum {
    DF_ALG_BY_CONTEXT = 0x00,
    DF_ALG_2K3DES     = 0x02,
    DF_ALG_3K3DES     = 0x04,
    DF_ALG_AES        = 0x09
} DESFireISOAlgorithm;
 
class DESFireEV1Chip;
 
class LLA_CARDS_DESFIRE_API DESFireEV1Commands : public ICommands
{
  public:
    DESFireEV1Commands() = default;
 
    virtual void selectApplication(std::shared_ptr<DESFireEV1Location> location);
 
    virtual void createApplication(std::shared_ptr<DESFireEV1Location> location,
                                   DESFireKeySettings settings, unsigned char maxNbKeys);
 
    virtual void createStdDataFile(std::shared_ptr<DESFireEV1Location> location,
                                   const DESFireAccessRights &accessRights,
                                   unsigned int fileSize);
 
    virtual unsigned int getFreeMem() = 0;
 
    virtual std::vector<DFName> getDFNames() = 0;
 
    virtual std::vector<unsigned short> getISOFileIDs() = 0;
 
    virtual void selectApplication(unsigned int aid) = 0;
 
    virtual void createApplication(unsigned int aid, DESFireKeySettings settings,
                                   unsigned char maxNbKeys, DESFireKeyType cryptoMethod,
                                   FidSupport fidSupported = FIDS_NO_ISO_FID,
                                   unsigned short isoFID   = 0x00,
                                   ByteVector isoDFName = ByteVector()) = 0;
 
    virtual void getKeySettings(DESFireKeySettings &settings, unsigned char &maxNbKeys,
                                DESFireKeyType &keyType) = 0;
 
    virtual ByteVector getCardUID() = 0;
 
    virtual void createStdDataFile(unsigned char fileno, EncryptionMode comSettings,
                                   const DESFireAccessRights &accessRights,
                                   unsigned int fileSize,
                                   unsigned short isoFID = 0x00) = 0;
 
    virtual void createBackupFile(unsigned char fileno, EncryptionMode comSettings,
                                  const DESFireAccessRights &accessRights,
                                  unsigned int fileSize,
                                  unsigned short isoFID = 0x00) = 0;
 
    virtual void createLinearRecordFile(unsigned char fileno, EncryptionMode comSettings,
                                        const DESFireAccessRights &accessRights,
                                        unsigned int fileSize,
                                        unsigned int maxNumberOfRecords,
                                        unsigned short isoFID = 0x00) = 0;
 
    virtual void createCyclicRecordFile(unsigned char fileno, EncryptionMode comSettings,
                                        const DESFireAccessRights &accessRights,
                                        unsigned int fileSize,
                                        unsigned int maxNumberOfRecords,
                                        unsigned short isoFID = 0x00) = 0;
 
    virtual void authenticateISO(unsigned char keyno,
                                 DESFireISOAlgorithm algorithm = DF_ALG_2K3DES) = 0;
 
    virtual void authenticateAES(unsigned char keyno) = 0;
 
    // virtual size_t readData(int fileno, size_t offset, size_t length, void* data,
    // EncryptionMode mode) = 0;
 
    // virtual size_t readRecords(int fileno, size_t offset, size_t length, void* data,
    // EncryptionMode mode) = 0;
 
    // virtual bool changeFileSettings(int fileno, EncryptionMode comSettings,
    // DESFireAccessRights accessRights, bool plain) = 0;
 
    // virtual bool changeKeySettings(DESFireKeySettings settings) = 0;
 
    // virtual bool changeKey(unsigned char keyno, std::shared_ptr<DESFireKey> key) = 0;
 
    // virtual bool getVersion(DESFireCommands::DESFireCardVersion& dataVersion) = 0;
 
    // virtual std::vector<int> getApplicationIDs() = 0;
 
    // virtual std::vector<int> getFileIDs() = 0;
 
    // virtual bool getValue(int fileno, EncryptionMode mode, int& value) = 0;
 
    virtual void setConfiguration(bool formatCardEnabled, bool randomIdEnabled) = 0;
 
    virtual void setConfiguration(std::shared_ptr<DESFireKey> defaultKey) = 0;
 
    virtual void setConfiguration(const ByteVector &ats) = 0;
 
    virtual std::shared_ptr<ISO7816Commands> getISO7816Commands() const
    {
        return std::shared_ptr<ISO7816Commands>();
    }
 
  protected:
    std::shared_ptr<DESFireEV1Chip> getDESFireEV1Chip() const;
};
}
 
#endif /* LOGICALACCESS_DESFIREEV1CARDPROVIDER_HPP */