-
Notifications
You must be signed in to change notification settings - Fork 9
/
bundle.go
589 lines (479 loc) · 12.9 KB
/
bundle.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
// Copyright 2022 Namespace Labs Inc; 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.
package localsecrets
import (
"bytes"
"compress/gzip"
"context"
"encoding/base64"
"fmt"
"io"
"io/fs"
"os"
"filippo.io/age"
"github.com/muesli/reflow/wordwrap"
"golang.org/x/exp/slices"
"google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/proto"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/internal/fnfs/maketarfs"
"namespacelabs.dev/foundation/internal/fnfs/memfs"
"namespacelabs.dev/foundation/internal/fnfs/tarfs"
"namespacelabs.dev/foundation/internal/keys"
)
const (
UserBundleName = "user.secrets"
WorkspaceBundleName = "workspace.secrets"
ServerBundleName = "server.secrets"
guardBegin = "BEGIN FOUNDATION SECRET BUNDLE"
guardEnd = "END FOUNDATION SECRET BUNDLE"
)
// A secrets bundle is a tar file which includes:
// - README.txt: A disclaimer file with information about the contents.
// - manifest.json: A list of defined keys, and receipients.
// - encrypted.age: An age-encrypted tar file with the secret values, or secret files.
type Bundle struct {
m *Manifest
values []valueDatabase
}
type valueDatabase struct {
filename string
m *ValueDatabase
files *memfs.FS
wasEncrypted bool
}
func (b *Bundle) Readers() []*Manifest_Reader {
return b.m.Reader
}
func (b *Bundle) Definitions() []*Manifest_Definition {
return b.m.Definition
}
func (b *Bundle) Set(k *ValueKey, value []byte) {
var hasDef bool
for _, sec := range b.values {
for _, v := range sec.m.Value {
if equalKey(v.Key, k) {
v.Value = value
v.FromPath = ""
hasDef = true
break
}
}
}
if !hasDef {
if len(b.values) == 0 {
b.values = append(b.values, valueDatabase{
filename: fmt.Sprintf("values/%d.values", len(b.values)),
m: &ValueDatabase{},
files: &memfs.FS{},
})
}
enc := b.values[len(b.values)-1]
enc.m.Value = append(enc.m.Value, &ValueDatabase_Value{
Key: k,
Value: value,
})
}
// Always re-generate definitions.
b.regen()
}
func (b *Bundle) Delete(packageName, key string) bool {
var deleted int
for _, sec := range b.values {
for {
index := slices.IndexFunc(sec.m.Value, func(e *ValueDatabase_Value) bool {
// Delete all {packageName, key} pairs, regardless of environment.
return e.Key.GetPackageName() == packageName && e.Key.GetKey() == key
})
if index < 0 {
break
}
sec.m.Value = slices.Delete(sec.m.Value, index, index+1)
deleted++
}
}
if deleted > 0 {
b.regen()
return true
}
return false
}
func (b *Bundle) Lookup(ctx context.Context, key *ValueKey) ([]byte, error) {
sel, v := b.match(key)
if v == nil {
return nil, nil
}
if v.FromPath != "" {
return fs.ReadFile(sel.files, v.FromPath)
}
return v.Value, nil
}
func (b *Bundle) WasEncrypted(key *ValueKey) (bool, bool) {
v, _ := b.match(key)
if v == nil {
return false, false
}
return v.wasEncrypted, true
}
func (b *Bundle) match(key *ValueKey) (*valueDatabase, *ValueDatabase_Value) {
var sel *valueDatabase
var nonSpecific *ValueDatabase_Value
for _, sec := range b.values {
for _, v := range sec.m.Value {
if v.Key.PackageName != key.PackageName || v.Key.Key != key.Key {
continue
}
// If the key is not bound to an environment, keep looking as there may be one that is.
if v.Key.EnvironmentName == "" {
sec := sec
sel = &sec
nonSpecific = v
} else if v.Key.EnvironmentName == key.EnvironmentName {
return &sec, v
}
}
}
return sel, nonSpecific
}
type LookupResult struct {
Key *ValueKey
Value []byte
}
func (b *Bundle) LookupValues(ctx context.Context, key *ValueKey) ([]LookupResult, error) {
var results []LookupResult
for _, sec := range b.values {
for _, v := range sec.m.Value {
if key.PackageName == v.Key.PackageName && key.Key == v.Key.Key && (key.EnvironmentName == "" || key.EnvironmentName == v.Key.EnvironmentName) {
contents := v.Value
if v.FromPath != "" {
var err error
contents, err = fs.ReadFile(sec.files, v.FromPath)
if err != nil {
return nil, err
}
}
results = append(results, LookupResult{v.Key, contents})
}
}
}
return results, nil
}
func (b *Bundle) EnsureReader(pubkey string) error {
xid, err := age.ParseX25519Recipient(pubkey)
if err != nil {
return fnerrors.BadInputError("bad receipient: %w", err)
}
for _, r := range b.m.Reader {
if r.PublicKey == xid.String() {
return nil
}
}
b.m.Reader = append(b.m.Reader, &Manifest_Reader{PublicKey: xid.String()})
return nil
}
func (b *Bundle) SetReaders(pubkeys []string) error {
if len(pubkeys) == 0 {
return fnerrors.New("can't reset the readers to an empty list")
}
var keys []*age.X25519Recipient
for _, pubkey := range pubkeys {
xid, err := age.ParseX25519Recipient(pubkey)
if err != nil {
return fnerrors.BadInputError("bad receipient %q: %w", pubkey, err)
}
keys = append(keys, xid)
}
b.m.Reader = nil
for _, xid := range keys {
b.m.Reader = append(b.m.Reader, &Manifest_Reader{PublicKey: xid.String()})
}
return nil
}
func (b *Bundle) regen() {
b.m.Definition = nil
for _, enc := range b.values {
for _, v := range enc.m.Value {
b.m.Definition = append(b.m.Definition, &Manifest_Definition{
Key: v.Key,
})
}
}
}
func (b *Bundle) SerializeTo(ctx context.Context, w io.Writer, encrypt bool) error {
ww := wordwrap.NewWriter(80)
fmt.Fprintf(ww, "This is a secrets bundle managed by Namespace. You can use `ns secrets` to modify this file.\n\nNOTE: Any changes made before %q are ignored.\n\n", guardBegin)
if err := ww.Close(); err != nil {
return err
}
if _, err := w.Write(ww.Bytes()); err != nil {
return err
}
b.DescribeTo(w)
fmt.Fprintln(w)
fmt.Fprintf(w, "-----%s-----\n", guardBegin)
var serialized memfs.FS
var recipients []age.Recipient
for _, reader := range b.m.Reader {
xid, err := age.ParseX25519Recipient(reader.PublicKey)
if err != nil {
return fnerrors.BadInputError("invalid bundle: bad receipient: %w", err)
}
recipients = append(recipients, xid)
}
m := &Manifest{
Definition: b.m.Definition,
Reader: b.m.Reader,
}
for _, enc := range b.values {
m.Values = append(m.Values, &Manifest_BundleReference{
Filename: enc.filename,
RawText: !encrypt,
})
}
manifestBytes, err := protojson.Marshal(m)
if err != nil {
return fnerrors.InternalError("failed to serialize manifest: %w", err)
}
serialized.Add("manifest.json", manifestBytes)
for _, enc := range b.values {
manifestBytes, err := protojson.Marshal(enc.m)
if err != nil {
return fnerrors.InternalError("failed to serialize manifest: %w", err)
}
var encFS *memfs.FS
if enc.files != nil {
encFS = enc.files.Clone().(*memfs.FS)
} else {
encFS = &memfs.FS{}
}
encFS.Add("manifest.json", manifestBytes)
var buf bytes.Buffer
if encrypt {
encryptedWriter, encErr := age.Encrypt(&buf, recipients...)
if encErr != nil {
return fnerrors.InternalError("failed to encrypt values: %w", err)
}
if err := maketarfs.TarFS(ctx, encryptedWriter, encFS, nil, nil); err != nil {
return fnerrors.InternalError("failed to create encrypted bundle: %w", err)
}
if err := encryptedWriter.Close(); err != nil {
return fnerrors.InternalError("failed to close encrypted bundle: %w", err)
}
} else {
if err := maketarfs.TarFS(ctx, &buf, encFS, nil, nil); err != nil {
return fnerrors.InternalError("failed to create encrypted bundle: %w", err)
}
}
serialized.Add(enc.filename, buf.Bytes())
}
var buf bytes.Buffer
gz := gzip.NewWriter(&buf)
if err := maketarfs.TarFS(ctx, gz, &serialized, nil, nil); err != nil {
return err
}
if err := gz.Close(); err != nil {
return err
}
if err := OutputBase64(w, buf.Bytes()); err != nil {
return err
}
fmt.Fprintf(w, "-----%s-----\n", guardEnd)
return err
}
func OutputBase64(w io.Writer, buf []byte) error {
var breaker lineBreaker
breaker.out = w
b64 := base64.NewEncoder(base64.StdEncoding, &breaker)
if _, err := b64.Write(buf); err != nil {
return err
}
if err := b64.Close(); err != nil {
return err
}
if err := breaker.Close(); err != nil {
return err
}
return nil
}
func (b *Bundle) DescribeTo(out io.Writer) {
switch len(b.Readers()) {
case 0:
fmt.Fprintln(out, "No readers.")
default:
fmt.Fprintln(out, "Readers:")
for _, r := range b.Readers() {
fmt.Fprintf(out, " %s", r.PublicKey)
if r.Description != "" {
fmt.Fprintf(out, " # %s", r.Description)
}
fmt.Fprintln(out)
}
}
switch len(b.Definitions()) {
case 0:
fmt.Fprintln(out, "No definitions.")
default:
fmt.Fprintln(out, "Definitions:")
for _, def := range b.Definitions() {
fmt.Fprintf(out, " ")
DescribeKey(out, def.Key)
if wasEncrypted, found := b.WasEncrypted(def.Key); found && !wasEncrypted {
fmt.Fprintf(out, " (unencrypted)")
}
fmt.Fprintln(out)
}
}
}
func DescribeKey(out io.Writer, key *ValueKey) {
fmt.Fprintf(out, "%s:%s", key.PackageName, key.Key)
if key.EnvironmentName != "" {
fmt.Fprintf(out, " (%s)", key.EnvironmentName)
}
}
func equalKey(a, b *ValueKey) bool {
return a.PackageName == b.PackageName && a.Key == b.Key && a.EnvironmentName == b.EnvironmentName
}
func NewBundle(ctx context.Context, keyID string) (*Bundle, error) {
identity, err := keys.Select(ctx, keyID)
if err != nil {
return nil, err
}
return &Bundle{
m: &Manifest{
Reader: []*Manifest_Reader{
{PublicKey: identity.Recipient().String()},
},
},
}, nil
}
func LoadBundle(ctx context.Context, keyDir fs.FS, raw []byte) (*Bundle, error) {
contents, err := detect(raw)
if err != nil {
return nil, err
}
fsys := tarfs.FS{
TarStream: func() (io.ReadCloser, error) {
return gzip.NewReader(bytes.NewReader(contents))
},
}
m := &Manifest{}
if err := readManifest("bundle", fsys, m); err != nil {
return nil, err
}
bundle := &Bundle{m: m}
for _, enc := range m.Values {
encFile, err := fsys.Open(enc.Filename)
if err != nil {
if os.IsNotExist(err) {
return nil, fnerrors.BadInputError("invalid bundle: encrypted values %q are missing", enc.Filename)
}
return nil, err
}
defer encFile.Close()
var archiveBytes []byte
if !enc.RawText {
archiveBytes, err = keys.Decrypt(ctx, keyDir, encFile)
if err != nil {
return nil, err
}
} else {
archiveBytes, err = io.ReadAll(encFile)
if err != nil {
return nil, err
}
}
encFS := tarfs.FS{
TarStream: func() (io.ReadCloser, error) {
return io.NopCloser(bytes.NewReader(archiveBytes)), nil
},
}
encm := &ValueDatabase{}
if err := readManifest("value bundle", encFS, encm); err != nil {
return nil, err
}
encbundle := valueDatabase{
filename: enc.Filename,
m: encm,
files: &memfs.FS{},
wasEncrypted: !enc.RawText,
}
for _, value := range encm.Value {
if value.FromPath != "" {
encrypted, err := fs.ReadFile(encFS, value.FromPath)
if err != nil {
return nil, fnerrors.BadInputError("invalid bundle: missing encrypted value: %w", err)
}
encbundle.files.Add(value.FromPath, encrypted)
}
}
bundle.values = append(bundle.values, encbundle)
}
return bundle, nil
}
func detect(raw []byte) ([]byte, error) {
guard := []byte(fmt.Sprintf("-----%s-----\n", guardBegin))
idx := bytes.Index(raw, guard)
if idx < 0 {
return nil, fnerrors.New("invalid bundle: missing begin guard")
}
rawLeft := raw[(idx + len(guard)):]
endIdx := bytes.Index(rawLeft, []byte(fmt.Sprintf("-----%s-----", guardEnd)))
if endIdx < 0 {
return nil, fnerrors.New("invalid bundle: missing end guard")
}
return io.ReadAll(base64.NewDecoder(base64.StdEncoding, bytes.NewReader(rawLeft[:endIdx])))
}
func readManifest(what string, fsys fs.FS, m proto.Message) error {
manifestBytes, err := fs.ReadFile(fsys, "manifest.json")
if err != nil {
if os.IsNotExist(err) {
return fnerrors.BadInputError("invalid %s: manifest.json is missing", what)
}
return err
}
if err := protojson.Unmarshal(manifestBytes, m); err != nil {
return fnerrors.BadInputError("invalid %s: manifest.json is invalid: %w", what, err)
}
return nil
}
// From Go's pem library.
const blockLineLength = 80
type lineBreaker struct {
line [blockLineLength]byte
used int
out io.Writer
}
var nl = []byte{'\n'}
func (l *lineBreaker) Write(b []byte) (n int, err error) {
if l.used+len(b) < blockLineLength {
copy(l.line[l.used:], b)
l.used += len(b)
return len(b), nil
}
n, err = l.out.Write(l.line[0:l.used])
if err != nil {
return
}
excess := blockLineLength - l.used
l.used = 0
n, err = l.out.Write(b[0:excess])
if err != nil {
return
}
n, err = l.out.Write(nl)
if err != nil {
return
}
return l.Write(b[excess:])
}
func (l *lineBreaker) Close() (err error) {
if l.used > 0 {
_, err = l.out.Write(l.line[0:l.used])
if err != nil {
return
}
_, err = l.out.Write(nl)
}
return
}