file_system.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_UNIFIED_NFC_NFC_ISODEP_FILE_SYSTEM_HPP
#define M5_UNIT_UNIFIED_NFC_NFC_ISODEP_FILE_SYSTEM_HPP
#include "isoDEP.hpp"
#include "nfc/apdu/apdu.hpp"
 
namespace m5 {
namespace nfc {
namespace isodep {
class IsoDEP;
}
 
struct FCP {
    uint16_t fid{};                 
    uint16_t file_size{};           
    uint8_t file_descriptor{0x01};  
    uint8_t file_size_tag{0x80};    
 
    std::vector<uint8_t> to_tlv() const
    {
        std::vector<uint8_t> fcp;
        fcp.reserve(16);
 
        // File Descriptor (0x82)
        fcp.push_back(0x82);
        fcp.push_back(1);
        fcp.push_back(file_descriptor);
 
        // File ID (0x83)
        fcp.push_back(0x83);
        fcp.push_back(2);
        fcp.push_back(static_cast<uint8_t>((fid >> 8) & 0xFF));
        fcp.push_back(static_cast<uint8_t>(fid & 0xFF));
 
        // File Size (tag: file_size_tag)
        fcp.push_back(file_size_tag);
        fcp.push_back(2);
        fcp.push_back(static_cast<uint8_t>((file_size >> 8) & 0xFF));
        fcp.push_back(static_cast<uint8_t>(file_size & 0xFF));
 
        //
        std::vector<uint8_t> out;
        out.reserve(fcp.size() + 2);
        out.push_back(0x62);
        out.push_back(static_cast<uint8_t>(fcp.size()));
        out.insert(out.end(), fcp.begin(), fcp.end());
        return out;
    }
};
 
bool parseFCI(FCP& fcp, const uint8_t* data, const uint32_t len);
 
class FileSystem {
public:
    explicit FileSystem(m5::nfc::isodep::IsoDEP& isoDEP) : _isoDEP{isoDEP}
    {
    }
    virtual ~FileSystem() = default;
 
 
    bool createFile(const uint8_t* fcp, const uint16_t fcp_len);
    bool createFile(const FCP& fcp);
    bool createFile(const uint16_t fid, const uint16_t file_size);
 
    bool selectFile(const m5::nfc::apdu::SelectBy by, const m5::nfc::apdu::SelectOccurrence occ,
                    const m5::nfc::apdu::SelectResponse res, const uint8_t* param, const uint8_t param_len);
 
    bool selectByFileId(const uint16_t fid,
                        const m5::nfc::apdu::SelectResponse res   = m5::nfc::apdu::SelectResponse::FCI,
                        const m5::nfc::apdu::SelectOccurrence occ = m5::nfc::apdu::SelectOccurrence::FirstOrOnly);
    bool selectFileIdAuto(const uint16_t fid,
                          const m5::nfc::apdu::SelectOccurrence occ = m5::nfc::apdu::SelectOccurrence::FirstOrOnly);
    bool selectByDfName(const uint8_t* aid, const uint8_t aid_len,
                        const m5::nfc::apdu::SelectResponse res   = m5::nfc::apdu::SelectResponse::FCI,
                        const m5::nfc::apdu::SelectOccurrence occ = m5::nfc::apdu::SelectOccurrence::FirstOrOnly);
    bool selectDfNameAuto(const uint8_t* aid, const uint8_t aid_len,
                          const m5::nfc::apdu::SelectOccurrence occ = m5::nfc::apdu::SelectOccurrence::FirstOrOnly);
    bool selectByPath(const uint8_t* path, const uint8_t path_len, const bool from_mf = true,
                      const m5::nfc::apdu::SelectResponse res   = m5::nfc::apdu::SelectResponse::FCI,
                      const m5::nfc::apdu::SelectOccurrence occ = m5::nfc::apdu::SelectOccurrence::FirstOrOnly);
    bool selectParent(const m5::nfc::apdu::SelectResponse res   = m5::nfc::apdu::SelectResponse::FCI,
                      const m5::nfc::apdu::SelectOccurrence occ = m5::nfc::apdu::SelectOccurrence::FirstOrOnly);
    inline bool selectMasterFile()
    {
        return selectByFileId(m5::nfc::apdu::master_file_id);
    }
 
    bool verify(const uint8_t* password, const uint16_t pass_len, const uint8_t param2);
    inline bool verifyGlobal(const uint8_t* password, const uint16_t pass_len)
    {
        return verify(password, pass_len, 0x80);
    }
    inline bool verifySpecific(const uint8_t* password, const uint16_t pass_len)
    {
        return verify(password, pass_len, 0x00);
    }
    bool readBinary(std::vector<uint8_t>& out, const uint16_t offset, const uint16_t le /* 1..256 recommended */);
    bool updateBinary(const uint16_t offset, const uint8_t* data, const uint16_t data_len);
 
    inline const std::vector<uint8_t>& lastSelectData() const
    {
        return _last_select_fci;
    }
 
protected:
    m5::nfc::isodep::IsoDEP& _isoDEP;
    std::vector<uint8_t> _last_select_fci{};
};
 
}  // namespace nfc
}  // namespace m5
#endif