From d0c0183d42e032b351e24c4f8beee1be550d306d Mon Sep 17 00:00:00 2001 From: revelaction <96388231+revelaction@users.noreply.github.com> Date: Mon, 9 Oct 2023 20:02:34 +0200 Subject: [PATCH] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4eebc1d..cc57699 100644 --- a/README.md +++ b/README.md @@ -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