-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
certs.go
563 lines (485 loc) · 17.6 KB
/
certs.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
// Copyright 2015 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
package security
import (
"context"
"crypto"
"crypto/rand"
"crypto/rsa"
"crypto/tls"
"crypto/x509"
"encoding/pem"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"time"
"github.com/cockroachdb/cockroach/pkg/util/envutil"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/errors"
"github.com/cockroachdb/errors/oserror"
)
const (
keyFileMode = 0600
certFileMode = 0644
)
// loadCACertAndKey loads the certificate and key files,parses them,
// and returns the x509 certificate and private key.
func loadCACertAndKey(sslCA, sslCAKey string) (*x509.Certificate, crypto.PrivateKey, error) {
// LoadX509KeyPair does a bunch of validation, including len(Certificates) != 0.
caCert, err := tls.LoadX509KeyPair(sslCA, sslCAKey)
if err != nil {
return nil, nil, errors.Errorf("error loading CA certificate %s and key %s: %s",
sslCA, sslCAKey, err)
}
// Extract x509 certificate from tls cert.
x509Cert, err := x509.ParseCertificate(caCert.Certificate[0])
if err != nil {
return nil, nil, errors.Errorf("error parsing CA certificate %s: %s", sslCA, err)
}
return x509Cert, caCert.PrivateKey, nil
}
func writeCertificateToFile(certFilePath string, certificate []byte, overwrite bool) error {
certBlock := &pem.Block{Type: "CERTIFICATE", Bytes: certificate}
return WritePEMToFile(certFilePath, certFileMode, overwrite, certBlock)
}
func writeKeyToFile(keyFilePath string, key crypto.PrivateKey, overwrite bool) error {
keyBlock, err := PrivateKeyToPEM(key)
if err != nil {
return err
}
return WritePEMToFile(keyFilePath, keyFileMode, overwrite, keyBlock)
}
func writePKCS8KeyToFile(keyFilePath string, key crypto.PrivateKey, overwrite bool) error {
keyBytes, err := PrivateKeyToPKCS8(key)
if err != nil {
return err
}
return SafeWriteToFile(keyFilePath, keyFileMode, overwrite, keyBytes)
}
// CreateCAPair creates a general CA certificate and associated key.
func CreateCAPair(
certsDir, caKeyPath string,
keySize int,
lifetime time.Duration,
allowKeyReuse bool,
overwrite bool,
) error {
return createCACertAndKey(certsDir, caKeyPath, CAPem, keySize, lifetime, allowKeyReuse, overwrite)
}
// CreateTenantClientCAPair creates a tenant client CA pair. The private key is
// written to caKeyPath and the public key is created in certsDir.
func CreateTenantClientCAPair(
certsDir, caKeyPath string,
keySize int,
lifetime time.Duration,
allowKeyReuse bool,
overwrite bool,
) error {
return createCACertAndKey(certsDir, caKeyPath, TenantClientCAPem, keySize, lifetime, allowKeyReuse, overwrite)
}
// CreateClientCAPair creates a client CA certificate and associated key.
func CreateClientCAPair(
certsDir, caKeyPath string,
keySize int,
lifetime time.Duration,
allowKeyReuse bool,
overwrite bool,
) error {
return createCACertAndKey(certsDir, caKeyPath, ClientCAPem, keySize, lifetime, allowKeyReuse, overwrite)
}
// CreateUICAPair creates a UI CA certificate and associated key.
func CreateUICAPair(
certsDir, caKeyPath string,
keySize int,
lifetime time.Duration,
allowKeyReuse bool,
overwrite bool,
) error {
return createCACertAndKey(certsDir, caKeyPath, UICAPem, keySize, lifetime, allowKeyReuse, overwrite)
}
// createCACertAndKey creates a CA key and a CA certificate.
// If the certs directory does not exist, it is created.
// If the key does not exist, it is created.
// The certificate is written to the certs directory. If the file already exists,
// we append the original certificates to the new certificate.
//
// The filename of the certificate file must be specified.
// It should be one of:
// - ca.crt: the general CA certificate
// - ca-client.crt: the CA certificate to verify client certificates
func createCACertAndKey(
certsDir, caKeyPath string,
caType PemUsage,
keySize int,
lifetime time.Duration,
allowKeyReuse bool,
overwrite bool,
) error {
if len(caKeyPath) == 0 {
return errors.New("the path to the CA key is required")
}
if len(certsDir) == 0 {
return errors.New("the path to the certs directory is required")
}
if caType != CAPem &&
caType != TenantClientCAPem &&
caType != ClientCAPem &&
caType != UICAPem {
return fmt.Errorf("caType argument to createCACertAndKey must be one of CAPem (%d), ClientCAPem (%d), or UICAPem (%d), got: %d",
CAPem, ClientCAPem, UICAPem, caType)
}
// The certificate manager expands the env for the certs directory.
// For consistency, we need to do this for the key as well.
caKeyPath = os.ExpandEnv(caKeyPath)
// Create a certificate manager with "create dir if not exist".
cm, err := NewCertificateManagerFirstRun(certsDir, CommandTLSSettings{})
if err != nil {
return err
}
var key crypto.PrivateKey
if _, err := os.Stat(caKeyPath); err != nil {
if !oserror.IsNotExist(err) {
return errors.Wrapf(err, "could not stat CA key file %s", caKeyPath)
}
// The key does not exist: create it.
key, err = rsa.GenerateKey(rand.Reader, keySize)
if err != nil {
return errors.Wrap(err, "could not generate new CA key")
}
// overwrite is not technically needed here, but use it in case something else created it.
if err := writeKeyToFile(caKeyPath, key, overwrite); err != nil {
return errors.Wrapf(err, "could not write CA key to file %s", caKeyPath)
}
log.Infof(context.Background(), "generated CA key %s", caKeyPath)
} else {
if !allowKeyReuse {
return errors.Errorf("CA key %s exists, but key reuse is disabled", caKeyPath)
}
// The key exists, parse it.
contents, err := ioutil.ReadFile(caKeyPath)
if err != nil {
return errors.Wrapf(err, "could not read CA key file %s", caKeyPath)
}
key, err = PEMToPrivateKey(contents)
if err != nil {
return errors.Wrapf(err, "could not parse CA key file %s", caKeyPath)
}
log.Infof(context.Background(), "using CA key from file %s", caKeyPath)
}
// Generate certificate.
certContents, err := GenerateCA(key.(crypto.Signer), lifetime)
if err != nil {
return errors.Wrap(err, "could not generate CA certificate")
}
var certPath string
// We've already checked the caType value at the beginning of this function.
switch caType {
case CAPem:
certPath = cm.CACertPath()
case TenantClientCAPem:
certPath = cm.TenantClientCACertPath()
case ClientCAPem:
certPath = cm.ClientCACertPath()
case UICAPem:
certPath = cm.UICACertPath()
default:
return errors.Newf("unknown CA type %v", caType)
}
var existingCertificates []*pem.Block
if _, err := os.Stat(certPath); err == nil {
// The cert file already exists, load certificates.
contents, err := ioutil.ReadFile(certPath)
if err != nil {
return errors.Wrapf(err, "could not read existing CA cert file %s", certPath)
}
existingCertificates, err = PEMToCertificates(contents)
if err != nil {
return errors.Wrapf(err, "could not parse existing CA cert file %s", certPath)
}
log.Infof(context.Background(), "found %d certificates in %s",
len(existingCertificates), certPath)
} else if !oserror.IsNotExist(err) {
return errors.Wrapf(err, "could not stat CA cert file %s", certPath)
}
// Always place the new certificate first.
certificates := []*pem.Block{{Type: "CERTIFICATE", Bytes: certContents}}
certificates = append(certificates, existingCertificates...)
if err := WritePEMToFile(certPath, certFileMode, overwrite, certificates...); err != nil {
return errors.Wrapf(err, "could not write CA certificate file %s", certPath)
}
log.Infof(context.Background(), "wrote %d certificates to %s", len(certificates), certPath)
return nil
}
// CreateNodePair creates a node key and certificate.
// The CA cert and key must load properly. If multiple certificates
// exist in the CA cert, the first one is used.
func CreateNodePair(
certsDir, caKeyPath string, keySize int, lifetime time.Duration, overwrite bool, hosts []string,
) error {
if len(caKeyPath) == 0 {
return errors.New("the path to the CA key is required")
}
if len(certsDir) == 0 {
return errors.New("the path to the certs directory is required")
}
// The certificate manager expands the env for the certs directory.
// For consistency, we need to do this for the key as well.
caKeyPath = os.ExpandEnv(caKeyPath)
// Create a certificate manager with "create dir if not exist".
cm, err := NewCertificateManagerFirstRun(certsDir, CommandTLSSettings{})
if err != nil {
return err
}
// Load the CA pair.
caCert, caPrivateKey, err := loadCACertAndKey(cm.CACertPath(), caKeyPath)
if err != nil {
return err
}
// Generate certificates and keys.
nodeKey, err := rsa.GenerateKey(rand.Reader, keySize)
if err != nil {
return errors.Wrap(err, "could not generate new node key")
}
// Allow control of the principal to place in the cert via an env var. This
// is intended for testing purposes only.
nodeUser, _ := MakeSQLUsernameFromUserInput(
envutil.EnvOrDefaultString("COCKROACH_CERT_NODE_USER", NodeUser),
UsernameValidation)
nodeCert, err := GenerateServerCert(caCert, caPrivateKey,
nodeKey.Public(), lifetime, nodeUser, hosts)
if err != nil {
return errors.Errorf("error creating node server certificate and key: %s", err)
}
certPath := cm.NodeCertPath()
if err := writeCertificateToFile(certPath, nodeCert, overwrite); err != nil {
return errors.Wrapf(err, "error writing node server certificate to %s", certPath)
}
log.Infof(context.Background(), "generated node certificate: %s", certPath)
keyPath := cm.NodeKeyPath()
if err := writeKeyToFile(keyPath, nodeKey, overwrite); err != nil {
return errors.Wrapf(err, "error writing node server key to %s", keyPath)
}
log.Infof(context.Background(), "generated node key: %s", keyPath)
return nil
}
// CreateUIPair creates a UI certificate and key using the UI CA.
// The CA cert and key must load properly. If multiple certificates
// exist in the CA cert, the first one is used.
func CreateUIPair(
certsDir, caKeyPath string, keySize int, lifetime time.Duration, overwrite bool, hosts []string,
) error {
if len(caKeyPath) == 0 {
return errors.New("the path to the CA key is required")
}
if len(certsDir) == 0 {
return errors.New("the path to the certs directory is required")
}
// The certificate manager expands the env for the certs directory.
// For consistency, we need to do this for the key as well.
caKeyPath = os.ExpandEnv(caKeyPath)
// Create a certificate manager with "create dir if not exist".
cm, err := NewCertificateManagerFirstRun(certsDir, CommandTLSSettings{})
if err != nil {
return err
}
// Load the CA pair.
caCert, caPrivateKey, err := loadCACertAndKey(cm.UICACertPath(), caKeyPath)
if err != nil {
return err
}
// Generate certificates and keys.
uiKey, err := rsa.GenerateKey(rand.Reader, keySize)
if err != nil {
return errors.Wrap(err, "could not generate new UI key")
}
uiCert, err := GenerateUIServerCert(caCert, caPrivateKey, uiKey.Public(), lifetime, hosts)
if err != nil {
return errors.Errorf("error creating UI server certificate and key: %s", err)
}
certPath := cm.UICertPath()
if err := writeCertificateToFile(certPath, uiCert, overwrite); err != nil {
return errors.Wrapf(err, "error writing UI server certificate to %s", certPath)
}
log.Infof(context.Background(), "generated UI certificate: %s", certPath)
keyPath := cm.UIKeyPath()
if err := writeKeyToFile(keyPath, uiKey, overwrite); err != nil {
return errors.Wrapf(err, "error writing UI server key to %s", keyPath)
}
log.Infof(context.Background(), "generated UI key: %s", keyPath)
return nil
}
// CreateClientPair creates a node key and certificate.
// The CA cert and key must load properly. If multiple certificates
// exist in the CA cert, the first one is used.
// If a client CA exists, this is used instead.
// If wantPKCS8Key is true, the private key in PKCS#8 encoding is written as well.
func CreateClientPair(
certsDir, caKeyPath string,
keySize int,
lifetime time.Duration,
overwrite bool,
user SQLUsername,
wantPKCS8Key bool,
) error {
if len(caKeyPath) == 0 {
return errors.New("the path to the CA key is required")
}
if len(certsDir) == 0 {
return errors.New("the path to the certs directory is required")
}
// The certificate manager expands the env for the certs directory.
// For consistency, we need to do this for the key as well.
caKeyPath = os.ExpandEnv(caKeyPath)
// Create a certificate manager with "create dir if not exist".
cm, err := NewCertificateManagerFirstRun(certsDir, CommandTLSSettings{})
if err != nil {
return err
}
var caCertPath string
// Check to see if we are using a client CA.
// We only check for its presence, not whether it has errors.
if cm.ClientCACert() != nil {
caCertPath = cm.ClientCACertPath()
} else {
caCertPath = cm.CACertPath()
}
// Load the CA pair.
caCert, caPrivateKey, err := loadCACertAndKey(caCertPath, caKeyPath)
if err != nil {
return err
}
// Generate certificates and keys.
clientKey, err := rsa.GenerateKey(rand.Reader, keySize)
if err != nil {
return errors.Wrap(err, "could not generate new client key")
}
clientCert, err := GenerateClientCert(caCert, caPrivateKey, clientKey.Public(), lifetime, user)
if err != nil {
return errors.Errorf("error creating client certificate and key: %s", err)
}
certPath := cm.ClientCertPath(user)
if err := writeCertificateToFile(certPath, clientCert, overwrite); err != nil {
return errors.Wrapf(err, "error writing client certificate to %s", certPath)
}
log.Infof(context.Background(), "generated client certificate: %s", certPath)
keyPath := cm.ClientKeyPath(user)
if err := writeKeyToFile(keyPath, clientKey, overwrite); err != nil {
return errors.Wrapf(err, "error writing client key to %s", keyPath)
}
log.Infof(context.Background(), "generated client key: %s", keyPath)
if wantPKCS8Key {
pkcs8KeyPath := keyPath + ".pk8"
if err := writePKCS8KeyToFile(pkcs8KeyPath, clientKey, overwrite); err != nil {
return errors.Wrapf(err, "error writing client PKCS8 key to %s", pkcs8KeyPath)
}
log.Infof(context.Background(), "generated PKCS8 client key: %s", pkcs8KeyPath)
}
return nil
}
// TenantClientPair are client certs for use with multi-tenancy.
type TenantClientPair struct {
PrivateKey *rsa.PrivateKey
Cert []byte
}
// CreateTenantClientPair creates a key and certificate for use as client certs
// when communicating with the KV layer. The tenant CA cert and key must load
// properly. If multiple certificates exist in the CA cert, the first one is
// used.
//
// To write the returned TenantClientPair to disk, use WriteTenantClientPair.
func CreateTenantClientPair(
certsDir, caKeyPath string,
keySize int,
lifetime time.Duration,
tenantIdentifier uint64,
hosts []string,
) (*TenantClientPair, error) {
if len(caKeyPath) == 0 {
return nil, errors.New("the path to the CA key is required")
}
if len(certsDir) == 0 {
return nil, errors.New("the path to the certs directory is required")
}
// The certificate manager expands the env for the certs directory.
// For consistency, we need to do this for the key as well.
caKeyPath = os.ExpandEnv(caKeyPath)
// Create a certificate manager with "create dir if not exist".
cm, err := NewCertificateManagerFirstRun(certsDir, CommandTLSSettings{})
if err != nil {
return nil, err
}
// Load the tenant client CA cert info. Note that this falls back to the regular client CA which in turn falls
// back to the CA.
clientCA, err := cm.getTenantClientCACertLocked()
if err != nil {
return nil, err
}
// Load the CA pair.
caCert, caPrivateKey, err := loadCACertAndKey(filepath.Join(certsDir, clientCA.Filename), caKeyPath)
if err != nil {
return nil, err
}
// Generate certificates and keys.
clientKey, err := rsa.GenerateKey(rand.Reader, keySize)
if err != nil {
return nil, errors.Wrap(err, "could not generate new tenant key")
}
clientCert, err := GenerateTenantClientCert(
caCert, caPrivateKey, clientKey.Public(), lifetime, tenantIdentifier, hosts,
)
if err != nil {
return nil, errors.Errorf("error creating tenant certificate and key: %s", err)
}
return &TenantClientPair{
PrivateKey: clientKey,
Cert: clientCert,
}, nil
}
// WriteTenantClientPair writes a TenantClientPair into certsDir.
func WriteTenantClientPair(certsDir string, cp *TenantClientPair, overwrite bool) error {
cm, err := NewCertificateManagerFirstRun(certsDir, CommandTLSSettings{})
if err != nil {
return err
}
cert, err := x509.ParseCertificate(cp.Cert)
if err != nil {
return err
}
tenantIdentifier := cert.Subject.CommonName
certPath := cm.TenantClientCertPath(tenantIdentifier)
if err := writeCertificateToFile(certPath, cp.Cert, overwrite); err != nil {
return errors.Wrapf(err, "error writing tenant certificate to %s", certPath)
}
log.Infof(context.Background(), "wrote SQL tenant client certificate: %s", certPath)
keyPath := cm.TenantClientKeyPath(tenantIdentifier)
if err := writeKeyToFile(keyPath, cp.PrivateKey, overwrite); err != nil {
return errors.Wrapf(err, "error writing tenant key to %s", keyPath)
}
log.Infof(context.Background(), "generated tenant key: %s", keyPath)
return nil
}
// PEMContentsToX509 takes raw pem-encoded contents and attempts to parse into
// x509.Certificate objects.
func PEMContentsToX509(contents []byte) ([]*x509.Certificate, error) {
derCerts, err := PEMToCertificates(contents)
if err != nil {
return nil, err
}
certs := make([]*x509.Certificate, len(derCerts))
for i, c := range derCerts {
x509Cert, err := x509.ParseCertificate(c.Bytes)
if err != nil {
return nil, err
}
certs[i] = x509Cert
}
return certs, nil
}