Merge pull request #426 from simplito/feat/json_struct_helpers

zurekz · web-flow · commit 4f77ab9493cd · 2026-05-11T10:29:16.000+02:00
Feat/json struct helpers
diff --git a/endpoint/core/include/privmx/endpoint/core/encryptors/DataEncryptor.hpp b/endpoint/core/include/privmx/endpoint/core/encryptors/DataEncryptor.hpp
@@ -91,15 +91,14 @@ class DataEncryptor : public DataEncryptorBase<T>
 {
 public:
     std::string encrypt(const T& data, const std::string& key) {
-        auto buffer = utils::Utils::stringifyVar(data.toJSON());
-        return utils::Base64::from(privmx::crypto::CryptoPrivmx::privmxEncrypt(privmx::crypto::CryptoPrivmx::privmxOptAesWithSignature(), buffer, key));
+        return utils::Base64::from(privmx::crypto::CryptoPrivmx::privmxEncrypt(privmx::crypto::CryptoPrivmx::privmxOptAesWithSignature(), data.serialize(), key));
     }
     std::string encrypt(const T& data, const EncKey& encKey) {
         return encrypt(data, encKey.key);
     }
     
     Pson::BinaryString sign(const T& data, const privmx::crypto::PrivateKey& privKey) {
-        auto buffer = utils::Utils::stringifyVar(data.toJSON());
+        auto buffer = data.serialize();
         auto signature = privKey.signToCompactSignatureWithHash(buffer);
         Pson::BinaryString plain;
         plain.push_back(1);
@@ -109,15 +108,12 @@ class DataEncryptor : public DataEncryptorBase<T>
     }
 
     Pson::BinaryString getSign(const T& data, const privmx::crypto::PrivateKey& privKey) {
-        auto buffer = utils::Utils::stringifyVar(data.toJSON());
-        return Pson::BinaryString(privKey.signToCompactSignatureWithHash(buffer));
+        return Pson::BinaryString(privKey.signToCompactSignatureWithHash(data.serialize()));
     }
 
     T decrypt(const std::string& data, const std::string& key) {
         auto decrypted = privmx::crypto::CryptoPrivmx::privmxDecrypt(true, utils::Base64::toString(data), key);
-        Poco::JSON::Parser parser;
-        auto var = parser.parse(decrypted);
-        return T::fromJSON(var);
+        return T::deserialize(decrypted);
     }
     T decrypt(const std::string& data, const EncKey& encKey) {
         return decrypt(data, encKey.key);
@@ -127,7 +123,7 @@ class DataEncryptor : public DataEncryptorBase<T>
         Pson::BinaryString plain = privmx::crypto::CryptoPrivmx::privmxDecrypt(true, utils::Base64::toString(data), key);
         Pson::BinaryString signature, data_buf;
         std::tie(signature, data_buf) = this->extractSignAndDataBuff(plain);
-        return {signature, T::fromJSON(privmx::utils::Utils::parseJsonObject(data_buf)), data_buf};
+        return {signature, T::deserialize(data_buf), data_buf};
     }
     std::tuple<Pson::BinaryString, T, Pson::BinaryString> decryptAndGetSign(const std::string& data, const EncKey& encKey) {
         return decryptAndGetSign(data, encKey.key);
diff --git a/endpoint/core/src/Subscriber.cpp b/endpoint/core/src/Subscriber.cpp
@@ -77,7 +77,7 @@ std::vector<std::string> Subscriber::subscribeFor(const std::vector<std::string>
             model.channels.push_back(subscriptionQueryString);
         }
     }
-    LOG_INFO("Subscriber:subscribeFor channels:" + privmx::utils::Utils::stringifyVar(model.toJSON()));
+    LOG_INFO("Subscriber:subscribeFor channels:" + model.serialize());
     auto requestResult = _gateway->request("subscribeToChannels", model.toJSON(), {.channel_type = rpc::ChannelType::WEBSOCKET});
     server::SubscribeToChannelsResult value = privmx::endpoint::core::server::SubscribeToChannelsResult::fromJSON(requestResult);
     LOG_TIME_DEBUG_CHECKPOINT(Subscriber:subscribeFor, "dataRecived")
diff --git a/endpoint/core/src/encryptors/DIO/DIOEncryptorV1.cpp b/endpoint/core/src/encryptors/DIO/DIOEncryptorV1.cpp
@@ -45,7 +45,7 @@ std::string DIOEncryptorV1::signAndEncode(const ExpandedDataIntegrityObject& dio
     } else {
         dioJSON.bridgeIdentity = std::nullopt;
     }
-    return _dataEncryptor.encode(_dataEncryptor.signAndPackDataWithSignature(core::Buffer::from(privmx::utils::Utils::stringify(dioJSON.toJSON())), authorKey));
+    return _dataEncryptor.encode(_dataEncryptor.signAndPackDataWithSignature(core::Buffer::from(dioJSON.serialize()), authorKey));
 }
 
 ExpandedDataIntegrityObject DIOEncryptorV1::decodeAndVerify(const std::string& signedDio) {
diff --git a/endpoint/core/src/encryptors/module/ModuleDataEncryptorV5.cpp b/endpoint/core/src/encryptors/module/ModuleDataEncryptorV5.cpp
@@ -34,7 +34,7 @@ dynamic::EncryptedModuleDataV5 ModuleDataEncryptorV5::encrypt(const ModuleDataTo
     result.privateMeta = _dataEncryptor.signAndEncryptAndEncode(kvdbData.privateMeta, authorPrivateKey, encryptionKey);
     fieldChecksums.insert(std::make_pair("privateMeta",privmx::crypto::Crypto::sha256(result.privateMeta)));
     dynamic::ModuleInternalMetaV5 internalMeta{.secret=kvdbData.internalMeta.secret, .resourceId=kvdbData.internalMeta.resourceId, .randomId=kvdbData.internalMeta.randomId};
-    result.internalMeta = _dataEncryptor.signAndEncryptAndEncode(Buffer::from(utils::Utils::stringifyVar(internalMeta.toJSON())), authorPrivateKey, encryptionKey);
+    result.internalMeta = _dataEncryptor.signAndEncryptAndEncode(Buffer::from(internalMeta.serialize()), authorPrivateKey, encryptionKey);
     fieldChecksums.insert(std::make_pair("internalMeta",privmx::crypto::Crypto::sha256(result.internalMeta)));
     result.authorPubKey = authorPrivateKey.getPublicKey().toBase58DER();
     ExpandedDataIntegrityObject expandedDio = {kvdbData.dio, .structureVersion=5, .fieldChecksums=fieldChecksums};
diff --git a/endpoint/event/src/EventApiImpl.cpp b/endpoint/event/src/EventApiImpl.cpp
@@ -196,7 +196,7 @@ void EventApiImpl::emitEventEx(const std::string& contextId, const std::vector<c
     model.channel = channelName;
     model.users = _eventKeyProvider.prepareKeysList(users, encryptionKey);
     _serverApi.contextSendCustomEvent(model);
-    PRIVMX_DEBUG("EventApiImpl", "emitEventEx", privmx::utils::Utils::stringify(model.toJSON(), true));
+    PRIVMX_DEBUG("EventApiImpl", "emitEventEx", model.serialize(), true);
 }
 
 void EventApiImpl::validateChannelName(const std::string& channelName) {
diff --git a/endpoint/inbox/src/InboxApiImpl.cpp b/endpoint/inbox/src/InboxApiImpl.cpp
@@ -575,7 +575,7 @@ store::FileMetaToEncryptV4 InboxApiImpl::prepareMeta(const privmx::endpoint::inb
         .publicMeta = commitFileInfo.publicMeta,
         .privateMeta = commitFileInfo.privateMeta,
         .fileSize = commitFileInfo.size,
-        .internalMeta = core::Buffer::from(utils::Utils::stringifyVar(internalFileMeta.toJSON()))
+        .internalMeta = core::Buffer::from(internalFileMeta.serialize())
     };
     return fileMetaToEncrypt;
 }
diff --git a/endpoint/inbox/src/encryptors/inbox/InboxDataProcessorV5.cpp b/endpoint/inbox/src/encryptors/inbox/InboxDataProcessorV5.cpp
@@ -45,7 +45,7 @@ server::InboxData InboxDataProcessorV5::packForServer(const InboxDataProcessorMo
         .resourceId = plainData.privateData.internalMeta.resourceId,
         .randomId = plainData.privateData.internalMeta.randomId,
     };
-    serverPrivateData.internalMeta = _dataEncryptor.signAndEncryptAndEncode(core::Buffer::from(utils::Utils::stringifyVar(internalMetaObj.toJSON())), authorPrivateKey, inboxKey);
+    serverPrivateData.internalMeta = _dataEncryptor.signAndEncryptAndEncode(core::Buffer::from(internalMetaObj.serialize()), authorPrivateKey, inboxKey);
     privateDataMapOfDataSha256.insert(std::make_pair("internalMeta", privmx::crypto::Crypto::sha256(serverPrivateData.internalMeta)));
     serverPrivateData.authorPubKey = authorPubKeyECC;
     core::ExpandedDataIntegrityObject privateDataExpandedDio = {plainData.privateData.dio, .structureVersion=InboxDataSchema::Version::VERSION_5, .fieldChecksums=privateDataMapOfDataSha256};
diff --git a/endpoint/store/src/StoreApiImpl.cpp b/endpoint/store/src/StoreApiImpl.cpp
@@ -611,7 +611,7 @@ std::string StoreApiImpl::storeFileFinalizeWriteRequest(const std::shared_ptr<Fi
                 .publicMeta = handle->getPublicMeta(),
                 .privateMeta = handle->getPrivateMeta(),
                 .fileSize = handle->getSize(),
-                .internalMeta = core::Buffer::from(utils::Utils::stringifyVar(internalFileMeta.toJSON()))
+                .internalMeta = core::Buffer::from(internalFileMeta.serialize())
             };
             encryptedMetaVar = _fileMetaEncryptorV4.encrypt(fileMeta, _userPrivKey, key.key).toJSON();
             break;
@@ -626,7 +626,7 @@ std::string StoreApiImpl::storeFileFinalizeWriteRequest(const std::shared_ptr<Fi
             store::FileMetaToEncryptV5 fileMeta {
                 .publicMeta = handle->getPublicMeta(),
                 .privateMeta = handle->getPrivateMeta(),
-                .internalMeta = core::Buffer::from(utils::Utils::stringifyVar(internalFileMeta.toJSON())),
+                .internalMeta = core::Buffer::from(internalFileMeta.serialize()),
                 .dio = fileDIO
             };
             auto encryptedMeta = _fileMetaEncryptorV5.encrypt(fileMeta, _userPrivKey, key.key);
@@ -1136,7 +1136,7 @@ File StoreApiImpl::convertStoreFileMetaV1ToFile(server::File file, dynamic::comp
     return convertServerFileToLibFile(
         file,
         core::Buffer(),
-        core::Buffer::from(utils::Utils::stringifyVar(storeFileMeta.toJSON())),
+        core::Buffer::from(storeFileMeta.serialize()),
         storeFileMeta.size,
         storeFileMeta.author.pubKey,
         storeFileMeta.statusCode,
@@ -1437,7 +1437,7 @@ void StoreApiImpl::updateFileMeta(const std::string& fileId, const core::Buffer&
     }
     Poco::Dynamic::Var encryptedMetaVar;
     auto fileInternalMeta = validateDecryptFileInternalMeta(file, storeToModuleKeys(store));
-    auto internalMeta = core::Buffer::from(utils::Utils::stringifyVar(fileInternalMeta.toJSON()));
+    auto internalMeta = core::Buffer::from(fileInternalMeta.serialize());
     switch (getStoreEntryDataStructureVersion(store.data.back())) {
         case StoreDataSchema::Version::UNKNOWN:
             throw UnknowStoreFormatException();
diff --git a/endpoint/store/src/encryptors/file/FileMetaEncryptor.cpp b/endpoint/store/src/encryptors/file/FileMetaEncryptor.cpp
@@ -31,7 +31,7 @@ Poco::Dynamic::Var FileMetaEncryptor::encrypt(const FileInfo& fileInfo, const Fi
                     .publicMeta = fileMeta.publicMeta,
                     .privateMeta = fileMeta.privateMeta,
                     .fileSize = fileMeta.internalFileMeta.size,
-                    .internalMeta = core::Buffer::from(utils::Utils::stringifyVar(fileMeta.internalFileMeta.toJSON()))
+                    .internalMeta = core::Buffer::from(fileMeta.internalFileMeta.serialize())
                 },
                 _userPrivKey,
                 encKey.key
@@ -41,7 +41,7 @@ Poco::Dynamic::Var FileMetaEncryptor::encrypt(const FileInfo& fileInfo, const Fi
                 store::FileMetaToEncryptV5{
                     .publicMeta = fileMeta.publicMeta,
                     .privateMeta = fileMeta.privateMeta,
-                    .internalMeta = core::Buffer::from(utils::Utils::stringifyVar(fileMeta.internalFileMeta.toJSON())),
+                    .internalMeta = core::Buffer::from(fileMeta.internalFileMeta.serialize()),
                     .dio = createDIO(fileInfo)
                 },
                 _userPrivKey,
diff --git a/endpoint/store/src/encryptors/file/FileMetaEncryptorV1.cpp b/endpoint/store/src/encryptors/file/FileMetaEncryptorV1.cpp
@@ -19,7 +19,7 @@ limitations under the License.
 using namespace privmx::endpoint::store;
 
 std::string FileMetaEncryptorV1::signAndEncrypt(const dynamic::compat_v1::StoreFileMeta& data, const privmx::crypto::PrivateKey& priv, const std::string& key) {
-    auto buffer {utils::Utils::stringify(data.toJSON())};
+    auto buffer {data.serialize()};
     auto signature = priv.signToCompactSignatureWithHash(buffer);
     std::string plain;
     plain.push_back(1);
diff --git a/utils/include/privmx/utils/JsonHelper.hpp b/utils/include/privmx/utils/JsonHelper.hpp
@@ -24,6 +24,7 @@ limitations under the License.
 #include <Poco/JSON/Object.h>
 #include <privmx/utils/PrivmxExtExceptions.hpp>
 #include <privmx/utils/Logger.hpp>
+#include <privmx/utils/Utils.hpp>
 
 namespace privmx {
 namespace utils {
@@ -261,11 +262,17 @@ struct STRUCT_NAME { \
         obj._parseFields(JSON); \
         return obj; \
     } \
+    static STRUCT_NAME deserialize(std::string JSON_string) { \
+        return STRUCT_NAME::fromJSON(privmx::utils::Utils::parseJsonObject(JSON_string)); \
+    } \
     Poco::JSON::Object::Ptr toJSON() const { \
         Poco::JSON::Object::Ptr result(new Poco::JSON::Object()); \
         serializeFields(result); \
         return result; \
     } \
+    std::string serialize() const { \
+        return privmx::utils::Utils::stringify(toJSON()); \
+    } \
 protected: \
     void _parseFields(Poco::JSON::Object::Ptr JSON) { FIELDS(_JSON_FROM) } \
     void serializeFields([[maybe_unused]] Poco::JSON::Object::Ptr result) const { FIELDS(_JSON_TO) } \
@@ -289,12 +296,18 @@ struct STRUCT_NAME : public BASE_NAME { \
         obj._parseFields(JSON); \
         return obj; \
     } \
+    static STRUCT_NAME deserialize(std::string JSON_string) { \
+        return STRUCT_NAME::fromJSON(privmx::utils::Utils::parseJsonObject(JSON_string)); \
+    } \
     Poco::JSON::Object::Ptr toJSON() const { \
         Poco::JSON::Object::Ptr result(new Poco::JSON::Object()); \
         BASE_NAME::serializeFields(result); \
         serializeFields(result); \
         return result; \
     } \
+    std::string serialize() const { \
+        return privmx::utils::Utils::stringify(toJSON()); \
+    } \
 protected: \
     void _parseFields(Poco::JSON::Object::Ptr JSON) { \
         BASE_NAME::_parseFields(JSON); \

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ std::vector<std::string> Subscriber::subscribeFor(const std::vector<std::string>`
`77`	`77`	`model.channels.push_back(subscriptionQueryString);`
`78`	`78`	`}`
`79`	`79`	`}`
`80`		`- LOG_INFO("Subscriber:subscribeFor channels:" + privmx::utils::Utils::stringifyVar(model.toJSON()));`
	`80`	`+ LOG_INFO("Subscriber:subscribeFor channels:" + model.serialize());`
`81`	`81`	`auto requestResult = _gateway->request("subscribeToChannels", model.toJSON(), {.channel_type = rpc::ChannelType::WEBSOCKET});`
`82`	`82`	`server::SubscribeToChannelsResult value = privmx::endpoint::core::server::SubscribeToChannelsResult::fromJSON(requestResult);`
`83`	`83`	`LOG_TIME_DEBUG_CHECKPOINT(Subscriber:subscribeFor, "dataRecived")`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ std::string DIOEncryptorV1::signAndEncode(const ExpandedDataIntegrityObject& dio`
`45`	`45`	`} else {`
`46`	`46`	`dioJSON.bridgeIdentity = std::nullopt;`
`47`	`47`	`}`
`48`		`- return _dataEncryptor.encode(_dataEncryptor.signAndPackDataWithSignature(core::Buffer::from(privmx::utils::Utils::stringify(dioJSON.toJSON())), authorKey));`
	`48`	`+ return _dataEncryptor.encode(_dataEncryptor.signAndPackDataWithSignature(core::Buffer::from(dioJSON.serialize()), authorKey));`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`ExpandedDataIntegrityObject DIOEncryptorV1::decodeAndVerify(const std::string& signedDio) {`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ void EventApiImpl::emitEventEx(const std::string& contextId, const std::vector<c`
`196`	`196`	`model.channel = channelName;`
`197`	`197`	`model.users = _eventKeyProvider.prepareKeysList(users, encryptionKey);`
`198`	`198`	`_serverApi.contextSendCustomEvent(model);`
`199`		`- PRIVMX_DEBUG("EventApiImpl", "emitEventEx", privmx::utils::Utils::stringify(model.toJSON(), true));`
	`199`	`+ PRIVMX_DEBUG("EventApiImpl", "emitEventEx", model.serialize(), true);`
`200`	`200`	`}`
`201`	`201`
`202`	`202`	`void EventApiImpl::validateChannelName(const std::string& channelName) {`
Original file line number	Diff line number	Diff line change
`@@ -575,7 +575,7 @@ store::FileMetaToEncryptV4 InboxApiImpl::prepareMeta(const privmx::endpoint::inb`
`575`	`575`	`.publicMeta = commitFileInfo.publicMeta,`
`576`	`576`	`.privateMeta = commitFileInfo.privateMeta,`
`577`	`577`	`.fileSize = commitFileInfo.size,`
`578`		`- .internalMeta = core::Buffer::from(utils::Utils::stringifyVar(internalFileMeta.toJSON()))`
	`578`	`+ .internalMeta = core::Buffer::from(internalFileMeta.serialize())`
`579`	`579`	`};`
`580`	`580`	`return fileMetaToEncrypt;`
`581`	`581`	`}`