Skip to content

fix: makes default token_url universe aware #1514

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

Merged
merged 3 commits into from
Apr 12, 2024
Merged

fix: makes default token_url universe aware #1514

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
03a04e2
fix: makes default token_url universe aware
aeitzman Apr 10, 2024
926d4e5
fix defaulting
aeitzman Apr 10, 2024
31fc39a
Merge branch 'main' into universe-domain-default
aeitzman Apr 12, 2024
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
8 changes: 6 additions & 2 deletions google/auth/external_account.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
# Cloud resource manager URL used to retrieve project information.
_CLOUD_RESOURCE_MANAGER = "https://cloudresourcemanager.googleapis.com/v1/projects/"
# Default Google sts token url.
_DEFAULT_TOKEN_URL = "https://sts.googleapis.com/v1/token"
_DEFAULT_TOKEN_URL = "https://sts.{universe_domain}/v1/token"


@dataclass
Expand Down Expand Up @@ -147,7 +147,12 @@ def __init__(
super(Credentials, self).__init__()
self._audience = audience
self._subject_token_type = subject_token_type
self._universe_domain = universe_domain or credentials.DEFAULT_UNIVERSE_DOMAIN
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this already available from the parent class?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The defaulting is, but it doesn't set the universe_domain from the constructor.

self._token_url = token_url
if self._token_url == _DEFAULT_TOKEN_URL:
self._token_url = self._token_url.replace(
"{universe_domain}", self._universe_domain
)
self._token_info_url = token_info_url
self._credential_source = credential_source
self._service_account_impersonation_url = service_account_impersonation_url
Expand All @@ -160,7 +165,6 @@ def __init__(
self._scopes = scopes
self._default_scopes = default_scopes
self._workforce_pool_user_project = workforce_pool_user_project
self._universe_domain = universe_domain or credentials.DEFAULT_UNIVERSE_DOMAIN
self._trust_boundary = {
"locations": [],
"encoded_locations": "0x0",
Expand Down
33 changes: 33 additions & 0 deletions tests/test_aws.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,39 @@ def test_service_account_impersonation_url_custom(self):
url + SERVICE_ACCOUNT_IMPERSONATION_URL_ROUTE
)

def test_info_with_default_token_url(self):
credentials = aws.Credentials(
audience=AUDIENCE,
subject_token_type=SUBJECT_TOKEN_TYPE,
credential_source=self.CREDENTIAL_SOURCE.copy(),
)

assert credentials.info == {
"type": "external_account",
"audience": AUDIENCE,
"subject_token_type": SUBJECT_TOKEN_TYPE,
"token_url": TOKEN_URL,
"credential_source": self.CREDENTIAL_SOURCE.copy(),
"universe_domain": DEFAULT_UNIVERSE_DOMAIN,
}

def test_info_with_default_token_url_with_universe_domain(self):
credentials = aws.Credentials(
audience=AUDIENCE,
subject_token_type=SUBJECT_TOKEN_TYPE,
credential_source=self.CREDENTIAL_SOURCE.copy(),
universe_domain="testdomain.org",
)

assert credentials.info == {
"type": "external_account",
"audience": AUDIENCE,
"subject_token_type": SUBJECT_TOKEN_TYPE,
"token_url": "https://sts.testdomain.org/v1/token",
"credential_source": self.CREDENTIAL_SOURCE.copy(),
"universe_domain": "testdomain.org",
}

def test_retrieve_subject_token_missing_region_url(self):
# When AWS_REGION envvar is not available, region_url is required for
# determining the current AWS region.
Expand Down
33 changes: 33 additions & 0 deletions tests/test_identity_pool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,6 +782,39 @@ def test_info_with_url_credential_source(self):
"universe_domain": DEFAULT_UNIVERSE_DOMAIN,
}

def test_info_with_default_token_url(self):
credentials = identity_pool.Credentials(
audience=AUDIENCE,
subject_token_type=SUBJECT_TOKEN_TYPE,
credential_source=self.CREDENTIAL_SOURCE_TEXT_URL.copy(),
)

assert credentials.info == {
"type": "external_account",
"audience": AUDIENCE,
"subject_token_type": SUBJECT_TOKEN_TYPE,
"token_url": TOKEN_URL,
"credential_source": self.CREDENTIAL_SOURCE_TEXT_URL,
"universe_domain": DEFAULT_UNIVERSE_DOMAIN,
}

def test_info_with_default_token_url_with_universe_domain(self):
credentials = identity_pool.Credentials(
audience=AUDIENCE,
subject_token_type=SUBJECT_TOKEN_TYPE,
credential_source=self.CREDENTIAL_SOURCE_TEXT_URL.copy(),
universe_domain="testdomain.org",
)

assert credentials.info == {
"type": "external_account",
"audience": AUDIENCE,
"subject_token_type": SUBJECT_TOKEN_TYPE,
"token_url": "https://sts.testdomain.org/v1/token",
"credential_source": self.CREDENTIAL_SOURCE_TEXT_URL,
"universe_domain": "testdomain.org",
}

def test_retrieve_subject_token_missing_subject_token(self, tmpdir):
# Provide empty text file.
empty_file = tmpdir.join("empty.txt")
Expand Down