Exporting your data out of Ente Auth
How do I create an encrypted export?
- Open
Settings > Data > Exportin Ente Auth. - Select Encrypted.
- Choose a strong password for this export. This is the export-encryption password you will need when importing the file; it is not automatically your Ente account password.
- Complete any device-authentication prompt and save the exported file in a private location outside the app. Keep a copy somewhere you can access after a device reset or change.
- Keep the export password safe. Ente cannot recover it for you. Before relying on the backup or removing the original codes, verify that you can import the file on another trusted installation and that the entries you need are present and work.
Keep a working copy of your codes while testing an export. Do not send the export, its password, or the underlying setup keys to support.
Auth Encrypted Export format
Overview
An encrypted Auth export uses a key derived from the password you choose when creating that export. Importing the file requires that export password. Changing your Ente account password does not change the password of an existing export.
The following sections describe the JSON structure, versioning, and key derivation parameters of the encrypted export.
Export JSON Sample
{
"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:
version: The version of the export format.kdfParams: Key derivation function parameters.encryptedData": The encrypted authentication data.encryptionNonce: The nonce used for encryption.
Version
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
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.
Encrypted Data
The Auth data is encrypted with XChaCha20-Poly1305. The encryption key is derived from the export password and the key derivation parameters stored in the file.
Automated backups
You can use Ente's CLI to automatically backup your Auth codes.
To export your data, add an account using ente account add command. In the first step, specify auth as the app name. At a later point, CLI will also ask you specify the path where it should write the exported codes.
You can change the export directory using following command
ente account update --app auth --email <email> --dir <path>Local backups
Ente Auth supports continuous on-device local backups to protect your codes even when offline. This feature creates encrypted backups on your device automatically.
How it works:
- Automatic daily backups: When enabled, Ente Auth creates one local backup per day when you open the app.
- Password-protected: All local backups are encrypted with a password you set. Keep this password safe, because Ente cannot recover it for you.
- Custom backup location: Choose where to store your backups on your device.
- Backup retention: The app keeps up to 5 most recent backups and automatically removes older ones.
If you use Ente Auth in offline mode, encrypted exports and local backups are the supported recovery path. Device transfers and OS backups should not be treated as a backup for offline codes. Store the backup or export file in a separate location you can access after a reset or device change. Learn more about using offline mode safely.
Setting up local backups:
- Open
Settings > Data > Local backup. - Enable Automatic backups.
- Set a backup password (minimum 8 characters).
- Select a folder where backups will be stored.
Manual backups:
You can trigger a manual backup at any time using the Create backup now button. Manual backups are useful before making significant changes to your codes.
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.
Decrypt using Ente CLI : Download the latest version of Ente CLI, and run the following command
./ente auth decrypt <export_file> <output_file>