SymmetricCryptoCardTransactionManagerSpi.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 <memory>
#include <vector>
 
#include "keypop/calypso/crypto/symmetric/SvCommandSecurityDataApi.hpp"
#include "keypop/calypso/crypto/symmetric/SymmetricCryptoException.hpp"
#include "keypop/calypso/crypto/symmetric/SymmetricCryptoIOException.hpp"
 
namespace keypop {
namespace calypso {
namespace crypto {
namespace symmetric {
namespace spi {
 
class SymmetricCryptoCardTransactionManagerSpi {
public:
    virtual std::vector<uint8_t> initTerminalSecureSessionContext() = 0;
 
    virtual void initTerminalSessionMac(
        const std::vector<uint8_t>& openSecureSessionDataOut,
        const uint8_t kif,
        const uint8_t kvc)
        = 0;
 
    virtual std::vector<uint8_t>
    updateTerminalSessionMac(const std::vector<uint8_t>& cardApdu)
        = 0;
 
    virtual std::vector<uint8_t> finalizeTerminalSessionMac() = 0;
 
    virtual std::vector<uint8_t> generateTerminalSessionMac() = 0;
 
    virtual void activateEncryption() = 0;
 
    virtual void deactivateEncryption() = 0;
 
    virtual bool
    isCardSessionMacValid(const std::vector<uint8_t>& cardSessionMac)
        = 0;
 
    virtual void computeSvCommandSecurityData(
        const std::shared_ptr<SvCommandSecurityDataApi> data)
        = 0;
 
    virtual bool isCardSvMacValid(const std::vector<uint8_t>& cardSvMac) = 0;
 
    virtual std::vector<uint8_t> cipherPinForPresentation(
        const std::vector<uint8_t>& cardChallenge,
        const std::vector<uint8_t>& pin,
        const std::shared_ptr<uint8_t> kif,
        const std::shared_ptr<uint8_t> kvc)
        = 0;
 
    virtual std::vector<uint8_t> cipherPinForModification(
        const std::vector<uint8_t>& cardChallenge,
        const std::vector<uint8_t>& currentPin,
        const std::vector<uint8_t>& newPin,
        const std::shared_ptr<uint8_t> kif,
        const std::shared_ptr<uint8_t> kvc)
        = 0;
 
    virtual std::vector<uint8_t> generateCipheredCardKey(
        const std::vector<uint8_t>& cardChallenge,
        const uint8_t issuerKeyKif,
        const uint8_t issuerKeyKvc,
        const uint8_t targetKeyKif,
        const uint8_t targetKeyKvc)
        = 0;
 
    virtual void synchronize() = 0;
};
 
} /* namespace spi */
} /* namespace symmetric */
} /* namespace crypto */
} /* namespace calypso */
} /* namespace keypop */