Skip to content

Commit 95b9fe7

Browse files
mpretty-cyrompretty-cyro
authored
Merge pull request #43 from mpretty-cyro/fix/rename_keys_current_hashes
Renamed current_hashes on GroupKeys to active_hashes for consistency
2 parents 3f71894 + cb84438 commit 95b9fe7

File tree

4 files changed

+27
-27
lines changed

4 files changed

+27
-27
lines changed

‎include/session/config/groups/keys.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ LIBSESSION_EXPORT bool groups_keys_load_message(
246246
config_object* info,
247247
config_object* members) LIBSESSION_WARN_UNUSED;
248248

249-
/// API: groups/groups_keys_current_hashes
249+
/// API: groups/groups_keys_active_hashes
250250
///
251251
/// Returns the hashes of currently active keys messages, that is, messages that have a decryption
252252
/// key that new devices or clients might require; these are the messages that should have their
@@ -258,7 +258,7 @@ LIBSESSION_EXPORT bool groups_keys_load_message(
258258
/// Outputs:
259259
/// - `config_string_list*` -- pointer to an array of message hashes. The returned pointer belongs
260260
/// to the caller and must be free()d when done.
261-
LIBSESSION_EXPORT config_string_list* groups_keys_current_hashes(const config_group_keys* conf);
261+
LIBSESSION_EXPORT config_string_list* groups_keys_active_hashes(const config_group_keys* conf);
262262

263263
/// API: groups/groups_keys_needs_rekey
264264
///

‎include/session/config/groups/keys.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ class Keys : public ConfigSig {
584584
Info& info,
585585
Members& members);
586586

587-
/// API: groups/Keys::current_hashes
587+
/// API: groups/Keys::active_hashes
588588
///
589589
/// Returns a set of message hashes of messages that contain currently active decryption keys.
590590
/// These are the messages that should be periodically renewed by clients with write access to
@@ -594,7 +594,7 @@ class Keys : public ConfigSig {
594594
///
595595
/// Outputs:
596596
/// - vector of message hashes
597-
std::unordered_set<std::string> current_hashes() const;
597+
std::unordered_set<std::string> active_hashes() const;
598598

599599
/// API: groups/Keys::needs_rekey
600600
///

‎src/config/groups/keys.cpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1124,7 +1124,7 @@ bool Keys::load_key_message(
11241124
return false;
11251125
}
11261126

1127-
std::unordered_set<std::string> Keys::current_hashes() const {
1127+
std::unordered_set<std::string> Keys::active_hashes() const {
11281128
std::unordered_set<std::string> hashes;
11291129
for (const auto& [g, hash] : active_msgs_)
11301130
hashes.insert(hash.begin(), hash.end());
@@ -1592,8 +1592,8 @@ LIBSESSION_C_API bool groups_keys_load_message(
15921592
false);
15931593
}
15941594

1595-
LIBSESSION_C_API config_string_list* groups_keys_current_hashes(const config_group_keys* conf) {
1596-
return make_string_list(unbox(conf).current_hashes());
1595+
LIBSESSION_C_API config_string_list* groups_keys_active_hashes(const config_group_keys* conf) {
1596+
return make_string_list(unbox(conf).active_hashes());
15971597
}
15981598

15991599
LIBSESSION_C_API bool groups_keys_needs_rekey(const config_group_keys* conf) {

‎tests/test_group_keys.cpp‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
181181
CHECK(a.info.merge(info_configs) == std::unordered_set{{"fakehash1"s}});
182182
CHECK(a.members.merge(mem_configs) == std::unordered_set{{"fakehash1"s}});
183183
CHECK(a.members.size() == 1);
184-
CHECK(a.keys.current_hashes() == std::unordered_set{{"keyhash1"s}});
184+
CHECK(a.keys.active_hashes() == std::unordered_set{{"keyhash1"s}});
185185
}
186186

187187
/* All attempts to merge non-admin members will throw, as none of the non admin members
@@ -193,7 +193,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
193193
CHECK_THROWS(m.info.merge(info_configs));
194194
CHECK_THROWS(m.members.merge(mem_configs));
195195
CHECK(m.members.size() == 0);
196-
CHECK(m.keys.current_hashes().empty());
196+
CHECK(m.keys.active_hashes().empty());
197197
}
198198

199199
info_configs.clear();
@@ -228,7 +228,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
228228
CHECK(a.info.merge(info_configs) == std::unordered_set{{"fakehash2"s}});
229229
CHECK(a.members.merge(mem_configs) == std::unordered_set{{"fakehash2"s}});
230230
CHECK(a.members.size() == 5);
231-
CHECK(a.keys.current_hashes() == std::unordered_set{{"keyhash1"s, "keyhash2"s}});
231+
CHECK(a.keys.active_hashes() == std::unordered_set{{"keyhash1"s, "keyhash2"s}});
232232
}
233233

234234
for (auto& m : members) {
@@ -237,7 +237,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
237237
CHECK(m.info.merge(info_configs) == std::unordered_set{{"fakehash2"s}});
238238
CHECK(m.members.merge(mem_configs) == std::unordered_set{{"fakehash2"s}});
239239
CHECK(m.members.size() == 5);
240-
CHECK(m.keys.current_hashes() == std::unordered_set{{"keyhash2"s}});
240+
CHECK(m.keys.active_hashes() == std::unordered_set{{"keyhash2"s}});
241241
}
242242

243243
info_configs.clear();
@@ -270,7 +270,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
270270
CHECK(a.info.get_name() == "tomatosauce"s);
271271
CHECK(a.info.get_description() ==
272272
"this is where you go to play in the tomato sauce, I guess"s);
273-
CHECK(a.keys.current_hashes() ==
273+
CHECK(a.keys.active_hashes() ==
274274
std::unordered_set{{"keyhash1"s, "keyhash2"s, "keyhash3"s}});
275275
}
276276

@@ -282,7 +282,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
282282
CHECK(m.info.get_name() == "tomatosauce"s);
283283
CHECK(m.info.get_description() ==
284284
"this is where you go to play in the tomato sauce, I guess"s);
285-
CHECK(m.keys.current_hashes() == std::unordered_set{{"keyhash2"s, "keyhash3"s}});
285+
CHECK(m.keys.active_hashes() == std::unordered_set{{"keyhash2"s, "keyhash3"s}});
286286
}
287287

288288
info_configs.clear();
@@ -318,7 +318,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
318318
CHECK(a.info.merge(info_configs) == std::unordered_set{{"fakehash4"s}});
319319
CHECK(a.members.merge(mem_configs) == std::unordered_set{{"fakehash4"s}});
320320
CHECK(a.members.size() == 3);
321-
CHECK(a.keys.current_hashes() ==
321+
CHECK(a.keys.active_hashes() ==
322322
std::unordered_set{{"keyhash1"s, "keyhash2"s, "keyhash3"s, "keyhash4"s}});
323323
}
324324

@@ -327,7 +327,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
327327
bool found_key = m.keys.load_key_message(
328328
"keyhash4", new_keys_config2, get_timestamp_ms(), m.info, m.members);
329329

330-
CHECK(m.keys.current_hashes() ==
330+
CHECK(m.keys.active_hashes() ==
331331
std::unordered_set{{"keyhash2"s, "keyhash3"s, "keyhash4"s}});
332332
if (i < 2) { // We should still be in the group
333333
CHECK(found_key);
@@ -425,10 +425,10 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
425425
CHECK(m.members.size() == 5);
426426

427427
if (i < 2)
428-
CHECK(m.keys.current_hashes() ==
428+
CHECK(m.keys.active_hashes() ==
429429
std::unordered_set{{"keyhash2"s, "keyhash3"s, "keyhash4"s, "keyhash5"s}});
430430
else
431-
CHECK(m.keys.current_hashes() == std::unordered_set{{"keyhash5"s}});
431+
CHECK(m.keys.active_hashes() == std::unordered_set{{"keyhash5"s}});
432432
}
433433

434434
std::pair<std::string, std::vector<unsigned char>> decrypted1, decrypted2;
@@ -457,7 +457,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
457457
members[1].keys.dump());
458458
CHECK(m1b.keys.size() == 4);
459459
CHECK(m1b.keys.group_keys().size() == 4);
460-
CHECK(m1b.keys.current_hashes() ==
460+
CHECK(m1b.keys.active_hashes() ==
461461
std::unordered_set{{"keyhash2"s, "keyhash3"s, "keyhash4"s, "keyhash5"s}});
462462
CHECK(m1b.members.size() == 5);
463463
auto m1b_m2 = m1b.members.get(members[2].session_id);
@@ -490,13 +490,13 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
490490
CHECK(a.info.merge(info_configs) == std::unordered_set{{"ifakehash6"s}});
491491
CHECK(a.members.merge(mem_configs) == std::unordered_set{{"mfakehash6"s}});
492492
CHECK(a.members.size() == 5);
493-
CHECK(a.keys.current_hashes() == std::unordered_set{
494-
{"keyhash1"s,
495-
"keyhash2"s,
496-
"keyhash3"s,
497-
"keyhash4"s,
498-
"keyhash5"s,
499-
"keyhash6"s}});
493+
CHECK(a.keys.active_hashes() == std::unordered_set{
494+
{"keyhash1"s,
495+
"keyhash2"s,
496+
"keyhash3"s,
497+
"keyhash4"s,
498+
"keyhash5"s,
499+
"keyhash6"s}});
500500
}
501501

502502
std::vector<unsigned char> new_keys_config7 =
@@ -526,7 +526,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
526526
CHECK(a.info.merge(info_configs) == std::unordered_set{{"ifakehash6"s, "ifakehash7"s}});
527527
CHECK(a.members.merge(mem_configs) == std::unordered_set{{"mfakehash6"s, "mfakehash7"s}});
528528
CHECK(a.members.size() == 5);
529-
CHECK(a.keys.current_hashes() == std::unordered_set{{"keyhash6"s, "keyhash7"s}});
529+
CHECK(a.keys.active_hashes() == std::unordered_set{{"keyhash6"s, "keyhash7"s}});
530530
}
531531

532532
for (size_t i = 0; i < members.size(); i++) {
@@ -546,7 +546,7 @@ TEST_CASE("Group Keys - C++ API", "[config][groups][keys][cpp]") {
546546
CHECK(m.info.merge(info_configs) == std::unordered_set{{"ifakehash6"s, "ifakehash7"s}});
547547
CHECK(m.members.merge(mem_configs) == std::unordered_set{{"mfakehash6"s, "mfakehash7"s}});
548548
CHECK(m.members.size() == 5);
549-
CHECK(m.keys.current_hashes() == std::unordered_set{{"keyhash6"s, "keyhash7"s}});
549+
CHECK(m.keys.active_hashes() == std::unordered_set{{"keyhash6"s, "keyhash7"s}});
550550
}
551551

552552
// Make sure keys propagate on dump restore to info/members:

0 commit comments

Comments
 (0)