Merge pull request #59 from mpretty-cyro/fix/legacy-blinding-flag

mpretty-cyro · web-flow · commit 551a48b258f5 · 2025-07-30T08:04:11.000+10:00
Removed the `legacy_blinding` flag from blinded contacts
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -17,7 +17,7 @@ if(CCACHE_PROGRAM)
 endif()
 
 project(libsession-util
-    VERSION 1.5.2
+    VERSION 1.5.3
     DESCRIPTION "Session client utility library"
     LANGUAGES ${LANGS})
 
diff --git a/include/session/config/contacts.h b/include/session/config/contacts.h
@@ -272,15 +272,13 @@ LIBSESSION_EXPORT contacts_blinded_contact_list* contacts_blinded(const config_o
 /// Inputs:
 /// - `conf` -- [in] Pointer to the config object
 /// - `blinded_id` -- [in] null terminated hex string
-/// - `legacy_blinding` -- [in] null terminated hex string
 /// - `blinded_contact` -- [out] the blinded contact info data
 ///
 /// Output:
 /// - `bool` -- Returns true if blinded contact exists
 LIBSESSION_EXPORT bool contacts_get_blinded(
         config_object* conf,
         const char* blinded_id,
-        bool legacy_blinding,
         contacts_blinded_contact* blinded_contact) LIBSESSION_WARN_UNUSED;
 
 /// API: contacts/contacts_get_or_construct_blinded
@@ -301,7 +299,6 @@ LIBSESSION_EXPORT bool contacts_get_blinded(
 ///     [in]    const char*                 community_base_url,
 ///     [in]    const char*                 community_pubkey_hex,
 ///     [in]    const char*                 blinded_id,
-///     [in]    bool                        legacy_blinding,
 ///     [out]   contacts_blinded_contact*   blinded_contact
 /// );
 /// ```
@@ -311,7 +308,6 @@ LIBSESSION_EXPORT bool contacts_get_blinded(
 /// - `community_base_url` -- [in] null terminated string
 /// - `community_pubkey_hex` -- [in] null terminated hex string
 /// - `blinded_id` -- [in] null terminated hex string
-/// - `legacy_blinding` -- [in] null terminated hex string
 /// - `blinded_contact` -- [out] the blinded contact info data
 ///
 /// Output:
@@ -321,7 +317,6 @@ LIBSESSION_EXPORT bool contacts_get_or_construct_blinded(
         const char* community_base_url,
         const char* community_pubkey_hex,
         const char* blinded_id,
-        bool legacy_blinding,
         contacts_blinded_contact* blinded_contact) LIBSESSION_WARN_UNUSED;
 
 /// API: contacts/contacts_set_blinded
@@ -355,8 +350,7 @@ LIBSESSION_EXPORT bool contacts_set_blinded(
 /// BOOL contacts_erase_blinded(
 ///     [in, out]   config_object*  conf,
 ///     [in]        const char*     community_base_url,
-///     [in]        const char*     blinded_id,
-///     [in]        bool            legacy_blinding
+///     [in]        const char*     blinded_id
 /// );
 /// ```
 ///
@@ -370,10 +364,7 @@ LIBSESSION_EXPORT bool contacts_set_blinded(
 /// Outputs:
 /// - `bool` -- True if erasing was successful
 LIBSESSION_EXPORT bool contacts_erase_blinded_contact(
-        config_object* conf,
-        const char* community_base_url,
-        const char* blinded_id,
-        bool legacy_blinding);
+        config_object* conf, const char* community_base_url, const char* blinded_id);
 
 typedef struct contacts_iterator {
     void* _internals;
diff --git a/include/session/config/contacts.hpp b/include/session/config/contacts.hpp
@@ -119,8 +119,6 @@ struct contact_info {
 };
 
 struct blinded_contact_info {
-    community comm;
-
     const std::string session_id() const;  // in hex
     std::string name;
     profile_pic profile_picture;
@@ -131,8 +129,7 @@ struct blinded_contact_info {
     explicit blinded_contact_info(
             std::string_view community_base_url,
             std::span<const unsigned char> community_pubkey,
-            std::string_view blinded_id,
-            bool legacy_blinding);
+            std::string_view blinded_id);
 
     // Internal ctor/method for C API implementations:
     blinded_contact_info(const struct contacts_blinded_contact& c);  // From c struct
@@ -154,17 +151,51 @@ struct blinded_contact_info {
     /// - `name` -- Name to assign to the contact
     void set_name(std::string name);
 
+    /// API: contacts/blinded_contact_info::community_base_url
+    ///
+    /// Accesses the base url for the community (i.e. not including room or pubkey). Always
+    /// lower-case/normalized.
+    ///
+    /// Inputs: None
+    ///
+    /// Outputs:
+    /// - `const std::string&` -- Returns the base url
+    const std::string& community_base_url() const { return comm.base_url(); }
+
+    /// API: contacts/blinded_contact_info::community_pubkey
+    ///
+    /// Accesses the community server pubkey (32 bytes).
+    ///
+    /// Inputs: None
+    ///
+    /// Outputs:
+    /// - `const std::vector<unsigned char>&` -- Returns the pubkey
+    const std::vector<unsigned char>& community_pubkey() const { return comm.pubkey(); }
+
+    /// API: contacts/blinded_contact_info::community_pubkey_hex
+    ///
+    /// Accesses the community server pubkey as hex (64 hex digits).
+    ///
+    /// Inputs: None
+    ///
+    /// Outputs:
+    /// - `std::string` -- Returns the pubkey
+    std::string community_pubkey_hex() const { return comm.pubkey_hex(); }
+
+  private:
+    friend class Contacts;
+    friend struct session::config::comm_iterator_helper;
+
+    community comm;
+
+    void load(const dict& info_dict);
+
     /// These functions are here so we can use the `comm_iterator_helper` for loading data
     /// into this struct
     void set_base_url(std::string_view base_url);
     void set_room(std::string_view room);
     void set_pubkey(std::span<const unsigned char> pubkey);
     void set_pubkey(std::string_view pubkey);
-
-  private:
-    friend class Contacts;
-    friend struct session::config::comm_iterator_helper;
-    void load(const dict& info_dict);
 };
 
 class Contacts : public ConfigBase {
@@ -444,13 +475,11 @@ class Contacts : public ConfigBase {
     ///
     /// Inputs:
     /// - `blinded_id_hex` -- hex string of the session id
-    /// - `legacy_blinding` -- flag indicating whether the pubkey is using legacy blinding
     ///
     /// Outputs:
     /// - `std::optional<blinded_contact_info>` - Returns nullopt if blinded session ID was not
     /// found, otherwise a filled out blinded_contact_info
-    std::optional<blinded_contact_info> get_blinded(
-            std::string_view blinded_id_hex, bool legacy_blinding) const;
+    std::optional<blinded_contact_info> get_blinded(std::string_view blinded_id_hex) const;
 
     /// API: contacts/Contacts::get_or_construct_blinded
     ///
@@ -468,15 +497,13 @@ class Contacts : public ConfigBase {
     /// - `community_pubkey_hex` -- Hex string of the public key for the community this blinded id
     /// originates from
     /// - `blinded_id_hex` -- hex string of the blinded id
-    /// - `legacy_blinding` -- flag indicating whether the pubkey is using legacy blinding
     ///
     /// Outputs:
     /// - `blinded_contact_info` - Returns a filled out blinded_contact_info
     blinded_contact_info get_or_construct_blinded(
             std::string_view community_base_url,
             std::string_view community_pubkey_hex,
-            std::string_view blinded_id_hex,
-            bool legacy_blinding);
+            std::string_view blinded_id_hex);
 
     /// API: contacts/contacts::set_blinded
     ///
@@ -503,12 +530,10 @@ class Contacts : public ConfigBase {
     /// Inputs:
     /// - `base_url` -- the base url for the community this blinded contact originated from
     /// - `blinded_id` -- hex string of the blinded id
-    /// - `legacy_blinding` -- flag indicating whether `blinded_id` is using legacy blinding
     ///
     /// Outputs:
     /// - `bool` - Returns true if contact was found and removed, false otherwise
-    bool erase_blinded(
-            std::string_view base_url, std::string_view blinded_id, bool legacy_blinding);
+    bool erase_blinded(std::string_view base_url, std::string_view blinded_id);
 
     struct iterator;
     /// API: contacts/contacts::begin
diff --git a/src/config/contacts.cpp b/src/config/contacts.cpp
@@ -10,6 +10,7 @@
 #include <variant>
 
 #include "internal.hpp"
+#include "session/blinding.hpp"
 #include "session/config/contacts.h"
 #include "session/config/error.h"
 #include "session/export.h"
@@ -308,12 +309,16 @@ size_t Contacts::size() const {
 blinded_contact_info::blinded_contact_info(
         std::string_view community_base_url,
         std::span<const unsigned char> community_pubkey,
-        std::string_view blinded_id,
-        bool legacy_blinding) :
+        std::string_view blinded_id) :
         comm{community(
-                std::move(community_base_url), blinded_id.substr(2), std::move(community_pubkey))},
-        legacy_blinding{legacy_blinding} {
-    check_session_id(blinded_id, legacy_blinding ? "15" : "25");
+                std::move(community_base_url), blinded_id.substr(2), std::move(community_pubkey))} {
+    auto prefix = get_session_id_prefix(blinded_id);
+    legacy_blinding = (prefix == session::SessionIDPrefix::community_blinded_legacy);
+
+    if (prefix != session::SessionIDPrefix::community_blinded &&
+        prefix != session::SessionIDPrefix::community_blinded_legacy)
+        throw std::invalid_argument{
+                "Invalid blinded ID: Expected '15' or '25' prefix; got " + std::string{blinded_id}};
 }
 
 void blinded_contact_info::load(const dict& info_dict) {
@@ -378,6 +383,10 @@ void blinded_contact_info::set_base_url(std::string_view base_url) {
 }
 
 void blinded_contact_info::set_room(std::string_view room) {
+    if (room.size() != 64 || !oxenc::is_hex(room))
+        throw std::invalid_argument{
+                fmt::format("Invalid room: expected 64 hex digits; got {}", room)};
+
     comm.set_room(room);
 }
 
@@ -403,9 +412,8 @@ ConfigBase::DictFieldProxy Contacts::blinded_contact_field(
 
 using any_blinded_contact = std::variant<blinded_contact_info>;
 
-std::optional<blinded_contact_info> Contacts::get_blinded(
-        std::string_view blinded_id_hex, bool legacy_blinding) const {
-    check_session_id(blinded_id_hex, legacy_blinding ? "15" : "25");
+std::optional<blinded_contact_info> Contacts::get_blinded(std::string_view blinded_id_hex) const {
+    get_session_id_prefix(blinded_id_hex);
 
     if (auto* b = data["b"].dict()) {
         auto comm = comm_iterator_helper{b->begin(), b->end()};
@@ -426,16 +434,12 @@ std::optional<blinded_contact_info> Contacts::get_blinded(
 blinded_contact_info Contacts::get_or_construct_blinded(
         std::string_view community_base_url,
         std::string_view community_pubkey_hex,
-        std::string_view blinded_id_hex,
-        bool legacy_blinding) {
-    if (auto maybe = get_blinded(blinded_id_hex, legacy_blinding))
+        std::string_view blinded_id_hex) {
+    if (auto maybe = get_blinded(blinded_id_hex))
         return *std::move(maybe);
 
     return blinded_contact_info{
-            community_base_url,
-            to_span(oxenc::from_hex(community_pubkey_hex)),
-            blinded_id_hex,
-            legacy_blinding};
+            community_base_url, to_span(oxenc::from_hex(community_pubkey_hex)), blinded_id_hex};
 }
 
 std::vector<blinded_contact_info> Contacts::blinded() const {
@@ -475,9 +479,13 @@ void Contacts::set_blinded(const blinded_contact_info& bc) {
     set_ts(info["j"], bc.created);
 }
 
-bool Contacts::erase_blinded(
-        std::string_view base_url_, std::string_view blinded_id, bool legacy_blinding) {
-    check_session_id(blinded_id, legacy_blinding ? "15" : "25");
+bool Contacts::erase_blinded(std::string_view base_url_, std::string_view blinded_id) {
+    auto prefix = get_session_id_prefix(blinded_id);
+
+    if (prefix != session::SessionIDPrefix::community_blinded &&
+        prefix != session::SessionIDPrefix::community_blinded_legacy)
+        throw std::invalid_argument{
+                "Invalid blinded ID: Expected '15' or '25' prefix; got " + std::string{blinded_id}};
 
     auto base_url = community::canonical_url(base_url_);
     auto pk = std::string(blinded_id.substr(2));
@@ -588,14 +596,11 @@ LIBSESSION_C_API size_t contacts_size(const config_object* conf) {
 }
 
 LIBSESSION_C_API bool contacts_get_blinded(
-        config_object* conf,
-        const char* blinded_id,
-        bool legacy_blinding,
-        contacts_blinded_contact* blinded_contact) {
+        config_object* conf, const char* blinded_id, contacts_blinded_contact* blinded_contact) {
     return wrap_exceptions(
             conf,
             [&] {
-                if (auto bc = unbox<Contacts>(conf)->get_blinded(blinded_id, legacy_blinding)) {
+                if (auto bc = unbox<Contacts>(conf)->get_blinded(blinded_id)) {
                     bc->into(*blinded_contact);
                     return true;
                 }
@@ -609,17 +614,13 @@ LIBSESSION_C_API bool contacts_get_or_construct_blinded(
         const char* community_base_url,
         const char* community_pubkey_hex,
         const char* blinded_id,
-        bool legacy_blinding,
         contacts_blinded_contact* blinded_contact) {
     return wrap_exceptions(
             conf,
             [&] {
                 unbox<Contacts>(conf)
                         ->get_or_construct_blinded(
-                                community_base_url,
-                                community_pubkey_hex,
-                                blinded_id,
-                                legacy_blinding)
+                                community_base_url, community_pubkey_hex, blinded_id)
                         .into(*blinded_contact);
                 return true;
             },
@@ -682,13 +683,9 @@ LIBSESSION_C_API bool contacts_set_blinded(
 }
 
 LIBSESSION_C_API bool contacts_erase_blinded(
-        config_object* conf,
-        const char* community_base_url,
-        const char* blinded_id,
-        bool legacy_blinding) {
+        config_object* conf, const char* community_base_url, const char* blinded_id) {
     try {
-        return unbox<Contacts>(conf)->erase_blinded(
-                community_base_url, blinded_id, legacy_blinding);
+        return unbox<Contacts>(conf)->erase_blinded(community_base_url, blinded_id);
     } catch (...) {
         return false;
     }
diff --git a/src/config/internal.cpp b/src/config/internal.cpp
@@ -1,5 +1,6 @@
 #include "internal.hpp"
 
+#include <fmt/ranges.h>
 #include <oxenc/base32z.h>
 #include <oxenc/base64.h>
 #include <oxenc/bt_value_producer.h>
@@ -8,9 +9,24 @@
 
 #include <iterator>
 #include <optional>
+#include <oxen/log/format.hpp>
+
+using namespace oxen::log::literals;
 
 namespace session::config {
 
+namespace {
+
+    constexpr std::array all_session_id_prefixes = {
+            session::SessionIDPrefix::standard,
+            session::SessionIDPrefix::group,
+            session::SessionIDPrefix::community_blinded_legacy,
+            session::SessionIDPrefix::community_blinded,
+            session::SessionIDPrefix::version_blinded,
+            session::SessionIDPrefix::unblinded};
+
+}  // namespace
+
 void check_session_id(std::string_view session_id, std::string_view prefix) {
     if (!(session_id.size() == 64 + prefix.size() && oxenc::is_hex(session_id) &&
           session_id.substr(0, prefix.size()) == prefix))
@@ -19,6 +35,24 @@ void check_session_id(std::string_view session_id, std::string_view prefix) {
                 "; got " + std::string{session_id}};
 }
 
+SessionIDPrefix get_session_id_prefix(std::string_view id) {
+    if (oxenc::is_hex(id) && id.size() == 66) {
+        for (auto prefix : all_session_id_prefixes) {
+            auto prefix_str = to_string(prefix);
+
+            if ((id.size() == 64 + prefix_str.size() &&
+                 id.substr(0, prefix_str.size()) == prefix_str))
+                return prefix;
+        }
+    }
+
+    // If we get here then the id wasn't any of the currently defined prefixes
+    throw std::invalid_argument{fmt::format(
+            "Invalid session ID: expected 66 hex digits starting with one of [{}]; got {}",
+            fmt::join(all_session_id_prefixes, ", "),
+            id)};
+}
+
 std::string session_id_to_bytes(std::string_view session_id, std::string_view prefix) {
     check_session_id(session_id, prefix);
     return oxenc::from_hex(session_id);
diff --git a/src/config/internal.hpp b/src/config/internal.hpp
diff --git a/tests/test_config_contacts.cpp b/tests/test_config_contacts.cpp
