-
Notifications
You must be signed in to change notification settings - Fork 0
/
ca.go
1307 lines (1176 loc) · 36.8 KB
/
ca.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
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright IBM Corp. 2017 All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package lib
import (
"bytes"
"crypto/dsa"
"crypto/ecdsa"
"crypto/rsa"
"crypto/x509"
"encoding/pem"
"fmt"
"io/ioutil"
"os"
"path"
"path/filepath"
"strconv"
"sync"
"time"
"github.com/pkg/errors"
"github.com/cloudflare/cfssl/config"
cfcsr "github.com/cloudflare/cfssl/csr"
"github.com/cloudflare/cfssl/initca"
"github.com/cloudflare/cfssl/log"
"github.com/cloudflare/cfssl/signer"
cflocalsigner "github.com/cloudflare/cfssl/signer/local"
"github.com/hyperledger/fabric-ca/api"
"github.com/hyperledger/fabric-ca/lib/dbutil"
"github.com/hyperledger/fabric-ca/lib/ldap"
"github.com/hyperledger/fabric-ca/lib/metadata"
"github.com/hyperledger/fabric-ca/lib/spi"
"github.com/hyperledger/fabric-ca/lib/tcert"
"github.com/hyperledger/fabric-ca/lib/tls"
"github.com/hyperledger/fabric-ca/util"
"github.com/hyperledger/fabric/bccsp"
"github.com/hyperledger/fabric/common/attrmgr"
"github.com/jmoiron/sqlx"
)
const (
defaultDatabaseType = "sqlite3"
// CAChainParentFirstEnvVar is the name of the environment variable that needs to be set
// for server to return CA chain in parent-first order
CAChainParentFirstEnvVar = "CA_CHAIN_PARENT_FIRST"
)
var (
// Default root CA certificate expiration is 15 years (in hours).
defaultRootCACertificateExpiration = "131400h"
// Default intermediate CA certificate expiration is 5 years (in hours).
defaultIntermediateCACertificateExpiration = parseDuration("43800h")
// Default issued certificate expiration is 1 year (in hours).
defaultIssuedCertificateExpiration = parseDuration("8760h")
)
// CA represents a certificate authority which signs, issues and revokes certificates
type CA struct {
// The home directory for the CA
HomeDir string
// The CA's configuration
Config *CAConfig
// The file path of the config file
ConfigFilePath string
// The database handle used to store certificates and optionally
// the user registry information, unless LDAP it enabled for the
// user registry function.
db *sqlx.DB
// The crypto service provider (BCCSP)
csp bccsp.BCCSP
// The certificate DB accessor
certDBAccessor *CertDBAccessor
// The user registry
registry spi.UserRegistry
// The signer used for enrollment
enrollSigner signer.Signer
// The options to use in verifying a signature in token-based authentication
verifyOptions *x509.VerifyOptions
// The attribute manager
attrMgr *attrmgr.Mgr
// The tcert manager for this CA
tcertMgr *tcert.Mgr
// The key tree
keyTree *tcert.KeyTree
// The server hosting this CA
server *Server
// Indicates if database was successfully initialized
dbInitialized bool
// DB levels
levels *dbutil.Levels
// CA mutex
mutex sync.Mutex
}
const (
certificateError = "Invalid certificate in file"
)
// newCA creates a new CA with the specified
// home directory, parent server URL, and config
func newCA(caFile string, config *CAConfig, server *Server, renew bool) (*CA, error) {
ca := new(CA)
ca.ConfigFilePath = caFile
err := initCA(ca, filepath.Dir(caFile), config, server, renew)
if err != nil {
err2 := ca.closeDB()
if err2 != nil {
log.Errorf("Close DB failed: %s", err2)
}
return nil, err
}
return ca, nil
}
// initCA will initialize the passed in pointer to a CA struct
func initCA(ca *CA, homeDir string, config *CAConfig, server *Server, renew bool) error {
ca.HomeDir = homeDir
ca.Config = config
ca.server = server
err := ca.init(renew)
if err != nil {
return err
}
return nil
}
// Init initializes an instance of a CA
func (ca *CA) init(renew bool) (err error) {
log.Debugf("Init CA with home %s and config %+v", ca.HomeDir, *ca.Config)
// Initialize the config, setting defaults, etc
ca.dbInitialized = false
err = ca.initConfig()
if err != nil {
return err
}
// Initialize the crypto layer (BCCSP) for this CA
ca.csp, err = util.InitBCCSP(&ca.Config.CSP, "", ca.HomeDir)
if err != nil {
return err
}
// Initialize key materials
err = ca.initKeyMaterial(renew)
if err != nil {
return err
}
// Initialize the database
err = ca.initDB()
if err != nil {
log.Error("Error occurred initializing database: ", err)
// Return if a server configuration error encountered (e.g. Invalid max enrollment for a bootstrap user)
if isFatalError(err) {
return err
}
}
// Initialize the enrollment signer
err = ca.initEnrollmentSigner()
if err != nil {
return err
}
// Create the attribute manager
ca.attrMgr = attrmgr.New()
// Initialize TCert handling
keyfile := ca.Config.CA.Keyfile
certfile := ca.Config.CA.Certfile
ca.tcertMgr, err = tcert.LoadMgr(keyfile, certfile, ca.csp)
if err != nil {
return err
}
// FIXME: The root prekey must be stored persistently in DB and retrieved here if not found
rootKey, err := genRootKey(ca.csp)
if err != nil {
return err
}
ca.keyTree = tcert.NewKeyTree(ca.csp, rootKey)
log.Debug("CA initialization successful")
// Successful initialization
return nil
}
// Initialize the CA's key material
func (ca *CA) initKeyMaterial(renew bool) error {
log.Debug("Initialize key material")
// Make the path names absolute in the config
err := ca.makeFileNamesAbsolute()
if err != nil {
return err
}
keyFile := ca.Config.CA.Keyfile
certFile := ca.Config.CA.Certfile
// If we aren't renewing and the key and cert files exist, do nothing
if !renew {
// If they both exist, the CA was already initialized
keyFileExists := util.FileExists(keyFile)
certFileExists := util.FileExists(certFile)
if keyFileExists && certFileExists {
log.Info("The CA key and certificate files already exist")
log.Infof("Key file location: %s", keyFile)
log.Infof("Certificate file location: %s", certFile)
err = ca.validateCertAndKey(certFile, keyFile)
if err != nil {
return errors.WithMessage(err, "Validation of certificate and key failed")
}
// Load CN from existing enrollment information and set CSR accordingly
// CN needs to be set, having a multi CA setup requires a unique CN and can't
// be left blank
ca.Config.CSR.CN, err = ca.loadCNFromEnrollmentInfo(certFile)
if err != nil {
return err
}
return nil
}
// If key file does not exist but certFile does, key file is probably
// stored by BCCSP, so check for that now.
if certFileExists {
_, _, _, err = util.GetSignerFromCertFile(certFile, ca.csp)
if err != nil {
return errors.WithMessage(err, fmt.Sprintf("Failed to find private key for certificate in '%s'", certFile))
}
// Yes, it is stored by BCCSP
log.Info("The CA key and certificate already exist")
log.Infof("The key is stored by BCCSP provider '%s'", ca.Config.CSP.ProviderName)
log.Infof("The certificate is at: %s", certFile)
// Load CN from existing enrollment information and set CSR accordingly
// CN needs to be set, having a multi CA setup requires a unique CN and can't
// be left blank
ca.Config.CSR.CN, err = ca.loadCNFromEnrollmentInfo(certFile)
if err != nil {
return errors.WithMessage(err, fmt.Sprintf("Failed to get CN for certificate in '%s'", certFile))
}
return nil
}
}
// Get the CA cert
cert, err := ca.getCACert()
if err != nil {
return err
}
// Store the certificate to file
err = writeFile(certFile, cert, 0644)
if err != nil {
return errors.Wrap(err, "Failed to store certificate")
}
log.Infof("The CA key and certificate were generated for CA %s", ca.Config.CA.Name)
log.Infof("The key was stored by BCCSP provider '%s'", ca.Config.CSP.ProviderName)
log.Infof("The certificate is at: %s", certFile)
return nil
}
// Get the CA certificate for this CA
func (ca *CA) getCACert() (cert []byte, err error) {
if ca.Config.Intermediate.ParentServer.URL != "" {
// This is an intermediate CA, so call the parent fabric-ca-server
// to get the cert
log.Debugf("Getting CA cert; parent server URL is %s", util.GetMaskedURL(ca.Config.Intermediate.ParentServer.URL))
clientCfg := ca.Config.Client
if clientCfg == nil {
clientCfg = &ClientConfig{}
}
// Copy over the intermediate configuration into client configuration
clientCfg.TLS = ca.Config.Intermediate.TLS
clientCfg.Enrollment = ca.Config.Intermediate.Enrollment
clientCfg.CAName = ca.Config.Intermediate.ParentServer.CAName
clientCfg.CSP = ca.Config.CSP
clientCfg.CSR = ca.Config.CSR
clientCfg.CSP = ca.Config.CSP
if ca.Config.CSR.CN != "" {
return nil, errors.Errorf("CN '%s' cannot be specified for an intermediate CA. Remove CN from CSR section for enrollment of intermediate CA to be successful", ca.Config.CSR.CN)
}
if clientCfg.Enrollment.Profile == "" {
clientCfg.Enrollment.Profile = "ca"
}
if clientCfg.Enrollment.CSR == nil {
clientCfg.Enrollment.CSR = &api.CSRInfo{}
}
if clientCfg.Enrollment.CSR.CA == nil {
clientCfg.Enrollment.CSR.CA = &cfcsr.CAConfig{PathLength: 0, PathLenZero: true}
}
log.Debugf("Intermediate enrollment request: %+v, CSR: %+v, CA: %+v",
clientCfg.Enrollment, clientCfg.Enrollment.CSR, clientCfg.Enrollment.CSR.CA)
var resp *EnrollmentResponse
resp, err = clientCfg.Enroll(ca.Config.Intermediate.ParentServer.URL, ca.HomeDir)
if err != nil {
return nil, err
}
// Set the CN for an intermediate server to be the ID used to enroll with root CA
ca.Config.CSR.CN = resp.Identity.GetName()
ecert := resp.Identity.GetECert()
if ecert == nil {
return nil, errors.New("No enrollment certificate returned by parent server")
}
cert = ecert.Cert()
// Store the chain file as the concatenation of the parent's chain plus the cert.
chainPath := ca.Config.CA.Chainfile
chain, err := ca.concatChain(resp.ServerInfo.CAChain, cert)
if err != nil {
return nil, err
}
err = os.MkdirAll(path.Dir(chainPath), 0755)
if err != nil {
return nil, errors.Wrap(err, "Failed to create intermediate chain file directory")
}
err = util.WriteFile(chainPath, chain, 0644)
if err != nil {
return nil, errors.WithMessage(err, "Failed to create intermediate chain file")
}
log.Debugf("Stored intermediate certificate chain at %s", chainPath)
} else {
// This is a root CA, so create a CSR (Certificate Signing Request)
if ca.Config.CSR.CN == "" {
ca.Config.CSR.CN = "fabric-ca-server"
}
csr := &ca.Config.CSR
if csr.CA == nil {
csr.CA = &cfcsr.CAConfig{}
}
if csr.CA.Expiry == "" {
csr.CA.Expiry = defaultRootCACertificateExpiration
}
if csr.KeyRequest == nil {
csr.KeyRequest = GetKeyRequest(ca.Config)
}
req := cfcsr.CertificateRequest{
CN: csr.CN,
Names: csr.Names,
Hosts: csr.Hosts,
KeyRequest: &cfcsr.BasicKeyRequest{A: csr.KeyRequest.Algo, S: csr.KeyRequest.Size},
CA: csr.CA,
SerialNumber: csr.SerialNumber,
}
log.Debugf("Root CA certificate request: %+v", req)
// Generate the key/signer
_, cspSigner, err := util.BCCSPKeyRequestGenerate(&req, ca.csp)
if err != nil {
return nil, err
}
// Call CFSSL to initialize the CA
cert, _, err = initca.NewFromSigner(&req, cspSigner)
if err != nil {
return nil, errors.WithMessage(err, "Failed to create new CA certificate")
}
}
return cert, nil
}
// Return a certificate chain which is the concatenation of chain and cert
func (ca *CA) concatChain(chain []byte, cert []byte) ([]byte, error) {
result := make([]byte, len(chain)+len(cert))
parentFirst, ok := os.LookupEnv(CAChainParentFirstEnvVar)
parentFirstBool := false
// If CA_CHAIN_PARENT_FIRST env variable is set then get the boolean
// value
if ok {
var err error
parentFirstBool, err = strconv.ParseBool(parentFirst)
if err != nil {
return nil, errors.Wrapf(err, "failed to parse the environment variable '%s'", CAChainParentFirstEnvVar)
}
}
if parentFirstBool {
copy(result[:len(chain)], chain)
copy(result[len(chain):], cert)
} else {
copy(result[:len(cert)], cert)
copy(result[len(cert):], chain)
}
return result, nil
}
// Get the certificate chain for the CA
func (ca *CA) getCAChain() (chain []byte, err error) {
if ca.Config == nil {
return nil, errors.New("The server has no configuration")
}
certAuth := &ca.Config.CA
// If the chain file exists, we always return the chain from here
if util.FileExists(certAuth.Chainfile) {
return util.ReadFile(certAuth.Chainfile)
}
// Otherwise, if this is a root CA, we always return the contents of the CACertfile
if ca.Config.Intermediate.ParentServer.URL == "" {
return util.ReadFile(certAuth.Certfile)
}
// If this is an intermediate CA but the ca.Chainfile doesn't exist,
// it is an error. It should have been created during intermediate CA enrollment.
return nil, errors.Errorf("Chain file does not exist at %s", certAuth.Chainfile)
}
// Initialize the configuration for the CA setting any defaults and making filenames absolute
func (ca *CA) initConfig() (err error) {
// Init home directory if not set
if ca.HomeDir == "" {
ca.HomeDir, err = os.Getwd()
if err != nil {
return errors.Wrap(err, "Failed to initialize CA's home directory")
}
}
log.Debugf("CA Home Directory: %s", ca.HomeDir)
// Init config if not set
if ca.Config == nil {
ca.Config = new(CAConfig)
ca.Config.Registry.MaxEnrollments = -1
}
// Set config defaults
cfg := ca.Config
if cfg.Version == "" {
cfg.Version = "0"
}
if cfg.CA.Certfile == "" {
cfg.CA.Certfile = "ca-cert.pem"
}
if cfg.CA.Keyfile == "" {
cfg.CA.Keyfile = "ca-key.pem"
}
if cfg.CA.Chainfile == "" {
cfg.CA.Chainfile = "ca-chain.pem"
}
if cfg.CA.Chainfile == "" {
cfg.CA.Chainfile = "ca-chain.pem"
}
if cfg.CSR.CA == nil {
cfg.CSR.CA = &cfcsr.CAConfig{}
}
if cfg.CSR.CA.Expiry == "" {
cfg.CSR.CA.Expiry = defaultRootCACertificateExpiration
}
if cfg.Signing == nil {
cfg.Signing = &config.Signing{}
}
cs := cfg.Signing
if cs.Profiles == nil {
cs.Profiles = make(map[string]*config.SigningProfile)
}
caProfile := cs.Profiles["ca"]
initSigningProfile(&caProfile,
defaultIntermediateCACertificateExpiration,
true)
cs.Profiles["ca"] = caProfile
initSigningProfile(
&cs.Default,
defaultIssuedCertificateExpiration,
false)
tlsProfile := cs.Profiles["tls"]
initSigningProfile(&tlsProfile,
defaultIssuedCertificateExpiration,
false)
cs.Profiles["tls"] = tlsProfile
err = ca.checkConfigLevels()
if err != nil {
return err
}
// Set log level if debug is true
if ca.server != nil && ca.server.Config != nil && ca.server.Config.Debug {
log.Level = log.LevelDebug
}
ca.normalizeStringSlices()
return nil
}
// VerifyCertificate verifies that 'cert' was issued by this CA
// Return nil if successful; otherwise, return an error.
func (ca *CA) VerifyCertificate(cert *x509.Certificate) error {
opts, err := ca.getVerifyOptions()
if err != nil {
return errors.WithMessage(err, "Failed to get verify options")
}
_, err = cert.Verify(*opts)
if err != nil {
return errors.WithMessage(err, "Failed to verify certificate")
}
return nil
}
// Get the options to verify
func (ca *CA) getVerifyOptions() (*x509.VerifyOptions, error) {
if ca.verifyOptions != nil {
return ca.verifyOptions, nil
}
chain, err := ca.getCAChain()
if err != nil {
return nil, err
}
var intPool *x509.CertPool
var rootPool *x509.CertPool
for len(chain) > 0 {
var block *pem.Block
block, chain = pem.Decode(chain)
if block == nil {
break
}
if block.Type != "CERTIFICATE" {
continue
}
cert, err := x509.ParseCertificate(block.Bytes)
if err != nil {
return nil, errors.Wrap(err, "Failed to parse CA chain certificate")
}
if !cert.IsCA {
return nil, errors.New("A certificate in the CA chain is not a CA certificate")
}
// If authority key id is not present or if it is present and equal to subject key id,
// then it is a root certificate
if len(cert.AuthorityKeyId) == 0 || bytes.Equal(cert.AuthorityKeyId, cert.SubjectKeyId) {
if rootPool == nil {
rootPool = x509.NewCertPool()
}
rootPool.AddCert(cert)
} else {
if intPool == nil {
intPool = x509.NewCertPool()
}
intPool.AddCert(cert)
}
}
ca.verifyOptions = &x509.VerifyOptions{
Roots: rootPool,
Intermediates: intPool,
KeyUsages: []x509.ExtKeyUsage{x509.ExtKeyUsageAny},
}
return ca.verifyOptions, nil
}
// Initialize the database for the CA
func (ca *CA) initDB() error {
log.Debug("Initializing DB")
// If DB is initialized, don't need to proceed further
if ca.dbInitialized {
return nil
}
ca.mutex.Lock()
defer ca.mutex.Unlock()
// After obtaining a lock, check again to see if DB got initialized by another process
if ca.dbInitialized {
return nil
}
db := &ca.Config.DB
dbError := false
var err error
if db.Type == "" || db.Type == defaultDatabaseType {
db.Type = defaultDatabaseType
if db.Datasource == "" {
db.Datasource = "fabric-ca-server.db"
}
db.Datasource, err = util.MakeFileAbs(db.Datasource, ca.HomeDir)
if err != nil {
return err
}
}
// Strip out user:pass from datasource for logging
ds := db.Datasource
ds = dbutil.MaskDBCred(ds)
log.Debugf("Initializing '%s' database at '%s'", db.Type, ds)
switch db.Type {
case defaultDatabaseType:
ca.db, err = dbutil.NewUserRegistrySQLLite3(db.Datasource)
if err != nil {
return errors.WithMessage(err, "Failed to create user registry for SQLite")
}
case "postgres":
ca.db, err = dbutil.NewUserRegistryPostgres(db.Datasource, &db.TLS)
if err != nil {
return errors.WithMessage(err, "Failed to create user registry for PostgreSQL")
}
case "mysql":
ca.db, err = dbutil.NewUserRegistryMySQL(db.Datasource, &db.TLS, ca.csp)
if err != nil {
return errors.WithMessage(err, "Failed to create user registry for MySQL")
}
default:
return errors.Errorf("Invalid db.type in config file: '%s'; must be 'sqlite3', 'postgres', or 'mysql'", db.Type)
}
// Update the database to use the latest schema
err = dbutil.UpdateSchema(ca.db, ca.server.levels)
if err != nil {
return errors.Wrap(err, "Failed to update schema")
}
// Set the certificate DB accessor
ca.certDBAccessor = NewCertDBAccessor(ca.db, ca.levels.Certificate)
// If DB initialization fails and we need to reinitialize DB, need to make sure to set the DB accessor for the signer
if ca.enrollSigner != nil {
ca.enrollSigner.SetDBAccessor(ca.certDBAccessor)
}
// Initialize user registry to either use DB or LDAP
err = ca.initUserRegistry()
if err != nil {
return err
}
// If not using LDAP, migrate database if needed to latest version and load the users and affiliations table
if !ca.Config.LDAP.Enabled {
err = ca.checkDBLevels()
if err != nil {
return err
}
err = ca.loadUsersTable()
if err != nil {
log.Error(err)
dbError = true
if isFatalError(err) {
return err
}
}
err = ca.loadAffiliationsTable()
if err != nil {
log.Error(err)
dbError = true
}
err = ca.performMigration()
if err != nil {
log.Error(err)
dbError = true
}
}
if dbError {
return errors.Errorf("Failed to initialize %s database at %s ", db.Type, ds)
}
ca.dbInitialized = true
log.Infof("Initialized %s database at %s", db.Type, ds)
return nil
}
// Close CA's DB
func (ca *CA) closeDB() error {
if ca.db != nil {
err := ca.db.Close()
ca.db = nil
if err != nil {
return errors.Wrapf(err, "Failed to close CA database, where CA home directory is '%s'", ca.HomeDir)
}
}
return nil
}
// Initialize the user registry interface
func (ca *CA) initUserRegistry() error {
log.Debug("Initializing identity registry")
var err error
ldapCfg := &ca.Config.LDAP
if ldapCfg.Enabled {
// Use LDAP for the user registry
ca.registry, err = ldap.NewClient(ldapCfg, ca.server.csp)
log.Debugf("Initialized LDAP identity registry; err=%s", err)
if err == nil {
log.Info("Successfully initialized LDAP client")
} else {
log.Warningf("Failed to initialize LDAP client; err=%s", err)
}
return err
}
// Use the DB for the user registry
dbAccessor := new(Accessor)
dbAccessor.SetDB(ca.db)
ca.registry = dbAccessor
log.Debug("Initialized DB identity registry")
return nil
}
// Initialize the enrollment signer
func (ca *CA) initEnrollmentSigner() (err error) {
log.Debug("Initializing enrollment signer")
c := ca.Config
// If there is a config, use its signing policy. Otherwise create a default policy.
var policy *config.Signing
if c.Signing != nil {
policy = c.Signing
} else {
policy = &config.Signing{
Profiles: map[string]*config.SigningProfile{},
Default: config.DefaultConfig(),
}
policy.Default.CAConstraint.IsCA = true
}
// Make sure the policy reflects the new remote
parentServerURL := ca.Config.Intermediate.ParentServer.URL
if parentServerURL != "" {
err = policy.OverrideRemotes(parentServerURL)
if err != nil {
return errors.Wrap(err, "Failed initializing enrollment signer")
}
}
ca.enrollSigner, err = util.BccspBackedSigner(c.CA.Certfile, c.CA.Keyfile, policy, ca.csp)
if err != nil {
return err
}
ca.enrollSigner.SetDBAccessor(ca.certDBAccessor)
// Successful enrollment
return nil
}
// loadUsersTable adds the configured users to the table if not already found
func (ca *CA) loadUsersTable() error {
log.Debug("Loading identity table")
registry := &ca.Config.Registry
for _, id := range registry.Identities {
log.Debugf("Loading identity '%s'", id.Name)
err := ca.addIdentity(&id, false)
if err != nil {
return errors.WithMessage(err, "Failed to load identity table")
}
}
log.Debug("Successfully loaded identity table")
return nil
}
// loadAffiliationsTable adds the configured affiliations to the table
func (ca *CA) loadAffiliationsTable() error {
log.Debug("Loading affiliations table")
err := ca.loadAffiliationsTableR(ca.Config.Affiliations, "")
if err != nil {
return errors.WithMessage(err, "Failed to load affiliations table")
}
log.Debug("Successfully loaded affiliations table")
return nil
}
// Recursive function to load the affiliations table hierarchy
func (ca *CA) loadAffiliationsTableR(val interface{}, parentPath string) (err error) {
var path string
if val == nil {
return nil
}
switch val.(type) {
case string:
path = affiliationPath(val.(string), parentPath)
err = ca.addAffiliation(path, parentPath)
if err != nil {
return err
}
case []string:
for _, ele := range val.([]string) {
err = ca.loadAffiliationsTableR(ele, parentPath)
if err != nil {
return err
}
}
case []interface{}:
for _, ele := range val.([]interface{}) {
err = ca.loadAffiliationsTableR(ele, parentPath)
if err != nil {
return err
}
}
default:
for name, ele := range val.(map[string]interface{}) {
path = affiliationPath(name, parentPath)
err = ca.addAffiliation(path, parentPath)
if err != nil {
return err
}
err = ca.loadAffiliationsTableR(ele, path)
if err != nil {
return err
}
}
}
return nil
}
// Add an identity to the registry
func (ca *CA) addIdentity(id *CAConfigIdentity, errIfFound bool) error {
var err error
user, _ := ca.registry.GetUser(id.Name, nil)
if user != nil {
if errIfFound {
return errors.Errorf("Identity '%s' is already registered", id.Name)
}
log.Debugf("Identity '%s' already registered, loaded identity", user.GetName())
return nil
}
id.MaxEnrollments, err = getMaxEnrollments(id.MaxEnrollments, ca.Config.Registry.MaxEnrollments)
if err != nil {
return newFatalError(ErrConfig, "Configuration Error: %s", err)
}
rec := spi.UserInfo{
Name: id.Name,
Pass: id.Pass,
Type: id.Type,
Affiliation: id.Affiliation,
Attributes: ca.convertAttrs(id.Attrs),
MaxEnrollments: id.MaxEnrollments,
Level: ca.levels.Identity,
}
err = ca.registry.InsertUser(&rec)
if err != nil {
return errors.WithMessage(err, fmt.Sprintf("Failed to insert identity '%s'", id.Name))
}
log.Debugf("Registered identity: %+v", id)
return nil
}
func (ca *CA) addAffiliation(path, parentPath string) error {
return ca.registry.InsertAffiliation(path, parentPath, ca.levels.Affiliation)
}
// CertDBAccessor returns the certificate DB accessor for CA
func (ca *CA) CertDBAccessor() *CertDBAccessor {
return ca.certDBAccessor
}
// DBAccessor returns the registry DB accessor for server
func (ca *CA) DBAccessor() spi.UserRegistry {
return ca.registry
}
func (ca *CA) convertAttrs(inAttrs map[string]string) []api.Attribute {
var outAttrs []api.Attribute
for name, value := range inAttrs {
outAttrs = append(outAttrs, api.Attribute{
Name: name,
Value: value,
})
}
return outAttrs
}
// Make all file names in the CA config absolute
func (ca *CA) makeFileNamesAbsolute() error {
log.Debug("Making CA filenames absolute")
fields := []*string{
&ca.Config.CA.Certfile,
&ca.Config.CA.Keyfile,
&ca.Config.CA.Chainfile,
}
err := util.MakeFileNamesAbsolute(fields, ca.HomeDir)
if err != nil {
return err
}
err = tls.AbsTLSClient(&ca.Config.DB.TLS, ca.HomeDir)
if err != nil {
return err
}
err = tls.AbsTLSClient(&ca.Config.LDAP.TLS, ca.HomeDir)
if err != nil {
return err
}
return nil
}
// Convert all comma separated strings to string arrays
func (ca *CA) normalizeStringSlices() {
fields := []*[]string{
&ca.Config.CSR.Hosts,
&ca.Config.DB.TLS.CertFiles,
&ca.Config.LDAP.TLS.CertFiles,
}
for _, namePtr := range fields {
norm := util.NormalizeStringSlice(*namePtr)
*namePtr = norm
}
}
// userHasAttribute returns nil error and the value of the attribute
// if the user has the attribute, or an appropriate error if the user
// does not have this attribute.
func (ca *CA) userHasAttribute(username, attrname string) (string, error) {
val, err := ca.getUserAttrValue(username, attrname)
if err != nil {
return "", err
}
if val == "" {
return "", errors.Errorf("Identity '%s' does not have attribute '%s'", username, attrname)
}
return val, nil
}
// attributeIsTrue returns nil if the attribute has
// one of the following values: "1", "t", "T", "true", "TRUE", "True";
// otherwise it will return an error
func (ca *CA) attributeIsTrue(username, attrname string) error {
val, err := ca.userHasAttribute(username, attrname)
if err != nil {
return err
}
val2, err := strconv.ParseBool(val)
if err != nil {
return errors.Wrapf(err, "Invalid value for attribute '%s' of identity '%s'", attrname, username)
}
if val2 {
return nil
}
return errors.Errorf("Attribute '%s' is not set to true for identity '%s'", attrname, username)
}
// getUserAttrValue returns a user's value for an attribute
func (ca *CA) getUserAttrValue(username, attrname string) (string, error) {
log.Debugf("getUserAttrValue identity=%s, attr=%s", username, attrname)
user, err := ca.registry.GetUser(username, []string{attrname})
if err != nil {
return "", err
}
attrval, err := user.GetAttribute(attrname)
if err != nil {
return "", errors.WithMessage(err, fmt.Sprintf("Failed to get attribute '%s' for user '%s'", attrname, user.GetName()))
}
log.Debugf("getUserAttrValue identity=%s, name=%s, value=%s", username, attrname, attrval)
return attrval.Value, nil
}
// getUserAffiliation returns a user's affiliation
func (ca *CA) getUserAffiliation(username string) (string, error) {
log.Debugf("getUserAffilliation identity=%s", username)
user, err := ca.registry.GetUser(username, nil)
if err != nil {
return "", err
}
aff := GetUserAffiliation(user)
log.Debugf("getUserAffiliation identity=%s, aff=%s", username, aff)
return aff, nil
}
// Fill the CA info structure appropriately
func (ca *CA) fillCAInfo(info *serverInfoResponseNet) error {
caChain, err := ca.getCAChain()
if err != nil {
return err
}
info.CAName = ca.Config.CA.Name
info.CAChain = util.B64Encode(caChain)
return nil
}
// Perfroms checks on the provided CA cert to make sure it's valid
func (ca *CA) validateCertAndKey(certFile string, keyFile string) error {
log.Debug("Validating the CA certificate and key")
var err error
var certPEM []byte
certPEM, err = ioutil.ReadFile(certFile)
if err != nil {
return errors.Wrapf(err, certificateError+" '%s'", certFile)
}
cert, err := util.GetX509CertificateFromPEM(certPEM)
if err != nil {
return errors.WithMessage(err, fmt.Sprintf(certificateError+" '%s'", certFile))
}
if err = validateDates(cert); err != nil {
return errors.WithMessage(err, fmt.Sprintf(certificateError+" '%s'", certFile))
}
if err = validateUsage(cert, ca.Config.CA.Name); err != nil {
return errors.WithMessage(err, fmt.Sprintf(certificateError+" '%s'", certFile))
}
if err = validateIsCA(cert); err != nil {