Skip to content

chore: improve SSE default crypto module app description #55582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshtrichards merged 2 commits into from
Oct 9, 2025
Merged

chore: improve SSE default crypto module app description #55582

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a5d070
chore: improve SSE default crypto module app description
joshtrichards Oct 6, 2025
71b196b
fix: Apply suggestions from code review
joshtrichards Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions apps/encryption/appinfo/info.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 application until all files have been decrypted (`occ encryption:decrypt-all`).
* **WARNING**: Reverting to non-encrypted file storage after activation requires command-line access. The action is permanent via the Web UI."

**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>
Expand All @@ -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>
Expand Down
Loading