-
Notifications
You must be signed in to change notification settings - Fork 246
/
certificate.go
292 lines (256 loc) · 9.34 KB
/
certificate.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
package ca
import (
"path/filepath"
"strings"
"github.com/pkg/errors"
"github.com/smallstep/cli/flags"
"github.com/smallstep/cli/token"
"github.com/smallstep/cli/utils/cautils"
"github.com/urfave/cli"
"go.step.sm/cli-utils/command"
"go.step.sm/cli-utils/errs"
"go.step.sm/cli-utils/step"
"go.step.sm/cli-utils/ui"
"go.step.sm/crypto/pemutil"
)
func certificateCommand() cli.Command {
return cli.Command{
Name: "certificate",
Action: command.ActionFunc(certificateAction),
Usage: "generate a new private key and certificate signed by the root certificate",
UsageText: `**step ca certificate** <subject> <crt-file> <key-file>
[**--token**=<token>] [**--issuer**=<name>] [**--provisioner-password-file**=<file>]
[**--not-before**=<time|duration>] [**--not-after**=<time|duration>]
[**--san**=<SAN>] [**--set**=<key=value>] [**--set-file**=<file>]
[**--acme**=<file>] [**--standalone**] [**--webroot**=<file>]
[**--contact**=<email>] [**--http-listen**=<address>] [**--bundle**]
[**--kty**=<type>] [**--curve**=<curve>] [**--size**=<size>] [**--console**]
[**--x5c-cert**=<file>] [**--x5c-key**=<file>] [**--k8ssa-token-path**=<file>]
[**--offline**] [**--password-file**] [**--ca-url**=<uri>] [**--root**=<file>]
[**--context**=<name>]`,
Description: `**step ca certificate** command generates a new certificate pair
## POSITIONAL ARGUMENTS
<subject>
: The Common Name, DNS Name, or IP address that will be set as the
Subject Common Name for the certificate. If no Subject Alternative Names (SANs)
are configured (via the --san flag) then the <subject> will be set as the only SAN.
<crt-file>
: File to write the certificate (PEM format)
<key-file>
: File to write the private key (PEM format)
## EXAMPLES
Request a new certificate for a given domain. There are no additional SANs
configured, therefore (by default) the <subject> will be used as the only
SAN extension: DNS Name internal.example.com:
'''
$ TOKEN=$(step ca token internal.example.com)
$ step ca certificate --token $TOKEN internal.example.com internal.crt internal.key
'''
Request a new certificate with multiple Subject Alternative Names. The Subject
Common Name of the certificate will be 'foobar'. However, because additional SANs are
configured using the --san flag and 'foobar' is not one of these, 'foobar' will
not be in the SAN extensions of the certificate. The certificate will have 2
IP Address extensions (1.1.1.1, 10.2.3.4) and 1 DNS Name extension (hello.example.com):
'''
$ step ca certificate --san 1.1.1.1 --san hello.example.com --san 10.2.3.4 foobar internal.crt internal.key
'''
Request a new certificate with a 1h validity:
'''
$ TOKEN=$(step ca token internal.example.com)
$ step ca certificate --token $TOKEN --not-after=1h internal.example.com internal.crt internal.key
'''
Request a new certificate using the offline mode, requires the configuration
files, certificates, and keys created with **step ca init**:
'''
$ step ca certificate --offline internal.example.com internal.crt internal.key
'''
Request a new certificate using the offline mode with additional flags to avoid
console prompts:
'''
$ step ca certificate --offline \
--password-file ./pass.txt \
--provisioner foo \
--provisioner-password-file ./provisioner-pass.txt \
internal.example.com internal.crt internal.key
'''
Request a new certificate using an OIDC provisioner:
'''
$ step ca certificate --token $(step oauth --oidc --bare) joe@example.com joe.crt joe.key
'''
Request a new certificate using an OIDC provisioner while remaining in the console:
'''
$ step ca certificate joe@example.com joe.crt joe.key --issuer Google --console
'''
Request a new certificate with an RSA public key (default is ECDSA256):
'''
$ step ca certificate foo.internal foo.crt foo.key --kty RSA --size 4096
'''
Request a new certificate with an X5C provisioner:
'''
$ step ca certificate foo.internal foo.crt foo.key --x5c-cert x5c.cert --x5c-key x5c.key
'''
**Certificate Templates** - With a provisioner configured with a custom
template we can use the **--set** flag to pass user variables:
'''
$ step ca certificate foo.internal foo.crt foo.key --set emailAddresses=root@internal.com
$ step ca certificate foo.internal foo.crt foo.key --set emailAddresses='["foo@internal.com","root@internal.com"]'
'''
Or you can pass them from a file using **--set-file**:
'''
$ cat path/to/data.json
{
"emailAddresses": ["foo@internal.com","root@internal.com"]
}
$ step ca certificate foo.internal foo.crt foo.key --set-file path/to/data.json
'''
**step CA ACME** - In order to use the step CA ACME protocol you must add a
ACME provisioner to the step CA config. See **step ca provisioner add -h**.
Request a new certificate using the step CA ACME server and a standalone server
to serve the challenges locally (standalone mode is the default):
'''
$ step ca certificate foobar foo.crt foo.key --provisioner my-acme-provisioner --san foo.internal --san bar.internal
'''
Request a new certificate using the step CA ACME server and an existing server
along with webroot mode to serve the challenges locally:
'''
$ step ca certificate foobar foo.crt foo.key --provisioner my-acme-provisioner --webroot "./acme-www" \
--san foo.internal --san bar.internal
'''
Request a new certificate using the ACME protocol not served via the step CA
(e.g. letsencrypt). NOTE: Let's Encrypt requires that the Subject Common Name
of a requested certificate be validated as an Identifier in the ACME order along
with any other SANS. Therefore, the Common Name must be a valid DNS Name. The
step CA does not impose this requirement.
'''
$ step ca certificate foo.internal foo.crt foo.key \
--acme https://acme-staging-v02.api.letsencrypt.org/directory --san bar.internal
'''`,
Flags: []cli.Flag{
cli.StringSliceFlag{
Name: "san",
Usage: `Add <dns|ip|email|uri> Subject Alternative Name(s) (SANs)
that should be authorized. Use the '--san' flag multiple times to configure
multiple SANs. The '--san' flag and the '--token' flag are mutually exclusive.`,
},
cli.StringFlag{
Name: "attestation-ca-url",
Usage: "The base url of the Attestation CA to use",
},
cli.StringFlag{
Name: "attestation-ca-root",
Usage: "The path to the PEM <file> with trusted roots when connecting to the Attestation CA",
},
cli.BoolFlag{
Name: "attestation-ca-insecure",
Usage: "Disables TLS server validation when connecting to the Attestation CA",
Hidden: true,
},
cli.StringFlag{
Name: "tpm-storage-directory",
Usage: "The directory where TPM keys and certificates will be stored",
Value: filepath.Join(step.Path(), "tpm"),
},
flags.TemplateSet,
flags.TemplateSetFile,
flags.CaConfig,
flags.CaURL,
flags.Root,
flags.Token,
flags.Context,
flags.Provisioner,
flags.ProvisionerPasswordFile,
flags.KTY,
flags.Curve,
flags.Size,
flags.NotAfter,
flags.NotBefore,
flags.AttestationURI,
flags.Force,
flags.Offline,
flags.PasswordFile,
consoleFlag,
flags.KMSUri,
flags.X5cCert,
flags.X5cKey,
flags.X5cChain,
flags.NebulaCert,
flags.NebulaKey,
acmeFlag,
acmeStandaloneFlag,
acmeWebrootFlag,
acmeContactFlag,
acmeHTTPListenFlag,
flags.K8sSATokenPathFlag,
},
}
}
func certificateAction(ctx *cli.Context) error {
if err := errs.MinMaxNumberOfArguments(ctx, 2, 3); err != nil {
return err
}
// Allow two arguments with the attestation uri.
if ctx.NArg() == 2 && ctx.String("attestation-uri") == "" {
return errs.TooFewArguments(ctx)
}
args := ctx.Args()
subject := args.Get(0)
crtFile, keyFile := args.Get(1), args.Get(2)
tok := ctx.String("token")
offline := ctx.Bool("offline")
sans := ctx.StringSlice("san")
// offline and token are incompatible because the token is generated before
// the start of the offline CA.
if offline && tok != "" {
return errs.IncompatibleFlagWithFlag(ctx, "offline", "token")
}
// certificate flow unifies online and offline flows on a single api
flow, err := cautils.NewCertificateFlow(ctx)
if err != nil {
return err
}
if tok == "" {
// Use the ACME protocol with a different certificate authority.
if ctx.IsSet("acme") {
return cautils.ACMECreateCertFlow(ctx, "")
}
if tok, err = flow.GenerateToken(ctx, subject, sans); err != nil {
var acmeTokenErr *cautils.ACMETokenError
if errors.As(err, &acmeTokenErr) {
return cautils.ACMECreateCertFlow(ctx, acmeTokenErr.Name)
}
return err
}
}
req, pk, err := flow.CreateSignRequest(ctx, tok, subject, sans)
if err != nil {
return err
}
jwt, err := token.ParseInsecure(tok)
if err != nil {
return err
}
switch jwt.Payload.Type() {
case token.JWK: // Validate that subject matches the CSR common name.
if ctx.String("token") != "" && len(sans) > 0 {
return errs.MutuallyExclusiveFlags(ctx, "token", "san")
}
if !strings.EqualFold(subject, req.CsrPEM.Subject.CommonName) {
return errors.Errorf("token subject '%s' and argument '%s' do not match", req.CsrPEM.Subject.CommonName, subject)
}
case token.OIDC, token.AWS, token.GCP, token.Azure, token.K8sSA:
// Common name will be validated on the server side, it depends on
// server configuration.
default:
return errors.New("token is not supported")
}
if err := flow.Sign(ctx, tok, req.CsrPEM, crtFile); err != nil {
return err
}
_, err = pemutil.Serialize(pk, pemutil.ToFile(keyFile, 0600))
if err != nil {
return err
}
ui.PrintSelected("Certificate", crtFile)
ui.PrintSelected("Private Key", keyFile)
return nil
}