desfireev1stidstrcommands.hpp

Go to the documentation of this file.

 
#ifndef LOGICALACCESS_DESFIREEV1STIDSTRCOMMANDS_HPP
#define LOGICALACCESS_DESFIREEV1STIDSTRCOMMANDS_HPP
 
#include <logicalaccess/plugins/cards/desfire/desfireev1chip.hpp>
#include <logicalaccess/plugins/cards/desfire/desfireev1commands.hpp>
#include <logicalaccess/plugins/readers/stidstr/readercardadapters/stidstrreadercardadapter.hpp>
 
#include <string>
#include <vector>
#include <iostream>
 
namespace logicalaccess
{
#define CMD_DESFIREEV1STIDSTR "DESFireEV1STidSTR"
 
typedef enum {
    STID_DF_BR_106KBPS = 0x00, 
    STID_DF_BR_212KBPS = 0x01, 
    STID_DF_BR_424KBPS = 0x02  
} STidDESFireBaudrate;
 
typedef enum {
    STID_DF_KEYLOC_RAM     = 0x00, 
    STID_DF_KEYLOC_EEPROM  = 0x01, 
    STID_DF_KEYLOC_INDEXED = 0x02  
} STidKeyLocationType;
 
class LLA_READERS_STIDSTR_API DESFireEV1STidSTRCommands : public Commands
#ifndef SWIG
                                                       ,
                                                       public DESFireEV1Commands
#endif
{
  public:
    DESFireEV1STidSTRCommands();
 
    explicit DESFireEV1STidSTRCommands(std::string);
 
 
    virtual ~DESFireEV1STidSTRCommands();
 
    ByteVector scanDESFire() const;
 
    void releaseRFIDField() const;
 
    void changePPS(STidDESFireBaudrate readerToChipKbps,
                   STidDESFireBaudrate chipToReaderKbps) const;
 
    unsigned int getFreeMem() override;
 
    std::vector<DFName> getDFNames() override;
 
    std::vector<unsigned short> getISOFileIDs() override;
 
    virtual void erase();
#ifndef SWIG
    using DESFireEV1Commands::createApplication;
#endif
 
    virtual void createApplication(unsigned int aid, DESFireKeySettings settings,
                                   unsigned char maxNbKeys);
 
    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()) override;
 
    virtual void deleteApplication(unsigned int aid);
 
    void selectApplication(unsigned int aid) override;
 
    virtual void getKeySettings(DESFireKeySettings &settings, unsigned char &maxNbKeys);
 
    void getKeySettings(DESFireKeySettings &settings, unsigned char &maxNbKeys,
                        DESFireKeyType &keyType) override;
 
    ByteVector getCardUID() override;
#ifndef SWIG
    using DESFireEV1Commands::createStdDataFile;
#endif
 
    virtual void createStdDataFile(unsigned char fileno, EncryptionMode comSettings,
                                   const DESFireAccessRights &accessRights,
                                   unsigned int fileSize);
 
    void createStdDataFile(unsigned char fileno, EncryptionMode comSettings,
                           const DESFireAccessRights &accessRights, unsigned int fileSize,
                           unsigned short isoFID) override;
 
    virtual void commitTransaction();
 
    virtual void abortTransaction();
 
    virtual void createBackupFile(unsigned char fileno, EncryptionMode comSettings,
                                  const DESFireAccessRights &accessRights,
                                  unsigned int fileSize);
 
    void createBackupFile(unsigned char fileno, EncryptionMode comSettings,
                          const DESFireAccessRights &accessRights, unsigned int fileSize,
                          unsigned short isoFID) override;
 
    virtual void createValueFile(unsigned char fileno, EncryptionMode comSettings,
                                 const DESFireAccessRights &accessRights,
                                 int32_t lowerLimit, int32_t upperLimit,
                                 int32_t value, bool limitedCreditEnabled);
 
    virtual void createLinearRecordFile(unsigned char fileno, EncryptionMode comSettings,
                                        const DESFireAccessRights &accessRights,
                                        unsigned int fileSize,
                                        unsigned int maxNumberOfRecords);
 
    void createLinearRecordFile(unsigned char fileno, EncryptionMode comSettings,
                                const DESFireAccessRights &accessRights,
                                unsigned int fileSize, unsigned int maxNumberOfRecords,
                                unsigned short isoFID) override;
 
