account_protocol.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program 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; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program 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
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_IAM_MESSAGING_ACCOUNT_PROTOCOL_HPP
#define ORES_IAM_MESSAGING_ACCOUNT_PROTOCOL_HPP
 
#include <span>
#include <iosfwd>
#include <vector>
#include <expected>
#include <boost/uuid/uuid.hpp>
#include "ores.comms/messaging/message_types.hpp"
#include "ores.comms/messaging/message_traits.hpp"
#include "ores.iam/domain/account.hpp"
 
namespace ores::iam::messaging {
 
struct save_account_request final {
    boost::uuids::uuid account_id;  // Nil for create, valid UUID for update
    std::string username;
    std::string password;      // Plain text for new accounts, optional for updates
    std::string totp_secret;
    std::string email;
    std::string recorded_by;
    std::string change_reason_code;
    std::string change_commentary;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<save_account_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const save_account_request& v);
 
struct save_account_response final {
    bool success = false;
    std::string message;
    boost::uuids::uuid account_id;  // ID of created/updated account
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<save_account_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const save_account_response& v);
 
struct get_accounts_request final {
    std::uint32_t offset = 0;
    std::uint32_t limit = 100;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<get_accounts_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_accounts_request& v);
 
struct get_accounts_response final {
    std::vector<domain::account> accounts;
    std::uint32_t total_available_count = 0;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<get_accounts_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_accounts_response& v);
 
struct unlock_account_request final {
    std::vector<boost::uuids::uuid> account_ids;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<unlock_account_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const unlock_account_request& v);
 
struct unlock_account_result final {
    boost::uuids::uuid account_id;
    bool success = false;
    std::string message;
};
 
std::ostream& operator<<(std::ostream& s, const unlock_account_result& v);
 
struct unlock_account_response final {
    std::vector<unlock_account_result> results;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<unlock_account_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const unlock_account_response& v);
 
struct delete_account_request final {
    boost::uuids::uuid account_id;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<delete_account_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const delete_account_request& v);
 
struct delete_account_response final {
    bool success = false;
    std::string message;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<delete_account_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const delete_account_response& v);
 
struct lock_account_request final {
    std::vector<boost::uuids::uuid> account_ids;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<lock_account_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const lock_account_request& v);
 
struct lock_account_result final {
    boost::uuids::uuid account_id;
    bool success = false;
    std::string message;
};
 
std::ostream& operator<<(std::ostream& s, const lock_account_result& v);
 
struct lock_account_response final {
    std::vector<lock_account_result> results;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<lock_account_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const lock_account_response& v);
 
struct reset_password_request final {
    std::vector<boost::uuids::uuid> account_ids;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<reset_password_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const reset_password_request& v);
 
struct reset_password_result final {
    boost::uuids::uuid account_id;
    bool success = false;
    std::string message;
};
 
std::ostream& operator<<(std::ostream& s, const reset_password_result& v);
 
struct reset_password_response final {
    std::vector<reset_password_result> results;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<reset_password_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const reset_password_response& v);
 
struct change_password_request final {
    std::string new_password;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<change_password_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const change_password_request& v);
 
struct change_password_response final {
    bool success = false;
    std::string message;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<change_password_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const change_password_response& v);
 
struct update_my_email_request final {
    std::string new_email;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<update_my_email_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const update_my_email_request& v);
 
struct update_my_email_response final {
    bool success = false;
    std::string message;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<update_my_email_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const update_my_email_response& v);
 
}
 
namespace ores::comms::messaging {
 
template<>
struct message_traits<iam::messaging::save_account_request> {
    using request_type = iam::messaging::save_account_request;
    using response_type = iam::messaging::save_account_response;
    static constexpr message_type request_message_type =
        message_type::save_account_request;
};
 
template<>
struct message_traits<iam::messaging::get_accounts_request> {
    using request_type = iam::messaging::get_accounts_request;
    using response_type = iam::messaging::get_accounts_response;
    static constexpr message_type request_message_type =
        message_type::get_accounts_request;
};
 
template<>
struct message_traits<iam::messaging::unlock_account_request> {
    using request_type = iam::messaging::unlock_account_request;
    using response_type = iam::messaging::unlock_account_response;
    static constexpr message_type request_message_type =
        message_type::unlock_account_request;
};
 
template<>
struct message_traits<iam::messaging::delete_account_request> {
    using request_type = iam::messaging::delete_account_request;
    using response_type = iam::messaging::delete_account_response;
    static constexpr message_type request_message_type =
        message_type::delete_account_request;
};
 
template<>
struct message_traits<iam::messaging::lock_account_request> {
    using request_type = iam::messaging::lock_account_request;
    using response_type = iam::messaging::lock_account_response;
    static constexpr message_type request_message_type =
        message_type::lock_account_request;
};
 
template<>
struct message_traits<iam::messaging::reset_password_request> {
    using request_type = iam::messaging::reset_password_request;
    using response_type = iam::messaging::reset_password_response;
    static constexpr message_type request_message_type =
        message_type::reset_password_request;
};
 
template<>
struct message_traits<iam::messaging::change_password_request> {
    using request_type = iam::messaging::change_password_request;
    using response_type = iam::messaging::change_password_response;
    static constexpr message_type request_message_type =
        message_type::change_password_request;
};
 
template<>
struct message_traits<iam::messaging::update_my_email_request> {
    using request_type = iam::messaging::update_my_email_request;
    using response_type = iam::messaging::update_my_email_response;
    static constexpr message_type request_message_type =
        message_type::update_my_email_request;
};
 
}
 
#endif