Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![License](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](LICENSE) [![ownCloud OSPO](https://img.shields.io/badge/OSPO-ownCloud-blue)](https://kiteworks.com/opensource) [![Docker Hub](https://img.shields.io/docker/pulls/owncloud)](https://hub.docker.com/r/owncloud/server)

An ownCloud Classic (OC10) app that provides transparent server-side encryption of files using AES-256 keys. Once enabled in the admin settings, all newly uploaded files are encrypted at rest. The module supports master key encryption, per-user keys, recovery keys, and optional HSM (Hardware Security Module) integration for key storage.
An ownCloud Classic (OC10) app that provides transparent server-side encryption of files using AES-256 keys. Once enabled in the admin settings, all newly uploaded files are encrypted at rest. The module supports master key encryption, recovery keys, and optional HSM (Hardware Security Module) integration for key storage. Per-user key encryption is deprecated and no longer recommended — see the [server release notes](https://doc.owncloud.com/docs/next/server_release_notes.html#deprecation-note-for-user-key-storage-encryption).

## Getting Started

Expand All @@ -16,7 +16,7 @@ sudo -u www-data php occ encryption:select-encryption-type masterkey
sudo -u www-data php occ encryption:encrypt-all
```

**Important:** Once enabled, encryption cannot be disabled. Read the documentation thoroughly before enabling. Requires OpenSSL 1.1.x (see repository notes regarding OpenSSL 3.x compatibility).
**Important:** Read the documentation thoroughly before enabling. To reverse encryption, run `occ encryption:decrypt-all` (decrypts all files and disables encryption), followed by `occ encryption:disable`. Requires OpenSSL 1.1.x: OpenSSL 3.x retired several legacy ciphers this module depends on, which can break access to already-encrypted files. If this happens, re-enable the legacy ciphers in your OpenSSL 3.x config -- see the "Providers" section of the OpenSSL 3.0 wiki for the workaround.

## Documentation

Expand Down
13 changes: 11 additions & 2 deletions agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cu
- `js/` -- Frontend JavaScript
- `css/` -- Stylesheets
- `templates/` -- PHP templates
- `tests/` -- PHPUnit tests
- `tests/` -- PHPUnit and acceptance tests
- `l10n/` -- Translations
- `Makefile` -- Build and test targets

Expand All @@ -31,9 +31,18 @@ This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cu
# Build
make dist

# Test
# Test (PHPUnit)
make test-php-unit

# Test (API acceptance)
make test-acceptance-api

# Test (CLI acceptance)
make test-acceptance-cli

# Test (WebUI acceptance)
make test-acceptance-webui

# Lint
make test-php-style
```
Expand Down