API key
Sent to the API to authenticate source requests, including uploads and downloads. Treat it as a secret account credential.
Encryption & security
Encryption happens on your machine, before upload. Understand the key, the encrypted file, and the boundary between your server and the service.
Start free trial
See what it does, who it’s for, and whether it fits your needs.
Opens with product context and a link to this page.
Start with the distinction
Your API key authorizes requests for a backup source. Your encryption key makes the contents of your backups readable. They are separate values and are not interchangeable.
During CLI setup, CalmBackup generates 32 random bytes and stores their 64-character hexadecimal representation as the encryption_key in your local configuration. The client derives the 32-byte AES key by hashing that configuration string with SHA-256.
Sent to the API to authenticate source requests, including uploads and downloads. Treat it as a secret account credential.
Used locally to encrypt and decrypt archives. It is not included in the upload or confirmation API requests.
02 / Encryption & security
The database dump and selected directories are first packaged into a compressed archive on the source machine. AES-256-GCM then transforms that archive into ciphertext.
AES-256 provides the encryption. GCM adds an authentication tag used to detect an invalid key or modified encrypted contents when the archive is decrypted. The client creates a fresh random 12-byte nonce for each encryption operation.

The client needs access to the readable database and files. Temporary dump and archive files are created locally during the backup process.
The locally derived 256-bit key, a fresh random nonce, and the compressed archive are supplied to the encryption operation.
A version header, nonce and authentication tag are stored alongside the ciphertext. The secret encryption key is not part of the file.
The client uploads the .tar.gz.enc file. Transport security and archive encryption serve different purposes: the file remains encrypted after the transfer finishes.
The file format
The CLI uses this ordered binary format. The nonce and authentication tag can travel with the archive; neither is a substitute for the encryption key.
| Field | Size | Purpose |
|---|---|---|
| Version | 2 bytes | Identifies the archive encryption format (01 00). |
| Nonce / IV | 12 bytes | Fresh random input used for this encryption operation. |
| Authentication tag | 16 bytes | Checked during GCM decryption to authenticate the encrypted contents. |
| Ciphertext | Remaining bytes | The encrypted compressed database-and-files archive. |
04 / Encryption & security
The encryption boundary is the archive’s contents. Operating a backup service also requires metadata about the source and upload. Encryption does not make the existence or size of a backup invisible.
| Stays on the client / inside the encrypted archive | Visible to the service |
|---|---|
| Encryption key and derived AES key | Source identity and account association |
| Database contents and included file contents | Archive filename and byte size |
| Readable archive contents | Client-reported SHA-256 checksum |
| Local database credentials | Database driver, backup status and timestamps |
05 / Encryption & security
Keep a secure copy of the encryption key in a separate password manager or another protected location outside the source machine. Check that the people responsible for recovery can access it when needed.
Changing the configured key affects future backups. It does not re-encrypt previous archives. Retain the matching old key for as long as you retain backups encrypted with it.
A login password reset or replacement API key cannot recreate a lost encryption key. If every copy of the encryption key is lost, the encrypted archives cannot be recovered through an account reset.

A closer look
The reviewed upload flow stores encrypted archives and metadata. Decryption is performed by the client using the key in its local configuration. The API does not receive that encryption key.
No. Authenticated decryption establishes that the ciphertext can be opened with the key and passes the authentication check. You still need to import the database, restore files and test application behavior.
You can use a new key for subsequent backups, but old archives still require their original key. Keep a record that maps retained archives or date ranges to the appropriate recovery key.

A calmer place to start
Connect a source, keep your encryption key safe, and try a restore. Make the whole routine familiar before you need it.
Start your 14-day trial