-
Notifications
You must be signed in to change notification settings - Fork 15
feat(toolbox_core): add helper methods for retrieving ID tokens #239
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.
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
Changes from 3 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
4c3e4c2
feat: add toolbox_auth_methods module
twishabansal 874f2f1
cleanup
twishabansal 308764a
feat: Add toolbox auth methods module
twishabansal 6626f69
Merge branch 'main' into twisha-auth-methods
twishabansal ee0aa61
add tests
twishabansal 441ea32
clean tests
twishabansal fe93385
lint
twishabansal 3a354ce
add docs
twishabansal d578b24
fix toc
twishabansal 4ae8c42
lint
twishabansal 11731fb
lint
twishabansal 9d35164
lint
twishabansal f196de9
lint
twishabansal 69c9e23
lint
twishabansal b8a340a
Merge branch 'main' into twisha-auth-methods
twishabansal 28ea3ff
Merge branch 'main' into twisha-auth-methods
twishabansal 699f8c6
Update packages/toolbox-core/README.md
twishabansal 942e23c
Merge branch 'main' into twisha-auth-methods
twishabansal 03a6327
Merge branch 'main' into twisha-auth-methods
twishabansal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
72 changes: 72 additions & 0 deletions
72
packages/toolbox-core/src/toolbox_core/toolbox_auth_methods.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# 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. | ||
|
||
# The tokens obtained by these functions are formatted as "Bearer" tokens | ||
# and are intended to be passed in the "Authorization" header of HTTP requests. | ||
# | ||
# Example User Experience: | ||
# from toolbox_core import toolbox_auth_methods | ||
# | ||
# auth_token_provider = toolbox_auth_methods.aget_google_id_token | ||
# toolbox = ToolboxClient( | ||
# URL, | ||
# client_headers={"Authorization": auth_token_provider}, | ||
# ) | ||
# tools = await toolbox.load_toolset() | ||
|
||
|
||
from functools import partial | ||
|
||
import google.auth | ||
from google.auth._credentials_async import Credentials | ||
from google.auth._default_async import default_async | ||
from google.auth.transport import _aiohttp_requests | ||
from google.auth.transport.requests import AuthorizedSession, Request | ||
|
||
|
||
async def aget_google_id_token(): | ||
""" | ||
Asynchronously fetches a Google ID token. | ||
|
||
The token is formatted as a 'Bearer' token string and is suitable for use | ||
in an HTTP Authorization header. This function uses Application Default | ||
Credentials. | ||
|
||
Returns: | ||
A string in the format "Bearer <google_id_token>". | ||
""" | ||
creds, _ = default_async() | ||
await creds.refresh(_aiohttp_requests.Request()) | ||
creds.before_request = partial(Credentials.before_request, creds) | ||
token = creds.id_token | ||
return f"Bearer {token}" | ||
|
||
|
||
def get_google_id_token(): | ||
""" | ||
Synchronously fetches a Google ID token. | ||
|
||
The token is formatted as a 'Bearer' token string and is suitable for use | ||
in an HTTP Authorization header. This function uses Application Default | ||
Credentials. | ||
|
||
Returns: | ||
A string in the format "Bearer <google_id_token>". | ||
""" | ||
credentials, _ = google.auth.default() | ||
session = AuthorizedSession(credentials) | ||
request = Request(session) | ||
credentials.refresh(request) | ||
token = credentials.id_token | ||
return f"Bearer {token}" |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.