scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-11-03 03:58:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation consistency GPG keys are PGP keys. (#13073)

Browse Source 
* Consistency: GPG keys are PGP keys

* Consistency: GPG keys are PGP keys

* Consistency: GPG keys are PGP keys

* Consistency: GPG keys are PGP keys

* Consistency: GPG keys are PGP keys

* Consistency: s/GPG/PGP keys, use GPG's proper name

* Use GPG's proper name GnuPG

* Use GPG's proper name GnuPG

* Consistency: GPG keys are PGP keys

* Fix typo
This commit is contained in:
Daniel Nathan Gray
2021-11-09 04:34:59 +10:30
committed by GitHub
parent 33a140a260
commit 07f75268bd
11 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
command/operator_generate_root.go
View File

@@ -180,7 +180,7 @@ func (c *OperatorGenerateRootCommand) Flags() *FlagSets {
EnvVar: "", EnvVar: "",
Completion: complete.PredictAnything, Completion: complete.PredictAnything,
Usage: "Path to a file on disk containing a binary or base64-encoded " + Usage: "Path to a file on disk containing a binary or base64-encoded " +
"public GPG key. This can also be specified as a Keybase username " + "public PGP key. This can also be specified as a Keybase username " +
"using the format \"keybase:<username>\". When supplied, the generated " + "using the format \"keybase:<username>\". When supplied, the generated " +
"root token will be encrypted and base64-encoded with the given public " + "root token will be encrypted and base64-encoded with the given public " +
"key.", "key.",

4
command/operator_init.go
View File

@@ -124,7 +124,7 @@ func (c *OperatorInitCommand) Flags() *FlagSets {
Value: (*pgpkeys.PubKeyFilesFlag)(&c.flagPGPKeys), Value: (*pgpkeys.PubKeyFilesFlag)(&c.flagPGPKeys),
Completion: complete.PredictAnything, Completion: complete.PredictAnything,
Usage: "Comma-separated list of paths to files on disk containing " + Usage: "Comma-separated list of paths to files on disk containing " +
"public GPG keys OR a comma-separated list of Keybase usernames using " + "public PGP keys OR a comma-separated list of Keybase usernames using " +
"the format \"keybase:<username>\". When supplied, the generated " + "the format \"keybase:<username>\". When supplied, the generated " +
"unseal keys will be encrypted and base64-encoded in the order " + "unseal keys will be encrypted and base64-encoded in the order " +
"specified in this list. The number of entries must match -key-shares, " + "specified in this list. The number of entries must match -key-shares, " +
@@ -136,7 +136,7 @@ func (c *OperatorInitCommand) Flags() *FlagSets {
Value: (*pgpkeys.PubKeyFileFlag)(&c.flagRootTokenPGPKey), Value: (*pgpkeys.PubKeyFileFlag)(&c.flagRootTokenPGPKey),
Completion: complete.PredictAnything, Completion: complete.PredictAnything,
Usage: "Path to a file on disk containing a binary or base64-encoded " + Usage: "Path to a file on disk containing a binary or base64-encoded " +
"public GPG key. This can also be specified as a Keybase username " + "public PGP key. This can also be specified as a Keybase username " +
"using the format \"keybase:<username>\". When supplied, the generated " + "using the format \"keybase:<username>\". When supplied, the generated " +
"root token will be encrypted and base64-encoded with the given public " + "root token will be encrypted and base64-encoded with the given public " +
"key.", "key.",

2
command/operator_rekey.go
View File

@@ -177,7 +177,7 @@ func (c *OperatorRekeyCommand) Flags() *FlagSets {
Value: (*pgpkeys.PubKeyFilesFlag)(&c.flagPGPKeys), Value: (*pgpkeys.PubKeyFilesFlag)(&c.flagPGPKeys),
Completion: complete.PredictAnything, Completion: complete.PredictAnything,
Usage: "Comma-separated list of paths to files on disk containing " + Usage: "Comma-separated list of paths to files on disk containing " +
"public GPG keys OR a comma-separated list of Keybase usernames using " + "public PGP keys OR a comma-separated list of Keybase usernames using " +
"the format \"keybase:<username>\". When supplied, the generated " + "the format \"keybase:<username>\". When supplied, the generated " +
"unseal keys will be encrypted and base64-encoded in the order " + "unseal keys will be encrypted and base64-encoded in the order " +
"specified in this list.", "specified in this list.",

2
website/content/docs/commands/operator/generate-root.mdx
View File

@@ -82,7 +82,7 @@ flags](/docs/commands) included on all commands.
- `-otp` `(string: "")` - OTP code to use with `-decode` or `-init`. - `-otp` `(string: "")` - OTP code to use with `-decode` or `-init`.
- `-pgp-key` `(keybase or pgp)`- Path to a file on disk containing a binary or - `-pgp-key` `(keybase or pgp)`- Path to a file on disk containing a binary or
base64-encoded public GPG key. This can also be specified as a Keybase base64-encoded public PGP key. This can also be specified as a Keybase
username using the format `keybase:<username>`. When supplied, the generated username using the format `keybase:<username>`. When supplied, the generated
root token will be encrypted and base64-encoded with the given public key. root token will be encrypted and base64-encoded with the given public key.

4
website/content/docs/commands/operator/init.mdx
View File

@@ -79,13 +79,13 @@ flags](/docs/commands) included on all commands.
`-t`. `-t`.
- `-pgp-keys` `(string: "...")` - Comma-separated list of paths to files on disk - `-pgp-keys` `(string: "...")` - Comma-separated list of paths to files on disk
containing public GPG keys OR a comma-separated list of Keybase usernames containing public PGP keys OR a comma-separated list of Keybase usernames
using the format `keybase:<username>`. When supplied, the generated unseal using the format `keybase:<username>`. When supplied, the generated unseal
keys will be encrypted and base64-encoded in the order specified in this list. keys will be encrypted and base64-encoded in the order specified in this list.
The number of entries must match -key-shares, unless -stored-shares are used. The number of entries must match -key-shares, unless -stored-shares are used.
- `-root-token-pgp-key` `(string: "")` - Path to a file on disk containing a - `-root-token-pgp-key` `(string: "")` - Path to a file on disk containing a
binary or base64-encoded public GPG key. This can also be specified as a binary or base64-encoded public PGP key. This can also be specified as a
Keybase username using the format `keybase:<username>`. When supplied, the Keybase username using the format `keybase:<username>`. When supplied, the
generated root token will be encrypted and base64-encoded with the given generated root token will be encrypted and base64-encoded with the given
public key. public key.

2
website/content/docs/commands/operator/rekey.mdx
View File

@@ -125,7 +125,7 @@ flags](/docs/commands) included on all commands.
nonce value must be provided with each unseal key. nonce value must be provided with each unseal key.
- `-pgp-keys` `(string: "...")` - Comma-separated list of paths to files on disk - `-pgp-keys` `(string: "...")` - Comma-separated list of paths to files on disk
containing public GPG keys OR a comma-separated list of Keybase usernames containing public PGP keys OR a comma-separated list of Keybase usernames
using the format `keybase:<username>`. When supplied, the generated unseal using the format `keybase:<username>`. When supplied, the generated unseal
keys will be encrypted and base64-encoded in the order specified in this list. keys will be encrypted and base64-encoded in the order specified in this list.

24
website/content/docs/concepts/pgp-gpg-keybase.mdx
View File

@@ -1,23 +1,23 @@
--- ---
layout: docs layout: docs
page_title: 'Using PGP, GPG, and Keybase' page_title: 'Using PGP, GnuPG, and Keybase'
description: |- description: |-
Vault has the ability to integrate with OpenPGP-compatible programs like GPG Vault has the ability to integrate with OpenPGP-compatible programs like
and services like Keybase.io to provide an additional layer of security when GnuPG and services like Keybase.io to provide an additional layer of security
performing certain operations. This page details the various GPG when performing certain operations. This page details the various PGP
integrations, their use, and operation. integrations, their use, and operation.
--- ---
# Using PGP, GPG, and Keybase # Using PGP, GnuPG, and Keybase
Vault has the ability to integrate with OpenPGP-compatible programs like GPG Vault has the ability to integrate with OpenPGP-compatible programs like GnuPG
and services like Keybase.io to provide an additional layer of security when and services like Keybase.io to provide an additional layer of security when
performing certain operations. This page details the various PGP integrations, performing certain operations. This page details the various PGP integrations,
their use, and operation. their use, and operation.
Keybase.io support is available only in the command-line tool and not via the Keybase.io support is available only in the command-line tool and not via the
Vault HTTP API, tools that help with initialization should use the Keybase.io Vault HTTP API, tools that help with initialization should use the Keybase.io
API in order to obtain the GPG keys needed for a secure initialization if you API in order to obtain the PGP keys needed for a secure initialization if you
want them to use Keybase for keys. want them to use Keybase for keys.
Once the Vault has been initialized, it is possible to use Keybase to decrypt Once the Vault has been initialized, it is possible to use Keybase to decrypt
@@ -37,7 +37,7 @@ able to decrypt the value, revealing the plain-text unseal key.
First, you must create, acquire, or import the appropriate key(s) onto the First, you must create, acquire, or import the appropriate key(s) onto the
local machine from which you are initializing Vault. This guide will not local machine from which you are initializing Vault. This guide will not
attempt to cover all aspects of PGP keys but give examples using two popular attempt to cover all aspects of PGP keys but give examples using two popular
programs: Keybase and GPG. programs: Keybase and GnuPG.
For beginners, we suggest using [Keybase.io](https://keybase.io/) ("Keybase") For beginners, we suggest using [Keybase.io](https://keybase.io/) ("Keybase")
as it can be both simpler and has a number of useful behaviors and properties as it can be both simpler and has a number of useful behaviors and properties
@@ -107,10 +107,10 @@ Key (will be hidden): ...
--- ---
## Initializing with GPG ## Initializing with GnuPG
GPG is an open-source implementation of the OpenPGP standard and is available GnuPG is an open-source implementation of the OpenPGP standard and is available
on nearly every platform. For more information, please see the [GPG on nearly every platform. For more information, please see the [GnuPG
manual](https://gnupg.org/gph/en/manual.html). manual](https://gnupg.org/gph/en/manual.html).
To create a new PGP key, run, following the prompts: To create a new PGP key, run, following the prompts:
@@ -158,7 +158,7 @@ to Vishal, and the third to Seth. These keys can be distributed over almost any
medium, although common sense and judgement are best advised. The encrypted medium, although common sense and judgement are best advised. The encrypted
keys are base64 encoded before returning. keys are base64 encoded before returning.
### Unsealing with a GPG ### Unsealing with GnuPG
Assuming you have been given an unseal key that was encrypted using your public Assuming you have been given an unseal key that was encrypted using your public
PGP key, you are now tasked with entering your unseal key. To get the PGP key, you are now tasked with entering your unseal key. To get the

2
website/content/docs/install.mdx
View File

@@ -24,7 +24,7 @@ with the SHA256 sums that can be verified.
We build and sign official packages for Ubuntu, Debian, Fedora, RHEL, Amazon We build and sign official packages for Ubuntu, Debian, Fedora, RHEL, Amazon
Linux, and other distributions. Follow the instructions at [HashiCorp Linux, and other distributions. Follow the instructions at [HashiCorp
Learn][learn-vault-install] to add our GPG key, add our repository, and Learn][learn-vault-install] to add our PGP key, add our repository, and
install. install.
## Precompiled Binaries ## Precompiled Binaries

2
website/content/guides/operations/generate-root.mdx
View File

@@ -90,7 +90,7 @@ In this method, an OTP is XORed with the generated token on final output.
### Using PGP ### Using PGP
1. Initialize a root token generation, providing the path to a GPG public key 1. Initialize a root token generation, providing the path to a PGP public key
or keybase username of a user to encrypted the resulting token. or keybase username of a user to encrypted the resulting token.
```text ```text

2
website/content/intro/getting-started/deploy.mdx
View File

@@ -145,7 +145,7 @@ somewhere, and continue. In a real deployment scenario, you would never
save these keys together. Instead, you would likely use Vault's PGP and save these keys together. Instead, you would likely use Vault's PGP and
Keybase.io support to encrypt each of these keys with the users' PGP keys. Keybase.io support to encrypt each of these keys with the users' PGP keys.
This prevents one single person from having all the unseal keys. Please This prevents one single person from having all the unseal keys. Please
see the documentation on [using PGP, GPG, and Keybase](/docs/concepts/pgp-gpg-keybase) see the documentation on [using PGP, GnuPG, and Keybase](/docs/concepts/pgp-gpg-keybase)
for more information. for more information.
## Seal/Unseal ## Seal/Unseal

2
website/data/docs-nav-data.json
View File

@@ -137,7 +137,7 @@
] ]
}, },
{ {
"title": "PGP, GPG, and Keybase", "title": "PGP, GnuPG, and Keybase",
"path": "concepts/pgp-gpg-keybase" "path": "concepts/pgp-gpg-keybase"
}, },
{ {