-
Notifications
You must be signed in to change notification settings - Fork 2.8k
/
BaseCredentialsFetcher.java
216 lines (182 loc) · 7.37 KB
/
BaseCredentialsFetcher.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
/*
* Copyright 2011-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* 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://aws.amazon.com/apache2.0
*
* This file 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.
*/
package com.amazonaws.auth;
import com.amazonaws.SdkClientException;
import com.amazonaws.annotation.SdkInternalApi;
import com.amazonaws.util.DateUtils;
import com.amazonaws.util.json.Jackson;
import com.fasterxml.jackson.databind.JsonNode;
import java.util.Date;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Helper class that contains the common behavior of the
* CredentialsProviders that loads the credentials from a
* local endpoint.
*/
@SdkInternalApi
abstract class BaseCredentialsFetcher {
private static final Log LOG = LogFactory.getLog(BaseCredentialsFetcher.class);
/**
* The threshold after the last attempt to load credentials (in
* milliseconds) at which credentials are attempted to be refreshed.
*/
private static final int REFRESH_THRESHOLD = 1000 * 60 * 60;
/**
* The threshold before credentials expire (in milliseconds) at which
* this class will attempt to load new credentials.
*/
private static final int EXPIRATION_THRESHOLD = 1000 * 60 * 15;
/** The name of the Json Object that contains the access key.*/
private static final String ACCESS_KEY_ID = "AccessKeyId";
/** The name of the Json Object that contains the secret access key.*/
private static final String SECRET_ACCESS_KEY = "SecretAccessKey";
/** The name of the Json Object that contains the token.*/
private static final String TOKEN = "Token";
/** The current instance profile credentials */
private volatile AWSCredentials credentials;
/** The expiration for the current instance profile credentials */
private volatile Date credentialsExpiration;
/** The time of the last attempt to check for new credentials */
protected volatile Date lastInstanceProfileCheck;
public AWSCredentials getCredentials() {
if (needsToLoadCredentials())
fetchCredentials();
if (expired()) {
throw new SdkClientException(
"The credentials received have been expired");
}
return credentials;
}
/**
* Returns true if credentials are null, credentials are within expiration or
* if the last attempt to refresh credentials is beyond the refresh threshold.
*/
boolean needsToLoadCredentials() {
if (credentials == null) return true;
if (credentialsExpiration != null) {
if (isWithinExpirationThreshold()) return true;
}
if (lastInstanceProfileCheck != null) {
if (isPastRefreshThreshold()) return true;
}
return false;
}
/**
* @return the raw credential response string from the local endpoint.
*/
abstract String getCredentialsResponse();
/**
* Fetches the credentials from the endpoint.
*/
private synchronized void fetchCredentials() {
if (!needsToLoadCredentials()) return;
JsonNode accessKey;
JsonNode secretKey;
JsonNode node;
JsonNode token;
try {
lastInstanceProfileCheck = new Date();
String credentialsResponse = getCredentialsResponse();
node = Jackson.fromSensitiveJsonString(credentialsResponse, JsonNode.class);
accessKey = node.get(ACCESS_KEY_ID);
secretKey = node.get(SECRET_ACCESS_KEY);
token = node.get(TOKEN);
if (null == accessKey || null == secretKey) {
throw new SdkClientException("Unable to load credentials. Access key or secret key are null.");
}
if (null != token) {
credentials = new BasicSessionCredentials(accessKey.asText(),
secretKey.asText(), token.asText());
} else {
credentials = new BasicAWSCredentials(accessKey.asText(),
secretKey.asText());
}
JsonNode expirationJsonNode = node.get("Expiration");
if (null != expirationJsonNode) {
/*
* TODO: The expiration string comes in a different format
* than what we deal with in other parts of the SDK, so we
* have to convert it to the ISO8601 syntax we expect.
*/
String expiration = expirationJsonNode.asText();
expiration = expiration.replaceAll("\\+0000$", "Z");
try {
credentialsExpiration = DateUtils.parseISO8601Date(expiration);
} catch(Exception ex) {
handleError("Unable to parse credentials expiration date from Amazon EC2 instance", ex);
}
}
} catch (Exception e) {
handleError("Unable to load credentials from service endpoint", e);
}
}
/**
* Handles reporting or throwing an error encountered while requesting
* credentials from the Amazon EC2 endpoint. The Service could be
* briefly unavailable for a number of reasons, so
* we need to gracefully handle falling back to valid credentials if they're
* available, and only throw exceptions if we really can't recover.
*
* @param errorMessage
* A human readable description of the error.
* @param e
* The error that occurred.
*/
private void handleError(String errorMessage, Exception e) {
// If we don't have any valid credentials to fall back on, then throw an exception
if (credentials == null || expired()) {
if (e instanceof SdkClientException) {
throw (SdkClientException) e;
}
throw new SdkClientException(errorMessage, e);
}
// Otherwise, just log the error and continuing using the current credentials
LOG.warn(errorMessage, e);
}
public void refresh() {
credentials = null;
}
/**
* Returns true if the current credentials are within the expiration
* threshold, and therefore, should be refreshed.
*/
private boolean isWithinExpirationThreshold() {
return (credentialsExpiration.getTime() - System.currentTimeMillis()) < EXPIRATION_THRESHOLD;
}
/**
* Returns true if the last attempt to refresh credentials is beyond the
* refresh threshold, and therefore the credentials should attempt to be
* refreshed.
*/
private boolean isPastRefreshThreshold() {
return (System.currentTimeMillis() - lastInstanceProfileCheck.getTime()) > REFRESH_THRESHOLD;
}
private boolean expired() {
if (credentialsExpiration != null) {
if (credentialsExpiration.getTime() < System.currentTimeMillis()) {
return true;
}
}
return false;
}
Date getCredentialsExpiration() {
return credentialsExpiration;
}
@Override
public String toString() {
return "BaseCredentialsFetcher";
}
}