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.

Sign up for GitHub

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

Jump to bottom

delay WebIdentityRoleOptions validation #2030

Merged
merged 2 commits into from
Mar 16, 2023
Merged

delay WebIdentityRoleOptions validation #2030

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
847c2d7
delay WebIdentityRoleOptions validation
aajtodd Feb 17, 2023
b83eb6f
fix RoleSessionName regression
aajtodd Feb 27, 2023
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
View file
Open in desktop
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"
]
}
31 changes: 21 additions & 10 deletions config/resolve_credentials.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,25 +384,36 @@ 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
},
}
var optFns []func(*stscreds.WebIdentityRoleOptions)

optFn, found, err := getWebIdentityCredentialProviderOptions(ctx, configs)
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,
RoleSessionName: sessionName,
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The opts value isn't passed to stscreds.NewWebIdentityRoleProvider, so the RoleSessionName set here is lost.

The original declaration of optFns should be restored, i.e.

optFns := []func(*stscreds.WebIdentityRoleOptions){
	func(options *stscreds.WebIdentityRoleOptions) {
		options.RoleSessionName = sessionName
	},
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I've restored the way RoleSessionName was being set.


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
63 changes: 63 additions & 0 deletions config/resolve_web_identity_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package config

import (
"context"
"fmt"
"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")

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

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

fmt.Println(config.Credentials)

})

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
View file
Open in desktop
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
View file
Open in desktop
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