forked from minio/kms-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
enclave.go
1175 lines (1062 loc) · 33 KB
/
enclave.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 2023 - MinIO, Inc. All rights reserved.
// Use of this source code is governed by the AGPLv3
// license that can be found in the LICENSE file.
package kes
import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"errors"
"io"
"math"
"net"
"net/http"
"sync"
"time"
"aead.dev/mem"
dto "github.com/prometheus/client_model/go"
"github.com/prometheus/common/expfmt"
)
// An Enclave is an isolated area within a KES server.
// It stores cryptographic keys, policies and other
// related information securely.
//
// A KES server contains at least one Enclave and,
// depending upon its persistence layer, may be able
// to hold many Enclaves.
//
// With Enclaves, a KES server implements multi-tenancy.
type Enclave struct {
// Name is the name of the KES server enclave.
Name string
// Endpoints contains one or multiple KES server
// endpoints. For example: https://127.0.0.1:7373
//
// Multiple endpoints should only be specified
// when multiple KES servers should be used, e.g.
// for high availability, but no round-robin DNS
// is used.
Endpoints []string
// HTTPClient is the HTTP client.
//
// The HTTP client uses its http.RoundTripper
// to send requests resp. receive responses.
//
// It must not be modified concurrently.
HTTPClient http.Client
init sync.Once
lb *loadBalancer
}
// EnclaveInfo describes a KES enclave.
type EnclaveInfo struct {
Name string
CreatedAt time.Time // Point in time when the enclave has been created
CreatedBy Identity // Identity that created the enclave
}
// NewEnclave returns a new Enclave that uses an API key
// for authentication.
//
// For obtaining an Enclave from a Client refer to Client.Enclave.
func NewEnclave(endpoint, name string, key APIKey, options ...CertificateOption) (*Enclave, error) {
cert, err := GenerateCertificate(key, options...)
if err != nil {
return nil, err
}
return NewEnclaveWithConfig(endpoint, name, &tls.Config{
MinVersion: tls.VersionTLS12,
Certificates: []tls.Certificate{cert},
}), nil
}
// NewEnclaveWithConfig returns a new Enclave with the given
// name and KES server endpoint that uses the given TLS config
// for mTLS authentication.
//
// Therefore, the config.Certificates must contain a TLS
// certificate that is valid for client authentication.
//
// NewClientWithConfig uses an http.Transport with reasonable
// defaults.
//
// For getting an Enclave from a Client refer to Client.Enclave.
func NewEnclaveWithConfig(endpoint, name string, config *tls.Config) *Enclave {
return &Enclave{
Name: name,
Endpoints: []string{endpoint},
HTTPClient: http.Client{
Transport: &http.Transport{
Proxy: http.ProxyFromEnvironment,
DialContext: (&net.Dialer{
Timeout: 30 * time.Second,
KeepAlive: 30 * time.Second,
DualStack: true,
}).DialContext,
ForceAttemptHTTP2: true,
MaxIdleConns: 100,
IdleConnTimeout: 90 * time.Second,
TLSHandshakeTimeout: 10 * time.Second,
ExpectContinueTimeout: 1 * time.Second,
TLSClientConfig: config,
},
},
}
}
// Metrics returns a KES server metric snapshot.
//
// It returns ErrNotAllowed if the client does not
// have sufficient permissions to fetch server metrics.
func (e *Enclave) Metrics(ctx context.Context) (Metric, error) {
const (
APIPath = "/v1/metrics"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponeSize = 1 * mem.MiB
)
e.init.Do(e.initLoadBalancer)
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, APIPath, nil)
if err != nil {
return Metric{}, err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return Metric{}, parseErrorResponse(resp)
}
const (
MetricRequestOK = "kes_http_request_success"
MetricRequestErr = "kes_http_request_error"
MetricRequestFail = "kes_http_request_failure"
MetricRequestActive = "kes_http_request_active"
MetricAuditEvents = "kes_log_audit_events"
MetricErrorEvents = "kes_log_error_events"
MetricResponseTime = "kes_http_response_time"
MetricSystemUpTme = "kes_system_up_time"
MetricSystemCPUs = "kes_system_num_cpu"
MetricSystemUsableCPUs = "kes_system_num_cpu_used"
MetricSystemThreads = "kes_system_num_threads"
MetricSystemHeapUsed = "kes_system_mem_heap_used"
MetricSystemHeapObjects = "kes_system_mem_heap_objects"
MetricSystemStackUsed = "kes_system_mem_stack_used"
)
var (
metric Metric
metricFamily dto.MetricFamily
)
decoder := expfmt.NewDecoder(mem.LimitReader(resp.Body, MaxResponeSize), expfmt.ResponseFormat(resp.Header))
for {
err := decoder.Decode(&metricFamily)
if err == io.EOF {
break
}
if err != nil {
return Metric{}, err
}
if len(metricFamily.Metric) == 0 {
return Metric{}, errors.New("kes: server response contains no metric")
}
var (
name = metricFamily.GetName()
kind = metricFamily.GetType()
)
switch {
case kind == dto.MetricType_COUNTER && name == MetricRequestOK:
for _, m := range metricFamily.GetMetric() {
metric.RequestOK += uint64(m.GetCounter().GetValue())
}
case kind == dto.MetricType_COUNTER && name == MetricRequestErr:
for _, m := range metricFamily.GetMetric() {
metric.RequestErr += uint64(m.GetCounter().GetValue())
}
case kind == dto.MetricType_COUNTER && name == MetricRequestFail:
for _, m := range metricFamily.GetMetric() {
metric.RequestFail += uint64(m.GetCounter().GetValue())
}
default:
if len(metricFamily.Metric) != 1 {
return Metric{}, errors.New("kes: server response contains more than one metric")
}
rawMetric := metricFamily.GetMetric()[0] // Safe since we checked length before
switch {
case kind == dto.MetricType_GAUGE && name == MetricRequestActive:
metric.RequestActive = uint64(rawMetric.GetGauge().GetValue())
case kind == dto.MetricType_COUNTER && name == MetricAuditEvents:
metric.AuditEvents = uint64(rawMetric.GetCounter().GetValue())
case kind == dto.MetricType_COUNTER && name == MetricErrorEvents:
metric.ErrorEvents = uint64(rawMetric.GetCounter().GetValue())
case kind == dto.MetricType_HISTOGRAM && name == MetricResponseTime:
metric.LatencyHistogram = map[time.Duration]uint64{}
for _, bucket := range rawMetric.GetHistogram().GetBucket() {
if math.IsInf(bucket.GetUpperBound(), 0) { // Ignore the +Inf bucket
continue
}
duration := time.Duration(1000*bucket.GetUpperBound()) * time.Millisecond
metric.LatencyHistogram[duration] = bucket.GetCumulativeCount()
}
delete(metric.LatencyHistogram, 0) // Delete the artificial zero entry
case kind == dto.MetricType_GAUGE && name == MetricSystemUpTme:
metric.UpTime = time.Duration(rawMetric.GetGauge().GetValue()) * time.Second
case kind == dto.MetricType_GAUGE && name == MetricSystemCPUs:
metric.CPUs = int(rawMetric.GetGauge().GetValue())
case kind == dto.MetricType_GAUGE && name == MetricSystemUsableCPUs:
metric.UsableCPUs = int(rawMetric.GetGauge().GetValue())
case kind == dto.MetricType_GAUGE && name == MetricSystemThreads:
metric.Threads = int(rawMetric.GetGauge().GetValue())
case kind == dto.MetricType_GAUGE && name == MetricSystemHeapUsed:
metric.HeapAlloc = uint64(rawMetric.GetGauge().GetValue())
case kind == dto.MetricType_GAUGE && name == MetricSystemHeapObjects:
metric.HeapObjects = uint64(rawMetric.GetGauge().GetValue())
case kind == dto.MetricType_GAUGE && name == MetricSystemStackUsed:
metric.StackAlloc = uint64(rawMetric.GetGauge().GetValue())
}
}
}
return metric, nil
}
// CreateKey creates a new cryptographic key. The key will
// be generated by the KES server.
//
// It returns ErrKeyExists if a key with the same name already
// exists.
func (e *Enclave) CreateKey(ctx context.Context, name string) error {
const (
APIPath = "/v1/key/create"
Method = http.MethodPost
StatusOK = http.StatusOK
)
e.init.Do(e.initLoadBalancer)
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), nil)
if err != nil {
return err
}
if resp.StatusCode != StatusOK {
return parseErrorResponse(resp)
}
return nil
}
// ImportKey imports the given key into a KES server. It
// returns ErrKeyExists if a key with the same key already
// exists.
func (e *Enclave) ImportKey(ctx context.Context, name string, req *ImportKeyRequest) error {
const (
APIPath = "/v1/key/import"
Method = http.MethodPost
StatusOK = http.StatusOK
)
e.init.Do(e.initLoadBalancer)
type Request struct {
Key []byte `json:"key"`
Cipher string `json:"cipher"`
}
body, err := json.Marshal(Request{
Key: req.Key,
Cipher: req.Cipher.String(),
})
if err != nil {
return err
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), bytes.NewReader(body), withHeader("Content-Type", "application/json"))
if err != nil {
return err
}
if resp.StatusCode != StatusOK {
return parseErrorResponse(resp)
}
return nil
}
// DescribeKey returns the KeyInfo for the given key.
//
// It returns ErrKeyNotFound if no such key exists.
func (e *Enclave) DescribeKey(ctx context.Context, name string) (*KeyInfo, error) {
const (
APIPath = "/v1/key/describe"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
type Response struct {
Name string `json:"name"`
ID string `json:"id"`
Algorithm KeyAlgorithm `json:"algorithm"`
CreatedAt time.Time `json:"created_at"`
CreatedBy Identity `json:"created_by"`
}
e.init.Do(e.initLoadBalancer)
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), nil)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return nil, parseErrorResponse(resp)
}
var response Response
if err := json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, err
}
return &KeyInfo{
Name: response.Name,
Algorithm: response.Algorithm,
CreatedAt: response.CreatedAt,
CreatedBy: response.CreatedBy,
}, nil
}
// DeleteKey deletes the key from a KES server. It returns
// ErrKeyNotFound if no such key exists.
func (e *Enclave) DeleteKey(ctx context.Context, name string) error {
const (
APIPath = "/v1/key/delete"
Method = http.MethodDelete
StatusOK = http.StatusOK
)
e.init.Do(e.initLoadBalancer)
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), nil)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return parseErrorResponse(resp)
}
return nil
}
// GenerateKey returns a new generated data encryption key (DEK).
// A DEK has a plaintext and ciphertext representation.
//
// The former should be used for cryptographic operations, like
// encrypting some data.
//
// The later is the result of encrypting the plaintext with the named
// key at the KES server. It should be stored at a durable location but
// does not need to stay secret. The ciphertext can only be decrypted
// with the named key at the KES server.
//
// The context is cryptographically bound to the ciphertext and the
// same context value must be provided when decrypting the ciphertext
// via Decrypt. Therefore, an application must either remember the
// context or must be able to re-generate it.
//
// GenerateKey returns ErrKeyNotFound if no key with the given name
// exists.
func (e *Enclave) GenerateKey(ctx context.Context, name string, context []byte) (DEK, error) {
const (
APIPath = "/v1/key/generate"
Method = http.MethodPost
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
e.init.Do(e.initLoadBalancer)
type Request struct {
Context []byte `json:"context,omitempty"` // A context is optional
}
type Response struct {
Plaintext []byte `json:"plaintext"`
Ciphertext []byte `json:"ciphertext"`
}
body, err := json.Marshal(Request{
Context: context,
})
if err != nil {
return DEK{}, err
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), bytes.NewReader(body), withHeader("Content-Type", "application/json"))
if err != nil {
return DEK{}, err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return DEK{}, parseErrorResponse(resp)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return DEK{}, err
}
return DEK(response), nil
}
// Encrypt encrypts the given plaintext with the named key at the
// KES server. The optional context is cryptographically bound to
// the returned ciphertext. The exact same context must be provided
// when decrypting the ciphertext again.
//
// Encrypt returns ErrKeyNotFound if no such key exists at the KES
// server.
func (e *Enclave) Encrypt(ctx context.Context, name string, plaintext, context []byte) ([]byte, error) {
const (
APIPath = "/v1/key/encrypt"
Method = http.MethodPost
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
e.init.Do(e.initLoadBalancer)
type Request struct {
Plaintext []byte `json:"plaintext"`
Context []byte `json:"context,omitempty"` // A context is optional
}
type Response struct {
Ciphertext []byte `json:"ciphertext"`
}
body, err := json.Marshal(Request{
Plaintext: plaintext,
Context: context,
})
if err != nil {
return nil, err
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), bytes.NewReader(body), withHeader("Content-Type", "application/json"))
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return nil, parseErrorResponse(resp)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, err
}
return response.Ciphertext, nil
}
// Decrypt decrypts the ciphertext with the named key at the KES
// server. The exact same context, used during Encrypt, must be
// provided.
//
// Decrypt returns ErrKeyNotFound if no such key exists. It returns
// ErrDecrypt when the ciphertext has been modified or a different
// context value is provided.
func (e *Enclave) Decrypt(ctx context.Context, name string, ciphertext, context []byte) ([]byte, error) {
const (
APIPath = "/v1/key/decrypt"
Method = http.MethodPost
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
e.init.Do(e.initLoadBalancer)
type Request struct {
Ciphertext []byte `json:"ciphertext"`
Context []byte `json:"context,omitempty"` // A context is optional
}
type Response struct {
Plaintext []byte `json:"plaintext"`
}
body, err := json.Marshal(Request{
Ciphertext: ciphertext,
Context: context,
})
if err != nil {
return nil, err
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), bytes.NewReader(body), withHeader("Content-Type", "application/json"))
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return nil, parseErrorResponse(resp)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, err
}
return response.Plaintext, nil
}
// ListKeys lists all names of cryptographic keys that match the given
// pattern. It returns a KeyIterator that iterates over all matched key
// names.
//
// The pattern matching happens on the server side. If pattern is empty
// the KeyIterator iterates over all key names.
func (e *Enclave) ListKeys(ctx context.Context, prefix string, n int) ([]string, string, error) {
const (
APIPath = "/v1/key/list"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
type Response struct {
Names []string `json:"names"`
ContinueAt string `json:"continue_at"`
}
e.init.Do(e.initLoadBalancer)
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, prefix), nil)
if err != nil {
return nil, "", err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return nil, "", parseErrorResponse(resp)
}
if resp.Header.Get("Content-Type") == "application/x-ndjson" {
return parseLegacyListing(resp.Body, n)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, "", err
}
return response.Names, response.ContinueAt, nil
}
// CreateSecret creates a new secret with the given name.
//
// It returns ErrSecretExists if a secret with the same name
// already exists.
func (e *Enclave) CreateSecret(ctx context.Context, name string, value []byte, options *SecretOptions) error {
const (
APIPath = "/v1/secret/create"
Method = http.MethodPost
StatusOK = http.StatusOK
)
e.init.Do(e.initLoadBalancer)
type Request struct {
Secret []byte `json:"secret"`
Type SecretType `json:"type,omitempty"`
}
req := Request{
Secret: value,
Type: SecretGeneric,
}
if options != nil {
req.Type = options.Type
}
body, err := json.Marshal(req)
if err != nil {
return err
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), bytes.NewReader(body))
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return parseErrorResponse(resp)
}
return nil
}
// DescribeSecret returns the SecretInfo for the given secret.
//
// It returns ErrSecretNotFound if no such secret exists.
func (e *Enclave) DescribeSecret(ctx context.Context, name string) (*SecretInfo, error) {
const (
APIPath = "/v1/secret/describe"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
e.init.Do(e.initLoadBalancer)
type Response struct {
Name string `json:"name"`
Type SecretType `json:"type"`
CreatedAt time.Time `json:"created_at"`
CreatedBy Identity `json:"created_by"`
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), nil)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return nil, parseErrorResponse(resp)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, err
}
return &SecretInfo{
Name: name,
Type: response.Type,
CreatedAt: response.CreatedAt,
CreatedBy: response.CreatedBy,
}, nil
}
// ReadSecret returns the secret with the given name.
//
// It returns ErrSecretNotFound if no such secret exists.
func (e *Enclave) ReadSecret(ctx context.Context, name string) ([]byte, *SecretInfo, error) {
const (
APIPath = "/v1/secret/read"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
e.init.Do(e.initLoadBalancer)
type Response struct {
Bytes []byte `json:"bytes"`
Name string `json:"name"`
Type SecretType `json:"type"`
CreatedAt time.Time `json:"created_at"`
CreatedBy Identity `json:"created_by"`
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), nil)
if err != nil {
return nil, nil, err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return nil, nil, parseErrorResponse(resp)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, nil, err
}
return response.Bytes, &SecretInfo{
Name: name,
Type: response.Type,
CreatedAt: response.CreatedAt,
CreatedBy: response.CreatedBy,
}, nil
}
// DeleteSecret deletes the secret with the given name.
//
// It returns ErrSecretNotFound if no such secret exists.
func (e *Enclave) DeleteSecret(ctx context.Context, name string) error {
const (
APIPath = "/v1/secret/delete"
Method = http.MethodDelete
StatusOK = http.StatusOK
)
e.init.Do(e.initLoadBalancer)
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), nil)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return parseErrorResponse(resp)
}
return nil
}
// ListSecrets returns a SecretIter that iterates over all secrets
// matching the pattern.
//
// The '*' pattern matches any secret. If pattern is empty the
// SecretIter iterates over all secrets names.
func (e *Enclave) ListSecrets(ctx context.Context, prefix string, n int) ([]string, string, error) {
const (
APIPath = "/v1/secret/list"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
type Response struct {
Names []string `json:"names"`
ContinueAt string `json:"continue_at"`
}
e.init.Do(e.initLoadBalancer)
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, prefix), nil)
if err != nil {
return nil, "", err
}
if resp.StatusCode != StatusOK {
return nil, "", parseErrorResponse(resp)
}
if resp.Header.Get("Content-Type") == "application/x-ndjson" {
return parseLegacyListing(resp.Body, n)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, "", err
}
return response.Names, response.ContinueAt, nil
}
// AssignPolicy assigns the policy to the identity.
// The KES admin identity cannot be assigned to any
// policy.
//
// AssignPolicy returns PolicyNotFound if no such policy exists.
func (e *Enclave) AssignPolicy(ctx context.Context, policy string, identity Identity) error {
const (
APIPath = "/v1/policy/assign"
Method = http.MethodPost
StatusOK = http.StatusOK
)
e.init.Do(e.initLoadBalancer)
type Request struct {
Identity Identity `json:"identity"`
}
body, err := json.Marshal(Request{Identity: identity})
if err != nil {
return err
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, policy), bytes.NewReader(body))
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return parseErrorResponse(resp)
}
return nil
}
// CreatePolicy creates a new policy.
//
// It returns ErrPolicyExists if such a policy already exists.
func (e *Enclave) CreatePolicy(ctx context.Context, name string, policy *Policy) error {
const (
APIPath = "/v1/policy/create"
Method = http.MethodPut
StatusOK = http.StatusOK
)
e.init.Do(e.initLoadBalancer)
body, err := json.Marshal(policy)
if err != nil {
return err
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), bytes.NewReader(body), withHeader("Content-Type", "application/json"))
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return parseErrorResponse(resp)
}
return nil
}
// DescribePolicy returns the PolicyInfo for the given policy.
// It returns ErrPolicyNotFound if no such policy exists.
func (e *Enclave) DescribePolicy(ctx context.Context, name string) (*PolicyInfo, error) {
const (
APIPath = "/v1/policy/describe"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
e.init.Do(e.initLoadBalancer)
type Response struct {
CreatedAt time.Time `json:"created_at"`
CreatedBy Identity `json:"created_by"`
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), nil)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return nil, parseErrorResponse(resp)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, err
}
return &PolicyInfo{
Name: name,
CreatedAt: response.CreatedAt,
CreatedBy: response.CreatedBy,
}, nil
}
// GetPolicy returns the policy with the given name.
// It returns ErrPolicyNotFound if no such policy
// exists.
func (e *Enclave) GetPolicy(ctx context.Context, name string) (*Policy, error) {
const (
APIPath = "/v1/policy/read"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
e.init.Do(e.initLoadBalancer)
type Response struct {
Allow map[string]Rule `json:"allow"`
Deny map[string]Rule `json:"deny"`
CreatedAt time.Time `json:"created_at"`
CreatedBy Identity `json:"created_by"`
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), nil)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return nil, parseErrorResponse(resp)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, err
}
return &Policy{
Allow: response.Allow,
Deny: response.Deny,
CreatedAt: response.CreatedAt,
CreatedBy: response.CreatedBy,
}, nil
}
// DeletePolicy deletes the policy with the given name. Any
// assigned identities will be removed as well.
//
// It returns ErrPolicyNotFound if no such policy exists.
func (e *Enclave) DeletePolicy(ctx context.Context, name string) error {
const (
APIPath = "/v1/policy/delete"
Method = http.MethodDelete
StatusOK = http.StatusOK
)
e.init.Do(e.initLoadBalancer)
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, name), nil)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return parseErrorResponse(resp)
}
return nil
}
// ListPolicies lists all policy names that match the given pattern.
//
// The pattern matching happens on the server side. If pattern is empty
// ListPolicies returns all policy names.
func (e *Enclave) ListPolicies(ctx context.Context, prefix string, n int) ([]string, string, error) {
const (
APIPath = "/v1/policy/list"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
type Response struct {
Names []string `json:"names"`
ContinueAt string `json:"continue_at"`
}
e.init.Do(e.initLoadBalancer)
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, prefix), nil)
if err != nil {
return nil, "", err
}
if resp.StatusCode != StatusOK {
return nil, "", parseErrorResponse(resp)
}
if resp.Header.Get("Content-Type") == "application/x-ndjson" {
return parseLegacyListing(resp.Body, n)
}
var response Response
if err = json.NewDecoder(mem.LimitReader(resp.Body, MaxResponseSize)).Decode(&response); err != nil {
return nil, "", err
}
return response.Names, response.ContinueAt, nil
}
// CreateIdentity returns an IdentityInfo describing the given identity.
func (e *Enclave) CreateIdentity(ctx context.Context, identity Identity, req *CreateIdentityRequest) error {
const (
APIPath = "/v1/identity/create"
Method = http.MethodPut
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
type Request struct {
Policy string `json:"policy"`
Admin bool `json:"admin"`
TTL string `json:"ttl"`
}
e.init.Do(e.initLoadBalancer)
var (
policy string
admin bool
ttl string
)
if req != nil {
policy, admin, ttl = req.Policy, req.Admin, req.TTL.String()
}
body, err := json.Marshal(Request{
Policy: policy,
Admin: admin,
TTL: ttl,
})
if err != nil {
return err
}
client := retry(e.HTTPClient)
resp, err := e.lb.Send(ctx, &client, Method, e.Endpoints, join(APIPath, identity.String()), bytes.NewReader(body))
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != StatusOK {
return parseErrorResponse(resp)
}
return nil
}
// DescribeIdentity returns an IdentityInfo describing the given identity.
func (e *Enclave) DescribeIdentity(ctx context.Context, identity Identity) (*IdentityInfo, error) {
const (
APIPath = "/v1/identity/describe"
Method = http.MethodGet
StatusOK = http.StatusOK
MaxResponseSize = 1 * mem.MiB
)
e.init.Do(e.initLoadBalancer)
type Response struct {