2018-10-05 21:48:36 +00:00
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
2019-03-18 19:38:19 +00:00
|
|
|
"flag"
|
2018-10-05 21:48:36 +00:00
|
|
|
"fmt"
|
2019-08-29 22:58:07 +00:00
|
|
|
"html"
|
2018-11-22 20:59:33 +00:00
|
|
|
"log"
|
2019-09-12 19:51:07 +00:00
|
|
|
"math/rand"
|
2018-10-05 21:48:36 +00:00
|
|
|
"net/http"
|
|
|
|
"os"
|
2018-11-22 20:59:33 +00:00
|
|
|
"reflect"
|
|
|
|
"regexp"
|
2019-08-29 22:58:07 +00:00
|
|
|
"strconv"
|
2018-11-08 19:45:19 +00:00
|
|
|
"time"
|
2019-09-12 19:51:07 +00:00
|
|
|
|
2019-12-12 00:26:38 +00:00
|
|
|
// Server profiler
|
|
|
|
_ "net/http/pprof"
|
|
|
|
|
2019-11-21 01:01:31 +00:00
|
|
|
"github.com/smallstep/certificates/authority"
|
2019-09-12 19:51:07 +00:00
|
|
|
"github.com/smallstep/certificates/commands"
|
2018-11-22 20:59:33 +00:00
|
|
|
"github.com/urfave/cli"
|
2020-10-29 20:10:03 +00:00
|
|
|
"go.step.sm/cli-utils/command"
|
|
|
|
"go.step.sm/cli-utils/command/version"
|
2021-08-10 07:38:30 +00:00
|
|
|
"go.step.sm/cli-utils/step"
|
2021-10-07 18:09:32 +00:00
|
|
|
"go.step.sm/cli-utils/ui"
|
2020-10-29 20:10:03 +00:00
|
|
|
"go.step.sm/cli-utils/usage"
|
2020-06-12 21:55:35 +00:00
|
|
|
|
|
|
|
// Enabled kms interfaces.
|
|
|
|
_ "github.com/smallstep/certificates/kms/awskms"
|
2021-10-06 00:09:40 +00:00
|
|
|
_ "github.com/smallstep/certificates/kms/azurekms"
|
2020-06-12 21:55:35 +00:00
|
|
|
_ "github.com/smallstep/certificates/kms/cloudkms"
|
|
|
|
_ "github.com/smallstep/certificates/kms/softkms"
|
2020-11-03 13:26:46 +00:00
|
|
|
_ "github.com/smallstep/certificates/kms/sshagentkms"
|
2020-06-12 21:55:35 +00:00
|
|
|
|
|
|
|
// Experimental kms interfaces.
|
2021-01-27 04:03:53 +00:00
|
|
|
_ "github.com/smallstep/certificates/kms/pkcs11"
|
2020-06-12 21:55:35 +00:00
|
|
|
_ "github.com/smallstep/certificates/kms/yubikey"
|
2020-09-09 02:26:32 +00:00
|
|
|
|
|
|
|
// Enabled cas interfaces.
|
|
|
|
_ "github.com/smallstep/certificates/cas/cloudcas"
|
|
|
|
_ "github.com/smallstep/certificates/cas/softcas"
|
2021-03-18 02:33:35 +00:00
|
|
|
_ "github.com/smallstep/certificates/cas/stepcas"
|
2022-01-14 17:56:17 +00:00
|
|
|
_ "github.com/smallstep/certificates/cas/vaultcas"
|
2018-10-05 21:48:36 +00:00
|
|
|
)
|
|
|
|
|
2018-11-22 20:59:33 +00:00
|
|
|
// commit and buildTime are filled in during build by the Makefile
|
|
|
|
var (
|
|
|
|
BuildTime = "N/A"
|
|
|
|
Version = "N/A"
|
|
|
|
)
|
2018-11-08 19:45:19 +00:00
|
|
|
|
2019-09-12 19:51:07 +00:00
|
|
|
func init() {
|
2021-08-10 07:38:30 +00:00
|
|
|
step.Set("Smallstep CA", Version, BuildTime)
|
2019-11-21 01:01:31 +00:00
|
|
|
authority.GlobalVersion.Version = Version
|
2019-09-12 19:51:07 +00:00
|
|
|
rand.Seed(time.Now().UnixNano())
|
2018-11-08 19:45:19 +00:00
|
|
|
}
|
|
|
|
|
2021-10-07 19:43:24 +00:00
|
|
|
func exit(code int) {
|
|
|
|
ui.Reset()
|
|
|
|
os.Exit(code)
|
|
|
|
}
|
|
|
|
|
2019-08-29 22:58:07 +00:00
|
|
|
// appHelpTemplate contains the modified template for the main app
|
|
|
|
var appHelpTemplate = `## NAME
|
|
|
|
**{{.HelpName}}** -- {{.Usage}}
|
|
|
|
## USAGE
|
|
|
|
{{if .UsageText}}{{.UsageText}}{{else}}**{{.HelpName}}**{{if .Commands}} <command>{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}_[arguments]_{{end}}{{end}}{{if .Description}}
|
|
|
|
## DESCRIPTION
|
|
|
|
{{.Description}}{{end}}{{if .VisibleCommands}}
|
|
|
|
## COMMANDS
|
|
|
|
{{range .VisibleCategories}}{{if .Name}}{{.Name}}:{{end}}
|
|
|
|
|||
|
|
|
|
|---|---|{{range .VisibleCommands}}
|
|
|
|
| **{{join .Names ", "}}** | {{.Usage}} |{{end}}
|
|
|
|
{{end}}{{if .VisibleFlags}}{{end}}
|
|
|
|
## OPTIONS
|
2021-03-24 21:55:34 +00:00
|
|
|
|
2019-08-29 22:58:07 +00:00
|
|
|
{{range $index, $option := .VisibleFlags}}{{if $index}}
|
|
|
|
{{end}}{{$option}}
|
|
|
|
{{end}}{{end}}{{if .Copyright}}{{if len .Authors}}
|
|
|
|
## AUTHOR{{with $length := len .Authors}}{{if ne 1 $length}}S{{end}}{{end}}:
|
|
|
|
{{range $index, $author := .Authors}}{{if $index}}
|
|
|
|
{{end}}{{$author}}{{end}}{{end}}{{if .Version}}{{if not .HideVersion}}
|
|
|
|
## ONLINE
|
|
|
|
This documentation is available online at https://smallstep.com/docs/certificates
|
|
|
|
## VERSION
|
|
|
|
{{.Version}}{{end}}{{end}}
|
|
|
|
## COPYRIGHT
|
|
|
|
{{.Copyright}}
|
|
|
|
## FEEDBACK ` +
|
|
|
|
html.UnescapeString("&#"+strconv.Itoa(128525)+";") + " " +
|
|
|
|
html.UnescapeString("&#"+strconv.Itoa(127867)+";") +
|
|
|
|
`
|
|
|
|
The **step-ca** utility is not instrumented for usage statistics. It does not phone home.
|
|
|
|
But your feedback is extremely valuable. Any information you can provide regarding how you’re using **step-ca** helps.
|
2020-09-23 23:36:37 +00:00
|
|
|
Please send us a sentence or two, good or bad: **feedback@smallstep.com** or https://github.com/smallstep/certificates/discussions.
|
2019-08-29 22:58:07 +00:00
|
|
|
{{end}}
|
|
|
|
`
|
|
|
|
|
2018-10-05 21:48:36 +00:00
|
|
|
func main() {
|
2021-10-07 18:09:32 +00:00
|
|
|
// Initialize windows terminal
|
|
|
|
ui.Init()
|
|
|
|
|
2018-11-22 20:59:33 +00:00
|
|
|
// Override global framework components
|
|
|
|
cli.VersionPrinter = func(c *cli.Context) {
|
2019-09-12 19:51:07 +00:00
|
|
|
version.Command(c)
|
2018-11-08 19:45:19 +00:00
|
|
|
}
|
2019-08-29 22:58:07 +00:00
|
|
|
cli.AppHelpTemplate = appHelpTemplate
|
2018-11-22 20:59:33 +00:00
|
|
|
cli.SubcommandHelpTemplate = usage.SubcommandHelpTemplate
|
|
|
|
cli.CommandHelpTemplate = usage.CommandHelpTemplate
|
|
|
|
cli.HelpPrinter = usage.HelpPrinter
|
|
|
|
cli.FlagNamePrefixer = usage.FlagNamePrefixer
|
|
|
|
cli.FlagStringer = stringifyFlag
|
2019-09-12 19:51:07 +00:00
|
|
|
|
2018-11-22 20:59:33 +00:00
|
|
|
// Configure cli app
|
|
|
|
app := cli.NewApp()
|
|
|
|
app.Name = "step-ca"
|
|
|
|
app.HelpName = "step-ca"
|
2021-08-10 07:38:30 +00:00
|
|
|
app.Version = step.Version()
|
2018-11-22 20:59:33 +00:00
|
|
|
app.Usage = "an online certificate authority for secure automated certificate management"
|
2021-10-08 18:59:57 +00:00
|
|
|
app.UsageText = `**step-ca** <config> [**--password-file**=<file>]
|
2021-09-16 19:05:23 +00:00
|
|
|
[**--ssh-host-password-file**=<file>] [**--ssh-user-password-file**=<file>]
|
|
|
|
[**--issuer-password-file**=<file>] [**--resolver**=<addr>] [**--help**] [**--version**]`
|
2018-11-22 20:59:33 +00:00
|
|
|
app.Description = `**step-ca** runs the Step Online Certificate Authority
|
|
|
|
(Step CA) using the given configuration.
|
|
|
|
See the README.md for more detailed configuration documentation.
|
|
|
|
## POSITIONAL ARGUMENTS
|
|
|
|
<config>
|
|
|
|
: File that configures the operation of the Step CA; this file is generated
|
|
|
|
when you initialize the Step CA using 'step ca init'
|
|
|
|
## EXIT CODES
|
|
|
|
This command will run indefinitely on success and return \>0 if any error occurs.
|
|
|
|
## EXAMPLES
|
|
|
|
These examples assume that you have already initialized your PKI by running
|
|
|
|
'step ca init'. If you have not completed this step please see the 'Getting Started'
|
|
|
|
section of the README.
|
|
|
|
Run the Step CA and prompt for password:
|
|
|
|
'''
|
|
|
|
$ step-ca $STEPPATH/config/ca.json
|
|
|
|
'''
|
|
|
|
Run the Step CA and read the password from a file - this is useful for
|
|
|
|
automating deployment:
|
|
|
|
'''
|
|
|
|
$ step-ca $STEPPATH/config/ca.json --password-file ./password.txt
|
|
|
|
'''`
|
2019-09-12 19:51:07 +00:00
|
|
|
app.Flags = append(app.Flags, commands.AppCommand.Flags...)
|
|
|
|
app.Flags = append(app.Flags, cli.HelpFlag)
|
2020-02-10 17:55:21 +00:00
|
|
|
app.Copyright = "(c) 2018-2020 Smallstep Labs, Inc."
|
2018-11-22 20:59:33 +00:00
|
|
|
|
|
|
|
// All non-successful output should be written to stderr
|
|
|
|
app.Writer = os.Stdout
|
|
|
|
app.ErrWriter = os.Stderr
|
2019-09-12 19:51:07 +00:00
|
|
|
app.Commands = command.Retrieve()
|
2018-10-05 21:48:36 +00:00
|
|
|
|
2018-11-22 20:59:33 +00:00
|
|
|
// Start the golang debug logger if environment variable is set.
|
|
|
|
// See https://golang.org/pkg/net/http/pprof/
|
|
|
|
debugProfAddr := os.Getenv("STEP_PROF_ADDR")
|
|
|
|
if debugProfAddr != "" {
|
|
|
|
go func() {
|
|
|
|
log.Println(http.ListenAndServe(debugProfAddr, nil))
|
|
|
|
}()
|
2018-10-05 21:48:36 +00:00
|
|
|
}
|
|
|
|
|
2019-08-29 22:58:07 +00:00
|
|
|
app.Action = func(_ *cli.Context) error {
|
2019-03-18 19:38:19 +00:00
|
|
|
// Hack to be able to run a the top action as a subcommand
|
|
|
|
set := flag.NewFlagSet(app.Name, flag.ContinueOnError)
|
|
|
|
set.Parse(os.Args)
|
2019-08-29 22:58:07 +00:00
|
|
|
ctx := cli.NewContext(app, set, nil)
|
2019-09-12 19:51:07 +00:00
|
|
|
return commands.AppCommand.Run(ctx)
|
2018-10-05 21:48:36 +00:00
|
|
|
}
|
|
|
|
|
2018-11-22 20:59:33 +00:00
|
|
|
if err := app.Run(os.Args); err != nil {
|
|
|
|
if os.Getenv("STEPDEBUG") == "1" {
|
|
|
|
fmt.Fprintf(os.Stderr, "%+v\n", err)
|
|
|
|
} else {
|
|
|
|
fmt.Fprintln(os.Stderr, err)
|
|
|
|
}
|
2021-10-07 19:43:24 +00:00
|
|
|
exit(1)
|
2018-10-05 21:48:36 +00:00
|
|
|
}
|
2021-10-07 19:43:24 +00:00
|
|
|
|
|
|
|
exit(0)
|
2018-10-05 21:48:36 +00:00
|
|
|
}
|
|
|
|
|
2018-11-22 20:59:33 +00:00
|
|
|
func flagValue(f cli.Flag) reflect.Value {
|
|
|
|
fv := reflect.ValueOf(f)
|
|
|
|
for fv.Kind() == reflect.Ptr {
|
|
|
|
fv = reflect.Indirect(fv)
|
|
|
|
}
|
|
|
|
return fv
|
|
|
|
}
|
|
|
|
|
|
|
|
var placeholderString = regexp.MustCompile(`<.*?>`)
|
|
|
|
|
|
|
|
func stringifyFlag(f cli.Flag) string {
|
|
|
|
fv := flagValue(f)
|
2021-10-08 18:59:57 +00:00
|
|
|
usg := fv.FieldByName("Usage").String()
|
|
|
|
placeholder := placeholderString.FindString(usg)
|
2018-11-22 20:59:33 +00:00
|
|
|
if placeholder == "" {
|
2019-08-01 20:13:50 +00:00
|
|
|
switch f.(type) {
|
|
|
|
case cli.BoolFlag, cli.BoolTFlag:
|
|
|
|
default:
|
|
|
|
placeholder = "<value>"
|
|
|
|
}
|
2018-11-22 20:59:33 +00:00
|
|
|
}
|
2021-10-08 18:59:57 +00:00
|
|
|
return cli.FlagNamePrefixer(fv.FieldByName("Name").String(), placeholder) + "\t" + usg
|
2018-11-22 20:59:33 +00:00
|
|
|
}
|