v5_connect.hpp

// Copyright Takatoshi Kondo 2022
//
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
 
#if !defined(ASYNC_MQTT_PACKET_V5_CONNECT_HPP)
#define ASYNC_MQTT_PACKET_V5_CONNECT_HPP
 
#include <utility>
#include <numeric>
 
#include <boost/numeric/conversion/cast.hpp>
 
#include <async_mqtt/exception.hpp>
#include <async_mqtt/buffer.hpp>
#include <async_mqtt/variable_bytes.hpp>
 
#include <async_mqtt/util/move.hpp>
#include <async_mqtt/util/static_vector.hpp>
#include <async_mqtt/util/endian_convert.hpp>
#include <async_mqtt/util/utf8validate.hpp>
 
#include <async_mqtt/packet/fixed_header.hpp>
#include <async_mqtt/packet/copy_to_static_vector.hpp>
#include <async_mqtt/packet/connect_flags.hpp>
#include <async_mqtt/packet/will.hpp>
#include <async_mqtt/packet/property_variant.hpp>
 
namespace async_mqtt::v5 {
 
namespace as = boost::asio;
 
class connect_packet {
public:
    connect_packet(
        bool clean_start,
        std::uint16_t keep_alive_sec,
        buffer client_id,
        optional<buffer> user_name = nullopt,
        optional<buffer> password = nullopt,
        properties props = {}
    ):connect_packet(
        clean_start,
        keep_alive_sec,
        force_move(client_id),
        nullopt,
        force_move(user_name),
        force_move(password),
        force_move(props)
    )
    {}
 
    connect_packet(
        bool clean_start,
        std::uint16_t keep_alive_sec,
        buffer client_id,
        optional<will> w,
        optional<buffer> user_name = nullopt,
        optional<buffer> password = nullopt,
        properties props = {}
    )
        : fixed_header_{
              make_fixed_header(control_packet_type::connect, 0b0000)
          },
          connect_flags_{0},
          // protocol name length, protocol name, protocol level, connect flag, client id length, client id, keep alive
          remaining_length_(boost::numeric_cast<std::uint32_t>(
              2 +                     // protocol name length
              4 +                     // protocol name
              1 +                     // protocol level
              1 +                     // connect flag
              2 +                     // keep alive
              2 +                     // client id length
              client_id.size()        // client id
          )),
          protocol_name_and_level_{0x00, 0x04, 'M', 'Q', 'T', 'T', 0x05},
          client_id_{force_move(client_id)},
          client_id_length_buf_(2),
          keep_alive_buf_(2),
          property_length_(boost::numeric_cast<std::uint32_t>(async_mqtt::size(props))),
          props_(force_move(props))
    {
        using namespace std::literals;
        endian_store(keep_alive_sec, keep_alive_buf_.data());
        endian_store(boost::numeric_cast<std::uint16_t>(client_id_.size()), client_id_length_buf_.data());
 
        if (!utf8string_check(client_id_)) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet client_id invalid utf8"
            );
        }
 
