Skip to content

Commit 4afe4cf

Browse files
committed
Spelling
* access * adminclient * ampersand * and * ascii * associated * auto-detected * browser * certificate * certificates * characters * command * compatibility * consist * decodes * digital * distinguished * doesn't * encoded * encrypted * encrypting * entities * error * extension * from the * from * github * herd * inspecting * interchangeable * interchangeably * issuing * json * macos * mixed * onboarding * outer * parameter * parses * password * preexisting * processed * publickey * reference * remaining * renegotiate * represents * secrecy * serialization * smartypants * smartypantsable * subcommand * subject * subtle * suppression * the * tidiness * too-soon * truststore * unmarshaling * use * wrapping Signed-off-by: Josh Soref <[email protected]>
1 parent 9feb476 commit 4afe4cf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+114
-114
lines changed

.github/workflows/release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
prerelease: ${{ steps.is_prerelease.outputs.IS_PRERELEASE }}
4848

4949
goreleaser:
50-
name: Upload Assets to Github w/ goreleaser
50+
name: Upload Assets to GitHub w/ goreleaser
5151
runs-on: ubuntu-latest
5252
needs: create_release
5353
steps:
@@ -177,12 +177,12 @@ jobs:
177177
token: ${{ secrets.DOCS_PAT }}
178178
path: './docs'
179179
- name: Update Reference
180-
id: update_refrence
180+
id: update_reference
181181
run: |
182182
./bin/step help --markdown ./docs/src/pages/docs/step-cli/reference
183183
cd ./docs
184184
git config user.email "[email protected]"
185-
git config user.name "Github Action CI"
185+
git config user.name "GitHub Action CI"
186186
git add . && git commit -a -m "step-cli ${{ needs.create_release.outputs.vversion }} reference update"
187187
- name: Push changes
188188
uses: ad-m/[email protected]

