-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(oauth2): Extract actor tokens for cert-bound OAuth2 STS exchange #13955
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
Open
macastelaz
wants to merge
8
commits into
googleapis:oauth2-bound-tokens
Choose a base branch
from
macastelaz:cert-bound-oauth-part2
base: oauth2-bound-tokens
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
a4813a2
feat(oauth2): Extract actor tokens for cert-bound OAuth2 STS exchange
macastelaz c739b37
fix(oauth2): share parsed JSON cache between subject and actor tokens
macastelaz 1a32e6f
feat(oauth2): fail loudly if actor token requested against non-file s…
macastelaz c42bd53
feat(oauth2): relax actor token mTLS URL validation to .mtls. for PSC…
macastelaz 803dd53
test(oauth2): add tests for strict actor token exceptions
macastelaz cbcce28
chore(oauth2): update copyright year to 2026 for new files
macastelaz 745d26b
Address architectural review feedback from paste 5381957298028544
macastelaz 48c29d2
Fix trailing whitespace and formatting in IdentityPoolCredentialsTest
macastelaz 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
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
103 changes: 0 additions & 103 deletions
103
...ry-java/oauth2_http/java/com/google/auth/oauth2/FileIdentityPoolSubjectTokenSupplier.java
This file was deleted.
Oops, something went wrong.
173 changes: 173 additions & 0 deletions
173
...h-library-java/oauth2_http/java/com/google/auth/oauth2/FileIdentityPoolTokenSupplier.java
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,173 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are | ||
| * met: | ||
| * | ||
| * * Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * * Redistributions in binary form must reproduce the above | ||
| * copyright notice, this list of conditions and the following disclaimer | ||
| * in the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * | ||
| * * Neither the name of Google LLC nor the names of its | ||
| * contributors may be used to endorse or promote products derived from | ||
| * this software without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
|
|
||
| package com.google.auth.oauth2; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkNotNull; | ||
|
|
||
| import com.google.api.client.json.GenericJson; | ||
| import com.google.api.client.json.JsonObjectParser; | ||
| import com.google.auth.oauth2.IdentityPoolCredentialSource.CredentialFormatType; | ||
| import com.google.common.io.CharStreams; | ||
| import java.io.BufferedReader; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.InputStreamReader; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.LinkOption; | ||
| import java.nio.file.Paths; | ||
| import org.jspecify.annotations.NullMarked; | ||
| import org.jspecify.annotations.Nullable; | ||
|
|
||
| /** | ||
| * Internal provider for retrieving the subject and actor tokens for {@link IdentityPoolCredentials} | ||
| * to exchange for GCP access tokens via a local file. | ||
| */ | ||
| @NullMarked | ||
| class FileIdentityPoolTokenSupplier | ||
| implements IdentityPoolSubjectTokenSupplier, IdentityPoolActorTokenSupplier { | ||
|
|
||
| private final long serialVersionUID = 2475549052347431993L; | ||
|
|
||
| private final IdentityPoolCredentialSource credentialSource; | ||
|
|
||
| private static class CachedFile { | ||
| final long lastModified; | ||
| final GenericJson parsedJson; | ||
|
|
||
| CachedFile(long lastModified, GenericJson parsedJson) { | ||
| this.lastModified = lastModified; | ||
| this.parsedJson = parsedJson; | ||
| } | ||
| } | ||
|
|
||
| private volatile CachedFile cachedFile; | ||
|
|
||
| FileIdentityPoolTokenSupplier(IdentityPoolCredentialSource credentialSource) { | ||
| this.credentialSource = checkNotNull(credentialSource, "credentialSource cannot be null"); | ||
| } | ||
|
|
||
| @Override | ||
| public String getSubjectToken(ExternalAccountSupplierContext context) throws IOException { | ||
| return getToken(credentialSource.subjectTokenFieldName); | ||
| } | ||
|
|
||
| @Override | ||
| public String getActorToken(ExternalAccountSupplierContext context) throws IOException { | ||
| if (credentialSource.credentialFormatType == CredentialFormatType.TEXT) { | ||
| throw new IllegalArgumentException( | ||
| "Actor tokens are only supported for JSON-formatted credential files with distinct field names."); | ||
| } | ||
| return getToken(credentialSource.actorTokenFieldName); | ||
| } | ||
|
|
||
| private String getToken(@Nullable String targetFieldName) throws IOException { | ||
| String credentialFilePath = credentialSource.getCredentialLocation(); | ||
| if (!Files.exists(Paths.get(credentialFilePath), LinkOption.NOFOLLOW_LINKS)) { | ||
| throw new IOException( | ||
| String.format( | ||
| "Invalid credential location. The file at %s does not exist.", credentialFilePath)); | ||
| } | ||
|
|
||
| if (credentialSource.credentialFormatType == CredentialFormatType.JSON) { | ||
| if (targetFieldName == null) { | ||
| throw new IOException("Target field name must be specified for JSON credentials."); | ||
| } | ||
| File file = new File(credentialFilePath); | ||
| long lastModified = file.lastModified(); | ||
|
|
||
| CachedFile cached = this.cachedFile; | ||
|
|
||
| if (cached == null || cached.lastModified < lastModified) { | ||
| synchronized (this) { | ||
| cached = this.cachedFile; | ||
| if (cached == null || cached.lastModified < lastModified) { | ||
| try (InputStream inputStream = Files.newInputStream(file.toPath())) { | ||
| JsonObjectParser parser = new JsonObjectParser(OAuth2Utils.JSON_FACTORY); | ||
| GenericJson parsedJson = | ||
| parser.parseAndClose(inputStream, StandardCharsets.UTF_8, GenericJson.class); | ||
| cached = new CachedFile(lastModified, parsedJson); | ||
| this.cachedFile = cached; | ||
| } catch (Exception e) { | ||
| throw new IOException( | ||
| "Error when attempting to read the token from the credential file.", e); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| Object value = cached.parsedJson.get(targetFieldName); | ||
| if (value == null) { | ||
| throw new IOException( | ||
| "Invalid token field name. No token was found for field: " + targetFieldName); | ||
| } | ||
| return value.toString(); | ||
| } | ||
|
|
||
| try (InputStream inputStream = Files.newInputStream(Paths.get(credentialFilePath))) { | ||
| BufferedReader reader = | ||
| new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8)); | ||
| return CharStreams.toString(reader); | ||
| } catch (IOException e) { | ||
| throw new IOException("Error when attempting to read the token from the credential file.", e); | ||
| } | ||
| } | ||
|
|
||
| /** Used primarily for UrlIdentityPoolSubjectTokenSupplier */ | ||
| static String parseToken( | ||
| InputStream inputStream, | ||
| IdentityPoolCredentialSource credentialSource, | ||
| @Nullable String targetFieldName) | ||
| throws IOException { | ||
| try (InputStream in = inputStream; | ||
| java.io.Reader reader = new InputStreamReader(in, StandardCharsets.UTF_8)) { | ||
| if (credentialSource.credentialFormatType == CredentialFormatType.TEXT) { | ||
| return CharStreams.toString(new BufferedReader(reader)); | ||
| } | ||
|
|
||
| if (targetFieldName == null) { | ||
| throw new IOException("Target field name must be specified for JSON credentials."); | ||
| } | ||
|
|
||
| JsonObjectParser parser = new JsonObjectParser(OAuth2Utils.JSON_FACTORY); | ||
| GenericJson fileContents = | ||
| parser.parseAndClose(in, StandardCharsets.UTF_8, GenericJson.class); | ||
|
|
||
| if (!fileContents.containsKey(targetFieldName)) { | ||
| throw new IOException( | ||
| "Invalid token field name. No token was found for field: " + targetFieldName); | ||
| } | ||
| return (String) fileContents.get(targetFieldName); | ||
| } | ||
| } | ||
| } | ||
48 changes: 48 additions & 0 deletions
48
...-library-java/oauth2_http/java/com/google/auth/oauth2/IdentityPoolActorTokenSupplier.java
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,48 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are | ||
| * met: | ||
| * | ||
| * * Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * * Redistributions in binary form must reproduce the above | ||
| * copyright notice, this list of conditions and the following disclaimer | ||
| * in the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * | ||
| * * Neither the name of Google LLC nor the names of its | ||
| * contributors may be used to endorse or promote products derived from | ||
| * this software without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
|
|
||
| package com.google.auth.oauth2; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** Functional interface for supplying an actor token for IdentityPool credentials. */ | ||
| @FunctionalInterface | ||
| interface IdentityPoolActorTokenSupplier extends java.io.Serializable { | ||
|
|
||
| /** | ||
| * Returns a valid actor token as a string. | ||
| * | ||
| * @param context the context to use to fetch the actor token | ||
| * @return the actor token string | ||
| * @throws IOException if there was an error retrieving the token | ||
| */ | ||
| String getActorToken(ExternalAccountSupplierContext context) throws IOException; | ||
| } |
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
Oops, something went wrong.
Oops, something went wrong.
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.