Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
revelaction authored Oct 9, 2023
1 parent 0dac44a commit d0c0183
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@
relies on [age](https://age-encryption.org/v1) for encryption. Optionally it uses a
[yubikey](https://developers.yubico.com/PIV/) for encryption of the age key.

The main goal of `privage` is to have your secrets (credentials and other
The main goal of privage is to have your secrets (credentials and other
files) securely backed up in untrusted 3-party repositories whitout revealing
any secret information (not even the file name) to those 3-party repositories.


**WARNING: The author is not a cryptographer, and the code has not been reviewed. Use at your own risk.**

You may want to use `privage` if:
You may want to use privage if:

- You want to have your encrypted credentials and other secrets files in a revision control system repository (ex: git)
- You want to have backups of this repository in untrusted 3 party services (github, gitlab, bitbucket)
- You do not want to leak any information (not even the name of the files) in
case of a breach of those 3 party services, which you otherwise should always assume.
`privage` guarantees not leaking information because it also encrypts the metadata of the files.
privage guarantees not leaking information because it also encrypts the metadata of the files.
- You want to have one encrypted file per credential or secret file.
- You trust the computer running `privage`. `privage` uses unencrypted `age`
- You trust the computer running privage. `privage` uses unencrypted `age`
keys, following the reasoning
[here](https://github.com/FiloSottile/age#passphrase-protected-key-files).
`privage` supports yubikeys to encrypt the age secret key.
privage supports yubikeys to encrypt the age secret key.


# Features
Expand Down

0 comments on commit d0c0183

Please sign in to comment.