beenull/ente
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

yarn pretty

Browse source
This commit is contained in:
Manav Rathi 2024-03-14 10:43:19 +05:30
parent b2d64d9b72
commit 60d216c6fa
No known key found for this signature in database
8 changed files with 172 additions and 94 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/docs/auth/faq/index.md
View file

@ -1,21 +1,28 @@
# Frequently Asked Questions
### How secure is ente Auth?
All codes you backup via Ente is stored end-to-end encrypted. This means only you can access your codes. Our apps are open source and our cryptography has been externally audited.
All codes you backup via Ente is stored end-to-end encrypted. This means only
you can access your codes. Our apps are open source and our cryptography has
been externally audited.
### Can I access my codes on desktop?
You can access your codes on the web @ [auth.ente.io](https://auth.ente.io).
### How can I delete or edit codes?
You can delete or edit a code by swiping left on that item.
### How can I support this project?
You can support the development of this project by subscribing to our Photos app @ [ente.io](https://ente.io).
You can support the development of this project by subscribing to our Photos app
@ [ente.io](https://ente.io).
### How can I enable FaceID lock in Ente Auth?
You can enable FaceID lock under Settings → Security → Lockscreen.
### Why does the desktop and mobile app displays different code?
Please verify that the time on both your mobile and desktop is same.

123
docs/docs/auth/migration-guides/authy/index.md
View file

@ -4,68 +4,106 @@ description: Guide for importing your existing Authy 2FA tokens into Ente Auth
---
# Migrating from Authy
A guide written by Green, an ente.io lover
> [!WARNING]
> Authy will soon be dropping support for its desktop apps in the near future. If you are looking to switch to ente Authenticator from Authy, I heavily recommend you export your codes as soon as you can.
> [!WARNING] Authy will soon be dropping support for its desktop apps in the
> near future. If you are looking to switch to ente Authenticator from Authy, I
> heavily recommend you export your codes as soon as you can.
---
Migrating from Authy can be tiring, as you cannot export your 2FA codes through the app, meaning that you would have to reconfigure 2FA for all of your accounts for your new 2FA authenticator. However, easier ways exist to export your codes out of Authy. This guide will cover two of the most used methods for mograting from Authy to ente Authenticator.
Migrating from Authy can be tiring, as you cannot export your 2FA codes through
the app, meaning that you would have to reconfigure 2FA for all of your accounts
for your new 2FA authenticator. However, easier ways exist to export your codes
out of Authy. This guide will cover two of the most used methods for mograting
from Authy to ente Authenticator.
> [!CAUTION]
> Under any circumstances, do **NOT** share any JSON and TXT files generated using this guide, as they contain your **unencrypted** TOTP secrets!
> [!CAUTION] Under any circumstances, do **NOT** share any JSON and TXT files
> generated using this guide, as they contain your **unencrypted** TOTP secrets!
>
> Also, there is **NO GUARANTEE** that these methods will export ALL of your codes. Make sure that all your accounts have been imported successfully before deleting any codes from your Authy account!
> Also, there is **NO GUARANTEE** that these methods will export ALL of your
> codes. Make sure that all your accounts have been imported successfully before
> deleting any codes from your Authy account!
---
# Method 1: Use Neeraj's export tool
**Who should use this?** General users who want to save time by skipping the hard (and rather technical) parts of the process.<br><br>
One way to export is to [use this tool by Neeraj](https://github.com/ua741/authy-export/releases/tag/v0.0.4) to simplify the process and skip directly to importing to ente Authenticator.
**Who should use this?** General users who want to save time by skipping the
hard (and rather technical) parts of the process.<br><br>
One way to export is to
[use this tool by Neeraj](https://github.com/ua741/authy-export/releases/tag/v0.0.4)
to simplify the process and skip directly to importing to ente Authenticator.
To export from Authy, download the tool for your specific OS, then type the
following in your terminal:
To export from Authy, download the tool for your specific OS, then type the following in your terminal:
```
./<binary-name> <path_to_export_file>
```
Assuming the filename of the binary remains unmodified and the working directory of the terminal is the location of the binary, you should type this for MacOS:
> [!NOTE]
> On Apple Silicon devices, Rosetta 2 may be required to run the binary.
Assuming the filename of the binary remains unmodified and the working directory
of the terminal is the location of the binary, you should type this for MacOS:
> [!NOTE] On Apple Silicon devices, Rosetta 2 may be required to run the binary.
```
./authy-export-darwin-amd64 authy_codes.txt
```
For Linux:
```
./authy-export-linux-amd64 authy_codes.txt
```
For Windows:
```
./authy-export-windows-amd64.exe authy_codes.txt
```
This will generate a text file called `authy_codes.txt`, which contains your Authy codes in ente's plaintext export format. You can now import this to ente Authenticator!
This will generate a text file called `authy_codes.txt`, which contains your
Authy codes in ente's plaintext export format. You can now import this to ente
Authenticator!
# Method 2: Use gboudreau's GitHub guide
**Who should use this?** Power users who have spare time on their hands and prefer a more "known and established" solution to exporting Authy codes.<br><br>
A user on GitHub (gboudreau) wrote a guide to export codes from Authy (morpheus on Discord found this and showed it to us), so we are going to be using that for the migration.
**Who should use this?** Power users who have spare time on their hands and
prefer a more "known and established" solution to exporting Authy codes.<br><br>
To export your data, please follow [this guide](https://gist.github.com/gboudreau/94bb0c11a6209c82418d01a59d958c93).
A user on GitHub (gboudreau) wrote a guide to export codes from Authy (morpheus
on Discord found this and showed it to us), so we are going to be using that for
the migration.
This will create a JSON file called `authy-to-bitwarden-export.json`, which contains your Authy codes in Bitwarden's export format. You can now import this to ente Authenticator!
To export your data, please follow
[this guide](https://gist.github.com/gboudreau/94bb0c11a6209c82418d01a59d958c93).
This will create a JSON file called `authy-to-bitwarden-export.json`, which
contains your Authy codes in Bitwarden's export format. You can now import this
to ente Authenticator!
# Method 2.1: If the export worked, but the import didn't
> [!NOTE]
> This is intended only for users who successfully exported their codes using the guide in method 2, but could not import it to ente Authenticator for whatever reason. If the import was successful, or you haven't tried to import the codes yet, ignore this section.
> [!NOTE] This is intended only for users who successfully exported their codes
> using the guide in method 2, but could not import it to ente Authenticator for
> whatever reason. If the import was successful, or you haven't tried to import
> the codes yet, ignore this section.
>
> If the export itself failed, try using [**method 1**](#method-1-use-neerajs-export-tool) instead.
> If the export itself failed, try using
> [**method 1**](#method-1-use-neerajs-export-tool) instead.
Usually, you should be able to import Bitwarden exports directly into ente Authenticator. In case this didn't work for whatever reason, I've written a program in Python that converts the JSON file into a TXT file that ente Authenticator can use, so you can try importing using plain text import instead.
Usually, you should be able to import Bitwarden exports directly into ente
Authenticator. In case this didn't work for whatever reason, I've written a
program in Python that converts the JSON file into a TXT file that ente
Authenticator can use, so you can try importing using plain text import instead.
You can download my program
[here](https://github.com/gweeeen/ducky/blob/main/duckys_other_stuff/authy_to_ente.py),
or you can copy the program below:
You can download my program [here](https://github.com/gweeeen/ducky/blob/main/duckys_other_stuff/authy_to_ente.py), or you can copy the program below:
```py
import json
import os
@ -84,31 +122,50 @@ writer.close()
print('Saved to ' + os.getcwd() + '/auth_codes.txt')
```
To convert the file with this program, you will need to install [Python](https://www.python.org/downloads/) on your computer.
To convert the file with this program, you will need to install
[Python](https://www.python.org/downloads/) on your computer.
Before you run the program, make sure that both the Python program and the JSON file are in the same directory, otherwise this will not work!
Before you run the program, make sure that both the Python program and the JSON
file are in the same directory, otherwise this will not work!
To run the Python program, open it in your IDE and run the program, or open your terminal and type `python3 authy_to_ente.py` (MacOS/Linux, or any other OS that uses bash) or `py -3 authy_to_ente.py` (Windows). Once you run it, a new TXT file called `auth_codes.txt` will be generated. You can now import your data to ente Authenticator!
To run the Python program, open it in your IDE and run the program, or open your
terminal and type `python3 authy_to_ente.py` (MacOS/Linux, or any other OS that
uses bash) or `py -3 authy_to_ente.py` (Windows). Once you run it, a new TXT
file called `auth_codes.txt` will be generated. You can now import your data to
ente Authenticator!
---
You should now have a TXT file (method 1, method 2.1) or a JSON file (method 2) that countains your TOTP secrets, which can now be imported into ente Authenticator. To import your codes, please follow one of the steps below, depending on which method you used to export your codes.
You should now have a TXT file (method 1, method 2.1) or a JSON file (method 2)
that countains your TOTP secrets, which can now be imported into ente
Authenticator. To import your codes, please follow one of the steps below,
depending on which method you used to export your codes.
# Importing to ente Authenticator (Method 1, method 2.1)
1. Copy the TXT file to one of your devices with ente Authenticator.
2. Log in to your account (if you haven't already), or press "Use without backups".
3. Open the navigation menu (hamburger button on the top left), then press "Data", then press "Import codes".
2. Log in to your account (if you haven't already), or press "Use without
backups".
3. Open the navigation menu (hamburger button on the top left), then press
"Data", then press "Import codes".
4. Select the "Plain text" option.
5. Select the TXT file that was made earlier.
# Importing to ente Authenticator (Method 2)
1. Copy the JSON file to one of your devices with ente Authenticator.
2. Log in to your account (if you haven't already), or press "Use without backups".
3. Open the navigation menu (hamburger button on the top left), then press "Data", then press "Import codes".
2. Log in to your account (if you haven't already), or press "Use without
backups".
3. Open the navigation menu (hamburger button on the top left), then press
"Data", then press "Import codes".
4. Select the "Bitwarden" option.
5. Select the JSON file that was made earlier.
If this didn't work, refer to [**method 2.1**](#method-21-if-the-export-worked-but-the-import-didnt).<br><br>
If this didn't work, refer to
[**method 2.1**](#method-21-if-the-export-worked-but-the-import-didnt).<br><br>
And that's it! You have now successfully migrated from Authy to ente Authenticator.
And that's it! You have now successfully migrated from Authy to ente
Authenticator.
Now that your secrets are safely stored, I recommend you delete the unencrypted JSON and TXT files that were made during the migration process for security.
Now that your secrets are safely stored, I recommend you delete the unencrypted
JSON and TXT files that were made during the migration process for security.

62
docs/docs/auth/migration-guides/export.md
View file

@ -9,31 +9,32 @@ description: Guide for exporting your 2FA codes out from Ente Auth
### 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
```json
{
"version": 1,
"kdfParams": {
"memLimit": 4096,
"opsLimit": 3,
"salt": "example_salt"
},
"encryptedData": "encrypted_data_here",
"encryptionNonce": "nonce_here"
"version": 1,
"kdfParams": {
"memLimit": 4096,
"opsLimit": 3,
"salt": "example_salt"
},
"encryptedData": "encrypted_data_here",
"encryptionNonce": "nonce_here"
}
```
The main object used to represent the export data. It contains the following key-value pairs:
The main object used to represent the export data. It contains the following
key-value pairs:
- `version`: The version of the export format.
- `kdfParams`: Key derivation function parameters.
- `encryptedData"`: The encrypted authentication data.
- `encryptionNonce`: The nonce used for encryption.
- `version`: The version of the export format.
- `kdfParams`: Key derivation function parameters.
- `encryptedData"`: The encrypted authentication data.
- `encryptionNonce`: The nonce used for encryption.
#### Version
@ -41,29 +42,34 @@ 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`
- KDF Algorithm: `ARGON2ID`
- Decrypted data format: `otpauth://totp/...`, separated by a new line.
- Encryption Algo: `XChaCha20-Poly1305`
##### Key Derivation Function Params (KDF)
##### Key Derivation Function Params (KDF)
This section contains the parameters that were using during KDF operation:
- `memLimit`: Memory limit for the algorithm.
- `opsLimit`: Operations limit for the algorithm.
- `salt`: The salt used in the derivation process.
- `memLimit`: Memory limit for the algorithm.
- `opsLimit`: Operations limit for the algorithm.
- `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.
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.
## How to use the exported 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.
* **Decrypt using Ente CLI** : Download the latest version of [Ente CLI](https://github.com/ente-io/ente/releases?q=CLI&expanded=false), and run the following command
> Settings -> Data -> Import Codes -> ente Encrypted export.
- **Decrypt using Ente CLI** : Download the latest version of
[Ente CLI](https://github.com/ente-io/ente/releases?q=CLI&expanded=false),
and run the following command
```
./ente auth decrypt <export_file> <output_file>

7
docs/docs/auth/migration-guides/index.md
View file

@ -1,9 +1,10 @@
---
title: Migrating to Ente Auth
description: Guides for migrating your existing 2FA tokens into or out of Ente Auth
description:
Guides for migrating your existing 2FA tokens into or out of Ente Auth
---
# Migrating to/from Ente Auth
* [Migrating from Authy](authy/)
* [Exporting your data out of Ente Auth](export)
- [Migrating from Authy](authy/)
- [Exporting your data out of Ente Auth](export)

6
docs/docs/photos/faq/index.md
View file

@ -3,9 +3,7 @@ title: FAQ
description: Frequently asked questions about Ente Photos
---
# FAQ
_Coming soon_. On this page we'll document some help items in a question and answer format.
_Coming soon_. On this page we'll document some help items in a question and
answer format.

30
docs/docs/self-hosting/guides/custom-server/index.md
View file

@ -22,22 +22,32 @@ configure the endpoint the app should be connecting to.
# CLI
> [!WARNING]
> The new version of CLI that supports connecting to custom server is still in beta.
> You can download the beta version from [here](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0&expanded=true)
> [!WARNING] The new version of CLI that supports connecting to custom server is
> still in beta. You can download the beta version from
> [here](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0&expanded=true)
Define a config.yaml and put it either in the same directory as CLI or path defined in env variable `ENTE_CLI_CONFIG_PATH`
Define a config.yaml and put it either in the same directory as CLI or path
defined in env variable `ENTE_CLI_CONFIG_PATH`
```yaml
endpoint:
api: "http://localhost:8080"
api: "http://localhost:8080"
```
You should be able to [add an account](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_add.md), and subsequently increase the [storage and account validity](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_admin_update-subscription.md) using the CLI.
You should be able to
[add an account](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_add.md),
and subsequently increase the
[storage and account validity](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_admin_update-subscription.md)
using the CLI.
For the admin actions, you can create `server/museum.yaml`, and whitelist add the admin userID `internal.admins`. See [local.yaml](https://github.com/ente-io/ente/blob/main/server/configurations/local.yaml#L211C1-L232C1) in the server source code for details about how to define this.
For the admin actions, you can create `server/museum.yaml`, and whitelist add
the admin userID `internal.admins`. See
[local.yaml](https://github.com/ente-io/ente/blob/main/server/configurations/local.yaml#L211C1-L232C1)
in the server source code for details about how to define this.
You can use [account list](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_list.md) command to find the user id of any account.
You can use
[account list](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_list.md)
command to find the user id of any account.
```yaml
....
@ -45,5 +55,5 @@ internal:
admins:
# - 1580559962386440
....
```
....
```

9
docs/docs/self-hosting/guides/index.md
View file

@ -10,9 +10,8 @@ walkthroughs, tutorials and other FAQ pages in this directory.
See the sidebar for existing guides. In particular:
* If you're just looking to get started, see [configure custom
server](custom-server/).
* For self hosting both the server and web app using external S3 buckets for
object storage, see [using external S3](external-s3).
- If you're just looking to get started, see
[configure custom server](custom-server/).
- For self hosting both the server and web app using external S3 buckets for
object storage, see [using external S3](external-s3).

14
docs/docs/self-hosting/guides/mobile-build.md
View file

@ -30,8 +30,6 @@ flutter run --dart-define=endpoint=http://localhost:8080 --flavor independent --
flutter run --dart-define=endpoint=http://localhost:8080
```
Or for the auth app:
```sh
@ -46,9 +44,11 @@ flutter run --dart-define=endpoint=http://localhost:8080
```
## How to build non-debug builds
For building APK, [setup your
keystore](https://docs.flutter.dev/deployment/android#create-an-upload-keystore)
and run
```sh
For building APK,
[setup your keystore](https://docs.flutter.dev/deployment/android#create-an-upload-keystore)
and run
```sh
flutter build apk --release --flavor independent -t lib/main.dart
```
```