Merge pull request #64 from Doy-lee/doyle-pro-backend-polish

Pro backend request/response glue code

Author: mpretty-cyro

.gitmodules

@@ -22,3 +22,6 @@
 [submodule "external/oxen-logging"]
 	path = external/oxen-logging
 	url = https://github.com/oxen-io/oxen-logging.git
+[submodule "external/simdutf"]
+	path = external/simdutf
+	url = https://github.com/simdutf/simdutf.git

CMakeLists.txt

@@ -17,7 +17,7 @@ if(CCACHE_PROGRAM)
 endif()
 
 project(libsession-util
-    VERSION 1.5.7
+    VERSION 1.5.8
     DESCRIPTION "Session client utility library"
     LANGUAGES ${LANGS})
 

README.md

@@ -1,5 +1,37 @@
 # Session utility library
 
+## Build
+
+```
+# Configure the build
+#
+# Options
+#   Enable APIs for creating onion-requests with:
+#
+#     -D ENABLE_ONIONERQ
+#
+#   Enable testing of a Session Pro Backend by defining on the configure line:
+#
+#     -D TEST_PRO_BACKEND_WITH_DEV_SERVER=1
+#
+#   These tests require the Session Pro Backend running in development mode (SESH_PRO_BACKEND_DEV=1)
+#   to be running and tests the request and response flow of registering, updating and revoking
+#   Session Pro from the development backend. You must also have a libcurl available such that
+#   `find_package(CURL)` succeeds (e.g. a system installed libcurl) for this to compile
+#   successfully.
+#
+#   By default, it contacts http://127.0.0.1:5000 but this URL can be changed using the CLI arg
+#   --pro-backend-dev-server-url="<url>" when invoking the test suite.
+#
+cmake -G Ninja -S . -B Build
+
+# Regenerate protobuf files
+cmake --build Build --target regen-protobuf --parallel --verbose
+
+# Build
+cmake --build Build --parallel --verbose
+```
+
 ## Docs
 
 C Library: https://api.oxen.io/libsession-util-c/#/

external/CMakeLists.txt

@@ -193,3 +193,15 @@ libsession_static_bundle(libzstd_static)
 set(JSON_BuildTests OFF CACHE INTERNAL "")
 set(JSON_Install ON CACHE INTERNAL "") # Required to export targets that we use
 libsession_system_or_submodule(NLOHMANN nlohmann_json nlohmann_json>=3.7.0 nlohmann-json)
+
+set(JSON_BuildTests OFF CACHE INTERNAL "")
+set(JSON_Install ON CACHE INTERNAL "") # Required to export targets that we use
+
+function(simdutf_subdir)
+    set(SIMDUTF_TESTS OFF CACHE BOOL "")
+    set(SIMDUTF_TOOLS OFF CACHE BOOL "")
+    set(BUILD_SHARED_LIBS OFF)
+    add_subdirectory(simdutf)
+endfunction()
+simdutf_subdir()
+libsession_static_bundle(simdutf)

external/simdutf

