Skip to content
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

Add aes-encryption for backups #97

Merged
merged 16 commits into from
Oct 23, 2024
Merged

Add aes-encryption for backups #97

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
2397f19
add aes encryption with cli commands
ostempel Oct 7, 2024
4ceeefc
added and adjusted tests
ostempel Oct 7, 2024
8aec148
adjusted documentation with encryption
ostempel Oct 7, 2024
3fad9c9
fix linting and tests
ostempel Oct 7, 2024
5fb9a18
remove DetermineBackupFilePath and provide outDir directly
ostempel Oct 8, 2024
fb2072f
add encryption to integration tests
ostempel Oct 8, 2024
a61d7cb
fix debug log level
ostempel Oct 8, 2024
800f84a
refactor encryption to helper functions and adjust tests
ostempel Oct 9, 2024
ce9b4a9
fix linting
ostempel Oct 9, 2024
f25990b
fix encryption unit test
ostempel Oct 9, 2024
7a6cd79
adjust readme
ostempel Oct 14, 2024
9533151
validate encryption mode change on initalization and download
ostempel Oct 14, 2024
49621ad
fix linting
ostempel Oct 14, 2024
ab41ca3
fix decryption
ostempel Oct 15, 2024
5cf14d9
fix logging message
ostempel Oct 23, 2024
43b7365
fix error on file reading and db-check
ostempel Oct 23, 2024
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 Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ endif
kubectl --kubeconfig $(KUBECONFIG) delete -f "deploy/$(DB)-$(BACKUP_PROVIDER).yaml" || true # for idempotence
kubectl --kubeconfig $(KUBECONFIG) apply -f "deploy/$(DB)-$(BACKUP_PROVIDER).yaml"
# tailing
stern --kubeconfig $(KUBECONFIG) '.*'
kubectl stern --kubeconfig $(KUBECONFIG) '.*'

.PHONY: kind-cluster-create
kind-cluster-create: dockerimage
Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ With `--compression-method` you can define how generated backups are compressed
- S3 Buckets (tested against Ceph RADOS gateway)
- Local

## Encryption

For all three storage providers AES encryption is supported and can be enabled with `--encryption-key=<YOUR_KEY>`.
The key must be either 16 bytes (AES-128), 24 bytes (AES-192) or 32 bytes (AES-256) long.
ostempel marked this conversation as resolved.
Show resolved Hide resolved
The backups are stored at the storage provider with the `.aes` suffix. If the file does not have this suffix, decryption is skipped.

## How it works

![Sequence Diagram](docs/sequence.drawio.svg)
Expand Down
206 changes: 171 additions & 35 deletions api/v1/backup.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 40 additions & 2 deletions api/v1/backup_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading