chore: improve SSE default crypto module app description

Updated the app information for the encryption module to include detailed encryption features, warnings, and notes for existing files.

Signed-off-by: Josh <josh.t.richards@gmail.com>
This commit is contained in:
Josh 2025-10-06 11:32:33 -04:00 committed by GitHub
parent 678a8a75ad
commit 1a5d07034b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -7,12 +7,28 @@
<info xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://apps.nextcloud.com/schema/apps/info.xsd">
<id>encryption</id>
<name>Default encryption module</name>
<summary>Default encryption module for server-side encryption</summary>
<name>Default Encryption Module</name>
<summary>Default encryption module for Nextcloud Server-side Encryption (SSE)</summary>
<description>
In order to use this encryption module you need to enable server-side encryption in the admin settings. Once enabled this module will encrypt all your files transparently. The encryption is based on AES 256 keys.
The module will not touch existing files, only new files will be encrypted after server-side encryption was enabled. It is also not possible to disable the encryption again and switch back to an unencrypted system.
Please read the documentation to know all implications before you decide to enable server-side encryption.
<![CDATA[
This app provides the (default) cryptography implementation for Nextcloud's Server-side Encryption (SSE) feature.
**Encryption Details**
* **Cipher Mode:** AES-256-CTR (default)
* **Authentication:** HMAC-SHA256
**Important Warnings**
* **DANGER:** Do not disable this module until all files have been decrypted (`occ encryption:decrypt-all`).
* **WARNING:** Once SSE has been enabled, files cannot be decrypted unless you have command-line access.
**Notes for Existing Files**
* By default, enabling SSE does not encrypt existing files; only new files will be encrypted.
* To encrypt all existing files, use the command `occ encryption:encrypt-all`.
**Before You Begin**
* **Read the Documentation:** Before you enable SSE, encrypt existing files, or disable SSE, it is critical to
read the documentation to understand implications and the appropriate procedures to avoid data loss.
]]>
</description>
<version>2.21.0</version>
<licence>agpl</licence>
@ -21,12 +37,15 @@ Please read the documentation to know all implications before you decide to enab
<types>
<filesystem/>
</types>
<documentation>
<user>user-encryption</user>
<admin>admin-encryption</admin>
</documentation>
<category>files</category>
<category>security</category>
<bugs>https://github.com/nextcloud/server/issues</bugs>
<dependencies>