Skip to content

Commit

Permalink
add more to ogion section and alternatives
Browse files Browse the repository at this point in the history
Signed-off-by: Rafał Safin <rafal.safin@rafsaf.pl>
  • Loading branch information
Rafał Safin committed Oct 26, 2024
1 parent 533fd73 commit 2c9aae7
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,27 @@ A tool for performing scheduled database backups and transferring encrypted data

Backups are in `age` format using [age](https://github.com/FiloSottile/age), with strong encryption under the hood. Why age? it's modern replacement for GnuPG, available for most architectures and systems.

This project is more or less well tested cron-like runtime with predefined supported providers and backup targets (see below) with sensible defaults for backup commands. It has rich integration tests using providers container replacements: fake gcs, azurite, minio. Goal was to make 100% sure it will work in the wild.

There is **no compression before age encryption** step whatsoever. This is intentional, prepare for large backups size (compared to ogion 6.0 where 7zip was used, some backups that were 300MB now are 2.2GB). There are known exploits when mixing compression with encryption, and for small systems compression this just seems unnecessary. See:

- [CRIME](https://en.wikipedia.org/wiki/CRIME)
- [BREACH](https://en.wikipedia.org/wiki/BREACH)
- [Known plaintext attack](https://en.wikipedia.org/wiki/Known-plaintext_attack)
- [A Known Plaintext Attack on the PKZIP](https://link.springer.com/content/pdf/10.1007/3-540-60590-8_12.pdf)
- [TLSv1.3 removes compression](https://blog.cloudflare.com/tls-1-3-overview-and-q-and-a/)

## Documentation

- [https://ogion.rafsaf.pl](https://ogion.rafsaf.pl)

## Alternatives

There are better tools for big corporate databases and systems:

- [pgBackRest - Reliable PostgreSQL Backup & Restore](https://pgbackrest.org/)
- [postgres operator for k8s based on pgBackRest from crunchydata](https://access.crunchydata.com/documentation/postgres-operator/latest)

## Supported backup targets

- PostgreSQL ([all currently supported versions](https://endoflife.date/postgresql))
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description = "A tool for performing scheduled database backups and transferring
license = "GNU GPLv3"
name = "ogion"
package-mode = false
version = "7.1"
version = "7.2"

[tool.poetry.dependencies]
python = "^3.13"
Expand Down

0 comments on commit 2c9aae7

Please sign in to comment.