diff --git a/README.md b/README.md index 4ad84c56e..b83977772 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ Please ⭐ this repo to be notified of updates. ## 🔩 Architecture The architecture that powers end-to-end encrypted storage and sync of your -tokens has been documented [here](architecture/index.md). +tokens has been documented [here](architecture/README.md). ## 🧑‍💻 Building from source diff --git a/architecture/index.md b/architecture/README.md similarity index 94% rename from architecture/index.md rename to architecture/README.md index 260fb4a44..ceb31af34 100644 --- a/architecture/index.md +++ b/architecture/README.md @@ -8,7 +8,7 @@ specifications of the underlying cryptography. Your data is end-to-end encrypted with **ente**. Meaning, they are encrypted with your `keys` before they leave your device. -
@@ -39,7 +39,7 @@ leaves your device. During registration, your `masterKey` is encrypted with your`keyEncryptionKey`, and the resultant `encryptedMasterKey` is then sent to our servers for storage. - + #### Secondary Device @@ -92,7 +92,7 @@ leave your device unencrypted. - All of the above mentioned encrypted data is then pushed to the server for storage. - #### Download @@ -149,7 +149,7 @@ the server (as discussed in [Key Encryption](#key-encryption), and decrypts it with the entered `recoveryKey`. If the decryption succeeds, the client will know that you have entered the correct `recoveryKey`. - + Now that you have your `masterKey`, the client will prompt you to set a new password, using which it will derive a new `keyEncryptionKey`. This is then used @@ -204,12 +204,12 @@ your `publicKey`. This `encryptedAuthToken` can only be decrypted with your - This decrypted `authToken` can then from there on be used to authenticate all API calls against our servers. - + ### Security Only by verifying access to your email and knowing your password can you obtain -an`authToken` that can be used to authenticate yourself against our servers. +an `authToken` that can be used to authenticate yourself against our servers. --- diff --git a/architecture/authentication.svg b/architecture/assets/authentication.svg similarity index 100% rename from architecture/authentication.svg rename to architecture/assets/authentication.svg diff --git a/architecture/e2ee.svg b/architecture/assets/e2ee.svg similarity index 100% rename from architecture/e2ee.svg rename to architecture/assets/e2ee.svg diff --git a/architecture/key-derivation.svg b/architecture/assets/key-derivation.svg similarity index 100% rename from architecture/key-derivation.svg rename to architecture/assets/key-derivation.svg diff --git a/architecture/recovery.svg b/architecture/assets/recovery.svg similarity index 100% rename from architecture/recovery.svg rename to architecture/assets/recovery.svg diff --git a/architecture/token-encryption.svg b/architecture/assets/token-encryption.svg similarity index 100% rename from architecture/token-encryption.svg rename to architecture/assets/token-encryption.svg diff --git a/architecture/file-encryption.svg b/architecture/file-encryption.svg deleted file mode 100644 index f9f8b2b37..000000000 --- a/architecture/file-encryption.svg +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/architecture/sharing.svg b/architecture/sharing.svg deleted file mode 100644 index a5c4d5dce..000000000 --- a/architecture/sharing.svg +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - - - - - - - - - - - - -