Skip to content
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

delay WebIdentityRoleOptions validation #2030

Merged
merged 2 commits into from
Mar 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changelog/738653124e2a43e0ba6189b0d31764e7.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"id": "73865312-4e2a-43e0-ba61-89b0d31764e7",
"type": "bugfix",
"description": "Allow RoleARN to be set as functional option on STS WebIdentityRoleOptions. Fixes aws/aws-sdk-go-v2#2015.",
"modules": [
"config"
]
}
24 changes: 19 additions & 5 deletions config/resolve_credentials.go
Original file line number Diff line number Diff line change
Expand Up @@ -384,10 +384,6 @@ func assumeWebIdentity(ctx context.Context, cfg *aws.Config, filepath string, ro
return fmt.Errorf("token file path is not set")
}

if len(roleARN) == 0 {
return fmt.Errorf("role ARN is not set")
}

optFns := []func(*stscreds.WebIdentityRoleOptions){
func(options *stscreds.WebIdentityRoleOptions) {
options.RoleSessionName = sessionName
Expand All @@ -398,11 +394,29 @@ func assumeWebIdentity(ctx context.Context, cfg *aws.Config, filepath string, ro
if err != nil {
return err
}

if found {
optFns = append(optFns, optFn)
}

provider := stscreds.NewWebIdentityRoleProvider(sts.NewFromConfig(*cfg), roleARN, stscreds.IdentityTokenFile(filepath), optFns...)
opts := stscreds.WebIdentityRoleOptions{
RoleARN: roleARN,
}

for _, fn := range optFns {
fn(&opts)
}

if len(opts.RoleARN) == 0 {
return fmt.Errorf("role ARN is not set")
}

client := opts.Client
if client == nil {
client = sts.NewFromConfig(*cfg)
}

provider := stscreds.NewWebIdentityRoleProvider(client, roleARN, stscreds.IdentityTokenFile(filepath), optFns...)

cfg.Credentials = provider

Expand Down
59 changes: 59 additions & 0 deletions config/resolve_web_identity_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
package config

import (
"context"
"github.com/aws/aws-sdk-go-v2/credentials/stscreds"
"github.com/aws/aws-sdk-go-v2/internal/awstesting"
"os"
"path/filepath"
"runtime"
"strings"
"testing"
)

// see https://github.com/aws/aws-sdk-go-v2/issues/2015
func TestResolveWebIdentityWithOptions(t *testing.T) {

t.Run("token from env", func(t *testing.T) {
restoreEnv := initConfigTestEnv()
defer awstesting.PopEnv(restoreEnv)

var tokenFile = filepath.Join("testdata", "wit.txt")
os.Setenv("AWS_WEB_IDENTITY_TOKEN_FILE", tokenFile)
os.Setenv("AWS_REGION", "us-east-1")

_, err := LoadDefaultConfig(context.Background(),
WithWebIdentityRoleCredentialOptions(func(options *stscreds.WebIdentityRoleOptions) {
options.RoleARN = "test-arn"
}),
)

if err != nil {
t.Fatalf("expect no error, got %v", err)
}
})

t.Run("token from profile", func(t *testing.T) {
// profile is still required to fully specify web identity properties for consistency with other SDKs/SEP
restoreEnv := initConfigTestEnv()
defer awstesting.PopEnv(restoreEnv)

var configFileForWindows = filepath.Join("testdata", "config_source_shared_for_windows")
var configFile = filepath.Join("testdata", "config_source_shared")

os.Setenv("AWS_REGION", "us-east-1")
os.Setenv("AWS_PROFILE", "webident-partial")

if runtime.GOOS == "windows" {
os.Setenv("AWS_CONFIG_FILE", configFileForWindows)
} else {
os.Setenv("AWS_CONFIG_FILE", configFile)
}

_, err := LoadDefaultConfig(context.Background())

if err == nil || !strings.Contains(err.Error(), "web_identity_token_file requires role_arn") {
t.Fatalf("expected profile parsing error, got %v", err)
}
})
}
3 changes: 3 additions & 0 deletions config/testdata/config_source_shared
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,6 @@ sso_region = us-west-2
[profile webident]
web_identity_token_file = ./testdata/wit.txt
role_arn = webident_arn

[profile webident-partial]
web_identity_token_file = ./testdata/wit.txt
3 changes: 3 additions & 0 deletions config/testdata/config_source_shared_for_windows
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ sso_start_url = https://127.0.0.1/start
[profile webident]
web_identity_token_file = .\testdata\wit.txt
role_arn = webident_arn

[profile webident-partial]
web_identity_token_file = .\testdata\wit.txt