diff --git a/command/crypto/hash/hash.go b/command/crypto/hash/hash.go index 0a258429..33f4f1b3 100644 --- a/command/crypto/hash/hash.go +++ b/command/crypto/hash/hash.go @@ -101,29 +101,30 @@ For examples, see **step help crypto hash**. : must be one of: - **sha1** (or sha) - : SHA-1 produces a 160-bit hash value + **sha1** (or sha) + : SHA-1 produces a 160-bit hash value - **sha224** - : SHA-224 produces a 224-bit hash value + **sha224** + : SHA-224 produces a 224-bit hash value - **sha256** (default) - : SHA-256 produces a 256-bit hash value + **sha256** (default) + : SHA-256 produces a 256-bit hash value - **sha384** - : SHA-384 produces a 384-bit hash value + **sha384** + : SHA-384 produces a 384-bit hash value - **sha512** - : SHA-512 produces a 512-bit hash value + **sha512** + : SHA-512 produces a 512-bit hash value - **sha512-224** - : SHA-512/224 uses SHA-512 and truncates the output to 224 bits + **sha512-224** + : SHA-512/224 uses SHA-512 and truncates the output to 224 bits - **sha512-256** - : SHA-512/256 uses SHA-512 and truncates the output to 256 bits + **sha512-256** + : SHA-512/256 uses SHA-512 and truncates the output to 256 bits - **md5** (requires --insecure) - : MD5 produces a 128-bit hash value`, + **md5** (requires --insecure) + : MD5 produces a 128-bit hash value +`, }, cli.BoolFlag{ Name: "insecure", @@ -160,29 +161,30 @@ For examples, see **step help crypto hash**. : must be one of: - **sha1** (or sha) - : SHA-1 produces a 160-bit hash value + **sha1** (or sha) + : SHA-1 produces a 160-bit hash value - **sha224** - : SHA-224 produces a 224-bit hash value + **sha224** + : SHA-224 produces a 224-bit hash value - **sha256** (default) - : SHA-256 produces a 256-bit hash value + **sha256** (default) + : SHA-256 produces a 256-bit hash value - **sha384** - : SHA-384 produces a 384-bit hash value + **sha384** + : SHA-384 produces a 384-bit hash value - **sha512** - : SHA-512 produces a 512-bit hash value + **sha512** + : SHA-512 produces a 512-bit hash value - **sha512-224** - : SHA-512/224 produces a 224-bit hash value + **sha512-224** + : SHA-512/224 produces a 224-bit hash value - **sha512-256** - : SHA-512/256 produces a 256-bit hash value + **sha512-256** + : SHA-512/256 produces a 256-bit hash value - **md5** (requires --insecure) - : MD5 produces a 128-bit hash value`, + **md5** (requires --insecure) + : MD5 produces a 128-bit hash value +`, }, cli.BoolFlag{ Name: "insecure", diff --git a/command/crypto/jwe/jwe.go b/command/crypto/jwe/jwe.go index 05ac95f4..672cc066 100644 --- a/command/crypto/jwe/jwe.go +++ b/command/crypto/jwe/jwe.go @@ -25,22 +25,22 @@ be encrypted to multiple parties (using multiple keys). A typical JWE in compact serialization is a dot-separated string with five parts: - * Header: metadata describing how the plaintext payload was processed to - produce ciphertext (e.g., which algorithms were used to encrypt the - content encryption key and the plaintext payload) +* Header: metadata describing how the plaintext payload was processed to + produce ciphertext (e.g., which algorithms were used to encrypt the + content encryption key and the plaintext payload) - * Encrypted Key: the "content encryption key" that was used to encrypt the - plaintext payload, encrypted for the JWE recipient(s) (see: "what's with - the encrypted key" below) +* Encrypted Key: the "content encryption key" that was used to encrypt the + plaintext payload, encrypted for the JWE recipient(s) (see: "what's with + the encrypted key" below) - * Initialization Vector: an initialization vector for use with the specified - encryption algorithm, if applicable +* Initialization Vector: an initialization vector for use with the specified + encryption algorithm, if applicable - * Ciphertext: the ciphertext value resulting produced from authenticated - encryption of the plaintext with additional authenticated data +* Ciphertext: the ciphertext value resulting produced from authenticated + encryption of the plaintext with additional authenticated data - * Authentication Tag: value resulting fromthe authenticated encryption of - the plaintext with additional authenticated data +* Authentication Tag: value resulting fromthe authenticated encryption of + the plaintext with additional authenticated data ## What's with encrypted key? diff --git a/command/crypto/kdf/kdf.go b/command/crypto/kdf/kdf.go index ea40f830..a939003f 100644 --- a/command/crypto/kdf/kdf.go +++ b/command/crypto/kdf/kdf.go @@ -137,17 +137,18 @@ appear in places you might not expect. If omitted input is read from STDIN.`, : must be one of: - **scrypt** - : A password-based KDF designed to use exponential time and memory. + **scrypt** + : A password-based KDF designed to use exponential time and memory. - **bcrypt** - : A password-based KDF designed to use exponential time. + **bcrypt** + : A password-based KDF designed to use exponential time. - **argon2i** - : A password-based KDF optimized to resist side-channel attacks. + **argon2i** + : A password-based KDF optimized to resist side-channel attacks. - **argon2id** - : A password-based KDF optimized to resist GPU and side-channel attacks.`, + **argon2id** + : A password-based KDF optimized to resist GPU and side-channel attacks. +`, }, cli.BoolFlag{ Name: "insecure", diff --git a/command/oauth/cmd.go b/command/oauth/cmd.go index 0c346437..abc042b8 100644 --- a/command/oauth/cmd.go +++ b/command/oauth/cmd.go @@ -65,8 +65,7 @@ func init() { cmd := cli.Command{ Name: "oauth", Usage: "authorization and single sign-on using OAuth & OIDC", - UsageText: ` -**step oauth** [**--provider**=] [**--client-id**= **--client-secret**=] + UsageText: `**step oauth** [**--provider**=] [**--client-id**= **--client-secret**=] [**--scope**= ...] [**--bare** [**--oidc**]] [**--header** [**--oidc**]] **step oauth** **--authorization-endpoint**= **--token-endpoint**= @@ -121,7 +120,7 @@ $ step oauth --oidc --bare ''' Use a custom OAuth2.0 server: -'''' +''' $ step oauth --client-id my-client-id --client-secret my-client-secret \ --provider https://example.org '''`, diff --git a/flags/flags.go b/flags/flags.go index e77ad153..76ca8980 100644 --- a/flags/flags.go +++ b/flags/flags.go @@ -178,7 +178,7 @@ generating key.`, Name: "offline", Usage: `Creates a certificate without contacting the certificate authority. Offline mode uses the configuration, certificates, and keys created with **step ca init**, -but can accept a different configuration file using '--ca-config>' flag.`, +but can accept a different configuration file using **--ca-config** flag.`, } // CaConfig is a cli.Flag used to pass the CA configuration file. @@ -242,7 +242,7 @@ be stored in the 'sshpop' header.`, TeamURL = cli.StringFlag{ Name: "team-url", Usage: `The step queries to retrieve initial team configuration. Only used with -the --team option. If the url contains <\<\>> placeholders, they are replaced with the team ID.`, +the **--team** option. If the url contains <\<\>> placeholders, they are replaced with the team ID.`, } // RedirectURL is a cli.Flag used to pass the OAuth redirect URL. @@ -261,7 +261,7 @@ the --team option. If the url contains <\<\>> placeholders, they are replaced wi // TemplateSet is a cli.Flag used to send key-value pairs to the ca. TemplateSet = cli.StringSliceFlag{ Name: "set", - Usage: "The pair with template data variables to send to the CA. Use the '--set' flag multiple times to add multiple variables.", + Usage: "The pair with template data variables to send to the CA. Use the **--set** flag multiple times to add multiple variables.", } // TemplateSetFile is a cli.Flag used to send a JSON file to the CA.