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
|
package aws
import (
"context"
"encoding/base64"
"fmt"
"net/http"
"strings"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/kms"
"github.com/seaweedfs/seaweedfs/weed/glog"
seaweedkms "github.com/seaweedfs/seaweedfs/weed/kms"
"github.com/seaweedfs/seaweedfs/weed/util"
)
func init() {
// Register the AWS KMS provider
seaweedkms.RegisterProvider("aws", NewAWSKMSProvider)
}
// AWSKMSProvider implements the KMSProvider interface using AWS KMS
type AWSKMSProvider struct {
client *kms.KMS
region string
endpoint string // For testing with LocalStack or custom endpoints
}
// AWSKMSConfig contains configuration for the AWS KMS provider
type AWSKMSConfig struct {
Region string `json:"region"` // AWS region (e.g., "us-east-1")
AccessKey string `json:"access_key"` // AWS access key (optional if using IAM roles)
SecretKey string `json:"secret_key"` // AWS secret key (optional if using IAM roles)
SessionToken string `json:"session_token"` // AWS session token (optional for STS)
Endpoint string `json:"endpoint"` // Custom endpoint (optional, for LocalStack/testing)
Profile string `json:"profile"` // AWS profile name (optional)
RoleARN string `json:"role_arn"` // IAM role ARN to assume (optional)
ExternalID string `json:"external_id"` // External ID for role assumption (optional)
ConnectTimeout int `json:"connect_timeout"` // Connection timeout in seconds (default: 10)
RequestTimeout int `json:"request_timeout"` // Request timeout in seconds (default: 30)
MaxRetries int `json:"max_retries"` // Maximum number of retries (default: 3)
}
// NewAWSKMSProvider creates a new AWS KMS provider
func NewAWSKMSProvider(config util.Configuration) (seaweedkms.KMSProvider, error) {
if config == nil {
return nil, fmt.Errorf("AWS KMS configuration is required")
}
// Extract configuration
region := config.GetString("region")
if region == "" {
region = "us-east-1" // Default region
}
accessKey := config.GetString("access_key")
secretKey := config.GetString("secret_key")
sessionToken := config.GetString("session_token")
endpoint := config.GetString("endpoint")
profile := config.GetString("profile")
// Timeouts and retries
connectTimeout := config.GetInt("connect_timeout")
if connectTimeout == 0 {
connectTimeout = 10 // Default 10 seconds
}
requestTimeout := config.GetInt("request_timeout")
if requestTimeout == 0 {
requestTimeout = 30 // Default 30 seconds
}
maxRetries := config.GetInt("max_retries")
if maxRetries == 0 {
maxRetries = 3 // Default 3 retries
}
// Create AWS session
awsConfig := &aws.Config{
Region: aws.String(region),
MaxRetries: aws.Int(maxRetries),
HTTPClient: &http.Client{
Timeout: time.Duration(requestTimeout) * time.Second,
},
}
// Set custom endpoint if provided (for testing with LocalStack)
if endpoint != "" {
awsConfig.Endpoint = aws.String(endpoint)
awsConfig.DisableSSL = aws.Bool(strings.HasPrefix(endpoint, "http://"))
}
// Configure credentials
if accessKey != "" && secretKey != "" {
awsConfig.Credentials = credentials.NewStaticCredentials(accessKey, secretKey, sessionToken)
} else if profile != "" {
awsConfig.Credentials = credentials.NewSharedCredentials("", profile)
}
// If neither are provided, use default credential chain (IAM roles, etc.)
sess, err := session.NewSession(awsConfig)
if err != nil {
return nil, fmt.Errorf("failed to create AWS session: %w", err)
}
provider := &AWSKMSProvider{
client: kms.New(sess),
region: region,
endpoint: endpoint,
}
glog.V(1).Infof("AWS KMS provider initialized for region %s", region)
return provider, nil
}
// GenerateDataKey generates a new data encryption key using AWS KMS
func (p *AWSKMSProvider) GenerateDataKey(ctx context.Context, req *seaweedkms.GenerateDataKeyRequest) (*seaweedkms.GenerateDataKeyResponse, error) {
if req == nil {
return nil, fmt.Errorf("GenerateDataKeyRequest cannot be nil")
}
if req.KeyID == "" {
return nil, fmt.Errorf("KeyID is required")
}
// Validate key spec
var keySpec string
switch req.KeySpec {
case seaweedkms.KeySpecAES256:
keySpec = "AES_256"
default:
return nil, fmt.Errorf("unsupported key spec: %s", req.KeySpec)
}
// Build KMS request
kmsReq := &kms.GenerateDataKeyInput{
KeyId: aws.String(req.KeyID),
KeySpec: aws.String(keySpec),
}
// Add encryption context if provided
if len(req.EncryptionContext) > 0 {
kmsReq.EncryptionContext = aws.StringMap(req.EncryptionContext)
}
// Call AWS KMS
glog.V(4).Infof("AWS KMS: Generating data key for key ID %s", req.KeyID)
result, err := p.client.GenerateDataKeyWithContext(ctx, kmsReq)
if err != nil {
return nil, p.convertAWSError(err, req.KeyID)
}
// Extract the actual key ID from the response (resolves aliases)
actualKeyID := ""
if result.KeyId != nil {
actualKeyID = *result.KeyId
}
// Create standardized envelope format for consistent API behavior
envelopeBlob, err := seaweedkms.CreateEnvelope("aws", actualKeyID, base64.StdEncoding.EncodeToString(result.CiphertextBlob), nil)
if err != nil {
return nil, fmt.Errorf("failed to create ciphertext envelope: %w", err)
}
response := &seaweedkms.GenerateDataKeyResponse{
KeyID: actualKeyID,
Plaintext: result.Plaintext,
CiphertextBlob: envelopeBlob, // Store in standardized envelope format
}
glog.V(4).Infof("AWS KMS: Generated data key for key ID %s (actual: %s)", req.KeyID, actualKeyID)
return response, nil
}
// Decrypt decrypts an encrypted data key using AWS KMS
func (p *AWSKMSProvider) Decrypt(ctx context.Context, req *seaweedkms.DecryptRequest) (*seaweedkms.DecryptResponse, error) {
if req == nil {
return nil, fmt.Errorf("DecryptRequest cannot be nil")
}
if len(req.CiphertextBlob) == 0 {
return nil, fmt.Errorf("CiphertextBlob cannot be empty")
}
// Parse the ciphertext envelope to extract key information
envelope, err := seaweedkms.ParseEnvelope(req.CiphertextBlob)
if err != nil {
return nil, fmt.Errorf("failed to parse ciphertext envelope: %w", err)
}
if envelope.Provider != "aws" {
return nil, fmt.Errorf("invalid provider in envelope: expected 'aws', got '%s'", envelope.Provider)
}
ciphertext, err := base64.StdEncoding.DecodeString(envelope.Ciphertext)
if err != nil {
return nil, fmt.Errorf("failed to decode ciphertext from envelope: %w", err)
}
// Build KMS request
kmsReq := &kms.DecryptInput{
CiphertextBlob: ciphertext,
}
// Add encryption context if provided
if len(req.EncryptionContext) > 0 {
kmsReq.EncryptionContext = aws.StringMap(req.EncryptionContext)
}
// Call AWS KMS
glog.V(4).Infof("AWS KMS: Decrypting data key (blob size: %d bytes)", len(req.CiphertextBlob))
result, err := p.client.DecryptWithContext(ctx, kmsReq)
if err != nil {
return nil, p.convertAWSError(err, "")
}
// Extract the key ID that was used for encryption
keyID := ""
if result.KeyId != nil {
keyID = *result.KeyId
}
response := &seaweedkms.DecryptResponse{
KeyID: keyID,
Plaintext: result.Plaintext,
}
glog.V(4).Infof("AWS KMS: Decrypted data key using key ID %s", keyID)
return response, nil
}
// DescribeKey validates that a key exists and returns its metadata
func (p *AWSKMSProvider) DescribeKey(ctx context.Context, req *seaweedkms.DescribeKeyRequest) (*seaweedkms.DescribeKeyResponse, error) {
if req == nil {
return nil, fmt.Errorf("DescribeKeyRequest cannot be nil")
}
if req.KeyID == "" {
return nil, fmt.Errorf("KeyID is required")
}
// Build KMS request
kmsReq := &kms.DescribeKeyInput{
KeyId: aws.String(req.KeyID),
}
// Call AWS KMS
glog.V(4).Infof("AWS KMS: Describing key %s", req.KeyID)
result, err := p.client.DescribeKeyWithContext(ctx, kmsReq)
if err != nil {
return nil, p.convertAWSError(err, req.KeyID)
}
if result.KeyMetadata == nil {
return nil, fmt.Errorf("no key metadata returned from AWS KMS")
}
metadata := result.KeyMetadata
response := &seaweedkms.DescribeKeyResponse{
KeyID: aws.StringValue(metadata.KeyId),
ARN: aws.StringValue(metadata.Arn),
Description: aws.StringValue(metadata.Description),
}
// Convert AWS key usage to our enum
if metadata.KeyUsage != nil {
switch *metadata.KeyUsage {
case "ENCRYPT_DECRYPT":
response.KeyUsage = seaweedkms.KeyUsageEncryptDecrypt
case "GENERATE_DATA_KEY":
response.KeyUsage = seaweedkms.KeyUsageGenerateDataKey
}
}
// Convert AWS key state to our enum
if metadata.KeyState != nil {
switch *metadata.KeyState {
case "Enabled":
response.KeyState = seaweedkms.KeyStateEnabled
case "Disabled":
response.KeyState = seaweedkms.KeyStateDisabled
case "PendingDeletion":
response.KeyState = seaweedkms.KeyStatePendingDeletion
case "Unavailable":
response.KeyState = seaweedkms.KeyStateUnavailable
}
}
// Convert AWS origin to our enum
if metadata.Origin != nil {
switch *metadata.Origin {
case "AWS_KMS":
response.Origin = seaweedkms.KeyOriginAWS
case "EXTERNAL":
response.Origin = seaweedkms.KeyOriginExternal
case "AWS_CLOUDHSM":
response.Origin = seaweedkms.KeyOriginCloudHSM
}
}
glog.V(4).Infof("AWS KMS: Described key %s (actual: %s, state: %s)", req.KeyID, response.KeyID, response.KeyState)
return response, nil
}
// GetKeyID resolves a key alias or ARN to the actual key ID
func (p *AWSKMSProvider) GetKeyID(ctx context.Context, keyIdentifier string) (string, error) {
if keyIdentifier == "" {
return "", fmt.Errorf("key identifier cannot be empty")
}
// Use DescribeKey to resolve the key identifier
descReq := &seaweedkms.DescribeKeyRequest{KeyID: keyIdentifier}
descResp, err := p.DescribeKey(ctx, descReq)
if err != nil {
return "", fmt.Errorf("failed to resolve key identifier %s: %w", keyIdentifier, err)
}
return descResp.KeyID, nil
}
// Close cleans up any resources used by the provider
func (p *AWSKMSProvider) Close() error {
// AWS SDK clients don't require explicit cleanup
glog.V(2).Infof("AWS KMS provider closed")
return nil
}
// convertAWSError converts AWS KMS errors to our standard KMS errors
func (p *AWSKMSProvider) convertAWSError(err error, keyID string) error {
if awsErr, ok := err.(awserr.Error); ok {
switch awsErr.Code() {
case "NotFoundException":
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeNotFoundException,
Message: awsErr.Message(),
KeyID: keyID,
}
case "DisabledException", "KeyUnavailableException":
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeKeyUnavailable,
Message: awsErr.Message(),
KeyID: keyID,
}
case "AccessDeniedException":
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeAccessDenied,
Message: awsErr.Message(),
KeyID: keyID,
}
case "InvalidKeyUsageException":
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeInvalidKeyUsage,
Message: awsErr.Message(),
KeyID: keyID,
}
case "InvalidCiphertextException":
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeInvalidCiphertext,
Message: awsErr.Message(),
KeyID: keyID,
}
case "KMSInternalException", "KMSInvalidStateException":
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeKMSInternalFailure,
Message: awsErr.Message(),
KeyID: keyID,
}
default:
// For unknown AWS errors, wrap them as internal failures
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeKMSInternalFailure,
Message: fmt.Sprintf("AWS KMS error %s: %s", awsErr.Code(), awsErr.Message()),
KeyID: keyID,
}
}
}
// For non-AWS errors (network issues, etc.), wrap as internal failure
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeKMSInternalFailure,
Message: fmt.Sprintf("AWS KMS provider error: %v", err),
KeyID: keyID,
}
}
|