        if (clean_start) connect_flags_ |= connect_flags::mask_clean_start;
        if (user_name) {
            if (!utf8string_check(*user_name)) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet user name invalid utf8"
                );
            }
            connect_flags_ |= connect_flags::mask_user_name_flag;
            user_name_ = force_move(*user_name);
            user_name_length_buf_ = endian_static_vector(boost::numeric_cast<std::uint16_t>(user_name_.size()));
            remaining_length_ += 2 + user_name_.size();
        }
        if (password) {
            connect_flags_ |= connect_flags::mask_password_flag;
            password_ = force_move(*password);
            password_length_buf_ = endian_static_vector(boost::numeric_cast<std::uint16_t>(password_.size()));
            remaining_length_ += 2 + password_.size();
        }
 
        auto pb = val_to_variable_bytes(boost::numeric_cast<std::uint32_t>(property_length_));
        for (auto e : pb) {
            property_length_buf_.push_back(e);
        }
 
        for (auto const& prop : props_) {
            auto id = prop.id();
            if (!validate_property(property_location::connect, id)) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet property "s + id_to_str(id) + " is not allowed"
                );
            }
        }
 
        remaining_length_ += property_length_buf_.size() + property_length_;
 
        if (w) {
            connect_flags_ |= connect_flags::mask_will_flag;
            if (w->get_retain() == pub::retain::yes) connect_flags_ |= connect_flags::mask_will_retain;
            connect_flags::set_will_qos(connect_flags_, w->get_qos());
            if (!utf8string_check(w->topic())) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet will topic invalid utf8"
                );
            }
            will_topic_ = force_move(w->topic());
            will_topic_length_buf_ = endian_static_vector(boost::numeric_cast<std::uint16_t>(will_topic_.size()));
            if (w->message().size() > 0xffffL) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet will message too long"
                );
            }
            will_message_ = force_move(w->message());
            will_message_length_buf_ = endian_static_vector(boost::numeric_cast<std::uint16_t>(will_message_.size()));
            will_props_ = force_move(w->props());
            will_property_length_ = boost::numeric_cast<std::uint32_t>(async_mqtt::size(will_props_));
            auto pb = val_to_variable_bytes(boost::numeric_cast<std::uint32_t>(will_property_length_));
            for (auto e : pb) {
                will_property_length_buf_.push_back(e);
            }
 
            for (auto const& prop : will_props_) {
                auto id = prop.id();
                if (!validate_property(property_location::will, id)) {
                    throw make_error(
                        errc::bad_message,
                        "v5::connect_packet will_property "s + id_to_str(id) + " is not allowed"
                    );
                }
            }
 
            remaining_length_ +=
                will_property_length_buf_.size() + will_property_length_ +
                2 + will_topic_.size() +
                2 + will_message_.size();
        }
 
        auto rb = val_to_variable_bytes(boost::numeric_cast<std::uint32_t>(remaining_length_));
        for (auto e : rb) {
            remaining_length_buf_.push_back(e);
        }
    }
 
    connect_packet(buffer buf) {
        // fixed_header
        if (buf.empty()) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet fixed_header doesn't exist"
            );
        }
        fixed_header_ = static_cast<std::uint8_t>(buf.front());
        buf.remove_prefix(1);
        auto cpt_opt = get_control_packet_type_with_check(fixed_header_);
        if (!cpt_opt || *cpt_opt != control_packet_type::connect) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet fixed_header is invalid"
            );
        }
 
        // remaining_length
        if (auto vl_opt = insert_advance_variable_length(buf, remaining_length_buf_)) {
            remaining_length_ = *vl_opt;
        }
        else {
            throw make_error(errc::bad_message, "v5::connect_packet remaining length is invalid");
        }
        if (remaining_length_ != buf.size()) {
            throw make_error(errc::bad_message, "v5::connect_packet remaining length doesn't match buf.size()");
        }
 
        // protocol name and level
        if (!insert_advance(buf, protocol_name_and_level_)) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet length of protocol_name or level is invalid"
            );
        }
        static_vector<char, 7> expected_protocol_name_and_level {
            0, 4, 'M', 'Q', 'T', 'T', 5
        };
        if (protocol_name_and_level_ != expected_protocol_name_and_level) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet contents of protocol_name or level is invalid"
            );
        }
 
        // connect_flags
        if (buf.size() < 1) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet connect_flags doesn't exist"
            );
        }
        connect_flags_ = buf.front();
        if (connect_flags_ & 0b00000001) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet connect_flags reserved bit0 is 1 (must be 0)"
            );
        }
        buf.remove_prefix(1);
 
        // keep_alive
        if (!insert_advance(buf, keep_alive_buf_)) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet keep_alive is invalid"
            );
        }
 
        // property
        auto it = buf.begin();
        if (auto pl_opt = variable_bytes_to_val(it, buf.end())) {
            property_length_ = *pl_opt;
            std::copy(buf.begin(), it, std::back_inserter(property_length_buf_));
            buf.remove_prefix(std::size_t(std::distance(buf.begin(), it)));
            if (buf.size() < property_length_) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet properties_don't match its length"
                );
            }
            auto prop_buf = buf.substr(0, property_length_);
            props_ = make_properties(prop_buf, property_location::connect);
            buf.remove_prefix(property_length_);
        }
        else {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet property_length is invalid"
            );
        }
 
        // client_id_length
        if (!insert_advance(buf, client_id_length_buf_)) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet length of client_id is invalid"
            );
        }
        auto client_id_length = endian_load<std::uint16_t>(client_id_length_buf_.data());
 
        // client_id
        if (buf.size() < client_id_length) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet client_id doesn't match its length"
            );
        }
        client_id_ = buf.substr(0, client_id_length);
        if (!utf8string_check(client_id_)) {
            throw make_error(
                errc::bad_message,
                "v5::connect_packet client_id invalid utf8"
            );
        }
        buf.remove_prefix(client_id_length);
 
        // will
        if (connect_flags::has_will_flag(connect_flags_)) {
            // will_qos
            auto will_qos = connect_flags::will_qos(connect_flags_);
            if (will_qos != qos::at_most_once &&
                will_qos != qos::at_least_once &&
                will_qos != qos::exactly_once) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet will_qos is invalid"
                );
            }
 
            // will_property
            auto it = buf.begin();
            if (auto pl_opt = variable_bytes_to_val(it, buf.end())) {
                will_property_length_ = *pl_opt;
                std::copy(buf.begin(), it, std::back_inserter(will_property_length_buf_));
                buf.remove_prefix(std::size_t(std::distance(buf.begin(), it)));
                if (buf.size() < will_property_length_) {
                    throw make_error(
                        errc::bad_message,
                        "v5::connect_packet properties_don't match its length"
                    );
                }
                auto prop_buf = buf.substr(0, will_property_length_);
                will_props_ = make_properties(prop_buf, property_location::will);
                buf.remove_prefix(will_property_length_);
            }
            else {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet property_length is invalid"
                );
            }
 
            // will_topic_length
            if (!insert_advance(buf, will_topic_length_buf_)) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet length of will_topic is invalid"
                );
            }
            auto will_topic_length = endian_load<std::uint16_t>(will_topic_length_buf_.data());
 
            // will_topic
            if (buf.size() < will_topic_length) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet will_topic doesn't match its length"
                );
            }
            will_topic_ = buf.substr(0, will_topic_length);
            if (!utf8string_check(will_topic_)) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet will topic invalid utf8"
                );
            }
            buf.remove_prefix(will_topic_length);
 
            // will_message_length
            if (!insert_advance(buf, will_message_length_buf_)) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet length of will_message is invalid"
                );
            }
            auto will_message_length = endian_load<std::uint16_t>(will_message_length_buf_.data());
 
            // will_message
            if (buf.size() < will_message_length) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet will_message doesn't match its length"
                );
            }
            will_message_ = buf.substr(0, will_message_length);
            buf.remove_prefix(will_message_length);
        }
        else {
            auto will_retain = connect_flags::will_retain(connect_flags_);
            auto will_qos = connect_flags::will_qos(connect_flags_);
            if (will_retain == pub::retain::yes) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet combination of will_flag and will_retain is invalid"
                );
            }
            if (will_qos != qos::at_most_once) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet combination of will_flag and will_qos is invalid"
                );
            }
        }
        // user_name
        if (connect_flags::has_user_name_flag(connect_flags_)) {
            // user_name_topic_name_length
            if (!insert_advance(buf, user_name_length_buf_)) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet length of user_name is invalid"
                );
            }
            auto user_name_length = endian_load<std::uint16_t>(user_name_length_buf_.data());
 
            // user_name
            if (buf.size() < user_name_length) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet user_name doesn't match its length"
                );
            }
            user_name_ = buf.substr(0, user_name_length);
            if (!utf8string_check(user_name_)) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet user name invalid utf8"
                );
            }
            buf.remove_prefix(user_name_length);
        }
 
        // password
        if (connect_flags::has_password_flag(connect_flags_)) {
            // password_topic_name_length
            if (!insert_advance(buf, password_length_buf_)) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet length of password is invalid"
                );
            }
            auto password_length = endian_load<std::uint16_t>(password_length_buf_.data());
 
            // password
            if (buf.size() != password_length) {
                throw make_error(
                    errc::bad_message,
                    "v5::connect_packet password doesn't match its length"
                );
            }
            password_ = buf.substr(0, password_length);
            buf.remove_prefix(password_length);
        }
    }
 
    constexpr control_packet_type type() const {
        return control_packet_type::connect;
    }
 
    std::vector<as::const_buffer> const_buffer_sequence() const {
        std::vector<as::const_buffer> ret;
        ret.reserve(num_of_const_buffer_sequence());
 
        ret.emplace_back(as::buffer(&fixed_header_, 1));
        ret.emplace_back(as::buffer(remaining_length_buf_.data(), remaining_length_buf_.size()));
        ret.emplace_back(as::buffer(protocol_name_and_level_.data(), protocol_name_and_level_.size()));
        ret.emplace_back(as::buffer(&connect_flags_, 1));
        ret.emplace_back(as::buffer(keep_alive_buf_.data(), keep_alive_buf_.size()));
 
        ret.emplace_back(as::buffer(property_length_buf_.data(), property_length_buf_.size()));
        auto props_cbs = async_mqtt::const_buffer_sequence(props_);
        std::move(props_cbs.begin(), props_cbs.end(), std::back_inserter(ret));
 
        ret.emplace_back(as::buffer(client_id_length_buf_.data(), client_id_length_buf_.size()));
        ret.emplace_back(as::buffer(client_id_));
 
        if (connect_flags::has_will_flag(connect_flags_)) {
            ret.emplace_back(as::buffer(will_property_length_buf_.data(), will_property_length_buf_.size()));
            auto will_props_cbs = async_mqtt::const_buffer_sequence(will_props_);
            std::move(will_props_cbs.begin(), will_props_cbs.end(), std::back_inserter(ret));
            ret.emplace_back(as::buffer(will_topic_length_buf_.data(), will_topic_length_buf_.size()));
            ret.emplace_back(as::buffer(will_topic_));
            ret.emplace_back(as::buffer(will_message_length_buf_.data(), will_message_length_buf_.size()));
            ret.emplace_back(as::buffer(will_message_));
        }
 
        if (connect_flags::has_user_name_flag(connect_flags_)) {
            ret.emplace_back(as::buffer(user_name_length_buf_.data(), user_name_length_buf_.size()));
            ret.emplace_back(as::buffer(user_name_));
        }
 
        if (connect_flags::has_password_flag(connect_flags_)) {
            ret.emplace_back(as::buffer(password_length_buf_.data(), password_length_buf_.size()));
            ret.emplace_back(as::buffer(password_));
        }
 
        return ret;
    }
 
    std::size_t size() const {
        return
            1 +                            // fixed header
            remaining_length_buf_.size() +
            remaining_length_;
    }
 
    std::size_t num_of_const_buffer_sequence() const {
        return
            1 +                   // fixed header
            1 +                   // remaining length
            1 +                   // protocol name and level
            1 +                   // connect flags
            1 +                   // keep alive
            1 +                   // property length
            async_mqtt::num_of_const_buffer_sequence(props_) +
 
            2 +                   // client id length, client id
 
            1 +                   // will_property length
            async_mqtt::num_of_const_buffer_sequence(will_props_) +
            2 +                   // will topic name length, will topic name
            2 +                   // will message length, will message
            2 +                   // user name length, user name
            2;                    // password length, password
    }
 
    bool clean_start() const {
        return connect_flags::has_clean_start(connect_flags_);
    }
 
    std::uint16_t keep_alive() const {
        return endian_load<std::uint16_t>(keep_alive_buf_.data());
    }
 
    buffer client_id() const {
        return client_id_;
    }
 
    optional<buffer> user_name() const {
        if (connect_flags::has_user_name_flag(connect_flags_)) {
            return user_name_;
        }
        else {
            return nullopt;
        }
    }
 
    optional<buffer> password() const {
        if (connect_flags::has_password_flag(connect_flags_)) {
            return password_;
        }
        else {
            return nullopt;
        }
    }
 
    optional<will> get_will() const {
        if (connect_flags::has_will_flag(connect_flags_)) {
            pub::opts opts =
                connect_flags::will_retain(connect_flags_) |
                connect_flags::will_qos(connect_flags_);
            return
                async_mqtt::will{
                    will_topic_,
                    will_message_,
                    opts,
                    will_props_
                };
        }
        else {
            return nullopt;
        }
    }
 
    properties const& props() const {
        return props_;
    }
 
