Skip to content

chore: update gocrypt version to 2.0.0 and document breaking changes in README #42

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
merged 1 commit into from
May 12, 2025
Merged

chore: update gocrypt version to 2.0.0 and document breaking changes in README #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
FROM alpine:3.21.3 AS alpine

FROM sgaunet/gocrypt:1.5.1 AS gocrypt
FROM ghcr.io/sgaunet/gocrypt:2.0.0 AS gocrypt

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

Expand Down
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,23 @@ gitlab-backup2s3 is an enhanced docker image to export gitlab projects, encrypt

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

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

## Version Compatibility

⚠️ **Important Breaking Change** ⚠️

Version 2 of **gocrypt** (v2) introduced AES GCM (Galois/Counter Mode) encryption, which breaks compatibility with files encrypted using version 1 (v1).

- Files encrypted with v1 **cannot** be decrypted with v2
- Files encrypted with v2 **cannot** be decrypted with v1

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.

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.
Version 1 of **gitlab-backup2s3** is compatible with version 1 of **gocrypt**.

## Configuration

It needs some environement variables to run:
Expand Down
Loading