8000 refactor: Adapt service account credential exchanger to base credential exchanger interface by copybara-service[bot] · Pull Request #1446 · google/adk-python · GitHub
[go: up one dir, main page]
Skip to content

refactor: Adapt service account credential exchanger to base credential exchanger interface #1446

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 1 commit into from
Jun 18, 2025
Merged

refactor: Adapt service account credential exchanger to base credential exchanger interface #1446

Show file tree
Hide file tree
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
2 changes: 0 additions & 2 deletions src/google/adk/auth/exchanger/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,9 @@
"""Credential exchanger module."""

from .base_credential_exchanger import BaseCredentialExchanger
from .credential_exchanger_registry import CredentialExchangerRegistry
from .service_account_credential_exchanger import ServiceAccountCredentialExchanger

__all__ = [
"BaseCredentialExchanger",
"CredentialExchangerRegistry",
"ServiceAccountCredentialExchanger",
]
70 changes: 41 additions & 29 deletions ...h/service_account_credential_exchanger.py → ...r/service_account_credential_exchanger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,64 +16,79 @@

from __future__ import annotations

from typing import Optional

import google.auth
from google.auth.transport.requests import Request
from google.oauth2 import service_account
from typing_extensions import override

from ..utils.feature_decorator import experimental
from .auth_credential import AuthCredential
from .auth_credential import AuthCredentialTypes
from .auth_credential import HttpAuth
from .auth_credential import HttpCredentials
from ...utils.feature_decorator import experimental
from ..auth_credential import AuthCredential
from ..auth_credential import AuthCredentialTypes
from ..auth_schemes import AuthScheme
from .base_credential_exchanger import BaseCredentialExchanger


@experimental
class ServiceAccountCredentialExchanger:
class ServiceAccountCredentialExchanger(BaseCredentialExchanger):
"""Exchanges Google Service Account credentials for an access token.

Uses the default service credential if `use_default_credential = True`.
Otherwise, uses the service account credential provided in the auth
credential.
"""

def __init__(self, credential: AuthCredential):
if credential.auth_type != AuthCredentialTypes.SERVICE_ACCOUNT:
raise ValueError("Credential is not a service account credential.")
self._credential = credential

def exchange(self) -> AuthCredential:
@override
async def exchange(
self,
auth_credential: AuthCredential,
auth_scheme: Optional[AuthScheme] = None,
) -> AuthCredential:
"""Exchanges the service account auth credential for an access token.

If the AuthCredential contains a service account credential, it will be used
to exchange for an access token. Otherwise, if use_default_credential is True,
the default application credential will be used for exchanging an access token.

Args:
auth_scheme: The authentication scheme.
auth_credential: The credential to exchange.

Returns:
An AuthCredential in HTTP Bearer format, containing the access token.
An AuthCredential in OAUTH2 format, containing the exchanged credential JSON.

Raises:
ValueError: If service account credentials are missing or invalid.
Exception: If credential exchange or refresh fails.
"""
if auth_credential is None:
raise ValueError("Credential cannot be None.")

if auth_credential.auth_type != AuthCredentialTypes.SERVICE_ACCOUNT:
raise ValueError("Credential is not a service account credential.")

if auth_credential.service_account is None:
raise ValueError(
"Service account credentials are missing. Please provide them."
)

if (
self._credential is None
or self._credential.service_account is None
or (
self._credential.service_account.service_account_credential is None
and not self._credential.service_account.use_default_credential
)
auth_credential.service_account.service_account_credential is None
and not auth_credential.service_account.use_default_credential
):
raise ValueError(
"Service account credentials are missing. Please provide them, or set"
" `use_default_credential = True` to use application default"
" credential in a hosted service like Google Cloud Run."
"Service account credentials are invalid. Please set the"
" service_account_credential field or set `use_default_credential ="
" True` to use application default credential in a hosted service"
" like Google Cloud Run."
)

try:
if self._credential.service_account.use_default_credential:
if auth_credential.service_account.use_default_credential:
credentials, _ = google.auth.default()
else:
config = self._credential.service_account
config = auth_credential.service_account
credentials = service_account.Credentials.from_service_account_info(
config.service_account_credential.model_dump(), scopes=config.scopes
)
Expand All @@ -82,11 +97,8 @@ def exchange(self) -> AuthCredential:
credentials.refresh(Request())

return AuthCredential(
auth_type=AuthCredentialTypes.HTTP,
http=HttpAuth(
scheme="bearer",
credentials=HttpCredentials(token=credentials.token),
),
auth_type=AuthCredentialTypes.OAUTH2,
google_oauth2_json=credentials.to_json(),
)
except Exception as e:
raise ValueError(f"Failed to exchange service account token: {e}") from e
15 changes: 15 additions & 0 deletions tests/unittests/auth/exchanger/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Copyright 2025 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.

"""Tests for credential exchanger."""
Loading
0