Pro backend request/response glue code

.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

README.md

@@ -1,5 +1,34 @@
 # 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
+
+# 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)

include/session/blinding.h

@@ -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/config/base.hpp

@@ -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>;
@@ -944,7 +942,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/contacts.h

@@ -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_FEATURES pro_features;
+
 } 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_FEATURES pro_features;
+
 } contacts_blinded_contact;
 
 /// Struct containing a list of contacts_blinded_contact structs.  Typically where this is returned

include/session/config/contacts.hpp

@@ -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 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 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
 
+    SESSION_PROTOCOL_PRO_FEATURES pro_features = SESSION_PROTOCOL_PRO_FEATURES_NIL;
+
     explicit contact_info(std::string sid);
 
     // Internal ctor/method for C API implementations:
@@ -117,6 +122,25 @@ struct contact_info {
     void set_nickname(std::string nickname);
     void set_nickname_truncated(std::string nickname);
 
+    /// API: contacts/contact_info::get_pro_features
+    ///
+    /// Retrieves the bitset indicating which pro features the user currently has enabled.
+    ///
+    /// Inputs: None
+    ///
+    /// Outputs:
+    /// - `SESSION_PROTOCOL_PRO_FEATURES` - bitset indicating which pro features are enabled.
+    SESSION_PROTOCOL_PRO_FEATURES get_pro_features() const;
+
+    /// API: contacts/contact_info::set_pro_features
+    ///
+    /// Updates the pro features bitset for this contact. Note: If the bitset provided contains the
+    /// '10K_CHARACTER_LIMIT' feature then it will be removed.
+    ///
+    /// Inputs:
+    /// - `features` -- The updated pro features bitset to use.
+    void set_pro_features(SESSION_PROTOCOL_PRO_FEATURES features);
+
   private:
     friend class Contacts;
     void load(const dict& info_dict);
@@ -136,6 +160,8 @@ struct blinded_contact_info {
     bool legacy_blinding;
     std::chrono::sys_seconds created{};  // Unix timestamp (seconds) when this contact was added
 
+    SESSION_PROTOCOL_PRO_FEATURES pro_features = SESSION_PROTOCOL_PRO_FEATURES_NIL;
+
     blinded_contact_info() = default;
     explicit blinded_contact_info(
             std::string_view community_base_url,
@@ -193,6 +219,25 @@ struct blinded_contact_info {
     /// - `std::string` -- Returns the pubkey
     std::string community_pubkey_hex() const { return comm.pubkey_hex(); }
 
+    /// API: contacts/blinded_contact_info::get_pro_features
+    ///
+    /// Retrieves the bitset indicating which pro features the user currently has enabled.
+    ///
+    /// Inputs: None
+    ///
+    /// Outputs:
+    /// - `SESSION_PROTOCOL_PRO_FEATURES` - bitset indicating which pro features are enabled.
+    SESSION_PROTOCOL_PRO_FEATURES get_pro_features() const;
+
+    /// API: contacts/blinded_contact_info::set_pro_features
+    ///
+    /// Updates the pro features bitset for this contact. Note: If the bitset provided contains the
+    /// '10K_CHARACTER_LIMIT' feature then it will be removed.
+    ///
+    /// Inputs:
+    /// - `features` -- The updated pro features bitset to use.
+    void set_pro_features(SESSION_PROTOCOL_PRO_FEATURES features);
+
   private:
     friend class Contacts;
     friend struct session::config::comm_iterator_helper;
@@ -428,6 +473,17 @@ 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 pro features bitset to use. Note: If the bitset provided
+    /// contains the '10K_CHARACTER_LIMIT' feature then it will be removed.
+    void set_pro_features(std::string_view session_id, SESSION_PROTOCOL_PRO_FEATURES features);
+
     /// API: contacts/contacts::erase
     ///
     /// Removes a contact, if present.  Returns true if it was found and removed, false otherwise.

include/session/config/convo_info_volatile.h

@@ -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

include/session/config/convo_info_volatile.hpp

@@ -31,6 +31,8 @@ class val_loader;
 ///
 /// 1 - dict of one-to-one conversations.  Each key is the Session ID of the contact (in hex).
 ///     Values are dicts with keys:
+///     e - contacts pro expiry unix timestamp (in milliseconds)
+///     g - contacts pro gen_index_hash
 ///     r - the unix timestamp (in integer milliseconds) of the last-read message.  Always
 ///         included, but will be 0 if no messages are read.
 ///     u - will be present and set to 1 if this conversation is specifically marked unread.
@@ -44,13 +46,13 @@ class val_loader;
 ///           included, but will be 0 if no messages are read.
 ///       u - will be present and set to 1 if this conversation is specifically marked unread.
 ///
-/// g - group conversations (aka new, non-legacy closed groups).  The key is the group identifier
+/// g - group conversations (aka new, non-legacy groups).  The key is the group identifier
 ///     (beginning with 03).  Values are dicts with keys:
 ///     r - the unix timestamp (in integer milliseconds) of the last-read message.  Always
 ///         included, but will be 0 if no messages are read.
 ///     u - will be present and set to 1 if this conversation is specifically marked unread.
 ///
-/// C - legacy group conversations (aka closed groups).  The key is the group identifier (which
+/// C - legacy group conversations (aka groups).  The key is the group identifier (which
 ///     looks indistinguishable from a Session ID, but isn't really a proper Session ID).  Values
 ///     are dicts with keys:
 ///     r - the unix timestamp (integer milliseconds) of the last-read message.  Always included,
@@ -59,6 +61,8 @@ class val_loader;
 ///
 /// b - outgoing blinded message request conversations.  The key is the blinded Session ID without
 ///     the prefix.  Values are dicts with keys:
+///     e - contacts pro expiry unix timestamp (in milliseconds)
+///     g - contacts pro gen_index_hash
 ///     r - the unix timestamp (integer milliseconds) of the last-read message.  Always included,
 ///         but will be 0 if no messages are read.
 ///     u - will be present and set to 1 if this conversation is specifically marked unread.
@@ -79,6 +83,13 @@ namespace convo {
     struct one_to_one : base {
         std::string session_id;  // in hex
 
+        /// Hash of the generation index set by the Session Pro Backend
+        std::optional<array_uc32> pro_gen_index_hash;
+
+        /// Unix epoch timestamp to which this proof's entitlement to Session Pro features is valid
+        /// to
+        std::chrono::sys_time<std::chrono::milliseconds> pro_expiry_unix_ts{};
+
         /// API: convo_info_volatile/one_to_one::one_to_one
         ///
         /// Constructs an empty one_to_one from a session_id.  Session ID can be either bytes (33)
@@ -161,6 +172,13 @@ namespace convo {
         std::string blinded_session_id;  // in hex
         bool legacy_blinding;
 
+        /// Hash of the generation index set by the Session Pro Backend
+        std::optional<array_uc32> pro_gen_index_hash;
+
+        /// Unix epoch timestamp to which this proof's entitlement to Session Pro features is valid
+        /// to
+        std::chrono::sys_time<std::chrono::milliseconds> pro_expiry_unix_ts{};
+
         /// API: convo_info_volatile/blinded_one_to_one::blinded_one_to_one
         ///
         /// Constructs an empty blinded_one_to_one from a blinded_session_id.  Session ID can be

include/session/config/encrypt.hpp

@@ -2,10 +2,9 @@
 
 #include <span>
 #include <stdexcept>
+#include <string_view>
 #include <vector>
 
-#include "../types.hpp"
-
 namespace session::config {
 
 /// API: encrypt/encrypt