fix typos

pull/218/head
Josh Rabinowitz 6 years ago
parent fe1681aeb5
commit 28377b138c

@ -24,7 +24,7 @@
- name: Print gpg version
debug:
msg: "Running test againts {{ gpg_version.stdout_lines | first | string }}."
msg: "Running test against {{ gpg_version.stdout_lines | first | string }}."
changed_when: False
- name: Copy git-secret src

@ -7,7 +7,7 @@ git-secret-changes - view diff of the hidden files.
## DESCRIPTION
`git-secret-changes` - shows changes between the current version of hidden files and the ones already commited.
`git-secret-changes` - shows changes between the current version of hidden files and the ones already committed.
You can provide any number of hidden files to this command as arguments, and it will show changes for these files only.
Note that files must be specified by their encrypted names, typically `filename.yml.secret`.
If no arguments are provided, information about all hidden files will be shown.

@ -15,7 +15,7 @@ Under the hood, this uses the `gpg --decrypt` command.
## OPTIONS
-f - forces to overwrite exisiting files without prompt.
-f - forces to overwrite existing files without prompt.
-d - specifies `--homedir` option for the `gpg`, basically use this option if you store your keys in a custom location.
-p - specifies password for noinput mode, adds `--passphrase` option for `gpg`.
-h - shows help.

@ -9,9 +9,9 @@ git-secret-tell - adds a person, who can access private data.
## DESCRIPTION
`git-secret-tell` receives an email addresses as an input, searches for the `gpg`-key in the `gpg`'s
`homedir` by these emails, then imports a person's public key into the `git-secret`'s inner keychain.
From this moment this person can encrypt new files with the keyring which contains their key.
But they cannot decrypt the old files, which were already encrypted without their key.
They should be reencrypted with the new keyring by someone, who has the unencrypted files.
From this moment this person can encrypt new files with the keyring which contains their key,
but they cannot decrypt the old files, which were already encrypted without their key.
The files should be re-encrypted with the new keyring by someone who has the unencrypted files.
**Do not manually import secret key into `git-secret`**. Anyways, it won't work with any of the secret-keys imported.

@ -33,7 +33,7 @@ And you're done!
2. Import this key into your `gpg` setup (in ~/.gnupg or similar) by running `gpg --import KEY_NAME.txt`
3. Now add this person to your secrets repo by running `git secret tell persons@email.id`
(this will be the email address assocated with the public key)
(this will be the email address associated with the public key)
4. The newly added user cannot yet read the encrypted files. Now, re-encrypt the files using
`git secret reveal; git secret hide -d`, and then commit and push the newly encrypted files.
@ -41,7 +41,7 @@ And you're done!
Now the newly added user be able to decrypt the files in the repo using `git-secret`.
Note that it is possible to add yourself to the git-secret repo without decrypting existing files.
It will be possible to decrypt them after reencrypting them with the new keyring. So, if you don't
It will be possible to decrypt them after re-encrypting them with the new keyring. So, if you don't
want unexpected keys added, you can configure some server-side security policy with the `pre-receive` hook.
## Configuration
@ -86,7 +86,7 @@ All the other internal data is stored in the directory:
### `.gitsecret/keys`
This directory contains data used by git-secret and PGP to allow and maintain the correct encyption and access rights for the permitted parties.
This directory contains data used by git-secret and PGP to allow and maintain the correct encryption and access rights for the permitted parties.
Generally speaking, all the files in this directory *except* `random_seed` should be checked into your repo.
By default, `git secret init` will add the file `.gitsecret/keys/random_seed` to your .gitignore file.

@ -83,7 +83,7 @@ AWK_GPG_VER_CHECK='
}
'
# This is 1 for gpg vesion 2.1 or greater, otherwise 0
# This is 1 for gpg version 2.1 or greater, otherwise 0
GPG_VER_21="$(gpg --version | gawk "$AWK_GPG_VER_CHECK")"
@ -329,7 +329,7 @@ function _maybe_create_gitignore {
function _add_ignored_file {
# This function adds a line with the filename into the '.gitgnore' file.
# This function adds a line with the filename into the '.gitignore' file.
# It also creates '.gitignore' if it's not there
local filename="$1" # required
@ -455,7 +455,7 @@ function _find_and_clean {
}
function _find_and_clean_formated {
function _find_and_clean_formatted {
# required:
local pattern="$1" # can be any string pattern
@ -596,9 +596,9 @@ function _get_users_in_keyring {
}
function _get_recepients {
function _get_recipients {
# This function is required to create an encrypted file for different users.
# These users are called 'recepients' in the `gpg` terms.
# These users are called 'recipients' in the `gpg` terms.
# It basically just parses the `gpg` public keys
_parse_keyring_users 's/.*<\(.*\)>.*/-r\1/p'

@ -21,6 +21,6 @@ function clean {
_user_required
# User should see properly formated output:
_find_and_clean_formated "*$SECRETS_EXTENSION" "$verbose"
# User should see properly formatted output:
_find_and_clean_formatted "*$SECRETS_EXTENSION" "$verbose"
}

@ -20,7 +20,7 @@ function _optional_clean {
local verbose=${2:-""}
if [[ $clean -eq 1 ]]; then
_find_and_clean_formated "*$SECRETS_EXTENSION" "$verbose"
_find_and_clean_formatted "*$SECRETS_EXTENSION" "$verbose"
fi
}
@ -33,13 +33,13 @@ function _optional_delete {
local path_mappings
path_mappings=$(_get_secrets_dir_paths_mapping)
# We use custom formating here:
# We use custom formatting here:
if [[ ! -z "$verbose" ]]; then
echo && echo 'removing unencrypted files:'
fi
while read -r line; do
# So the formating would not be repeated several times here:
# So the formatting would not be repeated several times here:
local filename
filename=$(_get_record_filename "$line")
_find_and_clean "*$filename" "$verbose"
@ -144,7 +144,7 @@ function hide {
fi
local recipients
recipients=$(_get_recepients)
recipients=$(_get_recipients)
local gpg_local
gpg_local=$(_get_gpg_local)

Loading…
Cancel
Save