123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849 |
- # Copyright 2016 Google LLC
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing, software
- # distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions and
- # limitations under the License.
- import datetime
- import json
- import os
- import mock
- import pytest # type: ignore
- from google.auth import _helpers
- from google.auth import crypt
- from google.auth import exceptions
- from google.auth import iam
- from google.auth import jwt
- from google.auth import transport
- from google.auth.credentials import DEFAULT_UNIVERSE_DOMAIN
- from google.oauth2 import service_account
- import yatest.common as yc
- DATA_DIR = os.path.join(os.path.dirname(yc.source_path(__file__)), "..", "data")
- with open(os.path.join(DATA_DIR, "privatekey.pem"), "rb") as fh:
- PRIVATE_KEY_BYTES = fh.read()
- with open(os.path.join(DATA_DIR, "public_cert.pem"), "rb") as fh:
- PUBLIC_CERT_BYTES = fh.read()
- with open(os.path.join(DATA_DIR, "other_cert.pem"), "rb") as fh:
- OTHER_CERT_BYTES = fh.read()
- SERVICE_ACCOUNT_JSON_FILE = os.path.join(DATA_DIR, "service_account.json")
- SERVICE_ACCOUNT_NON_GDU_JSON_FILE = os.path.join(
- DATA_DIR, "service_account_non_gdu.json"
- )
- FAKE_UNIVERSE_DOMAIN = "universe.foo"
- with open(SERVICE_ACCOUNT_JSON_FILE, "rb") as fh:
- SERVICE_ACCOUNT_INFO = json.load(fh)
- with open(SERVICE_ACCOUNT_NON_GDU_JSON_FILE, "rb") as fh:
- SERVICE_ACCOUNT_INFO_NON_GDU = json.load(fh)
- SIGNER = crypt.RSASigner.from_string(PRIVATE_KEY_BYTES, "1")
- class TestCredentials(object):
- SERVICE_ACCOUNT_EMAIL = "service-account@example.com"
- TOKEN_URI = "https://example.com/oauth2/token"
- @classmethod
- def make_credentials(cls, universe_domain=DEFAULT_UNIVERSE_DOMAIN):
- return service_account.Credentials(
- SIGNER,
- cls.SERVICE_ACCOUNT_EMAIL,
- cls.TOKEN_URI,
- universe_domain=universe_domain,
- )
- def test_get_cred_info(self):
- credentials = self.make_credentials()
- assert not credentials.get_cred_info()
- credentials._cred_file_path = "/path/to/file"
- assert credentials.get_cred_info() == {
- "credential_source": "/path/to/file",
- "credential_type": "service account credentials",
- "principal": "service-account@example.com",
- }
- def test__make_copy_get_cred_info(self):
- credentials = self.make_credentials()
- credentials._cred_file_path = "/path/to/file"
- cred_copy = credentials._make_copy()
- assert cred_copy._cred_file_path == "/path/to/file"
- def test_constructor_no_universe_domain(self):
- credentials = service_account.Credentials(
- SIGNER, self.SERVICE_ACCOUNT_EMAIL, self.TOKEN_URI, universe_domain=None
- )
- assert credentials.universe_domain == DEFAULT_UNIVERSE_DOMAIN
- def test_from_service_account_info(self):
- credentials = service_account.Credentials.from_service_account_info(
- SERVICE_ACCOUNT_INFO
- )
- assert credentials._signer.key_id == SERVICE_ACCOUNT_INFO["private_key_id"]
- assert credentials.service_account_email == SERVICE_ACCOUNT_INFO["client_email"]
- assert credentials._token_uri == SERVICE_ACCOUNT_INFO["token_uri"]
- assert credentials._universe_domain == DEFAULT_UNIVERSE_DOMAIN
- assert not credentials._always_use_jwt_access
- def test_from_service_account_info_non_gdu(self):
- credentials = service_account.Credentials.from_service_account_info(
- SERVICE_ACCOUNT_INFO_NON_GDU
- )
- assert credentials.universe_domain == FAKE_UNIVERSE_DOMAIN
- assert credentials._always_use_jwt_access
- def test_from_service_account_info_args(self):
- info = SERVICE_ACCOUNT_INFO.copy()
- scopes = ["email", "profile"]
- subject = "subject"
- additional_claims = {"meta": "data"}
- credentials = service_account.Credentials.from_service_account_info(
- info, scopes=scopes, subject=subject, additional_claims=additional_claims
- )
- assert credentials.service_account_email == info["client_email"]
- assert credentials.project_id == info["project_id"]
- assert credentials._signer.key_id == info["private_key_id"]
- assert credentials._token_uri == info["token_uri"]
- assert credentials._scopes == scopes
- assert credentials._subject == subject
- assert credentials._additional_claims == additional_claims
- assert not credentials._always_use_jwt_access
- def test_from_service_account_file(self):
- info = SERVICE_ACCOUNT_INFO.copy()
- credentials = service_account.Credentials.from_service_account_file(
- SERVICE_ACCOUNT_JSON_FILE
- )
- assert credentials.service_account_email == info["client_email"]
- assert credentials.project_id == info["project_id"]
- assert credentials._signer.key_id == info["private_key_id"]
- assert credentials._token_uri == info["token_uri"]
- def test_from_service_account_file_non_gdu(self):
- info = SERVICE_ACCOUNT_INFO_NON_GDU.copy()
- credentials = service_account.Credentials.from_service_account_file(
- SERVICE_ACCOUNT_NON_GDU_JSON_FILE
- )
- assert credentials.service_account_email == info["client_email"]
- assert credentials.project_id == info["project_id"]
- assert credentials._signer.key_id == info["private_key_id"]
- assert credentials._token_uri == info["token_uri"]
- assert credentials._universe_domain == FAKE_UNIVERSE_DOMAIN
- assert credentials._always_use_jwt_access
- def test_from_service_account_file_args(self):
- info = SERVICE_ACCOUNT_INFO.copy()
- scopes = ["email", "profile"]
- subject = "subject"
- additional_claims = {"meta": "data"}
- credentials = service_account.Credentials.from_service_account_file(
- SERVICE_ACCOUNT_JSON_FILE,
- subject=subject,
- scopes=scopes,
- additional_claims=additional_claims,
- )
- assert credentials.service_account_email == info["client_email"]
- assert credentials.project_id == info["project_id"]
- assert credentials._signer.key_id == info["private_key_id"]
- assert credentials._token_uri == info["token_uri"]
- assert credentials._scopes == scopes
- assert credentials._subject == subject
- assert credentials._additional_claims == additional_claims
- def test_default_state(self):
- credentials = self.make_credentials()
- assert not credentials.valid
- # Expiration hasn't been set yet
- assert not credentials.expired
- # Scopes haven't been specified yet
- assert credentials.requires_scopes
- def test_sign_bytes(self):
- credentials = self.make_credentials()
- to_sign = b"123"
- signature = credentials.sign_bytes(to_sign)
- assert crypt.verify_signature(to_sign, signature, PUBLIC_CERT_BYTES)
- def test_signer(self):
- credentials = self.make_credentials()
- assert isinstance(credentials.signer, crypt.Signer)
- def test_signer_email(self):
- credentials = self.make_credentials()
- assert credentials.signer_email == self.SERVICE_ACCOUNT_EMAIL
- def test_create_scoped(self):
- credentials = self.make_credentials()
- scopes = ["email", "profile"]
- credentials = credentials.with_scopes(scopes)
- assert credentials._scopes == scopes
- def test_with_claims(self):
- credentials = self.make_credentials()
- new_credentials = credentials.with_claims({"meep": "moop"})
- assert new_credentials._additional_claims == {"meep": "moop"}
- def test_with_quota_project(self):
- credentials = self.make_credentials()
- new_credentials = credentials.with_quota_project("new-project-456")
- assert new_credentials.quota_project_id == "new-project-456"
- hdrs = {}
- new_credentials.apply(hdrs, token="tok")
- assert "x-goog-user-project" in hdrs
- def test_with_token_uri(self):
- credentials = self.make_credentials()
- new_token_uri = "https://example2.com/oauth2/token"
- assert credentials._token_uri == self.TOKEN_URI
- creds_with_new_token_uri = credentials.with_token_uri(new_token_uri)
- assert creds_with_new_token_uri._token_uri == new_token_uri
- def test_with_universe_domain(self):
- credentials = self.make_credentials()
- new_credentials = credentials.with_universe_domain("dummy_universe.com")
- assert new_credentials.universe_domain == "dummy_universe.com"
- assert new_credentials._always_use_jwt_access
- new_credentials = credentials.with_universe_domain("googleapis.com")
- assert new_credentials.universe_domain == "googleapis.com"
- assert not new_credentials._always_use_jwt_access
- def test__with_always_use_jwt_access(self):
- credentials = self.make_credentials()
- assert not credentials._always_use_jwt_access
- new_credentials = credentials.with_always_use_jwt_access(True)
- assert new_credentials._always_use_jwt_access
- def test__with_always_use_jwt_access_non_default_universe_domain(self):
- credentials = self.make_credentials(universe_domain=FAKE_UNIVERSE_DOMAIN)
- with pytest.raises(exceptions.InvalidValue) as excinfo:
- credentials.with_always_use_jwt_access(False)
- assert excinfo.match(
- "always_use_jwt_access should be True for non-default universe domain"
- )
- def test__make_authorization_grant_assertion(self):
- credentials = self.make_credentials()
- token = credentials._make_authorization_grant_assertion()
- payload = jwt.decode(token, PUBLIC_CERT_BYTES)
- assert payload["iss"] == self.SERVICE_ACCOUNT_EMAIL
- assert payload["aud"] == service_account._GOOGLE_OAUTH2_TOKEN_ENDPOINT
- def test__make_authorization_grant_assertion_scoped(self):
- credentials = self.make_credentials()
- scopes = ["email", "profile"]
- credentials = credentials.with_scopes(scopes)
- token = credentials._make_authorization_grant_assertion()
- payload = jwt.decode(token, PUBLIC_CERT_BYTES)
- assert payload["scope"] == "email profile"
- def test__make_authorization_grant_assertion_subject(self):
- credentials = self.make_credentials()
- subject = "user@example.com"
- credentials = credentials.with_subject(subject)
- token = credentials._make_authorization_grant_assertion()
- payload = jwt.decode(token, PUBLIC_CERT_BYTES)
- assert payload["sub"] == subject
- def test_apply_with_quota_project_id(self):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- quota_project_id="quota-project-123",
- )
- headers = {}
- credentials.apply(headers, token="token")
- assert headers["x-goog-user-project"] == "quota-project-123"
- assert "token" in headers["authorization"]
- def test_apply_with_no_quota_project_id(self):
- credentials = service_account.Credentials(
- SIGNER, self.SERVICE_ACCOUNT_EMAIL, self.TOKEN_URI
- )
- headers = {}
- credentials.apply(headers, token="token")
- assert "x-goog-user-project" not in headers
- assert "token" in headers["authorization"]
- @mock.patch("google.auth.jwt.Credentials", instance=True, autospec=True)
- def test__create_self_signed_jwt(self, jwt):
- credentials = service_account.Credentials(
- SIGNER, self.SERVICE_ACCOUNT_EMAIL, self.TOKEN_URI
- )
- audience = "https://pubsub.googleapis.com"
- credentials._create_self_signed_jwt(audience)
- jwt.from_signing_credentials.assert_called_once_with(credentials, audience)
- @mock.patch("google.auth.jwt.Credentials", instance=True, autospec=True)
- def test__create_self_signed_jwt_with_user_scopes(self, jwt):
- credentials = service_account.Credentials(
- SIGNER, self.SERVICE_ACCOUNT_EMAIL, self.TOKEN_URI, scopes=["foo"]
- )
- audience = "https://pubsub.googleapis.com"
- credentials._create_self_signed_jwt(audience)
- # JWT should not be created if there are user-defined scopes
- jwt.from_signing_credentials.assert_not_called()
- @mock.patch("google.auth.jwt.Credentials", instance=True, autospec=True)
- def test__create_self_signed_jwt_always_use_jwt_access_with_audience(self, jwt):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- default_scopes=["bar", "foo"],
- always_use_jwt_access=True,
- )
- audience = "https://pubsub.googleapis.com"
- credentials._create_self_signed_jwt(audience)
- jwt.from_signing_credentials.assert_called_once_with(credentials, audience)
- @mock.patch("google.auth.jwt.Credentials", instance=True, autospec=True)
- def test__create_self_signed_jwt_always_use_jwt_access_with_audience_similar_jwt_is_reused(
- self, jwt
- ):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- default_scopes=["bar", "foo"],
- always_use_jwt_access=True,
- )
- audience = "https://pubsub.googleapis.com"
- credentials._create_self_signed_jwt(audience)
- credentials._jwt_credentials._audience = audience
- credentials._create_self_signed_jwt(audience)
- jwt.from_signing_credentials.assert_called_once_with(credentials, audience)
- @mock.patch("google.auth.jwt.Credentials", instance=True, autospec=True)
- def test__create_self_signed_jwt_always_use_jwt_access_with_scopes(self, jwt):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- scopes=["bar", "foo"],
- always_use_jwt_access=True,
- )
- audience = "https://pubsub.googleapis.com"
- credentials._create_self_signed_jwt(audience)
- jwt.from_signing_credentials.assert_called_once_with(
- credentials, None, additional_claims={"scope": "bar foo"}
- )
- @mock.patch("google.auth.jwt.Credentials", instance=True, autospec=True)
- def test__create_self_signed_jwt_always_use_jwt_access_with_scopes_similar_jwt_is_reused(
- self, jwt
- ):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- scopes=["bar", "foo"],
- always_use_jwt_access=True,
- )
- audience = "https://pubsub.googleapis.com"
- credentials._create_self_signed_jwt(audience)
- credentials._jwt_credentials.additional_claims = {"scope": "bar foo"}
- credentials._create_self_signed_jwt(audience)
- jwt.from_signing_credentials.assert_called_once_with(
- credentials, None, additional_claims={"scope": "bar foo"}
- )
- @mock.patch("google.auth.jwt.Credentials", instance=True, autospec=True)
- def test__create_self_signed_jwt_always_use_jwt_access_with_default_scopes(
- self, jwt
- ):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- default_scopes=["bar", "foo"],
- always_use_jwt_access=True,
- )
- credentials._create_self_signed_jwt(None)
- jwt.from_signing_credentials.assert_called_once_with(
- credentials, None, additional_claims={"scope": "bar foo"}
- )
- @mock.patch("google.auth.jwt.Credentials", instance=True, autospec=True)
- def test__create_self_signed_jwt_always_use_jwt_access_with_default_scopes_similar_jwt_is_reused(
- self, jwt
- ):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- default_scopes=["bar", "foo"],
- always_use_jwt_access=True,
- )
- credentials._create_self_signed_jwt(None)
- credentials._jwt_credentials.additional_claims = {"scope": "bar foo"}
- credentials._create_self_signed_jwt(None)
- jwt.from_signing_credentials.assert_called_once_with(
- credentials, None, additional_claims={"scope": "bar foo"}
- )
- @mock.patch("google.auth.jwt.Credentials", instance=True, autospec=True)
- def test__create_self_signed_jwt_always_use_jwt_access(self, jwt):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- always_use_jwt_access=True,
- )
- credentials._create_self_signed_jwt(None)
- jwt.from_signing_credentials.assert_not_called()
- def test_token_usage_metrics_assertion(self):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- always_use_jwt_access=False,
- )
- credentials.token = "token"
- credentials.expiry = None
- headers = {}
- credentials.before_request(mock.Mock(), None, None, headers)
- assert headers["authorization"] == "Bearer token"
- assert headers["x-goog-api-client"] == "cred-type/sa"
- def test_token_usage_metrics_self_signed_jwt(self):
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- always_use_jwt_access=True,
- )
- credentials._create_self_signed_jwt("foo.googleapis.com")
- credentials.token = "token"
- credentials.expiry = None
- headers = {}
- credentials.before_request(mock.Mock(), None, None, headers)
- assert headers["authorization"] == "Bearer token"
- assert headers["x-goog-api-client"] == "cred-type/jwt"
- @mock.patch("google.oauth2._client.jwt_grant", autospec=True)
- def test_refresh_success(self, jwt_grant):
- credentials = self.make_credentials()
- token = "token"
- jwt_grant.return_value = (
- token,
- _helpers.utcnow() + datetime.timedelta(seconds=500),
- {},
- )
- request = mock.create_autospec(transport.Request, instance=True)
- # Refresh credentials
- credentials.refresh(request)
- # Check jwt grant call.
- assert jwt_grant.called
- called_request, token_uri, assertion = jwt_grant.call_args[0]
- assert called_request == request
- assert token_uri == credentials._token_uri
- assert jwt.decode(assertion, PUBLIC_CERT_BYTES)
- # No further assertion done on the token, as there are separate tests
- # for checking the authorization grant assertion.
- # Check that the credentials have the token.
- assert credentials.token == token
- # Check that the credentials are valid (have a token and are not
- # expired)
- assert credentials.valid
- @mock.patch("google.oauth2._client.jwt_grant", autospec=True)
- def test_before_request_refreshes(self, jwt_grant):
- credentials = self.make_credentials()
- token = "token"
- jwt_grant.return_value = (
- token,
- _helpers.utcnow() + datetime.timedelta(seconds=500),
- None,
- )
- request = mock.create_autospec(transport.Request, instance=True)
- # Credentials should start as invalid
- assert not credentials.valid
- # before_request should cause a refresh
- credentials.before_request(request, "GET", "http://example.com?a=1#3", {})
- # The refresh endpoint should've been called.
- assert jwt_grant.called
- # Credentials should now be valid.
- assert credentials.valid
- @mock.patch("google.auth.jwt.Credentials._make_jwt")
- def test_refresh_with_jwt_credentials(self, make_jwt):
- credentials = self.make_credentials()
- credentials._create_self_signed_jwt("https://pubsub.googleapis.com")
- request = mock.create_autospec(transport.Request, instance=True)
- token = "token"
- expiry = _helpers.utcnow() + datetime.timedelta(seconds=500)
- make_jwt.return_value = (b"token", expiry)
- # Credentials should start as invalid
- assert not credentials.valid
- # before_request should cause a refresh
- credentials.before_request(request, "GET", "http://example.com?a=1#3", {})
- # Credentials should now be valid.
- assert credentials.valid
- # Assert make_jwt was called
- assert make_jwt.call_count == 1
- assert credentials.token == token
- assert credentials.expiry == expiry
- def test_refresh_with_jwt_credentials_token_type_check(self):
- credentials = self.make_credentials()
- credentials._create_self_signed_jwt("https://pubsub.googleapis.com")
- credentials.refresh(mock.Mock())
- # Credentials token should be a JWT string.
- assert isinstance(credentials.token, str)
- payload = jwt.decode(credentials.token, verify=False)
- assert payload["aud"] == "https://pubsub.googleapis.com"
- @mock.patch("google.oauth2._client.jwt_grant", autospec=True)
- @mock.patch("google.auth.jwt.Credentials.refresh", autospec=True)
- def test_refresh_jwt_not_used_for_domain_wide_delegation(
- self, self_signed_jwt_refresh, jwt_grant
- ):
- # Create a domain wide delegation credentials by setting the subject.
- credentials = service_account.Credentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- always_use_jwt_access=True,
- subject="subject",
- )
- credentials._create_self_signed_jwt("https://pubsub.googleapis.com")
- jwt_grant.return_value = (
- "token",
- _helpers.utcnow() + datetime.timedelta(seconds=500),
- {},
- )
- request = mock.create_autospec(transport.Request, instance=True)
- # Refresh credentials
- credentials.refresh(request)
- # Make sure we are using jwt_grant and not self signed JWT refresh
- # method to obtain the token.
- assert jwt_grant.called
- assert not self_signed_jwt_refresh.called
- def test_refresh_missing_jwt_credentials(self):
- credentials = self.make_credentials()
- credentials = credentials.with_scopes(["foo", "bar"])
- credentials = credentials.with_always_use_jwt_access(True)
- assert not credentials._jwt_credentials
- credentials.refresh(mock.Mock())
- # jwt credentials should have been automatically created with scopes
- assert credentials._jwt_credentials is not None
- def test_refresh_non_gdu_domain_wide_delegation_not_supported(self):
- credentials = self.make_credentials(universe_domain="foo")
- credentials._subject = "bar@example.com"
- credentials._create_self_signed_jwt("https://pubsub.googleapis.com")
- with pytest.raises(exceptions.RefreshError) as excinfo:
- credentials.refresh(None)
- assert excinfo.match("domain wide delegation is not supported")
- class TestIDTokenCredentials(object):
- SERVICE_ACCOUNT_EMAIL = "service-account@example.com"
- TOKEN_URI = "https://example.com/oauth2/token"
- TARGET_AUDIENCE = "https://example.com"
- @classmethod
- def make_credentials(cls, universe_domain=DEFAULT_UNIVERSE_DOMAIN):
- return service_account.IDTokenCredentials(
- SIGNER,
- cls.SERVICE_ACCOUNT_EMAIL,
- cls.TOKEN_URI,
- cls.TARGET_AUDIENCE,
- universe_domain=universe_domain,
- )
- def test_constructor_no_universe_domain(self):
- credentials = service_account.IDTokenCredentials(
- SIGNER,
- self.SERVICE_ACCOUNT_EMAIL,
- self.TOKEN_URI,
- self.TARGET_AUDIENCE,
- universe_domain=None,
- )
- assert credentials._universe_domain == DEFAULT_UNIVERSE_DOMAIN
- def test_from_service_account_info(self):
- credentials = service_account.IDTokenCredentials.from_service_account_info(
- SERVICE_ACCOUNT_INFO, target_audience=self.TARGET_AUDIENCE
- )
- assert credentials._signer.key_id == SERVICE_ACCOUNT_INFO["private_key_id"]
- assert credentials.service_account_email == SERVICE_ACCOUNT_INFO["client_email"]
- assert credentials._token_uri == SERVICE_ACCOUNT_INFO["token_uri"]
- assert credentials._target_audience == self.TARGET_AUDIENCE
- assert not credentials._use_iam_endpoint
- def test_from_service_account_info_non_gdu(self):
- credentials = service_account.IDTokenCredentials.from_service_account_info(
- SERVICE_ACCOUNT_INFO_NON_GDU, target_audience=self.TARGET_AUDIENCE
- )
- assert (
- credentials._signer.key_id == SERVICE_ACCOUNT_INFO_NON_GDU["private_key_id"]
- )
- assert (
- credentials.service_account_email
- == SERVICE_ACCOUNT_INFO_NON_GDU["client_email"]
- )
- assert credentials._token_uri == SERVICE_ACCOUNT_INFO_NON_GDU["token_uri"]
- assert credentials._target_audience == self.TARGET_AUDIENCE
- assert credentials._use_iam_endpoint
- def test_from_service_account_file(self):
- info = SERVICE_ACCOUNT_INFO.copy()
- credentials = service_account.IDTokenCredentials.from_service_account_file(
- SERVICE_ACCOUNT_JSON_FILE, target_audience=self.TARGET_AUDIENCE
- )
- assert credentials.service_account_email == info["client_email"]
- assert credentials._signer.key_id == info["private_key_id"]
- assert credentials._token_uri == info["token_uri"]
- assert credentials._target_audience == self.TARGET_AUDIENCE
- assert not credentials._use_iam_endpoint
- def test_from_service_account_file_non_gdu(self):
- info = SERVICE_ACCOUNT_INFO_NON_GDU.copy()
- credentials = service_account.IDTokenCredentials.from_service_account_file(
- SERVICE_ACCOUNT_NON_GDU_JSON_FILE, target_audience=self.TARGET_AUDIENCE
- )
- assert credentials.service_account_email == info["client_email"]
- assert credentials._signer.key_id == info["private_key_id"]
- assert credentials._token_uri == info["token_uri"]
- assert credentials._target_audience == self.TARGET_AUDIENCE
- assert credentials._use_iam_endpoint
- def test_default_state(self):
- credentials = self.make_credentials()
- assert not credentials.valid
- # Expiration hasn't been set yet
- assert not credentials.expired
- def test_sign_bytes(self):
- credentials = self.make_credentials()
- to_sign = b"123"
- signature = credentials.sign_bytes(to_sign)
- assert crypt.verify_signature(to_sign, signature, PUBLIC_CERT_BYTES)
- def test_signer(self):
- credentials = self.make_credentials()
- assert isinstance(credentials.signer, crypt.Signer)
- def test_signer_email(self):
- credentials = self.make_credentials()
- assert credentials.signer_email == self.SERVICE_ACCOUNT_EMAIL
- def test_with_target_audience(self):
- credentials = self.make_credentials()
- new_credentials = credentials.with_target_audience("https://new.example.com")
- assert new_credentials._target_audience == "https://new.example.com"
- def test__with_use_iam_endpoint(self):
- credentials = self.make_credentials()
- new_credentials = credentials._with_use_iam_endpoint(True)
- assert new_credentials._use_iam_endpoint
- def test__with_use_iam_endpoint_non_default_universe_domain(self):
- credentials = self.make_credentials(universe_domain=FAKE_UNIVERSE_DOMAIN)
- with pytest.raises(exceptions.InvalidValue) as excinfo:
- credentials._with_use_iam_endpoint(False)
- assert excinfo.match(
- "use_iam_endpoint should be True for non-default universe domain"
- )
- def test_with_quota_project(self):
- credentials = self.make_credentials()
- new_credentials = credentials.with_quota_project("project-foo")
- assert new_credentials._quota_project_id == "project-foo"
- def test_with_token_uri(self):
- credentials = self.make_credentials()
- new_token_uri = "https://example2.com/oauth2/token"
- assert credentials._token_uri == self.TOKEN_URI
- creds_with_new_token_uri = credentials.with_token_uri(new_token_uri)
- assert creds_with_new_token_uri._token_uri == new_token_uri
- def test__make_authorization_grant_assertion(self):
- credentials = self.make_credentials()
- token = credentials._make_authorization_grant_assertion()
- payload = jwt.decode(token, PUBLIC_CERT_BYTES)
- assert payload["iss"] == self.SERVICE_ACCOUNT_EMAIL
- assert payload["aud"] == service_account._GOOGLE_OAUTH2_TOKEN_ENDPOINT
- assert payload["target_audience"] == self.TARGET_AUDIENCE
- @mock.patch("google.oauth2._client.id_token_jwt_grant", autospec=True)
- def test_refresh_success(self, id_token_jwt_grant):
- credentials = self.make_credentials()
- token = "token"
- id_token_jwt_grant.return_value = (
- token,
- _helpers.utcnow() + datetime.timedelta(seconds=500),
- {},
- )
- request = mock.create_autospec(transport.Request, instance=True)
- # Refresh credentials
- credentials.refresh(request)
- # Check jwt grant call.
- assert id_token_jwt_grant.called
- called_request, token_uri, assertion = id_token_jwt_grant.call_args[0]
- assert called_request == request
- assert token_uri == credentials._token_uri
- assert jwt.decode(assertion, PUBLIC_CERT_BYTES)
- # No further assertion done on the token, as there are separate tests
- # for checking the authorization grant assertion.
- # Check that the credentials have the token.
- assert credentials.token == token
- # Check that the credentials are valid (have a token and are not
- # expired)
- assert credentials.valid
- @mock.patch(
- "google.oauth2._client.call_iam_generate_id_token_endpoint", autospec=True
- )
- def test_refresh_iam_flow(self, call_iam_generate_id_token_endpoint):
- credentials = self.make_credentials()
- credentials._use_iam_endpoint = True
- token = "id_token"
- call_iam_generate_id_token_endpoint.return_value = (
- token,
- _helpers.utcnow() + datetime.timedelta(seconds=500),
- )
- request = mock.Mock()
- credentials.refresh(request)
- req, iam_endpoint, signer_email, target_audience, access_token, universe_domain = call_iam_generate_id_token_endpoint.call_args[
- 0
- ]
- assert req == request
- assert iam_endpoint == iam._IAM_IDTOKEN_ENDPOINT
- assert signer_email == "service-account@example.com"
- assert target_audience == "https://example.com"
- decoded_access_token = jwt.decode(access_token, verify=False)
- assert decoded_access_token["scope"] == "https://www.googleapis.com/auth/iam"
- @mock.patch(
- "google.oauth2._client.call_iam_generate_id_token_endpoint", autospec=True
- )
- def test_refresh_iam_flow_non_gdu(self, call_iam_generate_id_token_endpoint):
- credentials = self.make_credentials(universe_domain="fake-universe")
- token = "id_token"
- call_iam_generate_id_token_endpoint.return_value = (
- token,
- _helpers.utcnow() + datetime.timedelta(seconds=500),
- )
- request = mock.Mock()
- credentials.refresh(request)
- req, iam_endpoint, signer_email, target_audience, access_token, universe_domain = call_iam_generate_id_token_endpoint.call_args[
- 0
- ]
- assert req == request
- assert (
- iam_endpoint
- == "https://iamcredentials.fake-universe/v1/projects/-/serviceAccounts/{}:generateIdToken"
- )
- assert signer_email == "service-account@example.com"
- assert target_audience == "https://example.com"
- decoded_access_token = jwt.decode(access_token, verify=False)
- assert decoded_access_token["scope"] == "https://www.googleapis.com/auth/iam"
- @mock.patch("google.oauth2._client.id_token_jwt_grant", autospec=True)
- def test_before_request_refreshes(self, id_token_jwt_grant):
- credentials = self.make_credentials()
- token = "token"
- id_token_jwt_grant.return_value = (
- token,
- _helpers.utcnow() + datetime.timedelta(seconds=500),
- None,
- )
- request = mock.create_autospec(transport.Request, instance=True)
- # Credentials should start as invalid
- assert not credentials.valid
- # before_request should cause a refresh
- credentials.before_request(request, "GET", "http://example.com?a=1#3", {})
- # The refresh endpoint should've been called.
- assert id_token_jwt_grant.called
- # Credentials should now be valid.
- assert credentials.valid
|