status-go/protocol/encryption
Igor Sirotin c1dd9397f7
refactor_: remove generated files from source control (#5878)
* fix_: gitignore generated files

* chore_: delete generated files

* fix_: update go generate instructions

* feat(Makefile)_: clean-generated-files target

* feat(Makefile)_: `generate` target

* fix(Makefile)_: dependent generate target

* ci_: run generate, update docker file deps

* fix(Makefile)_: remove `clean-generated-files` target

* fix(Makefile)_: simpler GO_GENERATE_CMD arg

* fix_: temp workspace GO_GENERATE_FAST_DIR
2024-10-03 20:59:44 +01:00
..
migrations/sqlite refactor_: remove generated files from source control (#5878) 2024-10-03 20:59:44 +01:00
multidevice chore!: simplify local pairing API (#5643) 2024-08-14 21:10:19 +01:00
publisher feat_: log on panic (#5849) 2024-09-27 06:37:32 +08: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 encryption metadata issues #4613 2024-02-07 10:25:41 +00:00
encryptor.go fix: archive decryption fail (#5076) 2024-05-27 13:49:09 +01:00
helpers.go feat(communities)_: introduce bloom filter members list 2024-07-04 17:54:29 +02:00
persistence.go fix_: loading hash_ratchet_encryption from database checks group_id 2024-05-20 14:39:46 +03: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 Add index to hash ratchet & cache processed description 2024-03-13 11:35:11 +00:00
protocol.go feat: fallback pairing seed (#5614) 2024-07-30 17:14:05 +08:00
protocol_message.proto Fix encryption metadata issues #4613 2024-02-07 10:25:41 +00: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.