CmdCardOpenSession.h

Go to the documentation of this file.

/**************************************************************************************************
 * Copyright (c) 2021 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 <map>
#include <memory>
#include <vector>
 
/* Calypsonet Terminal Calypso */
#include "CalypsoCard.h"
 
/* Keyple Card Calypso */
#include "AbstractApduCommand.h"
#include "AbstractCardCommand.h"
#include "CalypsoCardClass.h"
 
/* Keyple Core Util */
#include "LoggerFactory.h"
 
namespace keyple {
namespace card {
namespace calypso {
 
using namespace calypsonet::terminal::calypso::card;
using namespace keyple::core::util::cpp;
 
using StatusProperties = AbstractApduCommand::StatusProperties;
 
class CmdCardOpenSession final : public AbstractCardCommand {
public:
    CmdCardOpenSession(const CalypsoCard::ProductType productType,
                       const uint8_t keyIndex,
                       const std::vector<uint8_t>& samChallenge,
                       const uint8_t sfi,
                       const uint8_t recordNumber,
                       const bool isExtendedModeAllowed);
 
    void createRev3(const uint8_t keyIndex,
                    const std::vector<uint8_t>& samChallenge,
                    const uint8_t sfi,
                    const uint8_t recordNumber);
 
    void createRev24(const uint8_t keyIndex,
                     const std::vector<uint8_t>& samChallenge,
                     const uint8_t sfi,
                     const uint8_t recordNumber);
 
    void createRev10(const uint8_t keyIndex,
                     const std::vector<uint8_t>& samChallenge,
                     const uint8_t sfi,
                     const uint8_t recordNumber);
 
    void buildLegacyApduRequest(const uint8_t keyIndex,
                                const std::vector<uint8_t>& samChallenge,
                                const uint8_t sfi,
                                const uint8_t recordNumber,
                                const uint8_t p1) ;
 
    bool isSessionBufferUsed() const override;
 
    uint8_t getSfi() const;
 
    uint8_t getRecordNumber() const;
 
    CmdCardOpenSession& setApduResponse(const std::shared_ptr<ApduResponseApi> apduResponse)
        override;
 
    void parseRev3(const std::vector<uint8_t>& apduResponseData);
 
    void parseRev24(const std::vector<uint8_t>& apduResponseData);
 
    void parseRev10(const std::vector<uint8_t>& apduResponseData);
 
    const std::vector<uint8_t>& getCardChallenge() const;
 
    int getTransactionCounterValue() const;
 
    bool wasRatified() const;
 
    bool isManageSecureSessionAuthorized() const;
 
    const std::shared_ptr<uint8_t> getSelectedKif() const;
 
    const std::shared_ptr<uint8_t> getSelectedKvc() const;
 
    const std::vector<uint8_t>& getRecordDataRead() const;
 
    const std::map<const int, const std::shared_ptr<StatusProperties>>& getStatusTable() const
        override;
 
private:
    class SecureSession {
    public:
        friend class CmdCardOpenSession;
 
        const std::vector<uint8_t>& getChallengeTransactionCounter() const;
 
        const std::vector<uint8_t>& getChallengeRandomNumber() const;
 
        bool isPreviousSessionRatified() const;
 
        bool isManageSecureSessionAuthorized() const;
 
        const std::shared_ptr<uint8_t> getKIF() const;
 
        const std::shared_ptr<uint8_t> getKVC() const;
 
        const std::vector<uint8_t>& getOriginalData() const;
 
        const std::vector<uint8_t>& getSecureSessionData() const;
 
    private:
        const std::vector<uint8_t> mChallengeTransactionCounter;
 
        const std::vector<uint8_t> mChallengeRandomNumber;
 
        const bool mPreviousSessionRatified;
 
        const bool mManageSecureSessionAuthorized;
 
        const std::shared_ptr<uint8_t> mKif;
 
        const std::shared_ptr<uint8_t> mKvc;
 
        const std::vector<uint8_t> mOriginalData;
 
        const std::vector<uint8_t> mSecureSessionData;
 
        SecureSession(const std::vector<uint8_t>& challengeTransactionCounter,
                      const std::vector<uint8_t>& challengeRandomNumber,
                      const bool previousSessionRatified,
                      const bool manageSecureSessionAuthorized,
                      const std::shared_ptr<uint8_t> kif,
                      const std::shared_ptr<uint8_t> kvc,
                      const std::vector<uint8_t>& originalData,
                      const std::vector<uint8_t>& secureSessionData);
    };
 
    const std::unique_ptr<Logger> mLogger = LoggerFactory::getLogger(typeid(CmdCardOpenSession));
 
    static const std::map<const int, const std::shared_ptr<StatusProperties>> STATUS_TABLE;
 
    const CalypsoCard::ProductType mProductType = CalypsoCard::ProductType::UNKNOWN;
 
    const bool mIsExtendedModeAllowed = false;
 
    uint8_t mSfi = 0;
 
    uint8_t mRecordNumber = 0;
 
    std::shared_ptr<SecureSession> mSecureSession = nullptr;
 
    static const std::map<const int, const std::shared_ptr<StatusProperties>> initStatusTable();
};
 
}
}
}