libese_weaver/inc/TransportFactory.h

/*
 **
 ** Copyright 2020, The Android Open Source Project
 **
 ** Licensed under the Apache License, Version 2.0 (the "License");
 ** you may not use this file except in compliance with the License.
 ** You may obtain a copy of the License at
 **
 **     http://www.apache.org/licenses/LICENSE-2.0
 **
 ** Unless required by applicable law or agreed to in writing, software
 ** distributed under the License is distributed on an "AS IS" BASIS,
 ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 ** See the License for the specific language governing permissions and
 ** limitations under the License.
 */
/******************************************************************************
 **
 ** The original Work has been changed by NXP.
 **
 ** Licensed under the Apache License, Version 2.0 (the "License");
 ** you may not use this file except in compliance with the License.
 ** You may obtain a copy of the License at
 **
 ** http://www.apache.org/licenses/LICENSE-2.0
 **
 ** Unless required by applicable law or agreed to in writing, software
 ** distributed under the License is distributed on an "AS IS" BASIS,
 ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 ** See the License for the specific language governing permissions and
 ** limitations under the License.
 **
 ** Copyright 2020-2023 NXP
 **
 *********************************************************************************/

#ifndef __SE_TRANSPORT_FACTORY__
#define __SE_TRANSPORT_FACTORY__

#include "HalToHalTransport.h"
#include "OmapiTransport.h"
#include "SocketTransport.h"

namespace se_transport {

using keymint::javacard::HalToHalTransport;
using keymint::javacard::ITransport;
using keymint::javacard::SocketTransport;
#ifdef OMAPI_TRANSPORT
using keymint::javacard::OmapiTransport;
#endif

/**
 * TransportFactory class decides which transport mechanism to be used to send data to secure element. In case of
 * emulator the communication channel is socket and in case of device the communication channel is via OMAPI.
 */
class TransportFactory {
    public:
    TransportFactory(bool isEmulator, const std::vector<uint8_t>& mAppletAID) {
        if (!isEmulator) {
#ifdef OMAPI_TRANSPORT
            mTransport = OmapiTransport::make(mAppletAID);
#else
            mTransport = std::shared_ptr<HalToHalTransport>(new HalToHalTransport(mAppletAID));
#endif
        }
#ifndef NXP_EXTNS
        else
            mTransport = std::shared_ptr<SocketTransport>(new SocketTransport(mAppletAID));
#endif
    }

    ~TransportFactory() {}

    /**
     * Sets Applet AID.
     */
    inline bool setAppletAid(const std::vector<uint8_t> &aid) {
        return mTransport->setAppletAid(aid);
    }

    /**
     * Establishes a communication channel with the secure element.
     */
    inline bool openConnection() {
        return mTransport->openConnection();
    }

    /**
     * Sends the data to the secure element and also receives back the data.
     * This is a blocking call.
     */
    inline bool sendData(const uint8_t* inData, const size_t inLen, std::vector<uint8_t>& output) {
        std::vector input(inData, inData + inLen);
        return mTransport->sendData(input, output);
    }

    /**
     * Close the connection.
     */
    inline bool closeConnection() {
        return mTransport->closeConnection();
    }

    /**
     * Returns the connection status of the communication channel.
     */
    inline bool isConnected() {
        return mTransport->isConnected();
    }

    private:
    /**
     * Holds the instance of either OmapiTransport class or SocketTransport class.
     */
    std::shared_ptr<ITransport> mTransport;

};
} // namespace se_transport
#endif /* __SE_TRANSPORT_FACTORY__ */