Skip to content

Commit da32b44

Browse files
authored
chore: update gocrypt version to 2.0.0 and document breaking changes in README (#42)
1 parent bc78c5e commit da32b44

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
FROM alpine:3.21.3 AS alpine
22

3-
FROM sgaunet/gocrypt:1.5.1 AS gocrypt
3+
FROM ghcr.io/sgaunet/gocrypt:2.0.0 AS gocrypt
44

55
FROM sgaunet/gitlab-backup:1.10.0 AS gitlab-backup-image
66

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,23 @@ gitlab-backup2s3 is an enhanced docker image to export gitlab projects, encrypt
1111

1212
You can use the binary but it will need some prerequisites :
1313

14-
* [gocrypt](https://github.com/sgaunet/gocrypt) >= v1.2.0 (if you like to encrypt archives with AES)
14+
* [gocrypt](https://github.com/sgaunet/gocrypt) >= v2.0.0 (if you like to encrypt archives with AES)
1515
* [gitlab-backup](https://github.com/sgaunet/gitlab-backup) >= v1.0.0
1616

17+
## Version Compatibility
18+
19+
⚠️ **Important Breaking Change** ⚠️
20+
21+
Version 2 of **gocrypt** (v2) introduced AES GCM (Galois/Counter Mode) encryption, which breaks compatibility with files encrypted using version 1 (v1).
22+
23+
- Files encrypted with v1 **cannot** be decrypted with v2
24+
- Files encrypted with v2 **cannot** be decrypted with v1
25+
26+
This incompatibility is due to the fundamental change in the encryption mode from v1 to v2. AES GCM provides better security with authenticated encryption but requires a different format that is not backwards compatible.
27+
28+
Version 2 of **gocrypt** is not compatible with version 1. If you have files encrypted with v1, you will need to decrypt them using the v1 version of **gocrypt** before you can use them with v2. Version 2 of gitlab-backup2s3 uses v2 of gocrypt.
29+
Version 1 of **gitlab-backup2s3** is compatible with version 1 of **gocrypt**.
30+
1731
## Configuration
1832

1933
It needs some environement variables to run:

0 commit comments

Comments
 (0)