-
Notifications
You must be signed in to change notification settings - Fork 216
/
IdTokenCredentials.java
196 lines (173 loc) · 7.12 KB
/
IdTokenCredentials.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
* Copyright 2019, 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 com.google.api.client.util.Preconditions;
import com.google.common.base.MoreObjects;
import java.io.IOException;
import java.util.List;
import java.util.Objects;
/**
* IdTokenCredentials provides a Google Issued OpenIdConnect token. <br>
* Use an ID token to access services that require presenting an ID token for authentication such as
* Cloud Functions or Cloud Run.<br>
* The following Credential subclasses support IDTokens: ServiceAccountCredentials,
* ComputeEngineCredentials, ImpersonatedCredentials.
*
* <p>For more information see <br>
* Usage:<br>
*
* <pre>
* String credPath = "/path/to/svc_account.json";
* String targetAudience = "https://example.com";
*
* // For Application Default Credentials (as ServiceAccountCredentials)
* // export GOOGLE_APPLICATION_CREDENTIALS=/path/to/svc.json
* GoogleCredentials adcCreds = GoogleCredentials.getApplicationDefault();
* if (!adcCreds instanceof IdTokenProvider) {
* // handle error message
* }
*
* IdTokenCredentials tokenCredential = IdTokenCredentials.newBuilder()
* .setIdTokenProvider(adcCreds)
* .setTargetAudience(targetAudience).build();
*
* // for ServiceAccountCredentials
* ServiceAccountCredentials saCreds = ServiceAccountCredentials.fromStream(new FileInputStream(credPath));
* saCreds = (ServiceAccountCredentials) saCreds.createScoped(Arrays.asList("https://www.googleapis.com/auth/iam"));
* IdTokenCredentials tokenCredential = IdTokenCredentials.newBuilder()
* .setIdTokenProvider(saCreds)
* .setTargetAudience(targetAudience).build();
*
* // for ComputeEngineCredentials
* ComputeEngineCredentials caCreds = ComputeEngineCredentials.create();
* IdTokenCredentials tokenCredential = IdTokenCredentials.newBuilder()
* .setIdTokenProvider(caCreds)
* .setTargetAudience(targetAudience)
* .setOptions(Arrays.asList(ComputeEngineCredentials.ID_TOKEN_FORMAT_FULL))
* .build();
*
* // for ImpersonatedCredentials
* ImpersonatedCredentials imCreds = ImpersonatedCredentials.create(saCreds,
* "impersonated-account@project.iam.gserviceaccount.com", null,
* Arrays.asList("https://www.googleapis.com/auth/cloud-platform"), 300);
* IdTokenCredentials tokenCredential = IdTokenCredentials.newBuilder()
* .setIdTokenProvider(imCreds)
* .setTargetAudience(targetAudience)
* .setOptions(Arrays.asList(ImpersonatedCredentials.INCLUDE_EMAIL))
* .build();
*
* // Use the IdTokenCredential in an authorized transport
* GenericUrl genericUrl = new GenericUrl("https://example.com");
* HttpCredentialsAdapter adapter = new HttpCredentialsAdapter(tokenCredential);
* HttpTransport transport = new NetHttpTransport();
* HttpRequest request = transport.createRequestFactory(adapter).buildGetRequest(genericUrl);
* HttpResponse response = request.execute();
*
* // Print the token, expiration and the audience
* System.out.println(tokenCredential.getIdToken().getTokenValue());
* System.out.println(tokenCredential.getIdToken().getJsonWebSignature().getPayload().getAudienceAsList());
* System.out.println(tokenCredential.getIdToken().getJsonWebSignature().getPayload().getExpirationTimeSeconds());
* </pre>
*/
public class IdTokenCredentials extends OAuth2Credentials {
private static final long serialVersionUID = -2133257318957588431L;
private IdTokenProvider idTokenProvider;
private String targetAudience;
private List<IdTokenProvider.Option> options;
private IdTokenCredentials(Builder builder) {
this.idTokenProvider = Preconditions.checkNotNull(builder.getIdTokenProvider());
this.targetAudience = Preconditions.checkNotNull(builder.getTargetAudience());
this.options = builder.getOptions();
}
@Override
public AccessToken refreshAccessToken() throws IOException {
return this.idTokenProvider.idTokenWithAudience(targetAudience, options);
}
public IdToken getIdToken() {
return (IdToken) getAccessToken();
}
@Override
public int hashCode() {
return Objects.hash(options, targetAudience);
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this).toString();
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof IdTokenCredentials)) {
return false;
}
IdTokenCredentials other = (IdTokenCredentials) obj;
return Objects.equals(this.idTokenProvider, other.idTokenProvider)
&& Objects.equals(this.targetAudience, other.targetAudience);
}
public Builder toBuilder() {
return new Builder()
.setIdTokenProvider(this.idTokenProvider)
.setTargetAudience(this.targetAudience)
.setOptions(this.options);
}
public static Builder newBuilder() {
return new Builder();
}
public static class Builder extends OAuth2Credentials.Builder {
private IdTokenProvider idTokenProvider;
private String targetAudience;
private List<IdTokenProvider.Option> options;
protected Builder() {}
public Builder setIdTokenProvider(IdTokenProvider idTokenProvider) {
this.idTokenProvider = idTokenProvider;
return this;
}
public IdTokenProvider getIdTokenProvider() {
return this.idTokenProvider;
}
public Builder setTargetAudience(String targetAudience) {
this.targetAudience = targetAudience;
return this;
}
public String getTargetAudience() {
return this.targetAudience;
}
public Builder setOptions(List<IdTokenProvider.Option> options) {
this.options = options;
return this;
}
public List<IdTokenProvider.Option> getOptions() {
return this.options;
}
public IdTokenCredentials build() {
return new IdTokenCredentials(this);
}
}
}