-
Notifications
You must be signed in to change notification settings - Fork 249
/
renew.go
663 lines (589 loc) · 19.7 KB
/
renew.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
package ca
import (
"crypto"
cryptoRand "crypto/rand"
"crypto/tls"
"crypto/x509"
"encoding/base64"
"encoding/pem"
"log"
"math/rand"
"net/http"
"net/url"
"os"
"os/exec"
"os/signal"
"strconv"
"strings"
"syscall"
"time"
"github.com/pkg/errors"
"github.com/smallstep/certificates/api"
"github.com/smallstep/certificates/ca"
"github.com/smallstep/certificates/pki"
"github.com/smallstep/cli/flags"
"github.com/smallstep/cli/token"
"github.com/smallstep/cli/utils"
"github.com/smallstep/cli/utils/cautils"
"github.com/smallstep/cli/utils/sysutils"
"github.com/urfave/cli"
"go.step.sm/cli-utils/command"
"go.step.sm/cli-utils/errs"
"go.step.sm/cli-utils/ui"
"go.step.sm/crypto/jose"
"go.step.sm/crypto/pemutil"
"go.step.sm/crypto/x509util"
)
func renewCertificateCommand() cli.Command {
return cli.Command{
Name: "renew",
Action: command.ActionFunc(renewCertificateAction),
Usage: "renew a certificate",
UsageText: `**step ca renew** <crt-file> <key-file>
[**--mtls**] [**--password-file**=<file>] [**--out**=<file>] [**--expires-in**=<duration>]
[**--force**] [**--pid**=<int>] [**--pid-file**=<file>] [**--signal**=<int>]
[**--exec**=<string>] [**--daemon**] [**--renew-period**=<duration>]
[**--ca-url**=<uri>] [**--root**=<file>] [**--context**=<name>]`,
Description: `
**step ca renew** command renews the given certificate (with a request to the
certificate authority) and writes the new certificate to disk - either overwriting
<crt-file> or using a new file when the **--out**=<file> flag is used.
With the **--daemon** flag the command will periodically update the given
certificate. By default, it will renew the certificate before 2/3 of the validity
period of the certificate has elapsed. A random jitter is used to avoid multiple
instances running at the same time. The amount of time between renewal and
certificate expiration can be configured using the **--expires-in** flag, or a
fixed period can be set with the **--renew-period** flag.
The **--daemon** flag can be combined with **--pid**, **--signal**, or **--exec**
to provide certificate reloads on your services.
By default, the renew command authenticates to step-ca using mTLS, except when
the certificate is expired and renewal after expiry is allowed by the CA.
There are scenarios where mTLS is not possible: When step-ca is behind a layer 7 proxy,
when the server's leaf certificate EKU is not configured for client authentication,
or when the server is a StepCAS RA for an upstream step-ca server.
For these scenarios, use **--mtls=false** to force a flow that uses X5C
token-based authentication.
## POSITIONAL ARGUMENTS
<crt-file>
: The certificate in PEM format that we want to renew.
<key-file>
: They key file of the certificate.
## EXAMPLES
Renew a certificate with the configured CA:
'''
$ step ca renew internal.crt internal.key
Would you like to overwrite internal.crt [Y/n]: y
'''
Renew a certificate without overwriting the previous certificate:
'''
$ step ca renew --out renewed.crt internal.crt internal.key
'''
Renew a certificate forcing the overwrite of the previous certificate:
'''
$ step ca renew --force internal.crt internal.key
'''
Renew a certificate using the token flow instead of mTLS:
'''
$ step ca renew --mtls=false --force internal.crt internal.key
'''
Renew a certificate providing the <--ca-url> and <--root> flags:
'''
$ step ca renew --ca-url https://ca.smallstep.com:9000 \
--root /path/to/root_ca.crt internal.crt internal.key
Would you like to overwrite internal.crt [Y/n]: y
'''
Renew skipped because it was too early:
'''
$ step ca renew --expires-in 8h internal.crt internal.key
certificate not renewed: expires in 10h52m5s
'''
Renew the certificate before 2/3 of the validity has passed:
'''
$ step ca renew --daemon internal.crt internal.key
'''
Renew the certificate before 8 hours and 30m of the expiration time:
'''
$ step ca renew --daemon --expires-in 8h30m internal.crt internal.key
'''
Renew the certificate every 16h:
'''
$ step ca renew --daemon --renew-period 16h internal.crt internal.key
'''
Renew the certificate and reload nginx:
'''
$ step ca renew --daemon --exec "nginx -s reload" internal.crt internal.key
'''
Renew the certificate and convert it to DER:
'''
$ step ca renew --daemon --renew-period 16h \
--exec "step certificate format --force --out internal.der internal.crt" \
internal.crt internal.key
'''
Renew a certificate using the offline mode, requires the configuration
files, certificates, and keys created with **step ca init**:
'''
$ step ca renew --offline internal.crt internal.key
'''`,
Flags: []cli.Flag{
cli.BoolTFlag{
Name: "mtls",
Usage: `Use mTLS to renew a certificate. Use --mtls=false to force the token
authorization flow instead.`,
},
flags.CaConfig,
flags.Force,
flags.Offline,
flags.PasswordFile,
cli.StringFlag{
Name: "out,output-file",
Usage: "The new certificate <file> path. Defaults to overwriting the <crt-file> positional argument",
},
cli.StringFlag{
Name: "expires-in",
Usage: `The amount of time remaining before certificate expiration,
at which point a renewal should be attempted. The certificate renewal will not
be performed if the time to expiration is greater than the **--expires-in** value.
A random jitter (duration/20) will be added to avoid multiple services hitting the
renew endpoint at the same time. The <duration> is a sequence of decimal numbers,
each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m".
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".`,
},
cli.IntFlag{
Name: "pid",
Usage: `The process id to signal after the certificate has been renewed. By default the
the SIGHUP (1) signal will be used, but this can be configured with the **--signal**
flag.`,
},
cli.StringFlag{
Name: "pid-file",
Usage: `The <file> from which to read the process id that will be signaled after the certificate
has been renewed. By default the SIGHUP (1) signal will be used, but this can be configured with the **--signal**
flag.`,
},
cli.IntFlag{
Name: "signal",
Usage: `The signal <number> to send to the selected PID, so it can reload the
configuration and load the new certificate. Default value is SIGHUP (1)`,
Value: int(syscall.SIGHUP),
},
cli.StringFlag{
Name: "exec",
Usage: "The <command> to run after the certificate has been renewed.",
},
cli.BoolFlag{
Name: "daemon",
Usage: `Run the renew command as a daemon, renewing and overwriting the certificate
periodically. By default the daemon will renew a certificate before 2/3 of the
time to expiration has elapsed. The period can be configured using the
**--renew-period** or **--expires-in** flags.`,
},
cli.StringFlag{
Name: "renew-period",
Usage: `The period with which to schedule renewals of the certificate in daemon mode.
Requires the **--daemon** flag. The <duration> is a sequence of decimal numbers,
each with optional fraction and a unit suffix, such as "300ms", "1.5h", or "2h45m".
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".`,
},
flags.CaURL,
flags.Root,
flags.Context,
},
}
}
func renewCertificateAction(ctx *cli.Context) error {
err := errs.NumberOfArguments(ctx, 2)
if err != nil {
return err
}
args := ctx.Args()
certFile := args.Get(0)
keyFile := args.Get(1)
passFile := ctx.String("password-file")
isDaemon := ctx.Bool("daemon")
execCmd := ctx.String("exec")
outFile := ctx.String("out")
if outFile == "" {
outFile = certFile
}
rootFile := ctx.String("root")
if rootFile == "" {
rootFile = pki.GetRootCAPath()
}
caURL, err := flags.ParseCaURL(ctx)
if err != nil {
return err
}
var expiresIn, renewPeriod time.Duration
if s := ctx.String("expires-in"); len(s) > 0 {
if expiresIn, err = time.ParseDuration(s); err != nil {
return errs.InvalidFlagValue(ctx, "expires-in", s, "")
}
}
if s := ctx.String("renew-period"); len(s) > 0 {
if renewPeriod, err = time.ParseDuration(s); err != nil {
return errs.InvalidFlagValue(ctx, "renew-period", s, "")
}
}
if expiresIn > 0 && renewPeriod > 0 {
return errs.IncompatibleFlagWithFlag(ctx, "expires-in", "renew-period")
}
if renewPeriod > 0 && !isDaemon {
return errs.RequiredWithFlag(ctx, "renew-period", "daemon")
}
if ctx.IsSet("pid") && ctx.IsSet("pid-file") {
return errs.MutuallyExclusiveFlags(ctx, "pid", "pid-file")
}
pid := ctx.Int("pid")
if ctx.IsSet("pid") && pid <= 0 {
return errs.InvalidFlagValue(ctx, "pid", strconv.Itoa(pid), "")
}
pidFile := ctx.String("pid-file")
if len(pidFile) > 0 {
pidB, err := os.ReadFile(pidFile)
if err != nil {
return errs.FileError(err, pidFile)
}
pid, err = strconv.Atoi(strings.TrimSpace(string(pidB)))
if err != nil {
return errs.Wrap(err, "error converting %s to integer process id", pidB)
}
if pid <= 0 {
return errs.InvalidFlagValue(ctx, "pid-file", strconv.Itoa(pid), "")
}
}
signum := ctx.Int("signal")
if ctx.IsSet("signal") && signum <= 0 {
return errs.InvalidFlagValue(ctx, "signal", strconv.Itoa(signum), "")
}
cert, err := tlsLoadX509KeyPair(certFile, keyFile, passFile)
if err != nil {
return err
}
cvp := cert.Leaf.NotAfter.Sub(cert.Leaf.NotBefore)
if renewPeriod > 0 && renewPeriod >= cvp {
return errors.Errorf("flag '--renew-period' must be within (lower than) the certificate "+
"validity period; renew-period=%v, cert-validity-period=%v", renewPeriod, cvp)
}
if expiresIn > cvp {
return errors.Errorf("flag '--expires-in' must be within (lower than) the certificate "+
"validity period; expires-in=%v, cert-validity-period=%v", expiresIn, cvp)
}
renewer, err := newRenewer(ctx, caURL, cert, rootFile)
if err != nil {
return err
}
afterRenew := getAfterRenewFunc(pid, signum, execCmd)
if isDaemon {
// Force is always enabled when daemon mode is used
ctx.Set("force", "true")
next := nextRenewDuration(cert.Leaf, expiresIn, renewPeriod)
return renewer.Daemon(outFile, next, expiresIn, renewPeriod, afterRenew)
}
// Do not renew if (cert.notAfter - now) > (expiresIn + jitter)
if expiresIn > 0 {
//nolint:gosec // The random number below is not being used for crypto.
jitter := rand.Int63n(int64(expiresIn / 20))
if d := time.Until(cert.Leaf.NotAfter); d > expiresIn+time.Duration(jitter) {
ui.Printf("certificate not renewed: expires in %s\n", d.Round(time.Second))
return nil
}
}
if _, err := renewer.Renew(outFile); err != nil {
return err
}
ui.Printf("Your certificate has been saved in %s.\n", outFile)
return afterRenew()
}
func nextRenewDuration(leaf *x509.Certificate, expiresIn, renewPeriod time.Duration) time.Duration {
if renewPeriod > 0 {
// Renew now if it will be expired in renewPeriod
if (time.Until(leaf.NotAfter) - renewPeriod) <= 0 {
return 0
}
return renewPeriod
}
period := leaf.NotAfter.Sub(leaf.NotBefore)
if expiresIn == 0 {
expiresIn = period / 3
}
switch d := time.Until(leaf.NotAfter) - expiresIn; {
case d <= 0:
return 0
case d < period/20:
//nolint:gosec // The random number below is not being used for crypto.
return time.Duration(rand.Int63n(int64(d)))
default:
//nolint:gosec // The random number below is not being used for crypto.
n := rand.Int63n(int64(period / 20))
d -= time.Duration(n)
return d
}
}
func getAfterRenewFunc(pid, signum int, execCmd string) func() error {
return func() error {
if err := runKillPid(pid, signum); err != nil {
return err
}
return runExecCmd(execCmd)
}
}
func runKillPid(pid, signum int) error {
if pid == 0 {
return nil
}
if err := sysutils.Kill(pid, syscall.Signal(signum)); err != nil {
return errors.Wrapf(err, "kill %d with signal %d failed", pid, signum)
}
return nil
}
func runExecCmd(execCmd string) error {
execCmd = strings.TrimSpace(execCmd)
if execCmd == "" {
return nil
}
parts := strings.Split(execCmd, " ")
//nolint:gosec // arguments controlled by step.
cmd := exec.Command(parts[0], parts[1:]...)
cmd.Stdin = os.Stdin
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
return cmd.Run()
}
type renewer struct {
client cautils.CaClient
transport *http.Transport
key crypto.PrivateKey
offline bool
cert tls.Certificate
caURL *url.URL
mtls bool
}
func newRenewer(ctx *cli.Context, caURL string, cert tls.Certificate, rootFile string) (*renewer, error) {
if len(cert.Certificate) == 0 {
return nil, errors.New("error loading certificate: certificate chain is empty")
}
rootCAs, err := x509util.ReadCertPool(rootFile)
if err != nil {
return nil, err
}
tr := &http.Transport{
Proxy: http.ProxyFromEnvironment,
TLSClientConfig: &tls.Config{
RootCAs: rootCAs,
PreferServerCipherSuites: true,
MinVersion: tls.VersionTLS12,
},
}
if time.Now().Before(cert.Leaf.NotAfter) {
tr.TLSClientConfig.Certificates = []tls.Certificate{cert}
}
var client cautils.CaClient
offline := ctx.Bool("offline")
if offline {
caConfig := ctx.String("ca-config")
if caConfig == "" {
return nil, errs.InvalidFlagValue(ctx, "ca-config", "", "")
}
client, err = cautils.NewOfflineCA(ctx, caConfig)
if err != nil {
return nil, err
}
} else {
client, err = ca.NewClient(caURL, ca.WithTransport(tr))
if err != nil {
return nil, err
}
}
u, err := url.Parse(client.GetCaURL())
if err != nil {
return nil, errors.Errorf("error parsing CA URL: %s", client.GetCaURL())
}
return &renewer{
client: client,
transport: tr,
key: cert.PrivateKey,
offline: offline,
cert: cert,
caURL: u,
mtls: ctx.Bool("mtls"),
}, nil
}
func (r *renewer) Renew(outFile string) (resp *api.SignResponse, err error) {
if !r.mtls || time.Now().After(r.cert.Leaf.NotAfter) {
resp, err = r.RenewWithToken(r.cert)
} else {
resp, err = r.client.Renew(r.transport)
}
if err != nil {
return nil, errors.Wrap(err, "error renewing certificate")
}
if resp.CertChainPEM == nil || len(resp.CertChainPEM) == 0 {
resp.CertChainPEM = []api.Certificate{resp.ServerPEM, resp.CaPEM}
}
var data []byte
for _, certPEM := range resp.CertChainPEM {
pemblk, err := pemutil.Serialize(certPEM.Certificate)
if err != nil {
return nil, errors.Wrap(err, "error serializing certificate PEM")
}
data = append(data, pem.EncodeToMemory(pemblk)...)
}
if err := utils.WriteFile(outFile, data, 0600); err != nil {
return nil, errs.FileError(err, outFile)
}
return resp, nil
}
func (r *renewer) Rekey(priv interface{}, outCert, outKey string, writePrivateKey bool) (*api.SignResponse, error) {
csrBytes, err := x509.CreateCertificateRequest(cryptoRand.Reader, &x509.CertificateRequest{}, priv)
if err != nil {
return nil, err
}
csr, err := x509.ParseCertificateRequest(csrBytes)
if err != nil {
return nil, err
}
resp, err := r.client.Rekey(&api.RekeyRequest{CsrPEM: api.NewCertificateRequest(csr)}, r.transport)
if err != nil {
return nil, errors.Wrap(err, "error rekeying certificate")
}
if resp.CertChainPEM == nil || len(resp.CertChainPEM) == 0 {
resp.CertChainPEM = []api.Certificate{resp.ServerPEM, resp.CaPEM}
}
var data []byte
for _, certPEM := range resp.CertChainPEM {
pemblk, err := pemutil.Serialize(certPEM.Certificate)
if err != nil {
return nil, errors.Wrap(err, "error serializing certificate PEM")
}
data = append(data, pem.EncodeToMemory(pemblk)...)
}
if err := utils.WriteFile(outCert, data, 0600); err != nil {
return nil, errs.FileError(err, outCert)
}
if writePrivateKey {
_, err = pemutil.Serialize(priv, pemutil.ToFile(outKey, 0600))
if err != nil {
return nil, err
}
}
return resp, nil
}
// RenewAndPrepareNext renews the cert and prepares the cert for it's next renewal.
// NOTE: this function logs each time the certificate is successfully renewed.
func (r *renewer) RenewAndPrepareNext(outFile string, expiresIn, renewPeriod time.Duration) (time.Duration, error) {
const durationOnErrors = 1 * time.Minute
infoLog := log.New(os.Stdout, "INFO: ", log.LstdFlags)
resp, err := r.Renew(outFile)
if err != nil {
return durationOnErrors, err
}
x509Chain, err := pemutil.ReadCertificateBundle(outFile)
if err != nil {
return durationOnErrors, errs.Wrap(err, "error reading certificate chain")
}
x509ChainBytes := make([][]byte, len(x509Chain))
for i, c := range x509Chain {
x509ChainBytes[i] = c.Raw
}
cert := tls.Certificate{
Certificate: x509ChainBytes,
PrivateKey: r.key,
Leaf: x509Chain[0],
}
if len(cert.Certificate) == 0 {
return durationOnErrors, errors.New("error loading certificate: certificate chain is empty")
}
// Prepare next transport
r.cert = cert
r.transport.TLSClientConfig.Certificates = []tls.Certificate{cert}
// Get next renew duration
next := nextRenewDuration(resp.ServerPEM.Certificate, expiresIn, renewPeriod)
infoLog.Printf("%s certificate renewed, next in %s", resp.ServerPEM.Certificate.Subject.CommonName, next.Round(time.Second))
return next, nil
}
func (r *renewer) Daemon(outFile string, next, expiresIn, renewPeriod time.Duration, afterRenew func() error) error {
// Loggers
infoLog := log.New(os.Stdout, "INFO: ", log.LstdFlags)
errLog := log.New(os.Stderr, "ERROR: ", log.LstdFlags)
// Daemon loop
signals := make(chan os.Signal, 1)
signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP)
defer signal.Stop(signals)
infoLog.Printf("first renewal in %s", next.Round(time.Second))
var err error
for {
select {
case sig := <-signals:
switch sig {
case syscall.SIGHUP:
if next, err = r.RenewAndPrepareNext(outFile, expiresIn, renewPeriod); err != nil {
errLog.Println(err)
} else if err := afterRenew(); err != nil {
errLog.Println(err)
}
case syscall.SIGINT, syscall.SIGTERM:
return nil
}
case <-time.After(next):
if next, err = r.RenewAndPrepareNext(outFile, expiresIn, renewPeriod); err != nil {
errLog.Println(err)
} else if err := afterRenew(); err != nil {
errLog.Println(err)
}
}
}
}
// RenewWithToken creates an authorization token with the given certificate and
// attempts to renew the given certificate. It can be used to renew expired
// certificates.
func (r *renewer) RenewWithToken(cert tls.Certificate) (*api.SignResponse, error) {
claims, err := token.NewClaims(
token.WithAudience(r.caURL.ResolveReference(&url.URL{Path: "/renew"}).String()),
token.WithIssuer("step-ca-client/1.0"),
token.WithSubject(cert.Leaf.Subject.CommonName),
)
if err != nil {
return nil, errors.Wrap(err, "error creating authorization token")
}
var x5c []string
for _, b := range cert.Certificate {
x5c = append(x5c, base64.StdEncoding.EncodeToString(b))
}
if claims.ExtraHeaders == nil {
claims.ExtraHeaders = make(map[string]interface{})
}
claims.ExtraHeaders[jose.X5cInsecureKey] = x5c
tok, err := claims.Sign("", cert.PrivateKey)
if err != nil {
return nil, errors.Wrap(err, "error signing authorization token")
}
// Remove existing certificate from the transport. And close keep-alive
// connections. When daemon is used we don't want to re-use the connection
// that did not include a certificate.
r.transport.TLSClientConfig.Certificates = nil
defer r.transport.CloseIdleConnections()
return r.client.RenewWithToken(tok)
}
func tlsLoadX509KeyPair(certFile, keyFile, passFile string) (tls.Certificate, error) {
x509Chain, err := pemutil.ReadCertificateBundle(certFile)
if err != nil {
return tls.Certificate{}, errs.Wrap(err, "error reading certificate chain")
}
x509ChainBytes := make([][]byte, len(x509Chain))
for i, c := range x509Chain {
x509ChainBytes[i] = c.Raw
}
opts := []pemutil.Options{pemutil.WithFilename(keyFile)}
if passFile != "" {
opts = append(opts, pemutil.WithPasswordFile(passFile))
}
pk, err := pemutil.Read(keyFile, opts...)
if err != nil {
return tls.Certificate{}, errs.Wrap(err, "error parsing private key")
}
return tls.Certificate{
Certificate: x509ChainBytes,
PrivateKey: pk,
Leaf: x509Chain[0],
}, nil
}