SslHttpSession.hpp

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2023, the clio developers.
 
    Permission to use, copy, modify, and distribute this software for any
    purpose with or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#pragma once
 
#include "data/LedgerCacheInterface.hpp"
#include "util/Taggable.hpp"
#include "web/AdminVerificationStrategy.hpp"
#include "web/ProxyIpResolver.hpp"
#include "web/SslWsSession.hpp"
#include "web/dosguard/DOSGuardInterface.hpp"
#include "web/impl/HttpBase.hpp"
#include "web/interface/Concepts.hpp"
#include "web/interface/ConnectionBase.hpp"
 
#include <boost/asio/ip/tcp.hpp>
#include <boost/asio/ssl/context.hpp>
#include <boost/asio/ssl/stream_base.hpp>
#include <boost/beast/core/error.hpp>
#include <boost/beast/core/flat_buffer.hpp>
#include <boost/beast/core/stream_traits.hpp>
#include <boost/beast/core/tcp_stream.hpp>
#include <boost/beast/ssl/ssl_stream.hpp>
 
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <utility>
 
namespace web {
 
using tcp = boost::asio::ip::tcp;

template <SomeServerHandler HandlerType>
class SslHttpSession : public impl::HttpBase<SslHttpSession, HandlerType>,
                       public std::enable_shared_from_this<SslHttpSession<HandlerType>> {
    boost::beast::ssl_stream<boost::beast::tcp_stream> stream_;
    std::reference_wrapper<util::TagDecoratorFactory const> tagFactory_;
    std::uint32_t maxWsSendingQueueSize_;
 
public:
    explicit SslHttpSession(
        tcp::socket&& socket,
        std::string const& ip,
        std::shared_ptr<AdminVerificationStrategy> const& adminVerification,
        std::shared_ptr<ProxyIpResolver> proxyIpResolver,
        boost::asio::ssl::context& ctx,
        std::reference_wrapper<util::TagDecoratorFactory const> tagFactory,
        std::reference_wrapper<dosguard::DOSGuardInterface> dosGuard,
        std::shared_ptr<HandlerType> const& handler,
        std::reference_wrapper<data::LedgerCacheInterface const> cache,
        boost::beast::flat_buffer buffer,
        std::uint32_t maxWsSendingQueueSize
    )
        : impl::HttpBase<SslHttpSession, HandlerType>(
              ip,
              tagFactory,
              adminVerification,
              std::move(proxyIpResolver),
              dosGuard,
              handler,
              cache,
              std::move(buffer)
          )
        , stream_(std::move(socket), ctx)
        , tagFactory_(tagFactory)
        , maxWsSendingQueueSize_(maxWsSendingQueueSize)
    {
    }
 
    ~SslHttpSession() override = default;

    boost::beast::ssl_stream<boost::beast::tcp_stream>&
    stream()
    {
        return stream_;
    }

    void
    run()
    {
        auto self = this->shared_from_this();
        boost::asio::dispatch(stream_.get_executor(), [self]() {
            // Set the timeout.
            boost::beast::get_lowest_layer(self->stream()).expires_after(std::chrono::seconds(30));
 
            // Perform the SSL handshake
            // Note, this is the buffered version of the handshake.
            self->stream_.async_handshake(
                boost::asio::ssl::stream_base::server,
                self->buffer_.data(),
                boost::beast::bind_front_handler(&SslHttpSession<HandlerType>::onHandshake, self)
            );
        });
    }

    void
    onHandshake(boost::beast::error_code ec, std::size_t bytesUsed)
    {
        if (ec)
            return this->httpFail(ec, "handshake");
 
        this->buffer_.consume(bytesUsed);
        this->doRead();
    }

    void
    doClose()
    {
        boost::beast::get_lowest_layer(stream_).expires_after(std::chrono::seconds(30));
        stream_.async_shutdown(boost::beast::bind_front_handler(&SslHttpSession::onShutdown, this->shared_from_this()));
    }

    void
    onShutdown(boost::beast::error_code ec)
    {
        if (ec)
            return this->httpFail(ec, "shutdown");
        // At this point the connection is closed gracefully
    }

    void
    upgrade()
    {
        std::make_shared<SslWsUpgrader<HandlerType>>(
            std::move(stream_),
            this->clientIp_,
            tagFactory_,
            this->dosGuard_,
            this->handler_,
            std::move(this->buffer_),
            std::move(this->req_),
            ConnectionBase::isAdmin(),
            maxWsSendingQueueSize_
        )
            ->run();
    }
};
}  // namespace web