/
InternalAwsSecurityCredentialsSupplier.java
254 lines (223 loc) · 10.5 KB
/
InternalAwsSecurityCredentialsSupplier.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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/*
* Copyright 2024 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.http.GenericUrl;
import com.google.api.client.http.HttpContent;
import com.google.api.client.http.HttpHeaders;
import com.google.api.client.http.HttpMethods;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.json.GenericJson;
import com.google.api.client.json.JsonParser;
import com.google.auth.http.HttpTransportFactory;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;
/**
* Internal provider for retrieving AWS security credentials for {@Link AwsCredentials} to exchange
* for GCP access tokens. The credentials are retrieved either via environment variables or metadata
* endpoints.
*/
class InternalAwsSecurityCredentialsSupplier implements AwsSecurityCredentialsSupplier {
private static final long serialVersionUID = 4438370785261365013L;
// Supported environment variables.
static final String AWS_REGION = "AWS_REGION";
static final String AWS_DEFAULT_REGION = "AWS_DEFAULT_REGION";
static final String AWS_ACCESS_KEY_ID = "AWS_ACCESS_KEY_ID";
static final String AWS_SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY";
static final String AWS_SESSION_TOKEN = "AWS_SESSION_TOKEN";
static final String AWS_IMDSV2_SESSION_TOKEN_HEADER = "x-aws-ec2-metadata-token";
static final String AWS_IMDSV2_SESSION_TOKEN_TTL_HEADER = "x-aws-ec2-metadata-token-ttl-seconds";
static final String AWS_IMDSV2_SESSION_TOKEN_TTL = "300";
private final AwsCredentialSource awsCredentialSource;
private EnvironmentProvider environmentProvider;
private transient HttpTransportFactory transportFactory;
/**
* Constructor for InternalAwsSecurityCredentialsProvider
*
* @param awsCredentialSource the credential source to use.
* @param environmentProvider the environment provider to use for environment variables.
* @param transportFactory the transport factory to use for metadata requests.
*/
InternalAwsSecurityCredentialsSupplier(
AwsCredentialSource awsCredentialSource,
EnvironmentProvider environmentProvider,
HttpTransportFactory transportFactory) {
this.environmentProvider = environmentProvider;
this.awsCredentialSource = awsCredentialSource;
this.transportFactory = transportFactory;
}
@Override
public AwsSecurityCredentials getCredentials(ExternalAccountSupplierContext context)
throws IOException {
// Check environment variables for credentials first.
if (canRetrieveSecurityCredentialsFromEnvironment()) {
String accessKeyId = environmentProvider.getEnv(AWS_ACCESS_KEY_ID);
String secretAccessKey = environmentProvider.getEnv(AWS_SECRET_ACCESS_KEY);
String token = environmentProvider.getEnv(AWS_SESSION_TOKEN);
return new AwsSecurityCredentials(accessKeyId, secretAccessKey, token);
}
Map<String, Object> metadataRequestHeaders = createMetadataRequestHeaders(awsCredentialSource);
// Credentials not retrievable from environment variables - call metadata server.
// Retrieve the IAM role that is attached to the VM. This is required to retrieve the AWS
// security credentials.
if (awsCredentialSource.url == null || awsCredentialSource.url.isEmpty()) {
throw new IOException(
"Unable to determine the AWS IAM role name. The credential source does not contain the"
+ " url field.");
}
String roleName = retrieveResource(awsCredentialSource.url, "IAM role", metadataRequestHeaders);
// Retrieve the AWS security credentials by calling the endpoint specified by the credential
// source.
String awsCredentials =
retrieveResource(
awsCredentialSource.url + "/" + roleName, "credentials", metadataRequestHeaders);
JsonParser parser = OAuth2Utils.JSON_FACTORY.createJsonParser(awsCredentials);
GenericJson genericJson = parser.parseAndClose(GenericJson.class);
String accessKeyId = (String) genericJson.get("AccessKeyId");
String secretAccessKey = (String) genericJson.get("SecretAccessKey");
String token = (String) genericJson.get("Token");
// These credentials last for a few hours - we may consider caching these in the
// future.
return new AwsSecurityCredentials(accessKeyId, secretAccessKey, token);
}
@Override
public String getRegion(ExternalAccountSupplierContext context) throws IOException {
String region;
if (canRetrieveRegionFromEnvironment()) {
// For AWS Lambda, the region is retrieved through the AWS_REGION environment variable.
region = environmentProvider.getEnv(AWS_REGION);
if (region != null && region.trim().length() > 0) {
return region;
}
return environmentProvider.getEnv(AWS_DEFAULT_REGION);
}
Map<String, Object> metadataRequestHeaders = createMetadataRequestHeaders(awsCredentialSource);
if (awsCredentialSource.regionUrl == null || awsCredentialSource.regionUrl.isEmpty()) {
throw new IOException(
"Unable to determine the AWS region. The credential source does not contain the region URL.");
}
region = retrieveResource(awsCredentialSource.regionUrl, "region", metadataRequestHeaders);
// There is an extra appended character that must be removed. If `us-east-1b` is returned,
// we want `us-east-1`.
return region.substring(0, region.length() - 1);
}
private boolean canRetrieveRegionFromEnvironment() {
// The AWS region can be provided through AWS_REGION or AWS_DEFAULT_REGION. Only one is
// required.
List<String> keys = ImmutableList.of(AWS_REGION, AWS_DEFAULT_REGION);
for (String env : keys) {
String value = environmentProvider.getEnv(env);
if (value != null && value.trim().length() > 0) {
// Region available.
return true;
}
}
return false;
}
private boolean canRetrieveSecurityCredentialsFromEnvironment() {
// Check if both AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are available.
List<String> keys = ImmutableList.of(AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY);
for (String env : keys) {
String value = environmentProvider.getEnv(env);
if (value == null || value.trim().length() == 0) {
// Return false if one of them are missing.
return false;
}
}
return true;
}
@VisibleForTesting
boolean shouldUseMetadataServer() {
return (!canRetrieveRegionFromEnvironment()
|| !canRetrieveSecurityCredentialsFromEnvironment());
}
private String retrieveResource(String url, String resourceName, Map<String, Object> headers)
throws IOException {
return retrieveResource(url, resourceName, HttpMethods.GET, headers, /* content= */ null);
}
private String retrieveResource(
String url,
String resourceName,
String requestMethod,
Map<String, Object> headers,
@Nullable HttpContent content)
throws IOException {
try {
HttpRequestFactory requestFactory = transportFactory.create().createRequestFactory();
HttpRequest request =
requestFactory.buildRequest(requestMethod, new GenericUrl(url), content);
HttpHeaders requestHeaders = request.getHeaders();
for (Map.Entry<String, Object> header : headers.entrySet()) {
requestHeaders.set(header.getKey(), header.getValue());
}
HttpResponse response = request.execute();
return response.parseAsString();
} catch (IOException e) {
throw new IOException(String.format("Failed to retrieve AWS %s.", resourceName), e);
}
}
@VisibleForTesting
Map<String, Object> createMetadataRequestHeaders(AwsCredentialSource awsCredentialSource)
throws IOException {
Map<String, Object> metadataRequestHeaders = new HashMap<>();
// AWS IDMSv2 introduced a requirement for a session token to be present
// with the requests made to metadata endpoints. This requirement is to help
// prevent SSRF attacks.
// Presence of "imdsv2_session_token_url" in Credential Source of config file
// will trigger a flow with session token, else there will not be a session
// token with the metadata requests.
// Both flows work for IDMS v1 and v2. But if IDMSv2 is enabled, then if
// session token is not present, Unauthorized exception will be thrown.
if (awsCredentialSource.imdsv2SessionTokenUrl != null) {
Map<String, Object> tokenRequestHeaders =
new HashMap<String, Object>() {
{
put(AWS_IMDSV2_SESSION_TOKEN_TTL_HEADER, AWS_IMDSV2_SESSION_TOKEN_TTL);
}
};
String imdsv2SessionToken =
retrieveResource(
awsCredentialSource.imdsv2SessionTokenUrl,
"Session Token",
HttpMethods.PUT,
tokenRequestHeaders,
/* content= */ null);
metadataRequestHeaders.put(AWS_IMDSV2_SESSION_TOKEN_HEADER, imdsv2SessionToken);
}
return metadataRequestHeaders;
}
}