private:
    std::uint8_t fixed_header_;
    char connect_flags_;
 
    std::size_t remaining_length_;
    static_vector<char, 4> remaining_length_buf_;
 
    static_vector<char, 7> protocol_name_and_level_;
    buffer client_id_;
    static_vector<char, 2> client_id_length_buf_;
 
    buffer will_topic_;
    static_vector<char, 2> will_topic_length_buf_;
    buffer will_message_;
    static_vector<char, 2> will_message_length_buf_;
    std::size_t will_property_length_;
    static_vector<char, 4> will_property_length_buf_;
    properties will_props_;
 
    buffer user_name_;
    static_vector<char, 2> user_name_length_buf_;
    buffer password_;
    static_vector<char, 2> password_length_buf_;
 
    static_vector<char, 2> keep_alive_buf_;
 
    std::size_t property_length_;
    static_vector<char, 4> property_length_buf_;
    properties props_;
};
 
inline std::ostream& operator<<(std::ostream& o, connect_packet const& v) {
    o <<
        "v5::connect{" <<
        "cid:" << v.client_id() << "," <<
        "ka:" << v.keep_alive() << "," <<
        "cs:" << v.clean_start();
    if (v.user_name()) {
        o << ",un:" << *v.user_name();
    }
    if (v.password()) {
        o << ",pw:" << "*****";
    }
    if (v.get_will()) {
        o << ",will:" << *v.get_will();
    }
    if (!v.props().empty()) {
        o << ",ps:" << v.props();
    };
    o << "}";
    return o;
}
 
} // namespace async_mqtt::v5
 
#endif // ASYNC_MQTT_PACKET_V5_CONNECT_HPP