    virtual void createCyclicRecordFile(unsigned char fileno, EncryptionMode comSettings,
                                        const DESFireAccessRights &accessRights,
                                        unsigned int fileSize,
                                        unsigned int maxNumberOfRecords);
 
    void createCyclicRecordFile(unsigned char fileno, EncryptionMode comSettings,
                                const DESFireAccessRights &accessRights,
                                unsigned int fileSize, unsigned int maxNumberOfRecords,
                                unsigned short isoFID) override;
 
    virtual void loadKey(std::shared_ptr<DESFireKey> key);
 
    virtual void loadKey(ByteVector key, bool diversify, bool isVolatile);
 
    virtual void authenticate(STidKeyLocationType keylocation, unsigned char keyno,
                              DESFireKeyType cryptoMethod, unsigned char keyindex);
 
    virtual void authenticate(unsigned char keyno);
 
    virtual void authenticate(unsigned char keyno, std::shared_ptr<DESFireKey> key);
 
    void authenticateISO(unsigned char keyno,
                         DESFireISOAlgorithm algorithm = DF_ALG_2K3DES) override;
 
    void authenticateAES(unsigned char keyno) override;
 
    virtual ByteVector readData(unsigned char fileno, unsigned int offset,
                                unsigned int length, EncryptionMode mode);
 
    virtual void writeData(unsigned char fileno, unsigned int offset,
                           const ByteVector &data, EncryptionMode mode);
 
    virtual void credit(unsigned char fileno, unsigned int value, EncryptionMode mode);
 
    virtual void debit(unsigned char fileno, unsigned int value, EncryptionMode mode);
 
    virtual void limitedCredit(unsigned char fileno, unsigned int value,
                               EncryptionMode mode);
 
    virtual void writeRecord(unsigned char fileno, unsigned int offset,
                             const ByteVector &data, EncryptionMode mode);
 
    virtual ByteVector readRecords(unsigned char fileno, unsigned int offset,
                                   unsigned int length, EncryptionMode mode);
 
    virtual void clearRecordFile(unsigned char fileno);
 
    virtual void changeFileSettings(unsigned char fileno, EncryptionMode comSettings,
                                    const DESFireAccessRights &accessRights, bool plain);
 
    virtual void deleteFile(unsigned char fileno);
 
    virtual void changeKeySettings(DESFireKeySettings settings);
 
    virtual void changeKey(unsigned char keyno, std::shared_ptr<DESFireKey> key);
 
    void changeKeyIndex(unsigned char keyno, DESFireKeyType cryptoMethod,
                        unsigned char keyversion, unsigned char newkeyindex,
                        unsigned char oldkeyindex) const;
 
    unsigned char getKeyVersion(unsigned char keyno) const;
 
    virtual void getVersion(DESFireCommands::DESFireCardVersion &dataVersion);
 
    virtual std::vector<unsigned int> getApplicationIDs();
 
    virtual ByteVector getFileIDs();
 
    virtual void getFileSettings(unsigned char fileno,
                                 DESFireCommands::FileSetting &fileSetting);
 
    virtual void getValue(unsigned char fileno, EncryptionMode mode, unsigned int &value);
 
    void setConfiguration(bool formatCardEnabled, bool randomIdEnabled) override;
 
    void setConfiguration(std::shared_ptr<DESFireKey> defaultKey) override;
 
    void setConfiguration(const ByteVector &ats) override;
 
    std::shared_ptr<Chip> getChip() const override
    {
        return Commands::getChip();
    }
 
    std::shared_ptr<ReaderCardAdapter> getReaderCardAdapter() const override
    {
        return Commands::getReaderCardAdapter();
    }
 
 
    std::shared_ptr<STidSTRReaderCardAdapter> getSTidSTRReaderCardAdapter() const
    {
        return std::dynamic_pointer_cast<STidSTRReaderCardAdapter>(
            getReaderCardAdapter());
    }
 
    static std::string STidKeyLocationTypeStr(STidKeyLocationType t);
 
  protected:
    unsigned int d_currentAid;
};
}
 
#endif /* LOGICALACCESS_DESFIREEV1STIDSTRCOMMANDS_H */