2022-11-14 14:32:32 +00:00
|
|
|
# ente Authenticator
|
2022-11-01 06:13:06 +00:00
|
|
|
|
2022-11-14 17:16:08 +00:00
|
|
|
ente's Authenticator app helps you generate and store 2 step verification (2FA)
|
2022-11-14 16:41:14 +00:00
|
|
|
tokens on your mobile devices.
|
2022-11-14 14:32:32 +00:00
|
|
|
|
|
|
|
|
## ✨ Features
|
|
|
|
|
|
2022-11-14 16:41:14 +00:00
|
|
|
### Secure Backups
|
2022-11-14 14:32:32 +00:00
|
|
|
|
|
|
|
|
ente provides end-to-end encrypted cloud backups so that you don't have to worry
|
|
|
|
|
about losing your tokens. We use the same protocols [ente
|
|
|
|
|
Photos](https://ente.io/photos) uses to encrypt and preserve your data.
|
|
|
|
|
|
|
|
|
|
|
2022-11-14 16:41:14 +00:00
|
|
|
### Multi Device Synchronization
|
2022-11-14 14:32:32 +00:00
|
|
|
|
|
|
|
|
ente will automatically sync the 2FA tokens you add to your account, across all
|
|
|
|
|
your devices. Every new device you sign into will have access to these tokens.
|
|
|
|
|
|
|
|
|
|
|
2022-11-14 16:41:14 +00:00
|
|
|
### Offline Mode
|
2022-11-14 14:32:32 +00:00
|
|
|
|
|
|
|
|
ente generates 2FA tokens offline, so your network connectivity will not get in
|
|
|
|
|
the way of your workflow.
|
|
|
|
|
|
2022-11-14 16:41:14 +00:00
|
|
|
### Import and Export Tokens
|
2022-11-14 14:32:32 +00:00
|
|
|
|
|
|
|
|
You can add tokens to ente by one of the following methods:
|
|
|
|
|
1. Scanning a QR code
|
|
|
|
|
2. Manually entering (copy-pasting) a 2FA secret
|
|
|
|
|
3. Bulk importing from a file that contains a list of codes in the following
|
|
|
|
|
format:
|
|
|
|
|
```
|
|
|
|
|
otpauth://totp/ACCOUNT?secret=SUPERSECRET&issuer=SERVICE
|
|
|
|
|
```
|
|
|
|
|
The codes maybe separated by new lines or commas.
|
|
|
|
|
|
|
|
|
|
You can also export the codes you have added to ente, to an **unencrypted** text
|
|
|
|
|
file, that adheres to the above format.
|
|
|
|
|
|
|
|
|
|
|
2022-11-14 17:16:08 +00:00
|
|
|
## 🔩 Architecture
|
2022-11-14 14:32:32 +00:00
|
|
|
|
2022-11-14 17:16:08 +00:00
|
|
|
The architecture that powers end-to-end encrypted storage and sync of your
|
|
|
|
|
tokens has been documented [here](architecture/index.md).
|
2022-11-14 14:32:32 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## 🧑💻 Building from source
|
|
|
|
|
|
|
|
|
|
1. [Install Flutter](https://flutter.dev/docs/get-started/install)
|
|
|
|
|
2. Clone this repository with `git clone git@github.com:ente-io/auth.git`
|
|
|
|
|
3. Pull in all submodules with `git submodule update --init --recursive`
|
|
|
|
|
4. For Android, run `flutter build apk --release --flavor independent`
|
|
|
|
|
5. For iOS, run `flutter build ios`
|
|
|
|
|
|
2022-11-14 17:16:08 +00:00
|
|
|
|
|
|
|
|
## 🙋♂️ Support
|
|
|
|
|
|
|
|
|
|
If you need help, please reach out to support@ente.io, and a human will get in
|
|
|
|
|
touch with you.
|
|
|
|
|
|
|
|
|
|
On the other hand, if you wish to support us, please
|
|
|
|
|
[star](https://github.com/ente-io/auth/stargazers) this project.
|
|
|
|
|
|
2022-11-14 14:32:32 +00:00
|
|
|
|
|
|
|
|
## 💜 Community
|
|
|
|
|
- Follow us on [Twitter](https://twitter.com/enteio)
|
|
|
|
|
- Join us on [Discord](https://ente.io/discord)
|
