status-go/protocol/encryption
Pascal Precht 9c568c58cf feat: introduce messenger APIs to extract discord channels
As part of the new Discord <-> Status Community Import functionality,
we're adding an API that extracts all discord categories and channels
from a previously exported discord export file.

These APIs can be used in clients to show the user what categories and
channels will be imported later on.

There are two APIs:

1. `Messenger.ExtractDiscordCategoriesAndChannels(filesToimport
   []string) (*MessengerResponse, map[string]*discord.ImportError)`

   This takes a list of exported discord export (JSON) files (typically one per
   channel), reads them, and extracts the categories and channels into
   dedicated data structures (`[]DiscordChannel` and `[]DiscordCategory`)

   It also returns the oldest message timestamp found in all extracted
   channels.

   The API is synchronous and returns the extracted data as
   a `*MessengerResponse`. This allows to make the API available
   status-go's RPC interface.

   The error case is a `map[string]*discord.ImportError` where each key
   is a file path of a JSON file that we tried to extract data from, and
   the value a `discord.ImportError` which holds an error message and an
   error code, allowing for distinguishing between "critical" errors and
   "non-critical" errors.

2. `Messenger.RequestExtractDiscordCategoriesAndChannels(filesToImport
   []string)`

   This is the asynchronous counterpart to
   `ExtractDiscordCategoriesAndChannels`. The reason this API has been
   added is because discord servers can have a lot of message and
   channel data, which causes `ExtractDiscordCategoriesAndChannels` to
   block the thread for too long, making apps potentially feel like they
   are stuck.

   This API runs inside a go routine, eventually calls
   `ExtractDiscordCategoriesAndChannels`, and then emits a newly
   introduced `DiscordCategoriesAndChannelsExtractedSignal` that clients
   can react to.

   Failure of extraction has to be determined by the
   `discord.ImportErrors` emitted by the signal.

**A note about exported discord history files**

We expect users to export their discord histories via the
[DiscordChatExporter](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#exportguild)
tool. The tool allows to export the data in different formats, such as
JSON, HTML and CSV.

We expect users to have their data exported as JSON.

Closes: https://github.com/status-im/status-desktop/issues/6690
2022-08-04 14:34:23 +02:00
..
github.com/protocol/encryption feat: display name 2022-03-14 13:48:34 -04:00
migrations feat: introduce messenger APIs to extract discord channels 2022-08-04 14:34:23 +02:00
multidevice fix: close resultsets so we don't leak them (#1809) 2020-05-14 11:51:32 +01:00
publisher using zap.NewNop() ignores configured log level 2021-08-19 11:35:40 +02:00
sharedsecret Remove unnecessary logs & fix flaky test 2020-11-26 16:25:52 +01:00
README.md Communities encryption 2021-11-30 20:52:47 +02:00
encryption_multi_device_test.go Communities encryption 2021-11-30 20:52:47 +02:00
encryption_test.go Reduce max keep in tests 2022-07-07 13:35:12 +01:00
encryptor.go Communities encryption integration 2022-06-17 21:24:39 +03:00
persistence.go Communities encryption integration 2022-06-17 21:24:39 +03:00
persistence_keys_storage_test.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
persistence_test.go Use goimports instead of gofmt 2020-01-06 10:17:23 +01:00
protocol.go Communities encryption integration 2022-06-17 21:24:39 +03:00
protocol_message.pb.go refactor: Require request access for all communities 2022-07-08 13:16:12 +02:00
protocol_message.proto Communities encryption integration 2022-06-17 21:24:39 +03:00
protocol_test.go Communities encryption 2021-11-30 20:52:47 +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.