This guide applies to password hash and MFA secret exports requested through Auth0 Support. Standard user exports through the Dashboard or Management API do not require PGP encryption.
What is PGP and why does Auth0 use it?
Think of PGP as a digital equivalent of a locked mailbox with two unique keys:- Public Key: This is like the address and mail slot of your mailbox. You can share it freely with anyone who wants to send you a secure package. In this case, you will provide your public key to Auth0. We will use it to lock (encrypt) your data export so that only you can open it.
- Private Key: This is the only key that can unlock your mailbox. You must keep it secret and never share it with anyone, including Auth0 Support. You will use this key to unlock (decrypt) the data export we send you.
Part 1: Generate your PGP key pair
To get started, you need to generate your own public and private key pair. This is a one-time setup that you will perform on your own computer.Recommended tools
We recommend using GnuPG (or GPG), a free, open-source, and widely trusted software for PGP encryption. Here are the recommended versions for your operating system:- Windows: Gpg4win (includes a helpful graphical user interface called Kleopatra)
- macOS: GPG Suite (integrates with macOS and includes GPG Keychain for key management)
- Linux: GnuPG is typically pre-installed. You can manage keys via the command line or with a graphical tool like Seahorse
Step-by-step generation guide
The exact steps may vary slightly depending on your chosen tool, but the general flow is the same.Download and install the recommended PGP software for your operating system. Follow the on-screen installation instructions.
This is a critical security step. Treat this like a master password. Use a long, complex, and unique passphrase that you will not forget. It is required every time you use your private key.
The default settings are often sufficient, but verifying these parameters ensures compliance and strong encryption.
Finalize the process. The software may ask you to move your mouse or type randomly to generate entropy for the key.
Part 2: Decrypt your data export
Once Auth0 Support has processed your request, we will send you a link to download a single encrypted file.Step-by-step decryption guide
On most systems with PGP software installed, you can simply right-click the file and select the Decrypt or Decrypt and Verify option.
Upon entering the correct passphrase, the software will decrypt the contents and ask you where to save the final, readable file.
Important security reminders
- Store a secure backup of your private key and its passphrase in a password manager or an offline device. If you lose your private key, you will permanently lose the ability to decrypt your data.
- The public key is safe to share. It cannot be used to decrypt your data.
- If you suspect your private key has been compromised, generate a new key pair immediately and notify Auth0 Support.