SamCommandProcessor.h

Go to the documentation of this file.

/**************************************************************************************************
 * Copyright (c) 2022 Calypso Networks Association https://calypsonet.org/                        *
 *                                                                                                *
 * See the NOTICE file(s) distributed with this work for additional information regarding         *
 * copyright ownership.                                                                           *
 *                                                                                                *
 * This program and the accompanying materials are made available under the terms of the Eclipse  *
 * Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0                  *
 *                                                                                                *
 * SPDX-License-Identifier: EPL-2.0                                                               *
 **************************************************************************************************/
 
#pragma once
 
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
/* Calypsonet Terminal Calypso */
#include "CalypsoSam.h"
#include "CardSecuritySetting.h"
 
/* Calypsonet Terminal Card */
#include "ProxyReaderApi.h"
 
/* Keyple Card Calypso */
#include "AbstractSamCommand.h"
#include "CalypsoCardAdapter.h"
#include "CmdCardSvDebit.h"
#include "CmdCardSvUndebit.h"
#include "CmdCardSvReload.h"
 
/* Keyple Core Util */
#include "LoggerFactory.h"
 
namespace keyple {
namespace card {
namespace calypso {
 
using namespace calypsonet::terminal::calypso;
using namespace calypsonet::terminal::calypso::sam;
using namespace calypsonet::terminal::calypso::transaction;
using namespace calypsonet::terminal::card;
using namespace keyple::core::util::cpp;
 
class SamCommandProcessor {
public:
    SamCommandProcessor(const std::shared_ptr<CalypsoCard> calypsoCard,
                        const std::shared_ptr<CardSecuritySetting> cardSecuritySetting);
 
    const std::vector<uint8_t> getSessionTerminalChallenge();
 
    const std::shared_ptr<uint8_t> computeKvc(const WriteAccessLevel writeAccessLevel,
                                              const std::shared_ptr<uint8_t> kvc) const;
 
    const std::shared_ptr<uint8_t> computeKif(const WriteAccessLevel writeAccessLevel,
                                              const std::shared_ptr<uint8_t> kif,
                                              const std::shared_ptr<uint8_t> kvc);
 
    void initializeDigester(const bool sessionEncryption,
                            const bool verificationMode,
                            const uint8_t kif,
                            const uint8_t kvc,
                            const std::vector<uint8_t>& digestData);
 
    void pushCardExchangedData(const std::vector<std::shared_ptr<ApduRequestSpi>>& requests,
                               const std::vector<std::shared_ptr<ApduResponseApi>>& responses,
                               const int startIndex);
 
    const std::vector<uint8_t> getTerminalSignature();
 
    void authenticateCardSignature(const std::vector<uint8_t>& cardSignatureLo);
 
    const std::vector<uint8_t> getEncryptedKey(const std::vector<uint8_t>& poChallenge,
                                               const uint8_t cipheringKif,
                                               const uint8_t cipheringKvc,
                                               const uint8_t sourceKif,
                                               const uint8_t sourceKvc);
 
    const std::vector<uint8_t> getCipheredPinData(const std::vector<uint8_t>& poChallenge,
                                                  const std::vector<uint8_t>& currentPin,
                                                  const std::vector<uint8_t>& newPin);
 
    const std::vector<uint8_t> getSvReloadComplementaryData(
        const std::shared_ptr<CmdCardSvReload> cmdCardSvReload,
        const std::vector<uint8_t>& svGetHeader,
        const std::vector<uint8_t>& svGetData);
 
    const std::vector<uint8_t> getSvDebitComplementaryData(
        const std::shared_ptr<CmdCardSvDebit> cmdCardSvDebit,
        const std::vector<uint8_t>& svGetHeader,
        const std::vector<uint8_t>& svGetData);
 
    const std::vector<uint8_t> getSvUndebitComplementaryData(
        const std::shared_ptr<CmdCardSvUndebit> cmdCardSvUndebit,
        const std::vector<uint8_t>& svGetHeader,
        const std::vector<uint8_t>& svGetData);
 
    void checkSvStatus(const std::vector<uint8_t>& svOperationResponseData);
 
private:
    const std::unique_ptr<Logger> mLogger = LoggerFactory::getLogger(typeid(SamCommandProcessor));
 
    static const uint8_t KIF_UNDEFINED;
    static const uint8_t CHALLENGE_LENGTH_REV_INF_32;
    static const uint8_t CHALLENGE_LENGTH_REV32;
    static const uint8_t SIGNATURE_LENGTH_REV_INF_32;
    static const uint8_t SIGNATURE_LENGTH_REV32;
    static const std::string UNEXPECTED_EXCEPTION;
 
    std::shared_ptr<ProxyReaderApi> mSamReader;
 
    const std::shared_ptr<CardSecuritySetting> mCardSecuritySettings;
 
    static std::vector<std::vector<uint8_t>> mCardDigestDataCache;
 
    const std::shared_ptr<CalypsoCardAdapter> mCalypsoCard;
 
    std::vector<uint8_t> mSamSerialNumber;
 
    CalypsoSam::ProductType mSamProductType;
 
    bool mSessionEncryption;
 
    bool mVerificationMode;
 
    uint8_t mKif;
 
    uint8_t mKvc;
 
    bool mIsDiversificationDone;
 
    bool mIsDigestInitDone;
 
    bool mIsDigesterInitialized;
 
    void pushCardExchangedData(const std::shared_ptr<ApduRequestSpi> request,
                               const std::shared_ptr<ApduResponseApi> response);
 
    const std::vector<std::shared_ptr<AbstractSamCommand>> getPendingSamCommands(
        const bool addDigestClose);
 
    const std::vector<std::shared_ptr<ApduRequestSpi>> getApduRequests(
        const std::vector<std::shared_ptr<AbstractSamCommand>> samCommands) const;
 
    const std::vector<uint8_t> getSvComplementaryData(
        const std::shared_ptr<AbstractSamCommand> cmdSamSvPrepare);
};
 
}
}
}