/
clientapi.go
733 lines (650 loc) · 26.1 KB
/
clientapi.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
// Copyright (c) Edgeless Systems GmbH.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
// package clientapi implements methods for users to interact with the Coordinator.
package clientapi
import (
"context"
"crypto/ecdsa"
"crypto/rand"
"crypto/sha256"
"crypto/x509"
"encoding/json"
"encoding/pem"
"errors"
"fmt"
"github.com/edgelesssys/marblerun/coordinator/constants"
"github.com/edgelesssys/marblerun/coordinator/crypto"
"github.com/edgelesssys/marblerun/coordinator/manifest"
"github.com/edgelesssys/marblerun/coordinator/quote"
"github.com/edgelesssys/marblerun/coordinator/recovery"
"github.com/edgelesssys/marblerun/coordinator/state"
"github.com/edgelesssys/marblerun/coordinator/store"
"github.com/edgelesssys/marblerun/coordinator/store/request"
"github.com/edgelesssys/marblerun/coordinator/store/wrapper"
"github.com/edgelesssys/marblerun/coordinator/updatelog"
"github.com/edgelesssys/marblerun/coordinator/user"
"github.com/google/uuid"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
type core interface {
Unlock()
RequireState(context.Context, ...state.State) error
AdvanceState(state.State, interface {
PutState(state.State) error
GetState() (state.State, error)
}) error
GetState(context.Context) (state.State, string, error)
GenerateSecrets(
map[string]manifest.Secret, uuid.UUID, *x509.Certificate, *ecdsa.PrivateKey, *ecdsa.PrivateKey,
) (map[string]manifest.Secret, error)
GetQuote() []byte
GenerateQuote([]byte) error
}
type transactionHandle interface {
BeginTransaction(context.Context) (store.Transaction, error)
SetEncryptionKey([]byte) error
SetRecoveryData([]byte)
LoadState() ([]byte, error)
}
type updateLog interface {
Info(msg string, fields ...zapcore.Field)
Reset()
String() string
}
// ClientAPI implements the client API.
type ClientAPI struct {
core core
recovery recovery.Recovery
txHandle transactionHandle
updateLog updateLog
log *zap.Logger
}
// New returns an initialized instance of the ClientAPI.
func New(txHandle transactionHandle, recovery recovery.Recovery, core core, log *zap.Logger,
) (*ClientAPI, error) {
updateLog, err := updatelog.New()
if err != nil {
return nil, err
}
return &ClientAPI{
core: core,
recovery: recovery,
txHandle: txHandle,
updateLog: updateLog,
log: log,
}, nil
}
// GetCertQuote gets the Coordinators certificate and corresponding quote (containing the cert).
//
// Returns the remote attestation quote of its own certificate alongside this certificate,
// which allows to verify the Coordinator's integrity and authentication for use of the ClientAPI.
func (a *ClientAPI) GetCertQuote(ctx context.Context) (cert string, certQuote []byte, err error) {
a.log.Info("GetCertQuote called")
defer a.core.Unlock()
if err := a.core.RequireState(ctx, state.AcceptingManifest, state.AcceptingMarbles, state.Recovery); err != nil {
a.log.Error("GetCertQuote: Coordinator not in correct state", zap.Error(err))
return "", nil, err
}
defer func() {
if err != nil {
a.log.Error("GetCertQuote failed", zap.Error(err))
}
}()
txdata, rollback, _, err := wrapper.WrapTransaction(ctx, a.txHandle)
if err != nil {
return "", nil, err
}
defer rollback()
rootCert, err := txdata.GetCertificate(constants.SKCoordinatorRootCert)
if err != nil {
return "", nil, fmt.Errorf("loading root certificate from store: %w", err)
}
if rootCert == nil {
return "", nil, errors.New("loaded nil root certificate from store")
}
intermediateCert, err := txdata.GetCertificate(constants.SKCoordinatorIntermediateCert)
if err != nil {
return "", nil, fmt.Errorf("loading intermediate certificate from store: %w", err)
}
if intermediateCert == nil {
return "", nil, errors.New("loaded nil intermediate certificate from store")
}
pemCertRoot := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: rootCert.Raw})
if len(pemCertRoot) <= 0 {
return "", nil, errors.New("pem.EncodeToMemory failed for root certificate")
}
// Include intermediate certificate if a manifest has been set
pemCertIntermediate := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: intermediateCert.Raw})
if len(pemCertIntermediate) <= 0 {
return "", nil, errors.New("pem.EncodeToMemory failed for intermediate certificate")
}
a.log.Info("GetCertQuote successful")
return string(pemCertIntermediate) + string(pemCertRoot), a.core.GetQuote(), nil
}
// GetManifestSignature returns the hash of the manifest.
//
// Returns ECDSA signature, SHA256 hash and byte encoded representation of the active manifest.
func (a *ClientAPI) GetManifestSignature(ctx context.Context) (manifestSignatureRootECDSA, manifestSignature, manifest []byte) {
a.log.Info("GetManifestSignature called")
txdata, rollback, _, err := wrapper.WrapTransaction(ctx, a.txHandle)
if err != nil {
a.log.Error("GetManifestSignature failed: initializing store transaction", zap.Error(err))
return nil, nil, nil
}
defer rollback()
rawManifest, err := txdata.GetRawManifest()
if err != nil {
a.log.Error("GetManifestSignature failed: loading manifest from store", zap.Error(err))
return nil, nil, nil
}
hash := sha256.Sum256(rawManifest)
signature, err := txdata.GetManifestSignature()
if err != nil {
a.log.Error("GetManifestSignature failed: loading manifest signature from store", zap.Error(err))
return nil, nil, nil
}
a.log.Info("GetManifestSignature successful")
return signature, hash[:], rawManifest
}
// GetSecrets allows a user to retrieve secrets from the Coordinator.
func (a *ClientAPI) GetSecrets(ctx context.Context, requestedSecrets []string, client *user.User) (map[string]manifest.Secret, error) {
a.log.Info("GetSecrets called", zap.Strings("secrets", requestedSecrets), zap.String("user", client.Name()))
defer a.core.Unlock()
// we can only return secrets if a manifest has already been set
if err := a.core.RequireState(ctx, state.AcceptingMarbles); err != nil {
a.log.Error("GetSecrets: Coordinator not in correct state", zap.Error(err))
return nil, err
}
// verify user is allowed to read the requested secrets
if !client.IsGranted(user.NewPermission(user.PermissionReadSecret, requestedSecrets)) {
a.log.Warn(
"GetSecrets failed: user is not allowed to read one or more secrets",
zap.Strings("secrets", requestedSecrets), zap.String("user", client.Name()),
)
return nil, fmt.Errorf("user %s is not allowed to read one or more secrets of: %v", client.Name(), requestedSecrets)
}
txdata, rollback, _, err := wrapper.WrapTransaction(ctx, a.txHandle)
if err != nil {
return nil, err
}
defer rollback()
secrets := make(map[string]manifest.Secret)
for _, requestedSecret := range requestedSecrets {
returnedSecret, err := txdata.GetSecret(requestedSecret)
if err != nil {
a.log.Error("GetSecrets failed: loading secret from store", zap.String("secret", requestedSecret), zap.Error(err))
return nil, fmt.Errorf("loading secret %s from store: %w", requestedSecret, err)
}
secrets[requestedSecret] = returnedSecret
}
a.log.Info("GetSecrets successful", zap.Strings("secrets", requestedSecrets), zap.String("user", client.Name()))
return secrets, nil
}
// GetStatus returns status information about the state of the Coordinator.
func (a *ClientAPI) GetStatus(ctx context.Context) (state.State, string, error) {
a.log.Info("GetStatus called")
return a.core.GetState(ctx)
}
// GetUpdateLog returns the update history of the Coordinator.
func (a *ClientAPI) GetUpdateLog(ctx context.Context) (string, error) {
a.log.Info("GetUpdateLog called")
defer a.core.Unlock()
if err := a.core.RequireState(ctx, state.AcceptingMarbles); err != nil {
a.log.Error("GetUpdateLog: Coordinator not in correct state", zap.Error(err))
return "", err
}
txdata, rollback, _, err := wrapper.WrapTransaction(ctx, a.txHandle)
if err != nil {
return "", err
}
defer rollback()
updateLog, err := txdata.GetUpdateLog()
if err != nil {
a.log.Error("GetUpdateLog failed: loading update log from store", zap.Error(err))
return "", fmt.Errorf("loading update log from store: %w", err)
}
a.log.Info("GetUpdateLog successful")
return updateLog, nil
}
// Recover sets an encryption key (ideally decrypted from the recovery data) and tries to unseal and load a saved state of the Coordinator.
func (a *ClientAPI) Recover(ctx context.Context, encryptionKey []byte) (keysLeft int, err error) {
a.log.Info("Recover called")
defer a.core.Unlock()
if err := a.core.RequireState(ctx, state.Recovery); err != nil {
a.log.Error("Recover: Coordinator not in correct state", zap.Error(err))
return -1, err
}
defer func() {
if err != nil {
a.log.Error("Recover failed", zap.Error(err))
}
}()
remaining, secret, err := a.recovery.RecoverKey(encryptionKey)
if err != nil {
return -1, fmt.Errorf("setting recovery key: %w", err)
}
// another key is needed to finish the recovery
if remaining != 0 {
a.log.Info("Recover: recovery incomplete, more keys needed", zap.Int("remaining", remaining))
return remaining, nil
}
// all keys are set, we can now load the state
if err := a.txHandle.SetEncryptionKey(secret); err != nil {
return -1, fmt.Errorf("setting recovery key: %w", err)
}
// load state
recoveryData, err := a.txHandle.LoadState()
if err != nil {
return -1, fmt.Errorf("loading state: %w", err)
}
a.txHandle.SetRecoveryData(recoveryData)
if err := a.recovery.SetRecoveryData(recoveryData); err != nil {
a.log.Error("Could not retrieve recovery data from state. Recovery will be unavailable", zap.Error(err))
}
txdata, rollback, _, err := wrapper.WrapTransaction(ctx, a.txHandle)
if err != nil {
return -1, err
}
defer rollback()
rootCert, err := txdata.GetCertificate(constants.SKCoordinatorRootCert)
if err != nil {
return -1, fmt.Errorf("loading root certificate from store: %w", err)
}
if err := a.core.GenerateQuote(rootCert.Raw); err != nil {
return -1, fmt.Errorf("generating quote failed: %w", err)
}
a.log.Info("Recover successful")
return 0, nil
}
// SetManifest sets the manifest of the Coordinator.
//
// rawManifest is the manifest of type Manifest in JSON format.
// recoverySecretMap is a map of recovery secrets that can be used to recover the Coordinator.
func (a *ClientAPI) SetManifest(ctx context.Context, rawManifest []byte) (recoverySecretMap map[string][]byte, err error) {
a.log.Info("SetManifest called")
defer a.core.Unlock()
if err := a.core.RequireState(ctx, state.AcceptingManifest, state.Recovery); err != nil {
a.log.Error("SetManifest: Coordinator not in correct state", zap.Error(err))
return nil, err
}
defer func() {
if err != nil {
a.log.Error("SetManifest failed", zap.Error(err))
}
}()
var mnf manifest.Manifest
if err := json.Unmarshal(rawManifest, &mnf); err != nil {
return nil, fmt.Errorf("unmarshaling manifest: %w", err)
}
if err := mnf.Check(a.log); err != nil {
return nil, fmt.Errorf("checking manifest: %w", err)
}
txdata, rollback, commit, err := wrapper.WrapTransaction(ctx, a.txHandle)
if err != nil {
return nil, err
}
defer rollback()
marbleRootCert, err := txdata.GetCertificate(constants.SKMarbleRootCert)
if err != nil {
return nil, fmt.Errorf("loading root certificate from store: %w", err)
}
rootPrivK, err := txdata.GetPrivateKey(constants.SKCoordinatorRootKey)
if err != nil {
return nil, fmt.Errorf("loading root private key from store: %w", err)
}
intermediatePrivK, err := txdata.GetPrivateKey(constants.SKCoordinatorIntermediateKey)
if err != nil {
return nil, fmt.Errorf("loading intermediate private key from store: %w", err)
}
// Generate shared secrets specified in manifest
secrets, err := a.core.GenerateSecrets(mnf.Secrets, uuid.Nil, marbleRootCert, intermediatePrivK, rootPrivK)
if err != nil {
a.log.Error("Could not generate specified secrets for the given manifest.", zap.Error(err))
return nil, fmt.Errorf("generating secrets from manifest: %w", err)
}
// generate placeholders for private secrets specified in manifest
privSecrets, err := a.core.GenerateSecrets(mnf.Secrets, uuid.New(), marbleRootCert, intermediatePrivK, rootPrivK)
if err != nil {
a.log.Error("Could not generate specified secrets for the given manifest.", zap.Error(err))
return nil, fmt.Errorf("generating placeholder secrets from manifest: %w", err)
}
// Set encryption key & generate recovery data
encryptionKey, err := a.recovery.GenerateEncryptionKey(mnf.RecoveryKeys)
if err != nil {
a.log.Error("could not set up encryption key for sealing the state", zap.Error(err))
return nil, fmt.Errorf("generating recovery encryption key: %w", err)
}
recoverySecretMap, recoveryData, err := a.recovery.GenerateRecoveryData(mnf.RecoveryKeys)
if err != nil {
a.log.Error("could not generate recovery data", zap.Error(err))
return nil, fmt.Errorf("generating recovery data: %w", err)
}
if err := a.txHandle.SetEncryptionKey(encryptionKey); err != nil {
a.log.Error("could not set encryption key to seal state", zap.Error(err))
return nil, fmt.Errorf("setting encryption key: %w", err)
}
// Parse X.509 user certificates and permissions from manifest
users, err := mnf.GenerateUsers()
if err != nil {
a.log.Error("Could not parse specified user certificate from supplied manifest", zap.Error(err))
return nil, fmt.Errorf("generating users from manifest: %w", err)
}
// sign raw manifest via ECDSA root key
hash := sha256.Sum256(rawManifest)
signature, err := ecdsa.SignASN1(rand.Reader, rootPrivK, hash[:])
if err != nil {
a.log.Error("Failed to create the manifest signature", zap.Error(err))
return nil, fmt.Errorf("signing manifest: %w", err)
}
for secretName, secret := range privSecrets {
secrets[secretName] = secret
}
for secretName, secret := range secrets {
if err := txdata.PutSecret(secretName, secret); err != nil {
return nil, fmt.Errorf("saving secret %q to store: %w", secretName, err)
}
}
for secretName, secret := range mnf.Secrets {
if secret.UserDefined {
if err := txdata.PutSecret(secretName, secret); err != nil {
return nil, fmt.Errorf("saving secret %q to store: %w", secretName, err)
}
// dummy values only used for template validation
secret.Cert.Raw = []byte{0x41}
secret.Private = []byte{0x41}
secret.Public = []byte{0x41}
secrets[secretName] = secret
}
}
if err := mnf.TemplateDryRun(secrets); err != nil {
return nil, fmt.Errorf("running manifest template dry run: %w", err)
}
if err := txdata.PutRawManifest(rawManifest); err != nil {
return nil, fmt.Errorf("saving manifest to store: %w", err)
}
if err := txdata.PutManifestSignature(signature); err != nil {
return nil, fmt.Errorf("saving manifest signature to store: %w", err)
}
for pkgName, pkg := range mnf.Packages {
if err := txdata.PutPackage(pkgName, pkg); err != nil {
return nil, fmt.Errorf("saving package %q to store: %w", pkgName, err)
}
}
for infraName, infra := range mnf.Infrastructures {
if err := txdata.PutInfrastructure(infraName, infra); err != nil {
return nil, fmt.Errorf("saving infrastructure %q to store: %w", infraName, err)
}
}
for marbleName, marble := range mnf.Marbles {
if err := txdata.PutMarble(marbleName, marble); err != nil {
return nil, fmt.Errorf("saving marble %q to store: %w", marbleName, err)
}
}
for tlsCfgName, tlsCfg := range mnf.TLS {
if err := txdata.PutTLS(tlsCfgName, tlsCfg); err != nil {
return nil, fmt.Errorf("saving TLS config %q to store: %w", tlsCfgName, err)
}
}
for _, user := range users {
if err := txdata.PutUser(user); err != nil {
return nil, fmt.Errorf("saving user %q to store: %w", user.Name(), err)
}
}
a.updateLog.Info("Initial manifest set")
if err := txdata.PutUpdateLog(a.updateLog.String()); err != nil {
return nil, fmt.Errorf("saving update log to store: %w", err)
}
if err := a.core.AdvanceState(state.AcceptingMarbles, txdata); err != nil {
return nil, fmt.Errorf("advancing state: %w", err)
}
a.txHandle.SetRecoveryData(recoveryData)
if err := commit(ctx); err != nil {
a.log.Error("sealing of state failed", zap.Error(err))
return nil, fmt.Errorf("sealing state: %w", err)
}
a.log.Info("SetManifest successful")
return recoverySecretMap, nil
}
// UpdateManifest allows to update certain package parameters of the original manifest, supplied via a JSON manifest.
func (a *ClientAPI) UpdateManifest(ctx context.Context, rawUpdateManifest []byte, updater *user.User) (err error) {
a.log.Info("UpdateManifest called")
defer a.core.Unlock()
// Only accept update manifest if we already have a manifest
if err := a.core.RequireState(ctx, state.AcceptingMarbles); err != nil {
a.log.Error("UpdateManifest: Coordinator not in correct state", zap.Error(err))
return err
}
defer func() {
if err != nil {
a.log.Error("UpdateManifest failed", zap.Error(err))
}
}()
// Unmarshal & check update manifest
var updateManifest manifest.Manifest
if err := json.Unmarshal(rawUpdateManifest, &updateManifest); err != nil {
return fmt.Errorf("unmarshaling update manifest: %w", err)
}
// verify updater is allowed to commit the update
var wantedPackages []string
for pkg := range updateManifest.Packages {
wantedPackages = append(wantedPackages, pkg)
}
if !updater.IsGranted(user.NewPermission(user.PermissionUpdatePackage, wantedPackages)) {
return fmt.Errorf("user %s is not allowed to update one or more packages of %v", updater.Name(), wantedPackages)
}
txdata, rollback, commit, err := wrapper.WrapTransaction(ctx, a.txHandle)
if err != nil {
return err
}
defer rollback()
currentPackages := make(map[string]quote.PackageProperties)
for pkgName := range updateManifest.Packages {
pkg, err := txdata.GetPackage(pkgName)
if err != nil {
return fmt.Errorf("loading current package %q from store: %w", pkgName, err)
}
currentPackages[pkgName] = pkg
}
if err := updateManifest.CheckUpdate(currentPackages); err != nil {
return fmt.Errorf("checking update manifest: %w", err)
}
// update manifest was valid, increase svn and regenerate secrets
for pkgName, pkg := range updateManifest.Packages {
if currentPackages[pkgName].SecurityVersion == nil {
currentPkg := currentPackages[pkgName]
currentPackages[pkgName] = quote.PackageProperties{
Debug: currentPkg.Debug,
UniqueID: currentPkg.UniqueID,
SecurityVersion: pkg.SecurityVersion,
ProductID: currentPkg.ProductID,
SignerID: currentPkg.SignerID,
AcceptedTCBStatuses: currentPkg.AcceptedTCBStatuses,
}
} else {
*currentPackages[pkgName].SecurityVersion = *pkg.SecurityVersion
}
}
rootCert, err := txdata.GetCertificate(constants.SKCoordinatorRootCert)
if err != nil {
return fmt.Errorf("loading root certificate from store: %w", err)
}
rootPrivK, err := txdata.GetPrivateKey(constants.SKCoordinatorRootKey)
if err != nil {
return fmt.Errorf("loading root private key from store: %w", err)
}
// Generate new cross-signed intermediate CA for Marble gRPC authentication
intermediateCert, intermediatePrivK, err := crypto.GenerateCert(rootCert.DNSNames, constants.CoordinatorIntermediateName, nil, rootCert, rootPrivK)
if err != nil {
a.log.Error("Could not generate a new intermediate CA for Marble authentication.", zap.Error(err))
return fmt.Errorf("generating new intermediate CA for Marble authentication: %w", err)
}
marbleRootCert, _, err := crypto.GenerateCert(rootCert.DNSNames, constants.CoordinatorIntermediateName, intermediatePrivK, nil, nil)
if err != nil {
return fmt.Errorf("generating new Marble root certificate: %w", err)
}
// Gather all shared certificate secrets we need to regenerate
secretsToRegenerate := make(map[string]manifest.Secret)
secrets, err := txdata.GetSecretMap()
if err != nil {
return fmt.Errorf("loading existing shared secrets from store: %w", err)
}
for name, secret := range secrets {
if secret.Shared && secret.Type != manifest.SecretTypeSymmetricKey {
secretsToRegenerate[name] = secret
}
}
// Regenerate shared secrets specified in manifest
regeneratedSecrets, err := a.core.GenerateSecrets(secretsToRegenerate, uuid.Nil, marbleRootCert, intermediatePrivK, rootPrivK)
if err != nil {
a.log.Error("Could not generate specified secrets for the given manifest.", zap.Error(err))
return fmt.Errorf("regenerating shared secrets for updated manifest: %w", err)
}
// Retrieve current recovery data before we seal the state again
currentRecoveryData, err := a.recovery.GetRecoveryData()
if err != nil {
a.log.Error("Could not retrieve the current recovery data from the recovery module. Cannot reseal the state, the update manifest will not be applied.")
return fmt.Errorf("retrieving current recovery data: %w", err)
}
a.updateLog.Reset()
for pkgName, pkg := range updateManifest.Packages {
a.updateLog.Info("SecurityVersion increased", zap.String("user", updater.Name()), zap.String("package", pkgName), zap.Uint("new version", *pkg.SecurityVersion))
}
if err := txdata.PutCertificate(constants.SKCoordinatorIntermediateCert, intermediateCert); err != nil {
return fmt.Errorf("saving new intermediate certificate to store: %w", err)
}
if err := txdata.PutPrivateKey(constants.SKCoordinatorIntermediateKey, intermediatePrivK); err != nil {
return fmt.Errorf("saving new intermediate private key to store: %w", err)
}
if err := txdata.PutCertificate(constants.SKMarbleRootCert, marbleRootCert); err != nil {
return fmt.Errorf("saving new Marble root certificate to store: %w", err)
}
if err := txdata.AppendUpdateLog(a.updateLog.String()); err != nil {
return fmt.Errorf("saving update log to store: %w", err)
}
// Overwrite updated packages in core
for name, pkg := range currentPackages {
if err := txdata.PutPackage(name, pkg); err != nil {
return fmt.Errorf("saving updated package to store: %w", err)
}
}
// Overwrite regenerated secrets in core
for name, secret := range regeneratedSecrets {
if err := txdata.PutSecret(name, secret); err != nil {
return fmt.Errorf("saving regenerated secret to store: %w", err)
}
}
a.log.Info("An update manifest overriding package settings from the original manifest was set.")
a.log.Info("Please restart your Marbles to enforce the update.")
a.txHandle.SetRecoveryData(currentRecoveryData)
if err := commit(ctx); err != nil {
return fmt.Errorf("updating manifest failed: committing store transaction: %w", err)
}
a.log.Info("UpdateManifest successful")
return nil
}
// VerifyUser checks if a given client certificate matches the admin certificates specified in the manifest.
func (a *ClientAPI) VerifyUser(ctx context.Context, clientCerts []*x509.Certificate) (*user.User, error) {
txdata, rollback, _, err := wrapper.WrapTransaction(ctx, a.txHandle)
if err != nil {
return nil, err
}
defer rollback()
userIter, err := txdata.GetIterator(request.User)
if err != nil {
return nil, fmt.Errorf("getting user iterator: %w", err)
}
// Check if a supplied client cert matches the supplied ones from the manifest stored in the core
// NOTE: We do not use the "correct" X.509 verify here since we do not really care about expiration and chain verification here.
for _, suppliedCert := range clientCerts {
for userIter.HasNext() {
name, err := userIter.GetNext()
if err != nil {
return nil, fmt.Errorf("getting next user: %w", err)
}
user, err := txdata.GetUser(name)
if err != nil {
return nil, fmt.Errorf("getting user %q: %w", name, err)
}
if suppliedCert.Equal(user.Certificate()) {
return user, nil
}
}
}
return nil, errors.New("client certificate did not match any MarbleRun users")
}
// WriteSecrets allows a user to set certain user-defined secrets for the Coordinator.
func (a *ClientAPI) WriteSecrets(ctx context.Context, rawSecretManifest []byte, updater *user.User) (err error) {
a.log.Info("WriteSecrets called", zap.String("user", updater.Name()))
defer a.core.Unlock()
// Only accept secrets if we already have a manifest
if err := a.core.RequireState(ctx, state.AcceptingMarbles); err != nil {
a.log.Error("WriteSecrets: Coordinator not in correct state", zap.Error(err))
return err
}
defer func() {
if err != nil {
a.log.Error("WriteSecrets failed", zap.Error(err), zap.String("user", updater.Name()))
}
}()
// Unmarshal & check secret manifest
var secretManifest map[string]manifest.UserSecret
if err := json.Unmarshal(rawSecretManifest, &secretManifest); err != nil {
return fmt.Errorf("unmarshaling secret manifest: %w", err)
}
txdata, rollback, commit, err := wrapper.WrapTransaction(ctx, a.txHandle)
if err != nil {
return err
}
defer rollback()
// validate and parse new secrets
secretMeta, err := txdata.GetSecretMap()
if err != nil {
return fmt.Errorf("loading existing secrets: %w", err)
}
newSecrets, err := manifest.ParseUserSecrets(secretManifest, secretMeta)
if err != nil {
return fmt.Errorf("parsing new secrets: %w", err)
}
// perform a dry run to check if the new secrets can be parsed as env vars or files
//
// set dummy values for user-defined secrets, only used for template validation, we do not care if any of these were set before
for k, v := range secretMeta {
if v.UserDefined {
v.Cert.Raw = []byte{0x41}
v.Private = []byte{0x41}
v.Public = []byte{0x41}
secretMeta[k] = v
}
}
// merge new secrets with existing secrets
for k, v := range newSecrets {
secretMeta[k] = v
}
mnf, err := txdata.GetManifest()
if err != nil {
return fmt.Errorf("loading manifest: %w", err)
}
// perform the dry run
if err := mnf.TemplateDryRun(secretMeta); err != nil {
return fmt.Errorf("running manifest template dry run: %w", err)
}
a.updateLog.Reset()
for secretName, secret := range newSecrets {
// verify user is allowed to set the secret
if !updater.IsGranted(user.NewPermission(user.PermissionWriteSecret, []string{secretName})) {
return fmt.Errorf("user %s is not allowed to update secret: %s", updater.Name(), secretName)
}
if err := txdata.PutSecret(secretName, secret); err != nil {
return fmt.Errorf("saving secret %q to store: %w", secretName, err)
}
a.updateLog.Info("Secret set", zap.String("user", updater.Name()), zap.String("secret", secretName), zap.String("type", secret.Type))
}
if err := txdata.AppendUpdateLog(a.updateLog.String()); err != nil {
return fmt.Errorf("saving update log to store: %w", err)
}
return commit(ctx)
}