AesGcmEncryptor.hpp

Go to the documentation of this file.

// ======================================================================
// \title  AesGcmEncryptor.hpp
// \author cadena and claradavisb
// \brief  hpp file for AesGcmEncryptor component implementation class
// ======================================================================

#ifndef Svc_Ccsds_AesGcmEncryptor_HPP
#define Svc_Ccsds_AesGcmEncryptor_HPP

#include "Svc/Ccsds/AesGcmEncryptor/AesGcmEncryptorComponentAc.hpp"
#include "Svc/Ccsds/Types/FppConstantsAc.hpp"
#include "Svc/Ccsds/Types/TMHeaderSerializableAc.hpp"
#include "Svc/Ccsds/Types/TMTrailerSerializableAc.hpp"
#include "Svc/Ccsds/Utils/SdlsAuthMask.hpp"

#include <openssl/evp.h>

namespace Svc {

namespace Ccsds {

class AesGcmEncryptor final : public AesGcmEncryptorComponentBase {
    enum class BufferOwnershipState {
        NOT_OWNED,  
        OWNED,      
    };

  public:
    static constexpr FwSizeType MAX_OUTPUT_SIZE =
        ComCfg::TmFrameFixedSize - TMHeader::SERIALIZED_SIZE - TMTrailer::SERIALIZED_SIZE - sizeof(U16);

    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    explicit AesGcmEncryptor(const char* const compName  
    );

    ~AesGcmEncryptor();

    AesGcmEncryptor(const AesGcmEncryptor&) = delete;
    AesGcmEncryptor& operator=(const AesGcmEncryptor&) = delete;
    AesGcmEncryptor(AesGcmEncryptor&&) = delete;
    AesGcmEncryptor& operator=(AesGcmEncryptor&&) = delete;

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for typed input ports
    // ----------------------------------------------------------------------

    void encryptIn_handler(FwIndexType portNum,  
                           U16 securityAssociationIndex,
                           Fw::Buffer& data,
                           const ComCfg::FrameContext& context) override;

    void encryptReturnIn_handler(FwIndexType portNum,  
                                 Fw::Buffer& data,
                                 const ComCfg::FrameContext& context) override;

    // ----------------------------------------------------------------------
    // Helpers
    // ----------------------------------------------------------------------

    void failFrame(Fw::Buffer& data, const ComCfg::FrameContext& context, Svc::Ccsds::SdlsStatus status);

  private:
    // ----------------------------------------------------------------------
    // Member variables
    // ----------------------------------------------------------------------

    U8 m_outBuf[ComCfg::TmFrameFixedSize];

    BufferOwnershipState m_bufferState;

    EVP_CIPHER* m_cipher;

    EVP_CIPHER_CTX* m_ctx;

    Svc::Ccsds::Utils::SdlsTmAuthMask m_aad;

    U8 m_aadVcId;

    U16 m_aadSaIndex;
};

}  // namespace Ccsds

}  // namespace Svc

#endif