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
|
package local
import (
"context"
"crypto/aes"
"crypto/cipher"
"crypto/rand"
"encoding/json"
"fmt"
"io"
"sort"
"strings"
"sync"
"time"
"github.com/seaweedfs/seaweedfs/weed/glog"
"github.com/seaweedfs/seaweedfs/weed/kms"
"github.com/seaweedfs/seaweedfs/weed/util"
)
// LocalKMSProvider implements a local, in-memory KMS for development and testing
// WARNING: This is NOT suitable for production use - keys are stored in memory
type LocalKMSProvider struct {
mu sync.RWMutex
keys map[string]*LocalKey
defaultKeyID string
enableOnDemandCreate bool // Whether to create keys on-demand for missing key IDs
}
// LocalKey represents a key stored in the local KMS
type LocalKey struct {
KeyID string `json:"keyId"`
ARN string `json:"arn"`
Description string `json:"description"`
KeyMaterial []byte `json:"keyMaterial"` // 256-bit master key
KeyUsage kms.KeyUsage `json:"keyUsage"`
KeyState kms.KeyState `json:"keyState"`
Origin kms.KeyOrigin `json:"origin"`
CreatedAt time.Time `json:"createdAt"`
Aliases []string `json:"aliases"`
Metadata map[string]string `json:"metadata"`
}
// LocalKMSConfig contains configuration for the local KMS provider
type LocalKMSConfig struct {
DefaultKeyID string `json:"defaultKeyId"`
Keys map[string]*LocalKey `json:"keys"`
EnableOnDemandCreate bool `json:"enableOnDemandCreate"`
}
func init() {
// Register the local KMS provider
kms.RegisterProvider("local", NewLocalKMSProvider)
}
// NewLocalKMSProvider creates a new local KMS provider
func NewLocalKMSProvider(config util.Configuration) (kms.KMSProvider, error) {
provider := &LocalKMSProvider{
keys: make(map[string]*LocalKey),
enableOnDemandCreate: true, // Default to true for development/testing convenience
}
// Load configuration if provided
if config != nil {
if err := provider.loadConfig(config); err != nil {
return nil, fmt.Errorf("failed to load local KMS config: %v", err)
}
}
// Create a default key if none exists
if len(provider.keys) == 0 {
defaultKey, err := provider.createDefaultKey()
if err != nil {
return nil, fmt.Errorf("failed to create default key: %v", err)
}
provider.defaultKeyID = defaultKey.KeyID
glog.V(1).Infof("Local KMS: Created default key %s", defaultKey.KeyID)
}
return provider, nil
}
// loadConfig loads configuration from the provided config
func (p *LocalKMSProvider) loadConfig(config util.Configuration) error {
if config == nil {
return nil
}
p.enableOnDemandCreate = config.GetBool("enableOnDemandCreate")
// TODO: Load pre-existing keys from configuration if provided
// For now, rely on default key creation in constructor
glog.V(2).Infof("Local KMS: enableOnDemandCreate = %v", p.enableOnDemandCreate)
return nil
}
// createDefaultKey creates a default master key for the local KMS
func (p *LocalKMSProvider) createDefaultKey() (*LocalKey, error) {
keyID, err := generateKeyID()
if err != nil {
return nil, fmt.Errorf("failed to generate key ID: %w", err)
}
keyMaterial := make([]byte, 32) // 256-bit key
if _, err := io.ReadFull(rand.Reader, keyMaterial); err != nil {
return nil, fmt.Errorf("failed to generate key material: %w", err)
}
key := &LocalKey{
KeyID: keyID,
ARN: fmt.Sprintf("arn:aws:kms:local:000000000000:key/%s", keyID),
Description: "Default local KMS key for SeaweedFS",
KeyMaterial: keyMaterial,
KeyUsage: kms.KeyUsageEncryptDecrypt,
KeyState: kms.KeyStateEnabled,
Origin: kms.KeyOriginLocal,
CreatedAt: time.Now(),
Aliases: []string{"alias/seaweedfs-default"},
Metadata: make(map[string]string),
}
p.mu.Lock()
defer p.mu.Unlock()
p.keys[keyID] = key
// Also register aliases
for _, alias := range key.Aliases {
p.keys[alias] = key
}
return key, nil
}
// GenerateDataKey implements the KMSProvider interface
func (p *LocalKMSProvider) GenerateDataKey(ctx context.Context, req *kms.GenerateDataKeyRequest) (*kms.GenerateDataKeyResponse, error) {
if req.KeySpec != kms.KeySpecAES256 {
return nil, &kms.KMSError{
Code: kms.ErrCodeInvalidKeyUsage,
Message: fmt.Sprintf("Unsupported key spec: %s", req.KeySpec),
KeyID: req.KeyID,
}
}
// Resolve the key
key, err := p.getKey(req.KeyID)
if err != nil {
return nil, err
}
if key.KeyState != kms.KeyStateEnabled {
return nil, &kms.KMSError{
Code: kms.ErrCodeKeyUnavailable,
Message: fmt.Sprintf("Key %s is in state %s", key.KeyID, key.KeyState),
KeyID: key.KeyID,
}
}
// Generate a random 256-bit data key
dataKey := make([]byte, 32)
if _, err := io.ReadFull(rand.Reader, dataKey); err != nil {
return nil, &kms.KMSError{
Code: kms.ErrCodeKMSInternalFailure,
Message: "Failed to generate data key",
KeyID: key.KeyID,
}
}
// Encrypt the data key with the master key
encryptedDataKey, err := p.encryptDataKey(dataKey, key, req.EncryptionContext)
if err != nil {
kms.ClearSensitiveData(dataKey)
return nil, &kms.KMSError{
Code: kms.ErrCodeKMSInternalFailure,
Message: fmt.Sprintf("Failed to encrypt data key: %v", err),
KeyID: key.KeyID,
}
}
return &kms.GenerateDataKeyResponse{
KeyID: key.KeyID,
Plaintext: dataKey,
CiphertextBlob: encryptedDataKey,
}, nil
}
// Decrypt implements the KMSProvider interface
func (p *LocalKMSProvider) Decrypt(ctx context.Context, req *kms.DecryptRequest) (*kms.DecryptResponse, error) {
// Parse the encrypted data key to extract metadata
metadata, err := p.parseEncryptedDataKey(req.CiphertextBlob)
if err != nil {
return nil, &kms.KMSError{
Code: kms.ErrCodeInvalidCiphertext,
Message: fmt.Sprintf("Invalid ciphertext format: %v", err),
}
}
// Verify encryption context matches
if !p.encryptionContextMatches(metadata.EncryptionContext, req.EncryptionContext) {
return nil, &kms.KMSError{
Code: kms.ErrCodeInvalidCiphertext,
Message: "Encryption context mismatch",
KeyID: metadata.KeyID,
}
}
// Get the master key
key, err := p.getKey(metadata.KeyID)
if err != nil {
return nil, err
}
if key.KeyState != kms.KeyStateEnabled {
return nil, &kms.KMSError{
Code: kms.ErrCodeKeyUnavailable,
Message: fmt.Sprintf("Key %s is in state %s", key.KeyID, key.KeyState),
KeyID: key.KeyID,
}
}
// Decrypt the data key
dataKey, err := p.decryptDataKey(metadata, key)
if err != nil {
return nil, &kms.KMSError{
Code: kms.ErrCodeInvalidCiphertext,
Message: fmt.Sprintf("Failed to decrypt data key: %v", err),
KeyID: key.KeyID,
}
}
return &kms.DecryptResponse{
KeyID: key.KeyID,
Plaintext: dataKey,
}, nil
}
// DescribeKey implements the KMSProvider interface
func (p *LocalKMSProvider) DescribeKey(ctx context.Context, req *kms.DescribeKeyRequest) (*kms.DescribeKeyResponse, error) {
key, err := p.getKey(req.KeyID)
if err != nil {
return nil, err
}
return &kms.DescribeKeyResponse{
KeyID: key.KeyID,
ARN: key.ARN,
Description: key.Description,
KeyUsage: key.KeyUsage,
KeyState: key.KeyState,
Origin: key.Origin,
}, nil
}
// GetKeyID implements the KMSProvider interface
func (p *LocalKMSProvider) GetKeyID(ctx context.Context, keyIdentifier string) (string, error) {
key, err := p.getKey(keyIdentifier)
if err != nil {
return "", err
}
return key.KeyID, nil
}
// Close implements the KMSProvider interface
func (p *LocalKMSProvider) Close() error {
p.mu.Lock()
defer p.mu.Unlock()
// Clear all key material from memory
for _, key := range p.keys {
kms.ClearSensitiveData(key.KeyMaterial)
}
p.keys = make(map[string]*LocalKey)
return nil
}
// getKey retrieves a key by ID or alias, creating it on-demand if it doesn't exist
func (p *LocalKMSProvider) getKey(keyIdentifier string) (*LocalKey, error) {
p.mu.RLock()
// Try direct lookup first
if key, exists := p.keys[keyIdentifier]; exists {
p.mu.RUnlock()
return key, nil
}
// Try with default key if no identifier provided
if keyIdentifier == "" && p.defaultKeyID != "" {
if key, exists := p.keys[p.defaultKeyID]; exists {
p.mu.RUnlock()
return key, nil
}
}
p.mu.RUnlock()
// Key doesn't exist - create on-demand if enabled and key identifier is reasonable
if keyIdentifier != "" && p.enableOnDemandCreate && p.isReasonableKeyIdentifier(keyIdentifier) {
glog.V(1).Infof("Creating on-demand local KMS key: %s", keyIdentifier)
key, err := p.CreateKeyWithID(keyIdentifier, fmt.Sprintf("Auto-created local KMS key: %s", keyIdentifier))
if err != nil {
return nil, &kms.KMSError{
Code: kms.ErrCodeKMSInternalFailure,
Message: fmt.Sprintf("Failed to create on-demand key %s: %v", keyIdentifier, err),
KeyID: keyIdentifier,
}
}
return key, nil
}
return nil, &kms.KMSError{
Code: kms.ErrCodeNotFoundException,
Message: fmt.Sprintf("Key not found: %s", keyIdentifier),
KeyID: keyIdentifier,
}
}
// isReasonableKeyIdentifier determines if a key identifier is reasonable for on-demand creation
func (p *LocalKMSProvider) isReasonableKeyIdentifier(keyIdentifier string) bool {
// Basic validation: reasonable length and character set
if len(keyIdentifier) < 3 || len(keyIdentifier) > 100 {
return false
}
// Allow alphanumeric characters, hyphens, underscores, and forward slashes
// This covers most reasonable key identifier formats without being overly restrictive
for _, r := range keyIdentifier {
if !((r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z') ||
(r >= '0' && r <= '9') || r == '-' || r == '_' || r == '/') {
return false
}
}
// Reject keys that start or end with separators
if keyIdentifier[0] == '-' || keyIdentifier[0] == '_' || keyIdentifier[0] == '/' ||
keyIdentifier[len(keyIdentifier)-1] == '-' || keyIdentifier[len(keyIdentifier)-1] == '_' || keyIdentifier[len(keyIdentifier)-1] == '/' {
return false
}
return true
}
// encryptedDataKeyMetadata represents the metadata stored with encrypted data keys
type encryptedDataKeyMetadata struct {
KeyID string `json:"keyId"`
EncryptionContext map[string]string `json:"encryptionContext"`
EncryptedData []byte `json:"encryptedData"`
Nonce []byte `json:"nonce"` // Renamed from IV to be more explicit about AES-GCM usage
}
// encryptDataKey encrypts a data key using the master key with AES-GCM for authenticated encryption
func (p *LocalKMSProvider) encryptDataKey(dataKey []byte, masterKey *LocalKey, encryptionContext map[string]string) ([]byte, error) {
block, err := aes.NewCipher(masterKey.KeyMaterial)
if err != nil {
return nil, err
}
gcm, err := cipher.NewGCM(block)
if err != nil {
return nil, err
}
// Generate a random nonce
nonce := make([]byte, gcm.NonceSize())
if _, err := io.ReadFull(rand.Reader, nonce); err != nil {
return nil, err
}
// Prepare additional authenticated data (AAD) from the encryption context
// Use deterministic marshaling to ensure consistent AAD
var aad []byte
if len(encryptionContext) > 0 {
var err error
aad, err = marshalEncryptionContextDeterministic(encryptionContext)
if err != nil {
return nil, fmt.Errorf("failed to marshal encryption context for AAD: %w", err)
}
}
// Encrypt using AES-GCM
encryptedData := gcm.Seal(nil, nonce, dataKey, aad)
// Create metadata structure
metadata := &encryptedDataKeyMetadata{
KeyID: masterKey.KeyID,
EncryptionContext: encryptionContext,
EncryptedData: encryptedData,
Nonce: nonce,
}
// Serialize metadata to JSON
return json.Marshal(metadata)
}
// decryptDataKey decrypts a data key using the master key with AES-GCM for authenticated decryption
func (p *LocalKMSProvider) decryptDataKey(metadata *encryptedDataKeyMetadata, masterKey *LocalKey) ([]byte, error) {
block, err := aes.NewCipher(masterKey.KeyMaterial)
if err != nil {
return nil, err
}
gcm, err := cipher.NewGCM(block)
if err != nil {
return nil, err
}
// Prepare additional authenticated data (AAD)
var aad []byte
if len(metadata.EncryptionContext) > 0 {
var err error
aad, err = marshalEncryptionContextDeterministic(metadata.EncryptionContext)
if err != nil {
return nil, fmt.Errorf("failed to marshal encryption context for AAD: %w", err)
}
}
// Decrypt using AES-GCM
nonce := metadata.Nonce
if len(nonce) != gcm.NonceSize() {
return nil, fmt.Errorf("invalid nonce size: expected %d, got %d", gcm.NonceSize(), len(nonce))
}
dataKey, err := gcm.Open(nil, nonce, metadata.EncryptedData, aad)
if err != nil {
return nil, fmt.Errorf("failed to decrypt with GCM: %w", err)
}
return dataKey, nil
}
// parseEncryptedDataKey parses the encrypted data key blob
func (p *LocalKMSProvider) parseEncryptedDataKey(ciphertextBlob []byte) (*encryptedDataKeyMetadata, error) {
var metadata encryptedDataKeyMetadata
if err := json.Unmarshal(ciphertextBlob, &metadata); err != nil {
return nil, fmt.Errorf("failed to parse ciphertext blob: %v", err)
}
return &metadata, nil
}
// encryptionContextMatches checks if two encryption contexts match
func (p *LocalKMSProvider) encryptionContextMatches(ctx1, ctx2 map[string]string) bool {
if len(ctx1) != len(ctx2) {
return false
}
for k, v := range ctx1 {
if ctx2[k] != v {
return false
}
}
return true
}
// generateKeyID generates a random key ID
func generateKeyID() (string, error) {
// Generate a UUID-like key ID
b := make([]byte, 16)
if _, err := io.ReadFull(rand.Reader, b); err != nil {
return "", fmt.Errorf("failed to generate random bytes for key ID: %w", err)
}
return fmt.Sprintf("%08x-%04x-%04x-%04x-%012x",
b[0:4], b[4:6], b[6:8], b[8:10], b[10:16]), nil
}
// CreateKey creates a new key in the local KMS (for testing)
func (p *LocalKMSProvider) CreateKey(description string, aliases []string) (*LocalKey, error) {
keyID, err := generateKeyID()
if err != nil {
return nil, fmt.Errorf("failed to generate key ID: %w", err)
}
keyMaterial := make([]byte, 32)
if _, err := io.ReadFull(rand.Reader, keyMaterial); err != nil {
return nil, err
}
key := &LocalKey{
KeyID: keyID,
ARN: fmt.Sprintf("arn:aws:kms:local:000000000000:key/%s", keyID),
Description: description,
KeyMaterial: keyMaterial,
KeyUsage: kms.KeyUsageEncryptDecrypt,
KeyState: kms.KeyStateEnabled,
Origin: kms.KeyOriginLocal,
CreatedAt: time.Now(),
Aliases: aliases,
Metadata: make(map[string]string),
}
p.mu.Lock()
defer p.mu.Unlock()
p.keys[keyID] = key
for _, alias := range aliases {
// Ensure alias has proper format
if !strings.HasPrefix(alias, "alias/") {
alias = "alias/" + alias
}
p.keys[alias] = key
}
return key, nil
}
// CreateKeyWithID creates a key with a specific keyID (for testing only)
func (p *LocalKMSProvider) CreateKeyWithID(keyID, description string) (*LocalKey, error) {
keyMaterial := make([]byte, 32)
if _, err := io.ReadFull(rand.Reader, keyMaterial); err != nil {
return nil, fmt.Errorf("failed to generate key material: %w", err)
}
key := &LocalKey{
KeyID: keyID,
ARN: fmt.Sprintf("arn:aws:kms:local:000000000000:key/%s", keyID),
Description: description,
KeyMaterial: keyMaterial,
KeyUsage: kms.KeyUsageEncryptDecrypt,
KeyState: kms.KeyStateEnabled,
Origin: kms.KeyOriginLocal,
CreatedAt: time.Now(),
Aliases: []string{}, // No aliases by default
Metadata: make(map[string]string),
}
p.mu.Lock()
defer p.mu.Unlock()
// Register key with the exact keyID provided
p.keys[keyID] = key
return key, nil
}
// marshalEncryptionContextDeterministic creates a deterministic byte representation of encryption context
// This ensures that the same encryption context always produces the same AAD for AES-GCM
func marshalEncryptionContextDeterministic(encryptionContext map[string]string) ([]byte, error) {
if len(encryptionContext) == 0 {
return nil, nil
}
// Sort keys to ensure deterministic output
keys := make([]string, 0, len(encryptionContext))
for k := range encryptionContext {
keys = append(keys, k)
}
sort.Strings(keys)
// Build deterministic representation with proper JSON escaping
var buf strings.Builder
buf.WriteString("{")
for i, k := range keys {
if i > 0 {
buf.WriteString(",")
}
// Marshal key and value to get proper JSON string escaping
keyBytes, err := json.Marshal(k)
if err != nil {
return nil, fmt.Errorf("failed to marshal encryption context key '%s': %w", k, err)
}
valueBytes, err := json.Marshal(encryptionContext[k])
if err != nil {
return nil, fmt.Errorf("failed to marshal encryption context value for key '%s': %w", k, err)
}
buf.Write(keyBytes)
buf.WriteString(":")
buf.Write(valueBytes)
}
buf.WriteString("}")
return []byte(buf.String()), nil
}
|