Skip to content

Commit f6676c9

Browse files
authored
add skipped integrity checking to README (#65)
1 parent 9601b99 commit f6676c9

File tree

5 files changed

+23
-2
lines changed

5 files changed

+23
-2
lines changed

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## v??.?.? (????-??-??)
4+
5+
* [add skipped integrity checking to README (#65)](https://github.com/nextcloud/encryption-recovery-tools/pull/65)
6+
* [Fix swapped GMP and ZLIB error messages (#64)](https://github.com/nextcloud/encryption-recovery-tools/pull/64)
7+
38
## v31.0.0 (2025-03-16)
49

510
* [add E2E improvements and Nextcloud31 test (#62)](https://github.com/nextcloud/encryption-recovery-tools/pull/62)
@@ -35,7 +40,7 @@
3540
* [Move testdata (#16)](https://github.com/nextcloud/encryption-recovery-tools/pull/16)
3641
* [improve decryptPrivateKey (#17)](https://github.com/nextcloud/encryption-recovery-tools/pull/17)
3742
* [support decryption infix #(18)](https://github.com/nextcloud/encryption-recovery-tools/pull/18)
38-
* [support several values for INSTANCEID, SECRET, RECOVERY_PASSWORD and USER_PASSWORDS (#19)](https://github.com/nextcloud/encryption-recovery-tools/pull/19)
43+
* [support several values for INSTANCEID, SECRET, RECOVERY\_PASSWORD and USER\_PASSWORDS (#19)](https://github.com/nextcloud/encryption-recovery-tools/pull/19)
3944
* [fix typo (#21)](https://github.com/nextcloud/encryption-recovery-tools/pull/21)
4045
* [introduce end-to-end encryption support (#23)](https://github.com/nextcloud/encryption-recovery-tools/pull/23)
4146
* [Fix default (#24)](https://github.com/nextcloud/encryption-recovery-tools/pull/24)

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ It supports the master-key encryption, the user-key encryption and can even use
1313

1414
For further information have a look at the [**README**](./server-side-encryption/README.md) of the script.
1515

16+
## Security Warning
17+
18+
The main goal of the Nextcloud Encryption Recovery Tools is to recover the contents of encrypted files in case there is a catastrophic failure.
19+
For that reason, the recovery scripts **do not** cryptographically verify the integrity of the files while processing them in order to be able to recover the contents of as many encrypted files as possible.
20+
1621
## Testing
1722

1823
The compatibility with Nextcloud releases is tested with [PHPUnit](https://phpunit.de).

end-to-end-encryption/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
This script can recover your precious files if you encrypted them with the **Nextcloud End-to-End Encryption** and still have access to the data directory and the user mnemonics.
66

7+
## Security Warning
8+
9+
The main goal of the Nextcloud Encryption Recovery Tools is to recover the contents of encrypted files in case there is a catastrophic failure.
10+
For that reason, the recovery scripts **do not** cryptographically verify the integrity of the files while processing them in order to be able to recover the contents of as many encrypted files as possible.
11+
_(On the contrary, the recovery script intentionally decrypts the AES-GCM protected files in AES-CTR mode to skip the integrity check of the Galois/Counter Mode.)_
12+
713
## Configuration
814

915
In order to use the script you have to configure the given values below:

end-to-end-encryption/recover.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1472,7 +1472,7 @@ function decryptFile($filename, $metadata, $targetname) {
14721472
if (false !== $tmp) {
14731473
$buffer .= $tmp;
14741474

1475-
while (BLOCKSIZE <= strlen($buffer)) {
1475+
while (BLOCKSIZE <= strlen($buffer)) {
14761476
$block = substr($buffer, 0, BLOCKSIZE);
14771477
$buffer = substr($buffer, BLOCKSIZE);
14781478

server-side-encryption/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
This script can recover your precious files if you encrypted them with the **Nextcloud Server-Side Encryption** and still have access to the data directory and the Nextcloud configuration file (`config/config.php`).
66
It supports the master-key encryption, the user-key encryption and can even use the rescue key if it had been enabled as well as the public sharing key for files that had been publicly shared.
77

8+
## Security Warning
9+
10+
The main goal of the Nextcloud Encryption Recovery Tools is to recover the contents of encrypted files in case there is a catastrophic failure.
11+
For that reason, the recovery scripts **do not** cryptographically verify the integrity of the files while processing them in order to be able to recover the contents of as many encrypted files as possible.
12+
813
## Configuration
914

1015
In order to use the script you have to configure the given values below:

0 commit comments

Comments
 (0)