forked from googleapis/google-http-java-client
/
ExecutableResponse.java
203 lines (179 loc) · 6.62 KB
/
ExecutableResponse.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
/*
* Copyright 2022 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.json.GenericJson;
import java.io.IOException;
import java.math.BigDecimal;
import java.time.Instant;
import javax.annotation.Nullable;
/**
* Encapsulates response values for the 3rd party executable response (e.g. OIDC, SAML, error
* responses).
*/
class ExecutableResponse {
private static final String SAML_SUBJECT_TOKEN_TYPE = "urn:ietf:params:oauth:token-type:saml2";
private final int version;
private final boolean success;
@Nullable private Long expirationTime;
@Nullable private String tokenType;
@Nullable private String subjectToken;
@Nullable private String errorCode;
@Nullable private String errorMessage;
ExecutableResponse(GenericJson json) throws IOException {
if (!json.containsKey("version")) {
throw new PluggableAuthException(
"INVALID_EXECUTABLE_RESPONSE", "The executable response is missing the `version` field.");
}
if (!json.containsKey("success")) {
throw new PluggableAuthException(
"INVALID_EXECUTABLE_RESPONSE", "The executable response is missing the `success` field.");
}
this.version = parseIntField(json.get("version"));
this.success = (boolean) json.get("success");
if (success) {
if (!json.containsKey("token_type")) {
throw new PluggableAuthException(
"INVALID_EXECUTABLE_RESPONSE",
"The executable response is missing the `token_type` field.");
}
this.tokenType = (String) json.get("token_type");
if (json.containsKey("expiration_time")) {
this.expirationTime = parseLongField(json.get("expiration_time"));
}
if (SAML_SUBJECT_TOKEN_TYPE.equals(tokenType)) {
this.subjectToken = (String) json.get("saml_response");
} else {
this.subjectToken = (String) json.get("id_token");
}
if (subjectToken == null || subjectToken.isEmpty()) {
throw new PluggableAuthException(
"INVALID_EXECUTABLE_RESPONSE",
"The executable response does not contain a valid token.");
}
} else {
// Error response must contain both an error code and message.
this.errorCode = (String) json.get("code");
this.errorMessage = (String) json.get("message");
if (errorCode == null
|| errorCode.isEmpty()
|| errorMessage == null
|| errorMessage.isEmpty()) {
throw new PluggableAuthException(
"INVALID_EXECUTABLE_RESPONSE",
"The executable response must contain `error` and `message` fields when unsuccessful.");
}
}
}
/**
* Returns the version of the executable output. Only version `1` is currently supported. This is
* useful for future changes to the expected output format.
*
* @return The version of the JSON output.
*/
int getVersion() {
return this.version;
}
/**
* Returns the status of the response.
*
* <p>When this is true, the response will contain the 3rd party token for a sign in / refresh
* operation. When this is false, the response should contain an additional error code and
* message.
*
* @return Whether the `success` field in the executable response is true.
*/
boolean isSuccessful() {
return this.success;
}
/** Returns true if the subject token is expired, false otherwise. */
boolean isExpired() {
return this.expirationTime != null && this.expirationTime <= Instant.now().getEpochSecond();
}
/** Returns whether the execution was successful and returned an unexpired token. */
boolean isValid() {
return isSuccessful() && !isExpired();
}
/** Returns the subject token expiration time in seconds (Unix epoch time). */
@Nullable
Long getExpirationTime() {
return this.expirationTime;
}
/**
* Returns the 3rd party subject token type.
*
* <p>Possible valid values:
*
* <ul>
* <li>urn:ietf:params:oauth:token-type:id_token
* <li>urn:ietf:params:oauth:token-type:jwt
* <li>urn:ietf:params:oauth:token-type:saml2
* </ul>
*
* @return The 3rd party subject token type for success responses, null otherwise.
*/
@Nullable
String getTokenType() {
return this.tokenType;
}
/** Returns the subject token if the execution was successful, null otherwise. */
@Nullable
String getSubjectToken() {
return this.subjectToken;
}
/** Returns the error code if the execution was unsuccessful, null otherwise. */
@Nullable
String getErrorCode() {
return this.errorCode;
}
/** Returns the error message if the execution was unsuccessful, null otherwise. */
@Nullable
String getErrorMessage() {
return this.errorMessage;
}
private static int parseIntField(Object field) {
if (field instanceof String) {
return Integer.parseInt((String) field);
}
if (field instanceof BigDecimal) {
return ((BigDecimal) field).intValue();
}
return (int) field;
}
private static long parseLongField(Object field) {
if (field instanceof String) {
return Long.parseLong((String) field);
}
if (field instanceof BigDecimal) {
return ((BigDecimal) field).longValue();
}
return (long) field;
}
}