docs(backups): encryption algorithms #8266

thomas-dkmt · 2025-01-23T15:54:22Z

Explain how backups are encrypted by Xen Orchestra, what each encryption algorithm (AES-256-GCM and ChaCha20-Poly1305) does, and how it works with Amazon S3.

Explain how backups are encrypted by Xen Orchestra, what each encryption algorithm does, and how it works with Amazon S3 Signed-off-by: Thomas Moraine <[email protected]>

julien-f · 2025-01-23T17:15:45Z

docs/docs/backups.md

@@ -26,6 +26,43 @@ Each backups' job execution is identified by a `runId`. You can find this `runId

 ![](./assets/log-runId.png)

+## Backup Encryption
+
+Xen Orchestra ensures robust data security for backups stored in Amazon S3 by leveraging advanced encryption algorithms. Here’s a closer look at how encryption works and the technology behind it:


Encryption is compatible will all remotes, not only Amazon S3.

Encryption is opt-in and requires configuring an encryption key on the remote (page Settings/Remotes), I think we should show that.

Fixed by 6587b3a

julien-f · 2025-01-23T17:18:36Z

docs/docs/backups.md

+
+Currently, backups use the `AES-256-GCM` encryption algorithm. While this is a highly secure option, it does have a file size limitation of 64 GiB. This isn’t an issue when working with Amazon S3, as the data is split into smaller blocks, making it fully compatible with the platform.
+
+In addition, this algorithm is fully compliant with [ANSSI guidelines](https://cyber.gouv.fr/sites/default/files/2021/03/anssi-guide-selection_crypto-1.0.pdf).


Suggested change

In addition, this algorithm is fully compliant with [ANSSI guidelines](https://cyber.gouv.fr/sites/default/files/2021/03/anssi-guide-selection_crypto-1.0.pdf).

In addition, this algorithm is fully compliant with [ANSSI guidelines 🇫🇷](https://cyber.gouv.fr/sites/default/files/2021/03/anssi-guide-selection_crypto-1.0.pdf).

Fixed by e4be723.

Replaced the flag with a 'French' label. Flags aren't good practice, as per https://www.flagsarenotlanguages.com/

julien-f · 2025-01-23T17:20:15Z

docs/docs/backups.md

+
+### Current Encryption Algorithm: `AES-256-GCM`
+
+Currently, backups use the `AES-256-GCM` encryption algorithm. While this is a highly secure option, it does have a file size limitation of 64 GiB. This isn’t an issue when working with Amazon S3, as the data is split into smaller blocks, making it fully compatible with the platform.


Suggested change

Currently, backups use the `AES-256-GCM` encryption algorithm. While this is a highly secure option, it does have a file size limitation of 64 GiB. This isn’t an issue when working with Amazon S3, as the data is split into smaller blocks, making it fully compatible with the platform.

Currently, backups use the [`AES-256-GCM`](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) encryption algorithm. While this is a highly secure option, it does have a file size limitation of 64 GiB. This isn’t an issue when working with Amazon S3, as the data is split into smaller blocks, making it fully compatible with the platform.

Fixed by 259124a

julien-f · 2025-01-23T17:23:17Z

docs/docs/backups.md

+
+To improve flexibility and performance, Xen Orchestra will transition to the `ChaCha20-Poly1305` encryption algorithm by February 2025. This update addresses the file size limitations of `AES-256-GCM` while maintaining a high level of security and compliance with ANSSI guidelines.
+
+Backup repositories that were encrypted with `AES-256-GCM` will remain accessible, to ensure a smooth transition.


Suggested change

Backup repositories that were encrypted with `AES-256-GCM` will remain accessible, to ensure a smooth transition.

Backup repositories that were encrypted with `AES-256-GCM` will remain accessible, to ensure a smooth transition.

This algorithm is also fully compliant with [ANSSI guidelines 🇫🇷](https://cyber.gouv.fr/sites/default/files/2021/03/anssi-guide-selection_crypto-1.0.pdf).

Fixed by e4be723.

Replaced the flag with a 'French' label. Flags aren't good practice, as per https://www.flagsarenotlanguages.com

julien-f · 2025-01-23T17:23:40Z

docs/docs/backups.md

+
+### Upcoming Change: `ChaCha20-Poly1305`
+
+To improve flexibility and performance, Xen Orchestra will transition to the `ChaCha20-Poly1305` encryption algorithm by February 2025. This update addresses the file size limitations of `AES-256-GCM` while maintaining a high level of security and compliance with ANSSI guidelines.


Suggested change

To improve flexibility and performance, Xen Orchestra will transition to the `ChaCha20-Poly1305` encryption algorithm by February 2025. This update addresses the file size limitations of `AES-256-GCM` while maintaining a high level of security and compliance with ANSSI guidelines.

To improve flexibility and performance, Xen Orchestra will transition to the [`ChaCha20-Poly1305`](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) encryption algorithm by February 2025. This update addresses the file size limitations of `AES-256-GCM` while maintaining a high level of security and compliance with ANSSI guidelines.

Fixed by 259124a

julien-f · 2025-01-23T17:25:12Z

docs/docs/backups.md

+### How It Works
+
+#### AES-256-GCM
+
+`AES-256-GCM` is a symmetric-key cryptographic block cipher, which is a method for encrypting data that ensures both confidentiality and integrity.
+
+This method uses a 256-bit secret key and a unique initialization vector (IV) to encrypt data with the AES algorithm, transforming it into unreadable blocks.
+The "GCM" part (Galois/Counter Mode) adds a verification tag to detect any tampering with the encrypted data. To decrypt, the same key and IV are required, and the tag ensures the data hasn’t been altered.
+
+It’s a fast and secure system, commonly used in applications like secure web browsing and messaging.
+
+#### ChaCha20-Poly1305
+
+`ChaCha20-Poly1305` is a stream cypher, which is a method for encrypting messages.
+
+Stream cyphers generate a random-looking sequence of bits, called a keystream, that matches the length of the message. This keystream is created using a secret key and an additional starting value called an initialization vector (IV).
+
+To encrypt the message, the cipher combines each bit of the message with the corresponding bit of the keystream using a simple XOR operation (a basic "bit-flipping" process).
+
+The result is the encrypted message, or ciphertext. Modern stream ciphers are designed to ensure the keystream appears completely random, even if someone tries to manipulate the initialization vector.


While it is quite interesting, I don't think it makes sense to put in our documentation. 🤔

Fixed by afcdbd8

Signed-off-by: Thomas Moraine <[email protected]>

…en-orchestra into doc-encryption-details Signed-off-by: Thomas Moraine <[email protected]>

Note: using flags to identify languages is bad practice Signed-off-by: Thomas Moraine <[email protected]>

Signed-off-by: Thomas Moraine <[email protected]>

fbeauchamp · 2025-01-24T08:27:09Z

docs/docs/backups.md

+2. Go to the section called **New file system remote**, or edit an existing remote.
+3. In the subsection called **Encrypt all new data sent to this remote** you will find a text area. Enter your encryption key there.
+4. Click the **Save configuration** Button to finish the encryption setup.
+


encryption is only compatible with block based remote. (Full backup don't care, but incremental backup will fail if not )

Fixed by 4d784b0

fbeauchamp · 2025-01-24T08:28:59Z

docs/docs/backups.md

+Encryption is opt-in and requires configuring an encryption key on the remote.
+
+1. Go to the Settings → Remote menu.
+2. Go to the section called **New file system remote**, or edit an existing remote.


encryption can't be changed if a remote contains any backup (either enabling/disabling of changing the key )

Fixed by 4d784b0

fbeauchamp · 2025-01-24T08:31:58Z

docs/docs/backups.md

+### Current Encryption Algorithm: `AES-256-GCM`
+Currently, backups use the [`AES-256-GCM`](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) encryption algorithm. While this is a highly secure option, it does have a file size limitation of 64 GiB. This isn't an issue when working with Amazon S3, as the data is split into smaller blocks, making it fully compatible with the platform. 
+
+In addition, this algorithm is fully compliant with [ANSSI guidelines (in French)](https://cyber.gouv.fr/sites/default/files/2021/03/anssi-guide-selection_crypto-1.0.pdf).


this algorithm is authenticated, that means an additional metadata is put at the end of any saved file. This is used on restore to ensure that the data restored are exactly the data that were encrypted, thus detecting bit rot or a malicious attacker without the key. Note this is not a recoverable error, the file will be unusable
https://en.wikipedia.org/wiki/Authenticated_encryption

Fixed by 4d784b0

~~TODO : it's the same for the other algorithm~~

fbeauchamp · 2025-01-24T08:32:45Z

docs/docs/backups.md

+
+To improve flexibility and performance, Xen Orchestra will transition to the [`ChaCha20-Poly1305`](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) encryption algorithm by February 2025. This update addresses the file size limitations of `AES-256-GCM` while maintaining a high level of security and compliance with ANSSI guidelines.
+
+Backup repositories that were encrypted with `AES-256-GCM` will remain accessible, to ensure a smooth transition.


as aes-256-gcm , chacha20-poly1305 is authenticated

docs/docs/backups.md

Add requirements on block-based remotes Warn that encryption can't be saved if remote contains a backup Explain how authentication works with AES-256-GCM Signed-off-by: Thomas Moraine <[email protected]>

Co-authored-by: Florent BEAUCHAMP <[email protected]>

Signed-off-by: Thomas Moraine <[email protected]>

backups.md: Explain backup encryption

43944e4

Explain how backups are encrypted by Xen Orchestra, what each encryption algorithm does, and how it works with Amazon S3 Signed-off-by: Thomas Moraine <[email protected]>

thomas-dkmt assigned julien-f and olivierlambert Jan 23, 2025

julien-f requested review from julien-f and fbeauchamp January 23, 2025 15:55

format with Prettier

0b2e366

julien-f reviewed Jan 23, 2025

View reviewed changes

thomas-dkmt added 4 commits January 23, 2025 18:55

backups.md: Remove unnecessary explanation of encryption algo

afcdbd8

Signed-off-by: Thomas Moraine <[email protected]>

backups.md: Explain how to set up backup encryption

6587b3a

Signed-off-by: Thomas Moraine <[email protected]>

Merge branch 'doc-encryption-details' of https://github.com/vatesfr/x…

8364252

…en-orchestra into doc-encryption-details Signed-off-by: Thomas Moraine <[email protected]>

backups.md: Mention that the ANSSI link is in French

e4be723

Note: using flags to identify languages is bad practice Signed-off-by: Thomas Moraine <[email protected]>

thomas-dkmt force-pushed the doc-encryption-details branch from a77fdbf to 515c20b Compare January 23, 2025 18:09

backups.md: Add links to explain the encryption algorithms

259124a

Signed-off-by: Thomas Moraine <[email protected]>

thomas-dkmt force-pushed the doc-encryption-details branch from 347e4ea to 259124a Compare January 23, 2025 18:10

thomas-dkmt requested a review from julien-f January 23, 2025 18:11

fbeauchamp requested changes Jan 24, 2025

View reviewed changes

thomas-dkmt and others added 3 commits January 24, 2025 10:23

backups.md: Explain further how AES-256-GCM works

4d784b0

Add requirements on block-based remotes Warn that encryption can't be saved if remote contains a backup Explain how authentication works with AES-256-GCM Signed-off-by: Thomas Moraine <[email protected]>

Update docs/docs/backups.md

98369f8

Co-authored-by: Florent BEAUCHAMP <[email protected]>

backups.md: Minor spelling corrections

b5a05e7

Signed-off-by: Thomas Moraine <[email protected]>

julien-f changed the title ~~Doc(XO): Explain backup encryption algorithms~~ docs(backups): encryption algorithms Jan 24, 2025

backups.md: Move auth info so it applies to both algorithms

1f8addb

Signed-off-by: Thomas Moraine <[email protected]>

thomas-dkmt requested a review from fbeauchamp January 24, 2025 15:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(backups): encryption algorithms #8266

docs(backups): encryption algorithms #8266

thomas-dkmt commented Jan 23, 2025

julien-f Jan 23, 2025

thomas-dkmt Jan 23, 2025

julien-f Jan 23, 2025

thomas-dkmt Jan 23, 2025

julien-f Jan 23, 2025

thomas-dkmt Jan 23, 2025

julien-f Jan 23, 2025

thomas-dkmt Jan 23, 2025 •

edited

Loading

julien-f Jan 23, 2025

thomas-dkmt Jan 23, 2025

julien-f Jan 23, 2025

thomas-dkmt Jan 23, 2025

fbeauchamp Jan 24, 2025

thomas-dkmt Jan 24, 2025

fbeauchamp Jan 24, 2025

thomas-dkmt Jan 24, 2025

fbeauchamp Jan 24, 2025

thomas-dkmt Jan 24, 2025

thomas-dkmt Jan 24, 2025 •

edited

Loading

fbeauchamp Jan 24, 2025


		Currently, backups use the `AES-256-GCM` encryption algorithm. While this is a highly secure option, it does have a file size limitation of 64 GiB. This isn’t an issue when working with Amazon S3, as the data is split into smaller blocks, making it fully compatible with the platform.

		In addition, this algorithm is fully compliant with [ANSSI guidelines](https://cyber.gouv.fr/sites/default/files/2021/03/anssi-guide-selection_crypto-1.0.pdf).


		### Current Encryption Algorithm: `AES-256-GCM`

		Currently, backups use the `AES-256-GCM` encryption algorithm. While this is a highly secure option, it does have a file size limitation of 64 GiB. This isn’t an issue when working with Amazon S3, as the data is split into smaller blocks, making it fully compatible with the platform.

	Currently, backups use the `AES-256-GCM` encryption algorithm. While this is a highly secure option, it does have a file size limitation of 64 GiB. This isn’t an issue when working with Amazon S3, as the data is split into smaller blocks, making it fully compatible with the platform.
	Currently, backups use the [`AES-256-GCM`](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) encryption algorithm. While this is a highly secure option, it does have a file size limitation of 64 GiB. This isn’t an issue when working with Amazon S3, as the data is split into smaller blocks, making it fully compatible with the platform.


		To improve flexibility and performance, Xen Orchestra will transition to the `ChaCha20-Poly1305` encryption algorithm by February 2025. This update addresses the file size limitations of `AES-256-GCM` while maintaining a high level of security and compliance with ANSSI guidelines.

		Backup repositories that were encrypted with `AES-256-GCM` will remain accessible, to ensure a smooth transition.


		### Upcoming Change: `ChaCha20-Poly1305`

		To improve flexibility and performance, Xen Orchestra will transition to the `ChaCha20-Poly1305` encryption algorithm by February 2025. This update addresses the file size limitations of `AES-256-GCM` while maintaining a high level of security and compliance with ANSSI guidelines.

docs(backups): encryption algorithms #8266

Are you sure you want to change the base?

docs(backups): encryption algorithms #8266

Conversation

thomas-dkmt commented Jan 23, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thomas-dkmt Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thomas-dkmt Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thomas-dkmt Jan 23, 2025 •

edited

Loading

thomas-dkmt Jan 24, 2025 •

edited

Loading