CalypsoCard.hpp

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2025 Calypso Networks Association https://calypsonet.org/    *
 *                                                                            *
 * This program and the accompanying materials are made available under the   *
 * terms of the MIT License which is available at                             *
 * https://opensource.org/licenses/MIT.                                       *
 *                                                                            *
 * SPDX-License-Identifier: MIT                                               *
 ******************************************************************************/
 
#pragma once
 
#include <cstdint>
#include <map>
#include <memory>
#include <ostream>
#include <vector>
 
#include "keypop/reader/selection/spi/IsoSmartCard.hpp"
 
namespace keypop {
namespace calypso {
namespace card {
namespace card {
 
class CalypsoCard : public IsoSmartCard {
public:
    enum class ProductType {
        PRIME_REVISION_1,
 
        PRIME_REVISION_2,
 
        PRIME_REVISION_3,
 
        LIGHT,
 
        BASIC,
 
        UNKNOWN
    };
 
    virtual const ProductType& getProductType() const = 0;
 
    virtual bool isHce() const = 0;
 
    virtual bool isDfInvalidated() const = 0;
 
    virtual const std::vector<uint8_t>& getDfName() const = 0;
 
    virtual const std::vector<uint8_t> getApplicationSerialNumber() const = 0;
 
    virtual const std::vector<uint8_t>& getStartupInfoRawData() const = 0;
 
    virtual uint8_t getPlatform() const = 0;
 
    virtual uint8_t getApplicationType() const = 0;
 
    virtual uint8_t getApplicationSubtype() const = 0;
 
    virtual uint8_t getSoftwareIssuer() const = 0;
 
    virtual uint8_t getSoftwareVersion() const = 0;
 
    virtual uint8_t getSoftwareRevision() const = 0;
 
    virtual uint8_t getSessionModification() const = 0;
 
    virtual const std::vector<uint8_t> getTraceabilityInformation() const = 0;
 
    virtual const std::shared_ptr<DirectoryHeader>
    getDirectoryHeader() const = 0;
 
    virtual const std::shared_ptr<ElementaryFile>
    getFileBySfi(const uint8_t sfi) const = 0;
 
    virtual const std::shared_ptr<ElementaryFile>
    getFileByLid(const uint16_t lid) const = 0;
 
    virtual const std::map<const uint8_t, const std::shared_ptr<ElementaryFile>>
    getAllFiles() const = 0;
 
    virtual const std::vector<std::shared_ptr<ElementaryFile>>&
    getFiles() const = 0;
 
    virtual bool isDfRatified() const = 0;
 
    virtual int getTransactionCounter() const = 0;
 
    virtual bool isPkiModeSupported() const = 0;
 
    virtual bool isExtendedModeSupported() const = 0;
 
    virtual bool isRatificationOnDeselectSupported() const = 0;
 
    virtual bool isPinFeatureAvailable() const = 0;
 
    virtual bool isPinBlocked() const = 0;
 
    virtual int getPinAttemptRemaining() const = 0;
 
    virtual bool isSvFeatureAvailable() const = 0;
 
    virtual int getSvBalance() const = 0;
 
    virtual int getSvLastTNum() const = 0;
 
    virtual const std::shared_ptr<SvLoadLogRecord> getSvLoadLogRecord() = 0;
 
    virtual const std::shared_ptr<SvDebitLogRecord> getSvDebitLogLastRecord()
        = 0;
 
    virtual const std::vector<std::shared_ptr<SvDebitLogRecord>>
    getSvDebitLogAllRecords() const = 0;
};
 
inline std::ostream&
operator<<(std::ostream& os, const CalypsoCard::ProductType& pt) {
    os << "PRODUCT_TYPE: ";
 
    switch (pt) {
    case CalypsoCard::ProductType::BASIC:
        os << "BASIC";
        break;
    case CalypsoCard::ProductType::LIGHT:
        os << "LIGHT";
        break;
    case CalypsoCard::ProductType::PRIME_REVISION_1:
        os << "PRIME_REVISION_1";
        break;
    case CalypsoCard::ProductType::PRIME_REVISION_2:
        os << "PRIME_REVISION_2";
        break;
    case CalypsoCard::ProductType::PRIME_REVISION_3:
        os << "PRIME_REVISION_3";
        break;
    default:
        os << "UNKNOWN";
        break;
    }
 
    return os;
}
 
} /* namespace card */
} /* namespace card */
} /* namespace calypso */
} /* namespace keypop */