Codechange: Update minimum CMake version to 3.16 for all parts. (#13141)

[openttd-github.git] / src / network / core / packet.cpp

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * @file packet.cpp Basic functions to create, fill and read packets.
 */

#include "../../stdafx.h"
#include "../../string_func.h"

#include "packet.h"

#include "../../safeguards.h"

/**
 * Create a packet that is used to read from a network socket.
 * @param cs                The socket handler associated with the socket we are reading from.
 * @param limit             The maximum size of packets to accept.
 * @param initial_read_size The initial amount of data to transfer from the socket into the
 *                          packet. This defaults to just the required bytes to determine the
 *                          packet's size. That default is the wanted for streams such as TCP
 *                          as you do not want to read data of the next packet yet. For UDP
 *                          you need to read the whole packet at once otherwise you might
 *                          loose some the data of the packet, so there you pass the maximum
 *                          size for the packet you expect from the network.
 */
Packet::Packet(NetworkSocketHandler *cs, size_t limit, size_t initial_read_size) : pos(0), limit(limit)
{
        assert(cs != nullptr);

        this->cs = cs;
        this->buffer.resize(initial_read_size);
}

/**
 * Creates a packet to send
 * @param cs    The socket handler associated with the socket we are writing to; could be \c nullptr.
 * @param type  The type of the packet to send
 * @param limit The maximum number of bytes the packet may have. Default is COMPAT_MTU.
 *              Be careful of compatibility with older clients/servers when changing
 *              the limit as it might break things if the other side is not expecting
 *              much larger packets than what they support.
 */
Packet::Packet(NetworkSocketHandler *cs, PacketType type, size_t limit) : pos(0), limit(limit), cs(cs)
{
        /* Allocate space for the the size so we can write that in just before sending the packet. */
        size_t size = EncodedLengthOfPacketSize();
        if (cs != nullptr && cs->send_encryption_handler != nullptr) {
                /* Allocate some space for the message authentication code of the encryption. */
                size += cs->send_encryption_handler->MACSize();
        }
        assert(this->CanWriteToPacket(size));
        this->buffer.resize(size, 0);

        this->Send_uint8(type);
}


/**
 * Writes the packet size from the raw packet from packet->size
 */
void Packet::PrepareToSend()
{
        /* Prevent this to be called twice and for packets that have been received. */
        assert(this->buffer[0] == 0 && this->buffer[1] == 0);

        this->buffer[0] = GB(this->Size(), 0, 8);
        this->buffer[1] = GB(this->Size(), 8, 8);

        if (cs != nullptr && cs->send_encryption_handler != nullptr) {
                size_t offset = EncodedLengthOfPacketSize();
                size_t mac_size = cs->send_encryption_handler->MACSize();
                size_t message_offset = offset + mac_size;
                cs->send_encryption_handler->Encrypt(std::span(&this->buffer[offset], mac_size), std::span(&this->buffer[message_offset], this->buffer.size() - message_offset));
        }

        this->pos  = 0; // We start reading from here
        this->buffer.shrink_to_fit();
}

/**
 * Is it safe to write to the packet, i.e. didn't we run over the buffer?
 * @param bytes_to_write The amount of bytes we want to try to write.
 * @return True iff the given amount of bytes can be written to the packet.
 */
bool Packet::CanWriteToPacket(size_t bytes_to_write)
{
        return this->Size() + bytes_to_write <= this->limit;
}

/*
 * The next couple of functions make sure we can send
 *  uint8_t, uint16_t, uint32_t and uint64_t endian-safe
 *  over the network. The least significant bytes are
 *  sent first.
 *
 *  So 0x01234567 would be sent as 67 45 23 01.
 *
 * A bool is sent as a uint8_t where zero means false
 *  and non-zero means true.
 */

/**
 * Package a boolean in the packet.
 * @param data The data to send.
 */
void Packet::Send_bool(bool data)
{
        this->Send_uint8(data ? 1 : 0);
}

/**
 * Package a 8 bits integer in the packet.
 * @param data The data to send.
 */
void Packet::Send_uint8(uint8_t data)
{
        assert(this->CanWriteToPacket(sizeof(data)));
        this->buffer.emplace_back(data);
}

/**
 * Package a 16 bits integer in the packet.
 * @param data The data to send.
 */
void Packet::Send_uint16(uint16_t data)
{
        assert(this->CanWriteToPacket(sizeof(data)));
        this->buffer.emplace_back(GB(data, 0, 8));
        this->buffer.emplace_back(GB(data, 8, 8));
}

/**
 * Package a 32 bits integer in the packet.
 * @param data The data to send.
 */
void Packet::Send_uint32(uint32_t data)
{
        assert(this->CanWriteToPacket(sizeof(data)));
        this->buffer.emplace_back(GB(data,  0, 8));
        this->buffer.emplace_back(GB(data,  8, 8));
        this->buffer.emplace_back(GB(data, 16, 8));
        this->buffer.emplace_back(GB(data, 24, 8));
}

/**
 * Package a 64 bits integer in the packet.
 * @param data The data to send.
 */
void Packet::Send_uint64(uint64_t data)
{
        assert(this->CanWriteToPacket(sizeof(data)));
        this->buffer.emplace_back(GB(data,  0, 8));
        this->buffer.emplace_back(GB(data,  8, 8));
        this->buffer.emplace_back(GB(data, 16, 8));
        this->buffer.emplace_back(GB(data, 24, 8));
        this->buffer.emplace_back(GB(data, 32, 8));
        this->buffer.emplace_back(GB(data, 40, 8));
        this->buffer.emplace_back(GB(data, 48, 8));
        this->buffer.emplace_back(GB(data, 56, 8));
}

/**
 * Sends a string over the network. It sends out
 * the string + '\0'. No size-byte or something.
 * @param data The string to send
 */
void Packet::Send_string(const std::string_view data)
{
        assert(this->CanWriteToPacket(data.size() + 1));
        this->buffer.insert(this->buffer.end(), data.begin(), data.end());
        this->buffer.emplace_back('\0');
}

/**
 * Copy a sized byte buffer into the packet.
 * @param data The data to send.
 */
void Packet::Send_buffer(const std::vector<uint8_t> &data)
{
        assert(this->CanWriteToPacket(sizeof(uint16_t) + data.size()));
        this->Send_uint16((uint16_t)data.size());
        this->buffer.insert(this->buffer.end(), data.begin(), data.end());
}

/**
 * Send as many of the bytes as possible in the packet. This can mean
 * that it is possible that not all bytes are sent. To cope with this
 * the function returns the span of bytes that were not sent.
 * @param span The span describing the range of bytes to send.
 * @return The span of bytes that were not written.
 */
std::span<const uint8_t> Packet::Send_bytes(const std::span<const uint8_t> span)
{
        size_t amount = std::min<size_t>(span.size(), this->limit - this->Size());
        this->buffer.insert(this->buffer.end(), span.data(), span.data() + amount);
        return span.subspan(amount);
}

/*
 * Receiving commands
 * Again, the next couple of functions are endian-safe
 *  see the comment before Send_bool for more info.
 */


/**
 * Is it safe to read from the packet, i.e. didn't we run over the buffer?
 * In case \c close_connection is true, the connection will be closed when one would
 * overrun the buffer. When it is false, the connection remains untouched.
 * @param bytes_to_read    The amount of bytes we want to try to read.
 * @param close_connection Whether to close the connection if one cannot read that amount.
 * @return True if that is safe, otherwise false.
 */
bool Packet::CanReadFromPacket(size_t bytes_to_read, bool close_connection)
{
        /* Don't allow reading from a quit client/client who send bad data */
        if (this->cs->HasClientQuit()) return false;

        /* Check if variable is within packet-size */
        if (this->pos + bytes_to_read > this->Size()) {
                if (close_connection) this->cs->NetworkSocketHandler::MarkClosed();
                return false;
        }

        return true;
}

/**
 * Check whether the packet, given the position of the "write" pointer, has read
 * enough of the packet to contain its size.
 * @return True iff there is enough data in the packet to contain the packet's size.
 */
bool Packet::HasPacketSizeData() const
{
        return this->pos >= EncodedLengthOfPacketSize();
}

/**
 * Get the number of bytes in the packet.
 * When sending a packet this is the size of the data up to that moment.
 * When receiving a packet (before PrepareToRead) this is the allocated size for the data to be read.
 * When reading a packet (after PrepareToRead) this is the full size of the packet.
 * @return The packet's size.
 */
size_t Packet::Size() const
{
        return this->buffer.size();
}

/**
 * Reads the packet size from the raw packet and stores it in the packet->size
 * @return True iff the packet size seems plausible.
 */
bool Packet::ParsePacketSize()
{
        size_t size = static_cast<size_t>(this->buffer[0]);
        size       += static_cast<size_t>(this->buffer[1]) << 8;

        /* If the size of the packet is less than the bytes required for the size and type of
         * the packet, or more than the allowed limit, then something is wrong with the packet.
         * In those cases the packet can generally be regarded as containing garbage data. */
        if (size < EncodedLengthOfPacketSize() + EncodedLengthOfPacketType() || size > this->limit) return false;

        this->buffer.resize(size);
        this->pos = static_cast<PacketSize>(EncodedLengthOfPacketSize());
        return true;
}

/**
 * Prepares the packet so it can be read
 * @return True when the packet was valid, otherwise false.
 */
bool Packet::PrepareToRead()
{
        /* Put the position on the right place */
        this->pos = static_cast<PacketSize>(EncodedLengthOfPacketSize());

        if (cs == nullptr || cs->receive_encryption_handler == nullptr) return true;

        size_t mac_size = cs->receive_encryption_handler->MACSize();
        if (this->buffer.size() <= pos + mac_size) return false;

        bool valid = cs->receive_encryption_handler->Decrypt(std::span(&this->buffer[pos], mac_size), std::span(&this->buffer[pos + mac_size], this->buffer.size() - pos - mac_size));
        this->pos += static_cast<PacketSize>(mac_size);
        return valid;
}

/**
 * Get the \c PacketType from this packet.
 * @return The packet type.
 */
PacketType Packet::GetPacketType() const
{
        assert(this->Size() >= EncodedLengthOfPacketSize() + EncodedLengthOfPacketType());
        size_t offset = EncodedLengthOfPacketSize();
        if (cs != nullptr && cs->send_encryption_handler != nullptr) offset += cs->send_encryption_handler->MACSize();
        return static_cast<PacketType>(buffer[offset]);
}

/**
 * Read a boolean from the packet.
 * @return The read data.
 */
bool Packet::Recv_bool()
{
        return this->Recv_uint8() != 0;
}

/**
 * Read a 8 bits integer from the packet.
 * @return The read data.
 */
uint8_t Packet::Recv_uint8()
{
        uint8_t n;

        if (!this->CanReadFromPacket(sizeof(n), true)) return 0;

        n = this->buffer[this->pos++];
        return n;
}

/**
 * Read a 16 bits integer from the packet.
 * @return The read data.
 */
uint16_t Packet::Recv_uint16()
{
        uint16_t n;

        if (!this->CanReadFromPacket(sizeof(n), true)) return 0;

        n  = (uint16_t)this->buffer[this->pos++];
        n += (uint16_t)this->buffer[this->pos++] << 8;
        return n;
}

/**
 * Read a 32 bits integer from the packet.
 * @return The read data.
 */
uint32_t Packet::Recv_uint32()
{
        uint32_t n;

        if (!this->CanReadFromPacket(sizeof(n), true)) return 0;

        n  = (uint32_t)this->buffer[this->pos++];
        n += (uint32_t)this->buffer[this->pos++] << 8;
        n += (uint32_t)this->buffer[this->pos++] << 16;
        n += (uint32_t)this->buffer[this->pos++] << 24;
        return n;
}

/**
 * Read a 64 bits integer from the packet.
 * @return The read data.
 */
uint64_t Packet::Recv_uint64()
{
        uint64_t n;

        if (!this->CanReadFromPacket(sizeof(n), true)) return 0;

        n  = (uint64_t)this->buffer[this->pos++];
        n += (uint64_t)this->buffer[this->pos++] << 8;
        n += (uint64_t)this->buffer[this->pos++] << 16;
        n += (uint64_t)this->buffer[this->pos++] << 24;
        n += (uint64_t)this->buffer[this->pos++] << 32;
        n += (uint64_t)this->buffer[this->pos++] << 40;
        n += (uint64_t)this->buffer[this->pos++] << 48;
        n += (uint64_t)this->buffer[this->pos++] << 56;
        return n;
}

/**
 * Extract a sized byte buffer from the packet.
 * @return The extracted buffer.
 */
std::vector<uint8_t> Packet::Recv_buffer()
{
        uint16_t size = this->Recv_uint16();
        if (size == 0 || !this->CanReadFromPacket(size, true)) return {};

        std::vector<uint8_t> data;
        while (size-- > 0) {
                data.push_back(this->buffer[this->pos++]);
        }

        return data;
}

/**
 * Extract at most the length of the span bytes from the packet into the span.
 * @param span The span to write the bytes to.
 * @return The number of bytes that were actually read.
 */
size_t Packet::Recv_bytes(std::span<uint8_t> span)
{
        auto tranfer_to_span = [](std::span<uint8_t> destination, const char *source, size_t amount) {
                size_t to_copy = std::min(amount, destination.size());
                std::copy(source, source + to_copy, destination.data());
                return to_copy;
        };

        return this->TransferOut(tranfer_to_span, span);
}

/**
 * Reads characters (bytes) from the packet until it finds a '\0', or reaches a
 * maximum of \c length characters.
 * When the '\0' has not been reached in the first \c length read characters,
 * more characters are read from the packet until '\0' has been reached. However,
 * these characters will not end up in the returned string.
 * The length of the returned string will be at most \c length - 1 characters.
 * @param length   The maximum length of the string including '\0'.
 * @param settings The string validation settings.
 * @return The validated string.
 */
std::string Packet::Recv_string(size_t length, StringValidationSettings settings)
{
        assert(length > 1);

        /* Both loops with Recv_uint8 terminate when reading past the end of the
         * packet as Recv_uint8 then closes the connection and returns 0. */
        std::string str;
        char character;
        while (--length > 0 && (character = this->Recv_uint8()) != '\0') str.push_back(character);

        if (length == 0) {
                /* The string in the packet was longer. Read until the termination. */
                while (this->Recv_uint8() != '\0') {}
        }

        return StrMakeValid(str, settings);
}

/**
 * Get the amount of bytes that are still available for the Transfer functions.
 * @return The number of bytes that still have to be transfered.
 */
size_t Packet::RemainingBytesToTransfer() const
{
        return this->Size() - this->pos;
}