From 1afd2ce27ea091b6164db45c8ff48c633359d238 Mon Sep 17 00:00:00 2001 From: Neeraj Gupta <254676+ua741@users.noreply.github.com> Date: Tue, 5 Sep 2023 13:15:59 +0530 Subject: [PATCH] Update encrypted export doc --- migration-guides/encrypted_export.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/migration-guides/encrypted_export.md b/migration-guides/encrypted_export.md index 5b6e92fbd3..2b149209ca 100644 --- a/migration-guides/encrypted_export.md +++ b/migration-guides/encrypted_export.md @@ -2,8 +2,9 @@ ## Overview -When we export the auth codes, the data is encrypted using a key derived from the user's password. -This document describes the JSON structure used to organize exported data, including versioning and key derivation parameters. +When we export the auth codes, the data is encrypted using a key derived from the user's password. +This document describes the JSON structure used to organize exported data, including versioning and key derivation +parameters. ## Export JSON Sample @@ -27,10 +28,12 @@ The main object used to represent the export data. It contains the following key - `encryptedData"`: The encrypted authentication data. - `encryptionNonce`: The nonce used for encryption. -### Version +### Version + +Export version is used to identify the format of the export data. -Export version is used to identify the format of the export data. #### Ver: 1 + * KDF Algorithm: `ARGON2ID` * Decrypted data format: `otpauth://totp/...`, separated by a new line. * Encryption Algo: `XChaCha20-Poly1305` @@ -44,9 +47,17 @@ This section contains the parameters that were using during KDF operation: - `salt`: The salt used in the derivation process. #### Encrypted Data + As mentioned above, the auth data is encrypted using a key that's derived by using user provided password & kdf params. -For encryption, we are using `XChaCha20-Poly1305` algorithm. +For encryption, we are using `XChaCha20-Poly1305` algorithm. ## How to use the export data -* **ente Authenticator app**: You can directly import the codes in the ente Authenticator app. - >Settings -> Data -> Import Codes -> ente Encrypted export. + +* **ente Authenticator app**: You can directly import the codes in the ente Authenticator app. + > Settings -> Data -> Import Codes -> ente Encrypted export. + +* **Decryption Tool** : You can download the [decrypt tool](decrypt/decrypt) and run the following command. + + ```./decrypt ``` + +