@@ -5,6 +5,7 @@ extern "C" {
 #endif
 
 #include <stddef.h>
+#include <stdint.h>
 
 #include "export.h"
 #include "platform.h"
@@ -15,7 +16,7 @@ extern "C" {
 ///
 /// Inputs:
 /// - `ed25519_seckey` -- [in] the Ed25519 private key of the sender (64 bytes).
-/// - `server_pk` -- [in] the public key of the open group server to generate the
+/// - `server_pk` -- [in] the public key of the community server to generate the
 ///   blinded id for (32 bytes).
 /// - `blinded_pk_out` -- [out] pointer to a buffer of at least 32 bytes where the blinded_pk will
 ///   be written if generation was successful.
@@ -36,7 +37,7 @@ LIBSESSION_EXPORT bool session_blind15_key_pair(
 ///
 /// Inputs:
 /// - `ed25519_seckey` -- [in] the Ed25519 private key of the sender (64 bytes).
-/// - `server_pk` -- [in] the public key of the open group server to generate the
+/// - `server_pk` -- [in] the public key of the community server to generate the
 ///   blinded id for (32 bytes).
 /// - `blinded_pk_out` -- [out] pointer to a buffer of at least 32 bytes where the blinded_pk will
 ///   be written if generation was successful.
@@ -75,7 +76,7 @@ LIBSESSION_EXPORT bool session_blind_version_key_pair(
 ///
 /// Inputs:
 /// - `ed25519_seckey` -- [in] the Ed25519 private key of the sender (64 bytes).
-/// - `server_pk` -- [in] the public key of the open group server to generate the
+/// - `server_pk` -- [in] the public key of the community server to generate the
 ///   blinded id for (32 bytes).
 /// - `msg` -- [in] Pointer to a data buffer containing the message to generate a signature for.
 /// - `msg_len` -- [in] Length of `msg`
@@ -97,7 +98,7 @@ LIBSESSION_EXPORT bool session_blind15_sign(
 ///
 /// Inputs:
 /// - `ed25519_seckey` -- [in] the Ed25519 private key of the sender (64 bytes).
-/// - `server_pk` -- [in] the public key of the open group server to generate the
+/// - `server_pk` -- [in] the public key of the community server to generate the
 ///   blinded id for (32 bytes).
 /// - `msg` -- [in] Pointer to a data buffer containing the message to generate a signature for.
 /// - `msg_len` -- [in] Length of `msg`
@@ -145,7 +146,7 @@ LIBSESSION_EXPORT bool session_blind_version_sign(
 /// Inputs:
 /// - `session_id` -- [in] the session_id to compare (66 bytes with a 05 prefix).
 /// - `blinded_id` -- [in] the blinded_id to compare, can be either 15 or 25 blinded (66 bytes).
-/// - `server_pk` -- [in] the public key of the open group server to the blinded id came from (64
+/// - `server_pk` -- [in] the public key of the community server to the blinded id came from (64
 /// bytes).
 ///
 /// Outputs:

include/session/blinding.h

@@ -7,6 +7,7 @@
 #include <list>
 #include <memory>
 #include <session/config.hpp>
+#include <session/types.hpp>
 #include <session/util.hpp>
 #include <span>
 #include <type_traits>
@@ -29,9 +30,6 @@ class bt_dict_consumer;
 
 namespace session::config {
 
-template <typename T, typename... U>
-static constexpr bool is_one_of = (std::is_same_v<T, U> || ...);
-
 /// True for a dict_value direct subtype, but not scalar sub-subtypes.
 template <typename T>
 static constexpr bool is_dict_subtype = is_one_of<T, config::scalar, config::set, config::dict>;
@@ -436,12 +434,16 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- This will be assigned to the dict if it is missing
-        void insert_if_missing(config::scalar&& value) {
+        //
+        /// Ouputs:
+        /// - `bool` -- True if the value was inserted, false otherwise
+        bool insert_if_missing(config::scalar&& value) {
             if (!_conf.is_dirty())
                 if (auto current = get_clean<config::set>(); current && current->count(value))
-                    return;
+                    return false;
 
             get_dirty<config::set>().insert(std::move(value));
+            return true;
         }
 
         /// API: base/ConfigBase::DictFieldProxy::set_erase_impl
@@ -450,28 +452,35 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- This will be deleted from the dict
-        void set_erase_impl(const config::scalar& value) {
+        ///
+        /// Outputs:
+        /// - `bool` -- True if an element was erased, false otherwise
+        bool set_erase_impl(const config::scalar& value) {
             if (!_conf.is_dirty())
                 if (auto current = get_clean<config::set>(); current && !current->count(value))
-                    return;
+                    return false;
 
             config::dict* data = &_conf.dirty().data();
 
             for (const auto& key : _inter_keys) {
                 auto it = data->find(key);
                 data = it != data->end() ? std::get_if<config::dict>(&it->second) : nullptr;
                 if (!data)
-                    return;
+                    return false;
             }
 
             auto it = data->find(_last_key);
             if (it == data->end())
-                return;
+                return false;
             auto& val = it->second;
-            if (auto* current = std::get_if<config::set>(&val))
+            bool result = false;
+            if (auto* current = std::get_if<config::set>(&val)) {
                 current->erase(value);
-            else
+                result = true;
+            } else {
                 val.emplace<config::set>();
+            }
+            return result;
         }
 
       public:
@@ -797,8 +806,8 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- The value to be set
-        void set_insert(std::string_view value) {
-            insert_if_missing(config::scalar{std::string{value}});
+        bool set_insert(std::string_view value) {
+            return insert_if_missing(config::scalar{std::string{value}});
         }
 
         /// API: base/ConfigBase::DictFieldProxy::set_insert(int64_t)
@@ -808,7 +817,7 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- The value to be set
-        void set_insert(int64_t value) { insert_if_missing(config::scalar{value}); }
+        bool set_insert(int64_t value) { return insert_if_missing(config::scalar{value}); }
 
         /// API: base/ConfigBase::DictFieldProxy::set_erase(std::string_view)
         ///
@@ -818,8 +827,11 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- The value to be set
-        void set_erase(std::string_view value) {
-            set_erase_impl(config::scalar{std::string{value}});
+        ///
+        /// Outputs:
+        /// - `bool` -- True if an element was erased, false otherwise
+        bool set_erase(std::string_view value) {
+            return set_erase_impl(config::scalar{std::string{value}});
         }
 
         /// API: base/ConfigBase::DictFieldProxy::set_erase(int64_t)
@@ -830,7 +842,10 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- The value to be set
-        void set_erase(int64_t value) { set_erase_impl(scalar{value}); }
+        ///
+        /// Outputs:
+        /// - `bool` -- True if an element was erased, false otherwise
+        bool set_erase(int64_t value) { return set_erase_impl(scalar{value}); }
 
         /// API: base/ConfigBase::DictFieldProxy::emplace
         ///
@@ -944,7 +959,7 @@ class ConfigBase : public ConfigSig {
     /// API: base/ConfigBase::load_key
     ///
     /// Called to load an ed25519 key for encryption; this is meant for use by single-ownership
-    /// config types, like UserProfile, but not shared config types (closed groups).
+    /// config types, like UserProfile, but not shared config types (groups).
     ///
     /// Takes a binary string which is either the 32-byte seed, or 64-byte libsodium secret (which
     /// is just the seed and pubkey concatenated together), and then calls `key(...)` with the seed.

include/session/config/base.hpp

@@ -7,6 +7,7 @@ extern "C" {
 #include "base.h"
 #include "expiring.h"
 #include "notify.h"
+#include "pro.h"
 #include "profile_pic.h"
 #include "util.h"
 
@@ -35,6 +36,8 @@ typedef struct contacts_contact {
 
     int64_t created;  // unix timestamp (seconds)
 
+    session_protocol_pro_profile_bitset profile_bitset;
+
 } contacts_contact;
 
 typedef struct contacts_blinded_contact {
@@ -52,6 +55,8 @@ typedef struct contacts_blinded_contact {
     bool legacy_blinding;
     int64_t created;  // unix timestamp (seconds)
 
+    session_protocol_pro_profile_bitset profile_bitset;
+
 } contacts_blinded_contact;
 
 /// Struct containing a list of contacts_blinded_contact structs.  Typically where this is returned

include/session/config/contacts.h

@@ -11,6 +11,7 @@
 #include "expiring.hpp"
 #include "namespaces.hpp"
 #include "notify.hpp"
+#include "pro.hpp"
 #include "profile_pic.hpp"
 
 extern "C" struct contacts_contact;
@@ -47,6 +48,7 @@ namespace session::config {
 ///     j - Unix timestamp (seconds) when the contact was created ("j" to match user_groups
 ///         equivalent "j"oined field). Omitted if 0.
 ///     t - The `profile_updated` unix timestamp (seconds) for this contacts profile information.
+///     f - session pro profile features bitset for this contact
 ///
 /// b - dict of blinded contacts.  This is a nested dict where the outer keys are the BASE_URL of
 ///     the community the blinded contact originated from and the outer value is a dict containing:
@@ -68,6 +70,7 @@ namespace session::config {
 ///       j - Unix timestamp (seconds) when the contact was created ("j" to match user_groups
 ///           equivalent "j"oined field). Omitted if 0.
 ///       y - flag indicating whether the blinded message request is using legac"y" blinding.
+///       f - session pro profile features bitset for this blinded contact
 
 struct contact_info {
     static constexpr size_t MAX_NAME_LENGTH = 100;
@@ -93,6 +96,8 @@ struct contact_info {
     std::chrono::seconds exp_timer{0};                 // The expiration timer (in seconds)
     int64_t created = 0;  // Unix timestamp (seconds) when this contact was added
 
+    ProProfileBitset profile_bitset = {};
+
     explicit contact_info(std::string sid);
 
     // Internal ctor/method for C API implementations:
@@ -136,6 +141,8 @@ struct blinded_contact_info {
     bool legacy_blinding;
     std::chrono::sys_seconds created{};  // Unix timestamp (seconds) when this contact was added
 
+    ProProfileBitset profile_bitset = {};
+
     blinded_contact_info() = default;
     explicit blinded_contact_info(
             std::string_view community_base_url,
@@ -428,6 +435,16 @@ class Contacts : public ConfigBase {
     /// - `timestamp` -- standard unix timestamp of the time contact was created
     void set_created(std::string_view session_id, int64_t timestamp);
 
+    /// API: contacts/contacts::set_pro_features
+    ///
+    /// Alternative to `set()` for setting a single field.  (If setting multiple fields at once you
+    /// should use `set()` instead).
+    ///
+    /// Inputs:
+    /// - `session_id` -- hex string of the session id
+    /// - `features` -- The updated profile features to use
+    void set_pro_features(std::string_view session_id, ProProfileBitset features);
+
     /// API: contacts/contacts::erase
     ///
     /// Removes a contact, if present.  Returns true if it was found and removed, false otherwise.

include/session/config/contacts.hpp

@@ -6,12 +6,18 @@ extern "C" {
 
 #include "base.h"
 #include "profile_pic.h"
+#include "session/types.h"
 
 typedef struct convo_info_volatile_1to1 {
     char session_id[67];  // in hex; 66 hex chars + null terminator.
 
     int64_t last_read;  // milliseconds since unix epoch
     bool unread;        // true if the conversation is explicitly marked unread
+
+    bool has_pro_gen_index_hash;     // Flag indicating if hash is set
+    bytes32 pro_gen_index_hash;      // Hash of the generation index set by the Session Pro Backend
+    uint64_t pro_expiry_unix_ts_ms;  // Unix epoch timestamp to which this contacts entitlement to
+                                     // Session Pro features is valid to
 } convo_info_volatile_1to1;
 
 typedef struct convo_info_volatile_community {
@@ -44,6 +50,11 @@ typedef struct convo_info_volatile_blinded_1to1 {
 
     int64_t last_read;  // ms since unix epoch
     bool unread;        // true if the conversation is explicitly marked unread
+
+    bool has_pro_gen_index_hash;     // Flag indicating if hash is set
+    bytes32 pro_gen_index_hash;      // Hash of the generation index set by the Session Pro Backend
+    uint64_t pro_expiry_unix_ts_ms;  // Unix epoch timestamp to which this contacts entitlement to
+                                     // Session Pro features is valid to
 } convo_info_volatile_blinded_1to1;
 
 /// API: convo_info_volatile/convo_info_volatile_init