ssl_session.cpp

Go to the documentation of this file.

 
#include "server/asio/ssl_session.h"
#include "server/asio/ssl_server.h"
 
namespace CppServer {
namespace Asio {
 
SSLSession::SSLSession(const std::shared_ptr<SSLServer>& server)
    : _id(CppCommon::UUID::Sequential()),
      _server(server),
      _io_context(server->service()->GetAsioContext()),
      _strand(*_io_context),
      _strand_required(_server->_strand_required),
      _stream(*_io_context, *server->context()),
      _connected(false),
      _handshaked(false),
      _shutting(false),
      _bytes_pending(0),
      _bytes_sending(0),
      _bytes_sent(0),
      _bytes_received(0),
      _receiving(false),
      _sending(false),
      _send_buffer_flush_offset(0)
{
}
 
size_t SSLSession::option_receive_buffer_size() const
{
    asio::socket_base::receive_buffer_size option;
    _stream.next_layer().get_option(option);
    return option.value();
}
 
size_t SSLSession::option_send_buffer_size() const
{
    asio::socket_base::send_buffer_size option;
    _stream.next_layer().get_option(option);
    return option.value();
}
 
void SSLSession::SetupReceiveBufferSize(size_t size)
{
    asio::socket_base::receive_buffer_size option((int)size);
    socket().set_option(option);
}
 
void SSLSession::SetupSendBufferSize(size_t size)
{
    asio::socket_base::send_buffer_size option((int)size);
    socket().set_option(option);
}
 
void SSLSession::Connect()
{
    // Apply the option: keep alive
    if (_server->option_keep_alive())
        socket().set_option(asio::ip::tcp::socket::keep_alive(true));
    // Apply the option: no delay
    if (_server->option_no_delay())
        socket().set_option(asio::ip::tcp::no_delay(true));
 
    // Prepare receive & send buffers
    _receive_buffer.resize(std::max(option_receive_buffer_size(), MIN_RECEIVE_BUFFER_SIZE));
    _send_buffer_main.reserve(std::max(option_send_buffer_size(), MIN_SEND_BUFFER_SIZE));
    _send_buffer_flush.reserve(std::max(option_send_buffer_size(), MIN_SEND_BUFFER_SIZE));
 
    // Reset statistic
    _bytes_pending = 0;
    _bytes_sending = 0;
    _bytes_sent = 0;
    _bytes_received = 0;
 
    // Call the session connecting handler
    onConnecting();
 
    // Update the connected flag
    _connected = true;
 
    // Call the session connected handler
    onConnected();
 
    // Call the session connected handler in the server
    auto connected_session(this->shared_from_this());
    _server->onConnected(connected_session);
 
    // Call the session handshaking handler
    onHandshaking();
 
    // Async SSL handshake with the handshake handler
    auto self(this->shared_from_this());
    auto async_handshake_handler = [this, self](std::error_code ec)
    {
        if (IsHandshaked())
            return;
 
        if (!ec)
        {
            // Update the handshaked flag
            _handshaked = true;
 
            // Try to receive something from the client
            TryReceive();
 
            // Call the session handshaked handler
            onHandshaked();
 
            // Call the session handshaked handler in the server
            auto handshaked_session(this->shared_from_this());
            _server->onHandshaked(handshaked_session);
 
            // Call the empty send buffer handler
            if (_send_buffer_main.empty())
                onEmpty();
        }
        else
        {
            // Disconnect in case of the bad handshake
            SendError(ec);
            Disconnect(ec);
        }
    };
    if (_strand_required)
        _stream.async_handshake(asio::ssl::stream_base::server, bind_executor(_strand, async_handshake_handler));
    else
        _stream.async_handshake(asio::ssl::stream_base::server, async_handshake_handler);
}
 
void SSLSession::Disconnect(std::error_code ec)
{
    if (!IsConnected())
        return;
 
    // Call the session disconnecting handler
    onDisconnecting();
 
    // Close the session socket
    socket().close();
 
    // Update the handshaked flag
    _handshaked = false;
 
    // Update the connected flag
    _connected = false;
    _shutting = false;
 
    // Update sending/receiving flags
    _receiving = false;
    _sending = false;
 
    // Clear send/receive buffers
    ClearBuffers();
 
    // Call the session disconnected handler
    onDisconnected();
 
    // Call the session disconnected handler in the server
    auto disconnected_session(this->shared_from_this());
    _server->onDisconnected(disconnected_session);
 
    // Dispatch the unregister session handler
    auto self(this->shared_from_this());
    auto unregister_session_handler = [this, self]()
    {
        _server->UnregisterSession(id());
    };
    if (_server->_strand_required)
        asio::dispatch(_server->_strand, unregister_session_handler);
    else
        asio::dispatch(*_server->_io_context, unregister_session_handler);
}
 
bool SSLSession::DisconnectAsync(bool dispatch)
{
    if (!IsConnected() || _shutting)
        return false;
 
    // Dispatch or post the disconnect handler
    auto self(this->shared_from_this());
    auto disconnect_handler = [this, self]()
    {
        if (!IsConnected() || _shutting)
            return;
 
        _shutting = true;
 
        asio::error_code ec;
 
        // Cancel the session socket
        socket().cancel(ec);
 
        // Async SSL shutdown with the shutdown handler
        auto async_shutdown_handler = [this, self](std::error_code ec2)
        {
            _shutting = false;
 
            Disconnect(ec2);
        };
        if (_strand_required)
            _stream.async_shutdown(bind_executor(_strand, async_shutdown_handler));
        else
            _stream.async_shutdown(async_shutdown_handler);
    };
    if (_strand_required)
    {
        if (dispatch)
            asio::dispatch(_strand, disconnect_handler);
        else
            asio::post(_strand, disconnect_handler);
    }
    else
    {
        if (dispatch)
            asio::dispatch(*_io_context, disconnect_handler);
        else
            asio::post(*_io_context, disconnect_handler);
    }
 
    return true;
}
 
size_t SSLSession::Send(const void* buffer, size_t size)
{
    if (!IsHandshaked())
        return 0;
 
    if (size == 0)
        return 0;
 
    assert((buffer != nullptr) && "Pointer to the buffer should not be null!");
    if (buffer == nullptr)
        return 0;
 
    asio::error_code ec;
 
    // Send data to the client
    size_t sent = asio::write(_stream, asio::buffer(buffer, size), ec);
    if (sent > 0)
    {
        // Update statistic
        _bytes_sent += sent;
        _server->_bytes_sent += sent;
 
        // Call the buffer sent handler
        onSent(sent, bytes_pending());
    }
 
    // Disconnect on error
    if (ec)
    {
        SendError(ec);
        Disconnect(ec);
    }
 
    return sent;
}
 
size_t SSLSession::Send(const void* buffer, size_t size, const CppCommon::Timespan& timeout)
{
    if (!IsHandshaked())
        return 0;
 
    if (size == 0)
        return 0;
 
    assert((buffer != nullptr) && "Pointer to the buffer should not be null!");
    if (buffer == nullptr)
        return 0;
 
    int done = 0;
    std::mutex mtx;
    std::condition_variable cv;
    asio::error_code error;
    asio::system_timer timer(_stream.get_executor());
 
    // Prepare done handler
    auto async_done_handler = [&](asio::error_code ec)
    {
        std::unique_lock<std::mutex> lck(mtx);
        if (done++ == 0)
        {
            error = ec;
            socket().cancel();
            timer.cancel();
        }
        cv.notify_one();
    };
 
    // Async wait for timeout
    timer.expires_after(timeout.chrono());
    timer.async_wait([&](const asio::error_code& ec) { async_done_handler(ec ? ec : asio::error::timed_out); });
 
    // Async write some data to the client
    size_t sent = 0;
    _stream.async_write_some(asio::buffer(buffer, size), [&](std::error_code ec, size_t write) { async_done_handler(ec); sent = write; });
 
    // Wait for complete or timeout
    std::unique_lock<std::mutex> lck(mtx);
    cv.wait(lck, [&]() { return done == 2; });
 
    // Send data to the client
    if (sent > 0)
    {
        // Update statistic
        _bytes_sent += sent;
        _server->_bytes_sent += sent;
 
        // Call the buffer sent handler
        onSent(sent, bytes_pending());
    }
 
    // Disconnect on error
    if (error && (error != asio::error::timed_out))
    {
        SendError(error);
        Disconnect(error);
    }
 
    return sent;
}
 
bool SSLSession::SendAsync(const void* buffer, size_t size)
{
    if (!IsHandshaked())
        return false;
 
    if (size == 0)
        return true;
 
    assert((buffer != nullptr) && "Pointer to the buffer should not be null!");
    if (buffer == nullptr)
        return false;
 
    {
        std::scoped_lock locker(_send_lock);
 
        // Detect multiple send handlers
        bool send_required = _send_buffer_main.empty() || _send_buffer_flush.empty();
 
        // Check the send buffer limit
        if (((_send_buffer_main.size() + size) > _send_buffer_limit) && (_send_buffer_limit > 0))
        {
            SendError(asio::error::no_buffer_space);
            return false;
        }
 
        // Fill the main send buffer
        const uint8_t* bytes = (const uint8_t*)buffer;
        _send_buffer_main.insert(_send_buffer_main.end(), bytes, bytes + size);
 
        // Update statistic
        _bytes_pending = _send_buffer_main.size();
 
        // Avoid multiple send handlers
        if (!send_required)
            return true;
    }
 
    // Dispatch the send handler
    auto self(this->shared_from_this());
    auto send_handler = [this, self]()
    {
        // Try to send the main buffer
        TrySend();
    };
    if (_strand_required)
        asio::dispatch(_strand, send_handler);
    else
        asio::dispatch(*_io_context, send_handler);
 
    return true;
}
 
size_t SSLSession::Receive(void* buffer, size_t size)
{
    if (!IsHandshaked())
        return 0;
 
    if (size == 0)
        return 0;
 
    assert((buffer != nullptr) && "Pointer to the buffer should not be null!");
    if (buffer == nullptr)
        return 0;
 
    asio::error_code ec;
 
    // Receive data from the client
    size_t received = _stream.read_some(asio::buffer(buffer, size), ec);
    if (received > 0)
    {
        // Update statistic
        _bytes_received += received;
        _server->_bytes_received += received;
 
        // Call the buffer received handler
        onReceived(buffer, received);
    }
 
    // Disconnect on error
    if (ec)
    {
        SendError(ec);
        Disconnect(ec);
    }
 
    return received;
}
 
std::string SSLSession::Receive(size_t size)
{
    std::string text(size, 0);
    text.resize(Receive(text.data(), text.size()));
    return text;
}
 
size_t SSLSession::Receive(void* buffer, size_t size, const CppCommon::Timespan& timeout)
{
    if (!IsHandshaked())
        return 0;
 
    if (size == 0)
        return 0;
 
    assert((buffer != nullptr) && "Pointer to the buffer should not be null!");
    if (buffer == nullptr)
        return 0;
 
    int done = 0;
    std::mutex mtx;
    std::condition_variable cv;
    asio::error_code error;
    asio::system_timer timer(_stream.get_executor());
 
    // Prepare done handler
    auto async_done_handler = [&](asio::error_code ec)
    {
        std::unique_lock<std::mutex> lck(mtx);
        if (done++ == 0)
        {
            error = ec;
            socket().cancel();
            timer.cancel();
        }
        cv.notify_one();
    };
 
    // Async wait for timeout
    timer.expires_after(timeout.chrono());
    timer.async_wait([&](const asio::error_code& ec) { async_done_handler(ec ? ec : asio::error::timed_out); });
 
    // Async read some data from the client
    size_t received = 0;
    _stream.async_read_some(asio::buffer(buffer, size), [&](std::error_code ec, size_t read) { async_done_handler(ec); received = read; });
 
    // Wait for complete or timeout
    std::unique_lock<std::mutex> lck(mtx);
    cv.wait(lck, [&]() { return done == 2; });
 
    // Received some data from the client
    if (received > 0)
    {
        // Update statistic
        _bytes_received += received;
        _server->_bytes_received += received;
 
        // Call the buffer received handler
        onReceived(buffer, received);
    }
 
    // Disconnect on error
    if (error && (error != asio::error::timed_out))
    {
        SendError(error);
        Disconnect(error);
    }
 
    return received;
}
 
std::string SSLSession::Receive(size_t size, const CppCommon::Timespan& timeout)
{
    std::string text(size, 0);
    text.resize(Receive(text.data(), text.size(), timeout));
    return text;
}
 
void SSLSession::ReceiveAsync()
{
    // Try to receive data from the client
    TryReceive();
}
 
void SSLSession::TryReceive()
{
    if (_receiving)
        return;
 
    if (!IsHandshaked())
        return;
 
    // Async receive with the receive handler
    _receiving = true;
    auto self(this->shared_from_this());
    auto async_receive_handler = make_alloc_handler(_receive_storage, [this, self](std::error_code ec, size_t size)
    {
        _receiving = false;
 
        if (!IsHandshaked())
            return;
 
        // Received some data from the client
        if (size > 0)
        {
            // Update statistic
            _bytes_received += size;
            _server->_bytes_received += size;
 
            // Call the buffer received handler
            onReceived(_receive_buffer.data(), size);
 
            // If the receive buffer is full increase its size
            if (_receive_buffer.size() == size)
            {
                // Check the receive buffer limit
                if (((2 * size) > _receive_buffer_limit) && (_receive_buffer_limit > 0))
                {
                    SendError(asio::error::no_buffer_space);
                    Disconnect(asio::error::no_buffer_space);
                    return;
                }
 
                _receive_buffer.resize(2 * size);
            }
        }
 
        // Try to receive again if the session is valid
        if (!ec)
            TryReceive();
        else
        {
            SendError(ec);
            Disconnect(ec);
        }
    });
    if (_strand_required)
        _stream.async_read_some(asio::buffer(_receive_buffer.data(), _receive_buffer.size()), bind_executor(_strand, async_receive_handler));
    else
        _stream.async_read_some(asio::buffer(_receive_buffer.data(), _receive_buffer.size()), async_receive_handler);
}
 
void SSLSession::TrySend()
{
    if (_sending)
        return;
 
    if (!IsHandshaked())
        return;
 
    // Swap send buffers
    if (_send_buffer_flush.empty())
    {
        std::scoped_lock locker(_send_lock);
 
        // Swap flush and main buffers
        _send_buffer_flush.swap(_send_buffer_main);
        _send_buffer_flush_offset = 0;
 
        // Update statistic
        _bytes_pending = 0;
        _bytes_sending += _send_buffer_flush.size();
    }
 
    // Check if the flush buffer is empty
    if (_send_buffer_flush.empty())
    {
        // Call the empty send buffer handler
        onEmpty();
        return;
    }
 
    // Async write with the write handler
    _sending = true;
    auto self(this->shared_from_this());
    auto async_write_handler = make_alloc_handler(_send_storage, [this, self](std::error_code ec, size_t size)
    {
        _sending = false;
 
        if (!IsHandshaked())
            return;
 
        // Send some data to the client
        if (size > 0)
        {
            // Update statistic
            _bytes_sending -= size;
            _bytes_sent += size;
            _server->_bytes_sent += size;
 
            // Increase the flush buffer offset
            _send_buffer_flush_offset += size;
 
            // Successfully send the whole flush buffer
            if (_send_buffer_flush_offset == _send_buffer_flush.size())
            {
                // Clear the flush buffer
                _send_buffer_flush.clear();
                _send_buffer_flush_offset = 0;
            }
 
            // Call the buffer sent handler
            onSent(size, bytes_pending());
        }
 
        // Try to send again if the session is valid
        if (!ec)
            TrySend();
        else
        {
            SendError(ec);
            Disconnect(ec);
        }
    });
    if (_strand_required)
        _stream.async_write_some(asio::buffer(_send_buffer_flush.data() + _send_buffer_flush_offset, _send_buffer_flush.size() - _send_buffer_flush_offset), bind_executor(_strand, async_write_handler));
    else
        _stream.async_write_some(asio::buffer(_send_buffer_flush.data() + _send_buffer_flush_offset, _send_buffer_flush.size() - _send_buffer_flush_offset), async_write_handler);
}
 
void SSLSession::ClearBuffers()
{
    {
        std::scoped_lock locker(_send_lock);
 
        // Clear send buffers
        _send_buffer_main.clear();
        _send_buffer_flush.clear();
        _send_buffer_flush_offset = 0;
 
        // Update statistic
        _bytes_pending = 0;
        _bytes_sending = 0;
    }
}
 
void SSLSession::ResetServer()
{
    // Reset cycle-reference to the server
    _server.reset();
}
 
void SSLSession::SendError(std::error_code ec)
{
    // Skip Asio disconnect errors
    if ((ec == asio::error::connection_aborted) ||
        (ec == asio::error::connection_refused) ||
        (ec == asio::error::connection_reset) ||
        (ec == asio::error::eof) ||
        (ec == asio::error::operation_aborted))
        return;
 
    // Skip OpenSSL annoying errors
    if (ec == asio::ssl::error::stream_truncated)
        return;
    if (ec.category() == asio::error::get_ssl_category())
    {
        if ((ERR_GET_REASON(ec.value()) == SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC) ||
            (ERR_GET_REASON(ec.value()) == SSL_R_PROTOCOL_IS_SHUTDOWN) ||
            (ERR_GET_REASON(ec.value()) == SSL_R_WRONG_VERSION_NUMBER))
            return;
    }
 
    onError(ec.value(), ec.category().name(), ec.message());
}
 
} // namespace Asio
} // namespace CppServer