LegacySam.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 <string>
#include <vector>
 
#include "keypop/calypso/crypto/legacysam/CounterIncrementAccess.hpp"
#include "keypop/calypso/crypto/legacysam/SystemKeyType.hpp"
#include "keypop/calypso/crypto/legacysam/sam/KeyParameter.hpp"
#include "keypop/calypso/crypto/legacysam/sam/SamParameters.hpp"
#include "keypop/reader/selection/spi/SmartCard.hpp"
 
namespace keypop {
namespace calypso {
namespace crypto {
namespace legacysam {
namespace sam {
 
using keypop::reader::selection::spi::SmartCard;
 
class LegacySam : public SmartCard {
public:
    enum class ProductType {
        SAM_C1,
 
        HSM_C1,
 
        SAM_S1E1,
 
        SAM_S1DX,
 
        UNKNOWN,
 
        NONE
    };
 
    virtual ProductType getProductType() const = 0;
 
    virtual std::string getProductInfo() const = 0;
 
    virtual const std::vector<uint8_t>& getSerialNumber() 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 std::shared_ptr<int> getCounter(const int counterNumber) const = 0;
 
    virtual const std::map<const int, int>& getCounters() const = 0;
 
    virtual CounterIncrementAccess
    getCounterIncrementAccess(const int counterNumber) const = 0;
 
    virtual std::shared_ptr<int>
    getCounterCeiling(const int counterNumber) const = 0;
 
    virtual const std::map<const int, int>& getCounterCeilings() const = 0;
 
    virtual const std::vector<uint8_t>& getCaCertificate() const = 0;
 
    virtual std::shared_ptr<SamParameters> getSamParameters() const = 0;
 
    virtual std::shared_ptr<KeyParameter>
    getSystemKeyParameter(const SystemKeyType systemKeyType) const = 0;
 
    virtual std::shared_ptr<KeyParameter>
    getWorkKeyParameter(const int recordNumber) const = 0;
 
    virtual std::shared_ptr<KeyParameter>
    getWorkKeyParameter(const uint8_t kif, const uint8_t kvc) const = 0;
};
 
} /* namespace sam */
} /* namespace legacysam */
} /* namespace crypto */
} /* namespace calypso */
} /* namespace keypop */