status-go/protocol/encryption
Patryk Osmaczko 1d3c618fb4 feat: encrypt `CommunityDescription` fields
Extended `CommunityDescription` with a `privateData` map. This map
associates each hash ratchet `key_id` and `seq_no` with an encrypted
`CommunityDescription`. Each encrypted instance includes only data
requiring encryption.

closes: status-im/status-desktop#12851
closes: status-im/status-desktop#12852
closes: status-im/status-desktop#12853
2023-12-22 18:17:06 +01:00
..
github.com/protocol/encryption feat: display name 2022-03-14 13:48:34 -04:00
migrations feat: implemented a mechanism to retrieve shard information for a given community ID (#4499) 2023-12-22 13:37:37 +01:00
multidevice fix: use proper migrations for protocol's test database 2023-10-03 15:11:58 +02:00
publisher using zap.NewNop() ignores configured log level 2021-08-19 11:35:40 +02:00
sharedsecret fix: use proper migrations for protocol's test database 2023-10-03 15:11:58 +02:00
README.md Communities encryption 2021-11-30 20:52:47 +02:00
encryption_multi_device_test.go fix: use proper migrations for protocol's test database 2023-10-03 15:11:58 +02:00
encryption_test.go Fix issues with out of order encryption and batched messages 2023-10-30 10:11:32 +00:00
encryptor.go feat: encrypt `CommunityDescription` fields 2023-12-22 18:17:06 +01:00
helpers.go Fix encryption id && rekey with a single message 2023-10-24 20:48:54 +01:00
persistence.go feat: encrypt `CommunityDescription` fields 2023-12-22 18:17:06 +01:00
persistence_keys_storage_test.go fix: use proper migrations for protocol's test database 2023-10-03 15:11:58 +02:00
persistence_test.go feat: encrypt `CommunityDescription` fields 2023-12-22 18:17:06 +01:00
protocol.go feat: encrypt `CommunityDescription` fields 2023-12-22 18:17:06 +01:00
protocol_message.pb.go feat: kick all members after ownership change and auto-accept after sharing the address (#4187) 2023-10-31 15:20:40 +01:00
protocol_message.proto Fix encryption id && rekey with a single message 2023-10-24 20:48:54 +01:00
protocol_test.go fix: use proper migrations for protocol's test database 2023-10-03 15:11:58 +02:00
x3dh.go Create a home submodule for Eth node bridges- Rename StatusBackend to GethStatusBackend 2019-11-27 17:02:09 +01:00
x3dh_test.go Use goimports instead of gofmt 2020-01-06 10:17:23 +01:00

README.md

protocol/encryption package

Hash ratchet encryption

encryptor.GenerateHashRatchetKey() generates a hash ratchet key and stores it in in the DB. There, 2 new tables are created: hash_ratchet_encryption and hash_ratchet_encryption_cache. Each hash ratchet key is uniquely identified by the (groupId, keyId) pair, where keyId is derived from a clock value.

protocol.BuildHashRatchetKeyExchangeMessage builds an 1-on-1 message containing the hash ratchet key, given it's ID.

protocol.BuildHashRatchetMessage builds a hash ratchet message with arbitrary payload, given groupId. It will use the latest hash ratchet key available. encryptor.encryptWithHR encrypts the payload using Hash Ratchet algorithms. Intermediate hashes are stored in hash_ratchet_encryption_cache table.

protocol.HandleMessage uses encryptor.decryptWithHR fn for decryption.