.goreleaser.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ release:
169169
- 📦 [step-cli_{{ .Version }}_amd64.deb](https://dl.step.sm/gh-release/cli/gh-release-header/{{ .Tag }}/step-cli_{{ .Version }}_amd64.deb)
170170
- 📦 [step-cli_{{ .Version }}_amd64.rpm](https://dl.step.sm/gh-release/cli/gh-release-header/{{ .Tag }}/step-cli_{{ .Version }}_amd64.rpm)
171171
172-
#### OSX Darwin
172+
#### macOS Darwin
173173
174174
- 📦 [step_darwin_{{ .Version }}_amd64.tar.gz](https://dl.step.sm/gh-release/cli/gh-release-header/{{ .Tag }}/step_darwin_{{ .Version }}_amd64.tar.gz)
175175
- 📦 [step_darwin_{{ .Version }}_arm64.tar.gz](https://dl.step.sm/gh-release/cli/gh-release-header/{{ .Tag }}/step_darwin_{{ .Version }}_arm64.tar.gz)
@@ -212,7 +212,7 @@ release:
212212
# Defaults to false.
213213
#disable: true
214214

215-
# You can add extra pre-existing files to the release.
215+
# You can add extra preexisting files to the release.
216216
# The filename on the release will be the last part of the path (base). If
217217
# another file with the same name exists, the latest one found will be used.
218218
# Defaults to empty.

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,11 +163,11 @@ to the value of provisioner-password-file flag.
163163

164164
## [0.0.2]
165165
### Added
166-
- `--bundle` flag to cert/inspect for inpecting all the full chain or bundle
166+
- `--bundle` flag to cert/inspect for inspecting all the full chain or bundle
167167
given a path. Default behavior is unchanged; only inspect the first (leaf)
168168
certificate.
169169
- distribution.md with documentation on how to create releases.
170-
- travis build and upload artifacts to Github Releases on tagged pushes.
170+
- travis build and upload artifacts to GitHub Releases on tagged pushes.
171171
- logging of invalid http requests to the oauth server
172172
### Changed
173173
- default PEM format encryption alg AES128 -> AES256

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ define BUNDLE
9191
# $(2) -- Binary Output Dir Name
9292
# $(3) -- Step Platform Name
9393
# $(4) -- Step Binary Architecture
94-
# $(5) -- Step Binary Name (For Windows Comaptibility)
94+
# $(5) -- Step Binary Name (For Windows Compatibility)
9595
$(q) ./make/bundle.sh $(1) "$(BINARY_OUTPUT)$(2)" "$(RELEASE)" "$(VERSION)" "$(3)" "$(4)" "$(5)"
9696
endef
9797

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Step CLI's command groups illustrate its wide-ranging uses:
2727

2828
- [`step certificate`](https://smallstep.com/docs/step-cli/reference/certificate/): Work with X.509 (TLS/HTTPS) certificates.
2929
- Create, revoke, validate, lint, and bundle X.509 certificates.
30-
- Install (and remove) X.509 certificates into your system's (and brower's) trust store.
30+
- Install (and remove) X.509 certificates into your system's (and browser's) trust store.
3131
- Validate certificate deployment and renewal status for automation
3232
- Create key pairs (RSA, ECDSA, EdDSA) and certificate signing requests (CSRs)
3333
- [Sign CSRs](https://smallstep.com/docs/step-cli/reference/certificate/sign/)

autocomplete/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
## Deprecated
2-
The files in this folder are deprecated and will be removed in the future. The prefered way to acces the completion scripts is through `step completion <shell>`.
2+
The files in this folder are deprecated and will be removed in the future. The prefered way to access the completion scripts is through `step completion <shell>`.

command/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ required, and ensuring they're printed out as a part of the `step help` or
7979
`step <command> -h` flow. If you need to add a different type of annotation to
8080
document an argument just add it to the `usage.Argument` struct!
8181

82-
When you add a flag, look into the pre-existing ones inside the `flags`
83-
package. Could you use one of the pre-existing flags in order to reduce
82+
When you add a flag, look into the preexisting ones inside the `flags`
83+
package. Could you use one of the preexisting flags in order to reduce
8484
duplication? If not, make sure to add a flag so it could be used in future!
8585

8686
The `errs` package contains functionality for defining and working with errors

command/base64/base64.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ YWJjMTIzJCVeJiooKV8rLT1-Cg==
5353
'''
5454
5555
Decode an url encoded base64 string. The encoding type can be enforced
56-
using the '-u' or '-r' flags, but it will be autodetected if they are not
56+
using the '-u' or '-r' flags, but it will be auto-detected if they are not
5757
passed:
5858
'''
5959
$ echo YWJjMTIzJCVeJiooKV8rLT1-Cg== | step base64 -d

command/ca/ca.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ $ step ca renew internal.crt internal.key \
7474
revokeCertificateCommand(),
7575
provisioner.Command(),
7676
signCertificateCommand(),
77-
rootComand(),
77+
rootCommand(),
7878
rootsCommand(),
7979
federationCommand(),
8080
acme.Command(),

command/ca/provisioner/caConfigClient.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
"go.step.sm/linkedca"
1313
)
1414

15-
// nodb implements the certificates/Admiclient interface with noops.
15+
// nodb implements the certificates/Adminclient interface with noops.
1616
type nodb struct{}
1717

1818
func newNoDB() *nodb {
@@ -179,7 +179,7 @@ func (client *caConfigClient) loadProvisioner(opts ...ca.ProvisionerOption) (pro
179179
return nil, errors.New("provisioner options must define either ID or Name to remove")
180180
}
181181

182-
return prov, errors.Wrapf(err, "erorr loading provisioner")
182+
return prov, errors.Wrapf(err, "error loading provisioner")
183183
}
184184

185185
func (client *caConfigClient) GetProvisioners(opts ...ca.ProvisionerOption) (provisioner.List, error) {

command/ca/provisioner/provisioner.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@ Use the '--remove-domain' flag multiple times to remove multiple domains.`,
578578
}
579579
oidcGroupFlag = cli.StringSliceFlag{
580580
Name: "group",
581-
Usage: `The <group> list used to validate the groups extenstion in an OpenID Connect token.
581+
Usage: `The <group> list used to validate the groups extension in an OpenID Connect token.
582582
Use the '--group' flag multiple times to configure multiple groups.`,
583583
}
584584
oidcTenantIDFlag = cli.StringFlag{

command/ca/rekey.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ flag.`,
166166
cli.StringFlag{
167167
Name: "pid-file",
168168
Usage: `The <file> from which to read the process id that will be signaled after the certificate
169-
has been rekeyed. By default the the SIGHUP (1) signal will be used, but this can be configured with the **--signal**
169+
has been rekeyed. By default the SIGHUP (1) signal will be used, but this can be configured with the **--signal**
170170
flag.`,
171171
},
172172
cli.IntFlag{

command/ca/renew.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ flag.`,
177177
cli.StringFlag{
178178
Name: "pid-file",
179179
Usage: `The <file> from which to read the process id that will be signaled after the certificate
180-
has been renewed. By default the the SIGHUP (1) signal will be used, but this can be configured with the **--signal**
180+
has been renewed. By default the SIGHUP (1) signal will be used, but this can be configured with the **--signal**
181181
flag.`,
182182
},
183183
cli.IntFlag{

command/ca/revoke.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ $ step ca revoke --offline 308893286343609293989051180431574390766
126126
'''
127127
128128
Revoke a certificate in offline mode using --cert and --key (the cert/key pair
129-
will be validated against the root and intermediate certifcates configured in
129+
will be validated against the root and intermediate certificates configured in
130130
the step CA):
131131
'''
132132
$ step ca revoke --offline --cert foo.crt --key foo.key

command/ca/root.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import (
1616
"go.step.sm/cli-utils/ui"
1717
)
1818

19-
func rootComand() cli.Command {
19+
func rootCommand() cli.Command {
2020
return cli.Command{
2121
Name: "root",
2222
Action: command.ActionFunc(rootAction),

command/certificate/bundle.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func bundleCommand() cli.Command {
2828
: The path to a leaf certificate to bundle with issuing certificate(s).
2929
3030
<ca>
31-
: The path to the Certificate Authority issusing certificate.
31+
: The path to the Certificate Authority issuing certificate.
3232
3333
<bundle-file>
3434
: The path to write the bundle.

command/certificate/install.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,17 @@ Install a certificate in all the supported truststores:
4343
$ step certificate install --all root-ca.pem
4444
'''
4545
46-
Install a certificate in Firefox and the system trustore:
46+
Install a certificate in Firefox and the system truststore:
4747
'''
4848
$ step certificate install --firefox root--ca.pem
4949
'''
5050
51-
Install a certificate in Java and the system trustore:
51+
Install a certificate in Java and the system truststore:
5252
'''
5353
$ step certificate install --java root-ca.pem
5454
'''
5555
56-
Install a certificate in Firefox, Java, but not in the system trustore:
56+
Install a certificate in Firefox, Java, but not in the system truststore:
5757
'''
5858
$ step certificate install --firefox --java --no-system root-ca.pem
5959
'''`,
@@ -113,12 +113,12 @@ Uninstall a certificate from all the supported truststores:
113113
$ step certificate uninstall --all root-ca.pem
114114
'''
115115
116-
Uninstall a certificate from Firefox and the system trustore:
116+
Uninstall a certificate from Firefox and the system truststore:
117117
'''
118118
$ step certificate uninstall --firefox root--ca.pem
119119
'''
120120
121-
Uninstall a certificate infrom Java and the system trustore:
121+
Uninstall a certificate from Java and the system truststore:
122122
'''
123123
$ step certificate uninstall --java root-ca.pem
124124
'''

command/certificate/p12.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ func p12Action(ctx *cli.Context) error {
149149

150150
// The first certificate in the bundle will be our server cert
151151
x509Cert := x509CertBundle[0]
152-
// Any remaning certs will be intermediates for the server
152+
// Any remaining certs will be intermediates for the server
153153
x509CAs = append(x509CAs, x509CertBundle[1:]...)
154154

155155
pkcs12Data, err = pkcs12.Encode(rand.Reader, key, x509Cert, x509CAs, password)

command/certificate/remote.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ func getPeerCertificates(addr, serverName, roots string, insecure bool) ([]*x509
7171
// by the URL prefix is used.
7272
//
7373
// Examples:
74-
// trimURL("https://smallstep.com/onbaording") -> "smallstep.com:443", true, nil
74+
// trimURL("https://smallstep.com/onboarding") -> "smallstep.com:443", true, nil
7575
// trimURL("https://ca.smallSTEP.com:8080") -> "ca.smallSTEP.com:8080", true, nil
7676
// trimURL("./certs/root_ca.crt") -> "", false, nil
7777
// trimURL("hTtPs://sMaLlStEp.cOm") -> "sMaLlStEp.cOm:443", true, nil

command/crl/inspect.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ func inspectAction(ctx *cli.Context) error {
266266
type CRL struct {
267267
Version int `json:"version"`
268268
SignatureAlgorithm SignatureAlgorithm `json:"signature_algorithm"`
269-
Issuer DistinguisedName `json:"issuer"`
269+
Issuer DistinguishedName `json:"issuer"`
270270
ThisUpdate time.Time `json:"this_update"`
271271
NextUpdate time.Time `json:"next_update"`
272272
RevokedCertificates []RevokedCertificate `json:"revoked_certificates"`
@@ -417,8 +417,8 @@ type Signature struct {
417417
Reason string `json:"reason,omitempty"`
418418
}
419419

420-
// DistinguisedName is the JSON representation of the CRL issuer.
421-
type DistinguisedName struct {
420+
// DistinguishedName is the JSON representation of the CRL issuer.
421+
type DistinguishedName struct {
422422
Country []string `json:"country,omitempty"`
423423
Organization []string `json:"organization,omitempty"`
424424
OrganizationalUnit []string `json:"organizational_unit,omitempty"`
@@ -433,7 +433,7 @@ type DistinguisedName struct {
433433
}
434434

435435
// String returns the one line representation of the distinguished name.
436-
func (d DistinguisedName) String() string {
436+
func (d DistinguishedName) String() string {
437437
var parts []string
438438
for _, dn := range d.raw {
439439
v := strings.ReplaceAll(pkix.RDNSequence{dn}.String(), "\\,", ",")
@@ -442,7 +442,7 @@ func (d DistinguisedName) String() string {
442442
return strings.Join(parts, " ")
443443
}
444444

445-
func newDistinguishedName(seq pkix.RDNSequence) DistinguisedName {
445+
func newDistinguishedName(seq pkix.RDNSequence) DistinguishedName {
446446
var n pkix.Name
447447
n.FillFromRDNSequence(&seq)
448448

@@ -463,7 +463,7 @@ func newDistinguishedName(seq pkix.RDNSequence) DistinguisedName {
463463
}
464464
}
465465

466-
return DistinguisedName{
466+
return DistinguishedName{
467467
Country: n.Country,
468468
Organization: n.Organization,
469469
OrganizationalUnit: n.OrganizationalUnit,

command/crypto/crypto.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ risks. That said, many of these factors are beyond the scope of this tool.
7474
compared to RSA. The strength of these keys is generally considered sufficient
7575
for the predictable and foreseeable future.
7676
77-
: Note that for cryptographic protocols that have perfect forward secrecry and
77+
: Note that for cryptographic protocols that have perfect forward secrecy and
7878
only use asymmetric keys for symmetric key negotiation your system will remain
7979
secure against future threats as long as the keys are large enough that they
8080
cannot be cracked today. In other words, sizing your keys to protect against
@@ -111,7 +111,7 @@ risks. That said, many of these factors are beyond the scope of this tool.
111111
opted not to gate non-safe curves**. We've further elected to make **P-256**
112112
the default curve for EC keys.
113113
114-
: Still, it is important to be aware of the security risks assocated with their
114+
: Still, it is important to be aware of the security risks associated with their
115115
risk. You should consider using "safe curves" if possible. We may change our
116116
mind as support for safe curves improves.
117117

command/crypto/jwe/encrypt.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ options must match unless the **--subtle** flag is also passed.
7272
: ECDH-ES using Concat KDF and CEK wrapped with "A256KW
7373
7474
**A128GCMKW**
75-
: Key wrappiung with AES GCM using 128-bit key
75+
: Key wrapping with AES GCM using 128-bit key
7676
7777
**A192GCMKW**
78-
: Key wrappiung with AES GCM using 192-bit key
78+
: Key wrapping with AES GCM using 192-bit key
7979
8080
**A256GCMKW** (default for oct keys)
81-
: Key wrappiung with AES GCM using 256-bit key
81+
: Key wrapping with AES GCM using 256-bit key
8282
8383
**PBES2-HS256+A128KW**
8484
: PBES2 with HMAC SHA-256 and "A128KW" wrapping

command/crypto/jwe/jwe.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ parts:
3939
* Ciphertext: the ciphertext value resulting produced from authenticated
4040
encryption of the plaintext with additional authenticated data
4141
42-
* Authentication Tag: value resulting fromthe authenticated encryption of
42+
* Authentication Tag: value resulting from the authenticated encryption of
4343
the plaintext with additional authenticated data
4444
4545
## What's with encrypted key?

command/crypto/jwk/create.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import (
2121
const (
2222
// 128-bit salt
2323
pbkdf2SaltSize = 16
24-
// 100k iterations. Nist recommends at least 10k, 1Passsword uses 100k.
24+
// 100k iterations. Nist recommends at least 10k, 1Password uses 100k.
2525
pbkdf2Iterations = 100000
2626
)
2727

@@ -47,7 +47,7 @@ All flags are optional. Defaults are suitable for most use cases.
4747
## POSITIONAL ARGUMENTS
4848
4949
<public-jwk-file>
50-
: Path to which the the public JWK should be written
50+
: Path to which the public JWK should be written
5151
5252
<private-jwk-file>
5353
: Path to which the (JWE encrypted) private JWK should be written

command/crypto/jwk/jwk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ JWK Set is a JSON object with a "keys" member whose value is an array of JWKs.
1919
Cryptographic algorithms and identifiers for used by JWKs are defined by the
2020
JSON Web Algorithms (JWA) specification in RFC7518. This tool also supports
2121
extensions defined in standards track RFC8037 defining curve and algorithm
22-
identifiers for Edwards-curve Digial Signatures.
22+
identifiers for Edwards-curve Digital Signatures.
2323
2424
JWKs and JWK Sets are used in the JSON Web Signature (JWS; RFC7515) and JSON
2525
Web Encryption (JWE; RFC7516) specifications for signing and encrypting JSON

command/crypto/jwt/jwt.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ eyJhdWQiOiJodHRwczovL2V4YW1wbGUuY29tIiwiZXhwIjoxNTM1MjQyNDcyLCJpYXQiOjE1MzI1NjQw
5555
DlSkxICjk2h1LarwJgXPbXQe7DwpLMOCvWp3I4GMcBP_5_QYPhVNBPQEeTKAUuQjYwlxZ5zVQnyp8ujvyf1Lqw
5656
'''
5757
58-
Verify the the previous token:
58+
Verify the previous token:
5959
'''
6060
$ echo $TOKEN | step crypto jwt verify --key p256.pub.json --iss "[email protected]" --aud "https://example.com"
6161
{

command/crypto/jwt/verify.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ func verifyAction(ctx *cli.Context) error {
146146
kid = tok.Headers[0].KeyID
147147
}
148148

149-
// Validate subtled
149+
// Validate subtle
150150
isSubtle := ctx.Bool("subtle")
151151
iss := ctx.String("iss")
152152
aud := ctx.String("aud")
@@ -263,7 +263,7 @@ func validateClaimsWithLeeway(ctx *cli.Context, c jose.Claims, e jose.Expected,
263263

264264
// we're not currently checking the subject
265265
if e.Subject != "" && e.Subject != c.Subject {
266-
ers = append(ers, "invalid subject subject (sub)")
266+
ers = append(ers, "invalid subject (sub)")
267267
}
268268

269269
// we're not currently checking the id

command/crypto/key/format.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ func parseJWK(ctx *cli.Context, b []byte) (interface{}, error) {
322322
// Parse decrypted key
323323
var jwk jose.JSONWebKey
324324
if err := json.Unmarshal(b, &jwk); err != nil {
325-
return nil, errors.Wrap(err, "error unmarshalling key")
325+
return nil, errors.Wrap(err, "error unmarshaling key")
326326
}
327327
if jwk.Key == nil {
328328
return nil, errors.New("error parsing key: not found")

command/crypto/nacl/box.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ func boxOpenAction(ctx *cli.Context) error {
286286
copy(pb[:], pub)
287287
copy(pv[:], priv)
288288

289-
// Fixme: if we prepend the nonce in the seal we can use use rawInput[24:]
289+
// Fixme: if we prepend the nonce in the seal we can use rawInput[24:]
290290
// as the message and rawInput[:24] as the nonce instead of requiring one.
291291
raw, ok := box.Open(nil, rawInput, &n, &pb, &pv)
292292
if !ok {

0 commit comments

Comments
 (0)