-
Notifications
You must be signed in to change notification settings - Fork 174
feat(worker): add AWS IAM flags to worker command for RDS IAM auth #1557
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 4 commits
1803a71
3fcc7d8
69317ed
7bad67d
a108e42
a1132aa
15eb724
efb626c
b056c62
397188d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "context" | ||
| "database/sql/driver" | ||
| "fmt" | ||
| "net/url" | ||
|
|
||
|
NumaryBot marked this conversation as resolved.
Outdated
NumaryBot marked this conversation as resolved.
Outdated
|
||
| awsconfig "github.com/aws/aws-sdk-go-v2/config" | ||
| "github.com/aws/aws-sdk-go-v2/credentials/stscreds" | ||
| "github.com/aws/aws-sdk-go-v2/feature/rds/auth" | ||
| "github.com/aws/aws-sdk-go-v2/service/sts" | ||
| "github.com/formancehq/go-libs/v5/pkg/cloud/aws/iam" | ||
|
NumaryBot marked this conversation as resolved.
Outdated
|
||
| "github.com/formancehq/go-libs/v5/pkg/storage/bun/connect" | ||
| "github.com/jackc/pgx/v5" | ||
| "github.com/jackc/pgx/v5/stdlib" | ||
| "github.com/spf13/pflag" | ||
| "github.com/xo/dburl" | ||
| ) | ||
|
|
||
| // roleIAMConnector implements driver.Connector for AWS RDS IAM authentication | ||
| // under an assumed IAM role. A fresh RDS auth token (and, transparently, fresh | ||
| // STS role credentials) is obtained on every Connect call so that neither the | ||
| // 15-minute RDS token window nor the 1-hour STS session window can cause silent | ||
| // authentication failures after a long idle period. | ||
| type roleIAMConnector struct { | ||
| dsn string | ||
| region string | ||
| creds stscreds.AssumeRoleProvider | ||
| } | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
|
|
||
| // Connect obtains a short-lived RDS authentication token signed with the | ||
| // assumed-role credentials and uses it as the PostgreSQL password. | ||
| func (c *roleIAMConnector) Connect(ctx context.Context) (driver.Conn, error) { | ||
| u, err := dburl.Parse(c.dsn) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("aws: parsing postgres uri: %w", err) | ||
| } | ||
|
|
||
| authToken, err := auth.BuildAuthToken( | ||
| ctx, | ||
| u.Host, | ||
| c.region, | ||
| u.URL.User.Username(), | ||
| &c.creds, | ||
| ) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("aws: building rds iam auth token for assumed role: %w", err) | ||
| } | ||
|
|
||
| // Inject the auth token as the password in the DSN. | ||
| authedURL := u.URL | ||
| authedURL.User = url.UserPassword(u.URL.User.Username(), authToken) | ||
| authedDSN := authedURL.String() | ||
|
NumaryBot marked this conversation as resolved.
Outdated
|
||
|
|
||
| pgxCfg, err := pgx.ParseConfig(authedDSN) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("aws: parsing dsn with iam auth token: %w", err) | ||
| } | ||
|
|
||
| return stdlib.GetConnector(*pgxCfg).Connect(ctx) | ||
|
NumaryBot marked this conversation as resolved.
Outdated
|
||
| } | ||
|
|
||
| // Driver returns the underlying driver. database/sql calls this only when | ||
| // sql.DB.Driver() is invoked by callers, which is uncommon. | ||
| func (c *roleIAMConnector) Driver() driver.Driver { return &roleIAMDriver{} } | ||
|
|
||
| // roleIAMDriver satisfies driver.Driver so that roleIAMConnector.Driver() has a | ||
| // concrete, non-nil return value. | ||
| type roleIAMDriver struct{} | ||
|
|
||
| func (d *roleIAMDriver) Open(name string) (driver.Conn, error) { | ||
| return nil, fmt.Errorf("aws: roleIAMDriver.Open is not supported; use OpenConnector") | ||
| } | ||
|
|
||
| // connectionOptionsFromFlags is a drop-in replacement for | ||
| // connect.ConnectionOptionsFromFlags that additionally handles the | ||
| // --aws-role-arn flag. | ||
| // | ||
| // When --postgres-aws-enable-iam is true and --aws-role-arn is non-empty, the | ||
| // base AWS credentials loaded from the other IAM flags are wrapped with an STS | ||
| // AssumeRole provider. The RDS authentication token that is generated on every | ||
| // connection will therefore be signed by the assumed role's credentials rather | ||
| // than the caller's identity. | ||
| // | ||
| // In all other cases (IAM disabled, or no role ARN supplied) the function | ||
| // delegates directly to connect.ConnectionOptionsFromFlags, preserving | ||
| // identical behaviour. | ||
| func connectionOptionsFromFlags(flags *pflag.FlagSet, ctx context.Context) (*connect.ConnectionOptions, error) { | ||
| awsEnable, _ := flags.GetBool(connect.PostgresAWSEnableIAMFlag) | ||
| if !awsEnable { | ||
| return connect.ConnectionOptionsFromFlags(flags, ctx) | ||
| } | ||
|
|
||
| roleArn, _ := flags.GetString(iam.AWSRoleArnFlag) | ||
| if roleArn == "" { | ||
| // No role assumption requested; existing code path handles this. | ||
| return connect.ConnectionOptionsFromFlags(flags, ctx) | ||
| } | ||
|
|
||
| // Load the base AWS configuration from the remaining IAM flags | ||
| // (region, static credentials, profile, etc.). | ||
| cfg, err := awsconfig.LoadDefaultConfig(ctx, iam.LoadOptionFromFlags(flags)) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("aws: loading base aws config: %w", err) | ||
| } | ||
|
|
||
| // Wrap the base credentials with an STS AssumeRole provider. | ||
| // stscreds.AssumeRoleProvider caches the temporary credentials and refreshes | ||
| // them automatically before they expire, so callers do not need to manage | ||
| // the STS session lifetime explicitly. | ||
| stsClient := sts.NewFromConfig(cfg) | ||
|
NumaryBot marked this conversation as resolved.
Outdated
NumaryBot marked this conversation as resolved.
Outdated
NumaryBot marked this conversation as resolved.
Outdated
NumaryBot marked this conversation as resolved.
Outdated
|
||
| assumeRoleProvider := stscreds.NewAssumeRoleProvider(stsClient, roleArn) | ||
|
|
||
| postgresURI, _ := flags.GetString(connect.PostgresURIFlag) | ||
| if postgresURI == "" { | ||
| return nil, fmt.Errorf("aws: missing --%s", connect.PostgresURIFlag) | ||
| } | ||
|
|
||
| connector := &roleIAMConnector{ | ||
| dsn: postgresURI, | ||
| region: cfg.Region, | ||
| creds: *assumeRoleProvider, | ||
| } | ||
|
|
||
| maxIdleConns, _ := flags.GetInt(connect.PostgresMaxIdleConnsFlag) | ||
| connMaxIdleTime, _ := flags.GetDuration(connect.PostgresConnMaxIdleTimeFlag) | ||
| connMaxLifetime, _ := flags.GetDuration(connect.PostgresConnMaxLifetimeFlag) | ||
| maxOpenConns, _ := flags.GetInt(connect.PostgresMaxOpenConnsFlag) | ||
|
|
||
| return &connect.ConnectionOptions{ | ||
| DatabaseSourceName: postgresURI, | ||
| MaxIdleConns: maxIdleConns, | ||
| ConnMaxIdleTime: connMaxIdleTime, | ||
| ConnMaxLifetime: connMaxLifetime, | ||
| MaxOpenConns: maxOpenConns, | ||
| Connector: func(dsn string) (driver.Connector, error) { | ||
|
NumaryBot marked this conversation as resolved.
Outdated
NumaryBot marked this conversation as resolved.
Outdated
|
||
| return connector, nil | ||
| }, | ||
| }, nil | ||
| } | ||
|
|
||
|
NumaryBot marked this conversation as resolved.
Outdated
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,7 @@ import ( | |
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
|
|
||
| "github.com/formancehq/go-libs/v5/pkg/cloud/aws/iam" | ||
| "github.com/formancehq/go-libs/v5/pkg/fx/storagefx" | ||
| "github.com/formancehq/go-libs/v5/pkg/observe/metrics" | ||
| "github.com/formancehq/go-libs/v5/pkg/observe/traces" | ||
|
|
@@ -93,7 +94,7 @@ func NewWorkerCommand() *cobra.Command { | |
| Use: "worker", | ||
| SilenceUsage: true, | ||
| RunE: func(cmd *cobra.Command, _ []string) error { | ||
| connectionOptions, err := connect.ConnectionOptionsFromFlags(cmd.Flags(), cmd.Context()) | ||
| connectionOptions, err := connectionOptionsFromFlags(cmd.Flags(), cmd.Context()) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
@@ -132,6 +133,7 @@ func NewWorkerCommand() *cobra.Command { | |
| connect.AddFlags(cmd.Flags()) | ||
| metrics.AddFlags(cmd.Flags()) | ||
| traces.AddFlags(cmd.Flags()) | ||
| iam.AddFlags(cmd.Flags()) | ||
|
NumaryBot marked this conversation as resolved.
NumaryBot marked this conversation as resolved.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟠 [major] --aws-role-arn flag is registered but silently ignored in the Postgres IAM connection path The worker command registers --aws-role-arn (alongside --postgres-aws-enable-iam), but connect.ConnectionOptionsFromFlags loads AWS config via iam.LoadOptionFromFlags, which reads region/static keys/session/profile but not role ARN. A worker started with --postgres-aws-enable-iam --aws-role-arn will not assume the requested role; it silently falls back to the default/static credential chain. MarkHidden (if used) only hides the flag from help output — Cobra still parses and accepts it — so the no-op behaviour is invisible to operators. Suggestion: Either (a) make the connection path consume AWSRoleArnFlag by wrapping the loaded credentials with stscreds.NewAssumeRoleProvider + aws.NewCredentialsCache when the flag is non-empty, (b) do not register --aws-role-arn on the worker command at all until the underlying library supports it and document the limitation clearly, or (c) add an explicit pre-run validation that returns a clear error when --aws-role-arn is set alongside --postgres-aws-enable-iam so operators are not silently misled. |
||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/formancehq/go-libs/v5/pkg/cloud/aws/iam" | ||
| "github.com/formancehq/go-libs/v5/pkg/storage/bun/connect" | ||
| ) | ||
|
|
||
| // TestWorkerCommandHasAWSIAMFlags verifies that the worker command registers | ||
| // all required AWS IAM flags, so that users running the standalone worker binary | ||
| // (e.g. on AWS ECS Fargate) can configure RDS IAM auth for the primary store | ||
| // via CLI flags, not just via environment variables. | ||
| func TestWorkerCommandHasAWSIAMFlags(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| cmd := NewWorkerCommand() | ||
| flags := cmd.Flags() | ||
|
|
||
| // These flags come from connect.AddFlags and enable IAM on the primary store | ||
| t.Run("postgres-aws-enable-iam flag is registered", func(t *testing.T) { | ||
| t.Parallel() | ||
| f := flags.Lookup(connect.PostgresAWSEnableIAMFlag) | ||
| require.NotNil(t, f, "--postgres-aws-enable-iam flag must be registered on the worker command") | ||
| assert.Equal(t, "false", f.DefValue) | ||
| }) | ||
|
|
||
| // These flags come from iam.AddFlags (added to fix issue #1556). | ||
| t.Run("aws-region flag is registered", func(t *testing.T) { | ||
| t.Parallel() | ||
| f := flags.Lookup(iam.AWSRegionFlag) | ||
| require.NotNil(t, f, "--aws-region flag must be registered on the worker command") | ||
| }) | ||
|
|
||
| t.Run("aws-access-key-id flag is registered", func(t *testing.T) { | ||
| t.Parallel() | ||
| f := flags.Lookup(iam.AWSAccessKeyIDFlag) | ||
| require.NotNil(t, f, "--aws-access-key-id flag must be registered on the worker command") | ||
| }) | ||
|
|
||
| t.Run("aws-secret-access-key flag is registered", func(t *testing.T) { | ||
| t.Parallel() | ||
| f := flags.Lookup(iam.AWSSecretAccessKeyFlag) | ||
| require.NotNil(t, f, "--aws-secret-access-key flag must be registered on the worker command") | ||
| }) | ||
|
|
||
| t.Run("aws-session-token flag is registered", func(t *testing.T) { | ||
| t.Parallel() | ||
| f := flags.Lookup(iam.AWSSessionTokenFlag) | ||
| require.NotNil(t, f, "--aws-session-token flag must be registered on the worker command") | ||
| }) | ||
|
|
||
| t.Run("aws-profile flag is registered", func(t *testing.T) { | ||
| t.Parallel() | ||
| f := flags.Lookup(iam.AWSProfileFlag) | ||
| require.NotNil(t, f, "--aws-profile flag must be registered on the worker command") | ||
| }) | ||
|
|
||
| // --aws-role-arn is now fully supported: connectionOptionsFromFlags wraps | ||
| // the base AWS credentials with an STS AssumeRole provider when this flag | ||
| // is set, so the flag must be registered AND visible to operators. | ||
| t.Run("aws-role-arn flag is registered and visible", func(t *testing.T) { | ||
| t.Parallel() | ||
| f := flags.Lookup(iam.AWSRoleArnFlag) | ||
| require.NotNil(t, f, "--aws-role-arn flag must be registered on the worker command") | ||
| assert.False(t, f.Hidden, "--aws-role-arn must be visible now that role assumption is implemented") | ||
| }) | ||
| } | ||
|
|
||
| // TestServeCommandHasAWSIAMFlags verifies the serve command also exposes | ||
| // the same AWS IAM flags for parity (regression guard). | ||
| func TestServeCommandHasAWSIAMFlags(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| cmd := NewServeCommand() | ||
| flags := cmd.Flags() | ||
|
|
||
| // Verify the IAM-enable flag defaults to false on serve as well | ||
| f := flags.Lookup(connect.PostgresAWSEnableIAMFlag) | ||
| require.NotNil(t, f, "--postgres-aws-enable-iam flag must be registered on the serve command") | ||
| assert.Equal(t, "false", f.DefValue) | ||
|
|
||
| iamFlags := []string{ | ||
| connect.PostgresAWSEnableIAMFlag, | ||
| iam.AWSRegionFlag, | ||
| iam.AWSAccessKeyIDFlag, | ||
| iam.AWSSecretAccessKeyFlag, | ||
| iam.AWSSessionTokenFlag, | ||
| iam.AWSProfileFlag, | ||
| iam.AWSRoleArnFlag, | ||
| } | ||
|
|
||
| for _, flagName := range iamFlags { | ||
| t.Run(flagName+" is registered on serve", func(t *testing.T) { | ||
| t.Parallel() | ||
| f := flags.Lookup(flagName) | ||
| require.NotNil(t, f, "--%s flag must be registered on the serve command", flagName) | ||
| }) | ||
| } | ||
|
|
||
| // --aws-role-arn must be visible: connectionOptionsFromFlags implements role | ||
| // assumption via STS, so hiding it would mislead operators. | ||
| t.Run("aws-role-arn is visible on serve", func(t *testing.T) { | ||
| t.Parallel() | ||
| f := flags.Lookup(iam.AWSRoleArnFlag) | ||
| require.NotNil(t, f) | ||
| assert.False(t, f.Hidden, "--aws-role-arn must be visible now that role assumption is implemented") | ||
| }) | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.