From 3991e172b2b3429a84f1c6dcd10a8230eaddf709 Mon Sep 17 00:00:00 2001 From: Attila Gulyas Date: Tue, 8 Aug 2023 17:32:51 -0400 Subject: [PATCH 1/2] Make term "trust store" consistent across the docs [..] See PR https://github.com/smallstep/docs/pull/260 for context. --- command/ca/bootstrap.go | 2 +- command/certificate/certificate.go | 4 +-- command/certificate/install.go | 50 +++++++++++++++--------------- 3 files changed, 28 insertions(+), 28 deletions(-) diff --git a/command/ca/bootstrap.go b/command/ca/bootstrap.go index 98aea1a56..fd79be625 100644 --- a/command/ca/bootstrap.go +++ b/command/ca/bootstrap.go @@ -65,7 +65,7 @@ $ step ca bootstrap --team superteam --team-url https://config.example.com/<> fingerprintFlag, cli.BoolFlag{ Name: "install", - Usage: "Install the root certificate into the system truststore.", + Usage: "Install the root certificate into the system's default trust store.", }, flags.Team, flags.TeamAuthority, diff --git a/command/certificate/certificate.go b/command/certificate/certificate.go index 639bbeea9..5aa3dbd32 100644 --- a/command/certificate/certificate.go +++ b/command/certificate/certificate.go @@ -70,12 +70,12 @@ Extract the public key from a PEM encoded certificate: $ step certificate key foo.crt ''' -Install a root certificate in the system truststore: +Install a root certificate in the system's default trust store: ''' $ step certificate install root-ca.crt ''' -Uninstall a root certificate from the system truststore: +Uninstall a root certificate from the system's default trust store: ''' $ step certificate uninstall root-ca.crt '''`, diff --git a/command/certificate/install.go b/command/certificate/install.go index c8cfdbcde..ed5da22d2 100644 --- a/command/certificate/install.go +++ b/command/certificate/install.go @@ -17,50 +17,50 @@ func installCommand() cli.Command { return cli.Command{ Name: "install", Action: command.ActionFunc(installAction), - Usage: "install a root certificate in the system truststore", + Usage: "install a root certificate in the supported trust stores", UsageText: `**step certificate install** [**--prefix**=] [**--all**] [**--java**] [**--firefox**] [**--no-system**]`, - Description: `**step certificate install** installs a root certificate in the system -truststore. + Description: `**step certificate install** installs a root certificate in +the supported trust stores. -Java and Firefox truststores are also supported via the respective flags. +Java's and Firefox's trust stores are also supported via the respective flags ## POSITIONAL ARGUMENTS -: Certificate to install in the system truststore +: Root certificate to install in the specified trust stores. ## EXAMPLES -Install a certificate in the system truststore: +Install a root certificate in the system's default trust store: ''' $ step certificate install root-ca.pem ''' -Install a certificate in all the supported truststores: +Install a root certificate in all the supported trust stores: ''' $ step certificate install --all root-ca.pem ''' -Install a certificate in Firefox and the system truststore: +Install a root certificate in Firefox's and the system's default trust store: ''' $ step certificate install --firefox root--ca.pem ''' -Install a certificate in Java and the system truststore: +Install a root certificate in Java's and the system's default trust store: ''' $ step certificate install --java root-ca.pem ''' -Install a certificate in Firefox, Java, but not in the system truststore: +Install a root certificate in Firefox's and Java's trust store, but not in the system's default trust store: ''' $ step certificate install --firefox --java --no-system root-ca.pem '''`, Flags: []cli.Flag{ cli.StringFlag{ Name: "prefix", - Usage: `The prefix used to the CA in the truststore. Defaults to the + Usage: `The prefix used to the CA in the trust store. Defaults to the certificate common name.`, }, cli.BoolFlag{ @@ -73,11 +73,11 @@ certificate common name.`, }, cli.BoolFlag{ Name: "no-system", - Usage: "disables the install on the system truststore", + Usage: "disables the install on the system's default trust store", }, cli.BoolFlag{ Name: "all", - Usage: "install on the system, Firefox and Java truststores", + Usage: "install in Firefox's, Java's, and the system's default trust store", }, }, } @@ -87,38 +87,38 @@ func uninstallCommand() cli.Command { return cli.Command{ Name: "uninstall", Action: command.ActionFunc(uninstallAction), - Usage: "uninstall a root certificate from the system truststore", + Usage: "uninstall a root certificate from the supported trust stores", UsageText: `**step certificate uninstall** [**--prefix**=] [**--all**] [**--java**] [**--firefox**] [**--no-system**]`, - Description: `**step certificate uninstall** uninstalls a root certificate from the system -truststore. + Description: `**step certificate uninstall** uninstalls a root certificate from +the supported trust stores. -Java and Firefox truststores are also supported via the respective flags. +Java's and Firefox's trust stores are also supported via the respective flags. ## POSITIONAL ARGUMENTS -: Certificate to uninstall from the system truststore +: Root certificate to uninstall from the specified trust stores. ## EXAMPLES -Uninstall from only the system truststore: +Uninstall only from the system's default trust store: ''' $ step certificate uninstall root-ca.pem ''' -Uninstall a certificate from all the supported truststores: +Uninstall a root certificate from all the supported trust stores: ''' $ step certificate uninstall --all root-ca.pem ''' -Uninstall a certificate from Firefox and the system truststore: +Uninstall a root certificate from Firefox's and the system's default trust store: ''' $ step certificate uninstall --firefox root--ca.pem ''' -Uninstall a certificate from Java and the system truststore: +Uninstall a root certificate from Java's and the system's default trust store: ''' $ step certificate uninstall --java root-ca.pem ''' @@ -130,7 +130,7 @@ $ step certificate uninstall --firefox --java --no-system root-ca.pem Flags: []cli.Flag{ cli.StringFlag{ Name: "prefix", - Usage: `The prefix used to the CA in the truststore. Defaults to the + Usage: `The prefix used to the CA in the trust store. Defaults to the certificate common name.`, }, cli.BoolFlag{ @@ -143,11 +143,11 @@ certificate common name.`, }, cli.BoolFlag{ Name: "no-system", - Usage: "disables the uninstall from the system truststore", + Usage: "disables the uninstall from the system's default trust store", }, cli.BoolFlag{ Name: "all", - Usage: "uninstall from the system, Firefox and Java truststores", + Usage: "uninstall from Firefox's, Java's, and the system's default trust store", }, }, } From 45579059e76c606dcc00d9f8006dbf3a3401b5e6 Mon Sep 17 00:00:00 2001 From: Attila Gulyas Date: Tue, 8 Aug 2023 20:24:47 -0400 Subject: [PATCH 2/2] Fix typo in example --- command/certificate/install.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/command/certificate/install.go b/command/certificate/install.go index ed5da22d2..314bc3c96 100644 --- a/command/certificate/install.go +++ b/command/certificate/install.go @@ -45,7 +45,7 @@ $ step certificate install --all root-ca.pem Install a root certificate in Firefox's and the system's default trust store: ''' -$ step certificate install --firefox root--ca.pem +$ step certificate install --firefox root-ca.pem ''' Install a root certificate in Java's and the system's default trust store: @@ -115,7 +115,7 @@ $ step certificate uninstall --all root-ca.pem Uninstall a root certificate from Firefox's and the system's default trust store: ''' -$ step certificate uninstall --firefox root--ca.pem +$ step certificate uninstall --firefox root-ca.pem ''' Uninstall a root certificate from Java's and the system's default trust store: