mirror of
https://github.com/fleetdm/fleet
synced 2026-05-18 22:49:19 +00:00
Adds support for reading server `private_key` from AWS Secrets Manager. Combined with #31075, this should allow removing all common sensitive secrets from the environment/config (if I missed any let me know). This works with localstack for local development (set `AWS_ENDPOINT_URL=$LOCALSTACK_URL`, `AWS_ACCESS_KEY_ID=test`, and `AWS_SECRET_ACCESS_KEY=test`). I did not include config options for `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` because they are a bad practice vs role credentials and defeat the purpose of this feature which is to remove secrets from the environment/config. # Checklist for submitter If some of the following don't apply, delete the relevant line. <!-- Note that API documentation changes are now addressed by the product design team. --> - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files) for more information. - [x] Added/updated automated tests - [x] Manual QA for all new/changed functionality --------- Co-authored-by: Scott Gress <scott@fleetdm.com>
130 lines
4.3 KiB
Go
130 lines
4.3 KiB
Go
package config
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"math/rand"
|
|
"strings"
|
|
"time"
|
|
|
|
aws_config "github.com/aws/aws-sdk-go-v2/config"
|
|
"github.com/aws/aws-sdk-go-v2/service/secretsmanager"
|
|
"github.com/aws/aws-sdk-go-v2/service/secretsmanager/types"
|
|
"github.com/fleetdm/fleet/v4/server/aws_common"
|
|
)
|
|
|
|
// SecretsManagerClient interface for dependency injection and testing
|
|
type SecretsManagerClient interface {
|
|
GetSecretValue(ctx context.Context, params *secretsmanager.GetSecretValueInput,
|
|
optFns ...func(*secretsmanager.Options)) (*secretsmanager.GetSecretValueOutput, error)
|
|
}
|
|
|
|
// parseRegionFromSecretARN extracts the AWS region from a Secrets Manager ARN
|
|
func parseRegionFromSecretARN(arn string) (string, error) {
|
|
// ARN format: arn:aws:secretsmanager:region:account:secret:name
|
|
parts := strings.Split(arn, ":")
|
|
if len(parts) < 6 || parts[0] != "arn" || parts[1] != "aws" || parts[2] != "secretsmanager" {
|
|
return "", fmt.Errorf("invalid Secrets Manager ARN format: %s", arn)
|
|
}
|
|
|
|
region := parts[3]
|
|
if region == "" {
|
|
return "", fmt.Errorf("region not found in ARN: %s", arn)
|
|
}
|
|
|
|
return region, nil
|
|
}
|
|
|
|
// retrieveSecretWithRetry retrieves the secret from AWS with retry logic
|
|
func retrieveSecretWithRetry(ctx context.Context, client SecretsManagerClient, secretArn string) (string, error) {
|
|
const maxRetries = 3
|
|
var lastErr error
|
|
|
|
for attempt := 0; attempt < maxRetries; attempt++ {
|
|
if attempt > 0 {
|
|
// Exponential backoff with jitter: base 100ms with ±50% randomization
|
|
baseBackoff := time.Duration(100*(1<<uint(attempt-1))) * time.Millisecond // #nosec G115 - attempt is bounded by maxRetries
|
|
jitter := time.Duration(rand.Float64()*float64(baseBackoff)) - baseBackoff/2 // #nosec G404 - not security sensitive
|
|
backoff := baseBackoff + jitter
|
|
select {
|
|
case <-ctx.Done():
|
|
return "", ctx.Err()
|
|
case <-time.After(backoff):
|
|
}
|
|
}
|
|
|
|
input := &secretsmanager.GetSecretValueInput{
|
|
SecretId: &secretArn,
|
|
}
|
|
|
|
output, err := client.GetSecretValue(ctx, input)
|
|
if err != nil {
|
|
lastErr = err
|
|
|
|
// Don't retry certain errors
|
|
var notFoundErr *types.ResourceNotFoundException
|
|
var unauthorizedErr *types.InvalidRequestException
|
|
var invalidParamErr *types.InvalidParameterException
|
|
|
|
if errors.As(err, ¬FoundErr) {
|
|
return "", fmt.Errorf("secret not found: %s", secretArn)
|
|
}
|
|
if errors.As(err, &unauthorizedErr) {
|
|
return "", fmt.Errorf("access denied to secret: %s", secretArn)
|
|
}
|
|
if errors.As(err, &invalidParamErr) {
|
|
return "", fmt.Errorf("invalid secret ARN: %s", secretArn)
|
|
}
|
|
|
|
// Retry for other errors (network issues, throttling, etc.)
|
|
continue
|
|
}
|
|
|
|
// Extract secret value
|
|
if output.SecretString != nil {
|
|
return *output.SecretString, nil
|
|
}
|
|
|
|
if output.SecretBinary != nil {
|
|
return "", fmt.Errorf("secret %s contains binary data, expected string", secretArn)
|
|
}
|
|
|
|
return "", fmt.Errorf("secret %s contains no data", secretArn)
|
|
}
|
|
|
|
return "", fmt.Errorf("failed to retrieve secret after %d attempts: %w", maxRetries, lastErr)
|
|
}
|
|
|
|
// RetrieveSecretsManagerSecret retrieves a secret from AWS Secrets Manager
|
|
// with support for STS assume role authentication
|
|
func RetrieveSecretsManagerSecret(ctx context.Context, secretArn, assumeRoleArn, externalID string) (string, error) {
|
|
return RetrieveSecretsManagerSecretWithOptions(ctx, secretArn, assumeRoleArn, externalID)
|
|
}
|
|
|
|
// RetrieveSecretsManagerSecretWithOptions retrieves a secret from AWS Secrets Manager
|
|
// with custom AWS config options (useful for testing with LocalStack)
|
|
func RetrieveSecretsManagerSecretWithOptions(ctx context.Context, secretArn, assumeRoleArn, externalID string, opts ...func(*aws_config.LoadOptions) error) (string, error) {
|
|
region, err := parseRegionFromSecretARN(secretArn)
|
|
if err != nil {
|
|
return "", fmt.Errorf("invalid secret ARN: %w", err)
|
|
}
|
|
|
|
configOpts := []func(*aws_config.LoadOptions) error{aws_config.WithRegion(region)}
|
|
configOpts = append(configOpts, opts...)
|
|
cfg, err := aws_config.LoadDefaultConfig(ctx, configOpts...)
|
|
if err != nil {
|
|
return "", fmt.Errorf("failed to load AWS config: %w", err)
|
|
}
|
|
|
|
if assumeRoleArn != "" {
|
|
cfg, err = aws_common.ConfigureAssumeRoleProvider(cfg, nil, assumeRoleArn, externalID)
|
|
if err != nil {
|
|
return "", fmt.Errorf("failed to configure assume role: %w", err)
|
|
}
|
|
}
|
|
|
|
client := secretsmanager.NewFromConfig(cfg)
|
|
|
|
return retrieveSecretWithRetry(ctx, client, secretArn)
|
|
}
|