Skip to content
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

docs: Update documentation for acceptable MDS token parmeter combinations. #1704

Merged
merged 2 commits into from
Mar 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,9 @@ public class ComputeEngineCredentials extends GoogleCredentials
*
* <p>Behavior of setting {@link GoogleAuthTransport} / {@link BindingEnforcement}:
*
* <p>MTLS-bound token where binding enforcement depends on IAM policy: MTLS / {}, {} /
* IAM_POLICY, MTLS / IAM_POLICY
* <p>MTLS-bound token where binding enforcement depends on IAM policy: MTLS / IAM_POLICY
*
* <p>MTLS-bound token where bindings are always enforced: {} / ON, MTLS / ON
* <p>MTLS-bound token where bindings are always enforced: MTLS / ON
*
* <p>DirectPath bound token: ALTS / {}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,9 @@ public void buildTokenUrl_nullTransport() {
.setGoogleAuthTransport(null)
.setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.ON)
.build();
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
String tokenUrl = credentials.createTokenUrlWithScopes();

assertEquals(TOKEN_URL + "?binding-enforcement=on", softBoundTokenUrl);
assertEquals(TOKEN_URL + "?binding-enforcement=on", tokenUrl);
}

@Test
Expand All @@ -212,9 +212,9 @@ public void buildTokenUrl_nullBindingEnforcement() {
.setGoogleAuthTransport(ComputeEngineCredentials.GoogleAuthTransport.MTLS)
.setBindingEnforcement(null)
.build();
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
String tokenUrl = credentials.createTokenUrlWithScopes();

assertEquals(TOKEN_URL + "?transport=mtls", softBoundTokenUrl);
assertEquals(TOKEN_URL + "?transport=mtls", tokenUrl);
}

@Test
Expand All @@ -230,25 +230,25 @@ public void buildTokenUrl_nullTransport_nullBindingEnforcement() {
}

@Test
public void buildTokenUrlSoftMtlsBound_mtls_transport() {
public void buildTokenUrl_mtls_transport() {
ComputeEngineCredentials credentials =
ComputeEngineCredentials.newBuilder()
.setGoogleAuthTransport(ComputeEngineCredentials.GoogleAuthTransport.MTLS)
.build();
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
String tokenUrl = credentials.createTokenUrlWithScopes();

assertEquals(TOKEN_URL + "?transport=mtls", softBoundTokenUrl);
assertEquals(TOKEN_URL + "?transport=mtls", tokenUrl);
}

@Test
public void buildTokenUrlSoftMtlsBound_iam_enforcement() {
public void buildTokenUrl_iam_enforcement() {
ComputeEngineCredentials credentials =
ComputeEngineCredentials.newBuilder()
.setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.IAM_POLICY)
.build();
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
String tokenUrl = credentials.createTokenUrlWithScopes();

assertEquals(TOKEN_URL + "?binding-enforcement=iam-policy", softBoundTokenUrl);
assertEquals(TOKEN_URL + "?binding-enforcement=iam-policy", tokenUrl);
}

@Test
Expand All @@ -264,14 +264,14 @@ public void buildTokenUrlSoftMtlsBound_mtls_transport_iam_enforcement() {
}

@Test
public void buildTokenUrlHardMtlsBound_always_enforced() {
public void buildTokenUrl_always_enforced() {
ComputeEngineCredentials credentials =
ComputeEngineCredentials.newBuilder()
.setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.ON)
.build();
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
String tokenUrl = credentials.createTokenUrlWithScopes();

assertEquals(TOKEN_URL + "?binding-enforcement=on", softBoundTokenUrl);
assertEquals(TOKEN_URL + "?binding-enforcement=on", tokenUrl);
}

@Test
Expand All @@ -281,9 +281,9 @@ public void buildTokenUrlHardMtlsBound_mtls_transport_always_enforced() {
.setGoogleAuthTransport(ComputeEngineCredentials.GoogleAuthTransport.MTLS)
.setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.ON)
.build();
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
String hardBoundTokenUrl = credentials.createTokenUrlWithScopes();

assertEquals(TOKEN_URL + "?transport=mtls&binding-enforcement=on", softBoundTokenUrl);
assertEquals(TOKEN_URL + "?transport=mtls&binding-enforcement=on", hardBoundTokenUrl);
}

@Test
Expand All @@ -292,9 +292,9 @@ public void buildTokenUrlHardDirectPathBound_alts_transport() {
ComputeEngineCredentials.newBuilder()
.setGoogleAuthTransport(ComputeEngineCredentials.GoogleAuthTransport.ALTS)
.build();
String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
String hardBoundTokenUrl = credentials.createTokenUrlWithScopes();

assertEquals(TOKEN_URL + "?transport=alts", softBoundTokenUrl);
assertEquals(TOKEN_URL + "?transport=alts", hardBoundTokenUrl);
}

@Test
Expand Down
Loading