Skip to content

Add handling for new grafana assume role keys #338

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add handling for new grafana assume role keys #338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 32 additions & 6 deletions pkg/awsauth/settings.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,16 @@ import (
)

const (
// awsTempCredsAccessKey and awsTempCredsSecretKey are the files containing the
awsTempCredsAccessKey = "/tmp/aws.credentials/access-key-id"
awsTempCredsSecretKey = "/tmp/aws.credentials/secret-access-key"
profileName = "assume_role_credentials"
// oldAwsTempCredsAccessKey and oldAwsTempCredsSecretKey are the files containing the keys for the old Grafana Assume Role implementation
oldAwsTempCredsAccessKey = "/tmp/aws.credentials/access-key-id"
oldAwsTempCredsSecretKey = "/tmp/aws.credentials/secret-access-key"

profileName = "assume_role_credentials"
)

// grafanaAssumeRoleKeysFolders are the folders for the keys for the Grafana Assume Role implementation
var grafanaAssumeRoleKeysFolders = []string{"aws-temp-credentials-1", "aws-temp-credentials-2"}

// Settings carries configuration for authenticating with AWS
type Settings struct {
AuthType AuthType
Expand Down Expand Up @@ -128,8 +132,30 @@ func (s Settings) WithSharedCredentials() LoadOptionsFunc {

// WithGrafanaAssumeRole returns a LoadOptionsFunc to initialize config for Grafana Assume Role
func (s Settings) WithGrafanaAssumeRole(ctx context.Context, client AWSAPIClient) LoadOptionsFunc {
accessKey, keyErr := os.ReadFile(awsTempCredsAccessKey)
secretKey, secretErr := os.ReadFile(awsTempCredsSecretKey)
// Iterate over the key folders until we get an active key
for _, folder := range grafanaAssumeRoleKeysFolders {
accessKeyFile := fmt.Sprintf("/tmp/%s/access-key-id", folder)
secretKeyFile := fmt.Sprintf("/tmp/%s/secret-access-key", folder)

accessKey, keyErr := os.ReadFile(accessKeyFile)
secretKey, secretErr := os.ReadFile(secretKeyFile)
if keyErr != nil || secretErr != nil {
continue
}

creds := client.NewStaticCredentialsProvider(string(accessKey), string(secretKey), "")
_, err := creds.Retrieve(ctx)
Copy link
Contributor

@njvrzm njvrzm Oct 3, 2025

Choose a reason for hiding this comment

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

Unfortunately this doesn't actually validate the credentials - you don't get an error regardless of what strings you pass in. We could validate them here by using GetCallerIdentity or the like, but that takes a nontrivial amount of time so we probably don't want to do it every time.

One approach would be to set a global to aws-temp-credentials-1 and use that when choosing keys, then in WithAssumeRole if we get an error indicating the credentials are invalid (have to check what that looks like) we switch the global to aws-temp-credentials-2 and retry (once).

// if the credentials are valid, return them. Otherwise try the next credentials folder
if err == nil {
return func(opts *config.LoadOptions) error {
opts.Credentials = creds
return nil
}
}
}

accessKey, keyErr := os.ReadFile(oldAwsTempCredsAccessKey)
secretKey, secretErr := os.ReadFile(oldAwsTempCredsSecretKey)
if keyErr == nil && secretErr == nil {
return func(opts *config.LoadOptions) error {
opts.Credentials = client.NewStaticCredentialsProvider(string(accessKey), string(secretKey), "")
Expand Down