|
2
|
1 |
/*
|
|
50768
|
2 |
* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
|
|
2
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
|
4 |
*
|
|
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
|
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
|
5506
|
7 |
* published by the Free Software Foundation. Oracle designates this
|
|
2
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
|
5506
|
9 |
* by Oracle in the LICENSE file that accompanied this code.
|
|
2
|
10 |
*
|
|
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
|
|
15 |
* accompanied this code).
|
|
|
16 |
*
|
|
|
17 |
* You should have received a copy of the GNU General Public License version
|
|
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
20 |
*
|
|
5506
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
|
22 |
* or visit www.oracle.com if you need additional information or have any
|
|
|
23 |
* questions.
|
|
2
|
24 |
*/
|
|
|
25 |
|
|
|
26 |
package sun.security.ssl;
|
|
|
27 |
|
|
|
28 |
import java.io.IOException;
|
|
50768
|
29 |
import java.nio.ByteBuffer;
|
|
|
30 |
import java.text.MessageFormat;
|
|
2
|
31 |
import java.util.*;
|
|
50768
|
32 |
|
|
|
33 |
import sun.security.ssl.SSLHandshake.HandshakeMessage;
|
|
|
34 |
import sun.security.util.HexDumpEncoder;
|
|
2
|
35 |
|
|
|
36 |
/**
|
|
50768
|
37 |
* SSL/(D)TLS extensions in a handshake message.
|
|
2
|
38 |
*/
|
|
50768
|
39 |
final class SSLExtensions {
|
|
|
40 |
private final HandshakeMessage handshakeMessage;
|
|
|
41 |
private Map<SSLExtension, byte[]> extMap = new LinkedHashMap<>();
|
|
2
|
42 |
private int encodedLength;
|
|
|
43 |
|
|
50768
|
44 |
// Extension map for debug logging
|
|
|
45 |
private final Map<Integer, byte[]> logMap =
|
|
|
46 |
SSLLogger.isOn ? null : new LinkedHashMap<>();
|
|
|
47 |
|
|
|
48 |
SSLExtensions(HandshakeMessage handshakeMessage) {
|
|
|
49 |
this.handshakeMessage = handshakeMessage;
|
|
|
50 |
this.encodedLength = 2; // 2: the length of the extensions.
|
|
2
|
51 |
}
|
|
|
52 |
|
|
50768
|
53 |
SSLExtensions(HandshakeMessage hm,
|
|
|
54 |
ByteBuffer m, SSLExtension[] extensions) throws IOException {
|
|
|
55 |
this.handshakeMessage = hm;
|
|
|
56 |
|
|
|
57 |
int len = Record.getInt16(m);
|
|
|
58 |
encodedLength = len + 2; // 2: the length of the extensions.
|
|
2
|
59 |
while (len > 0) {
|
|
50768
|
60 |
int extId = Record.getInt16(m);
|
|
|
61 |
int extLen = Record.getInt16(m);
|
|
|
62 |
if (extLen > m.remaining()) {
|
|
|
63 |
hm.handshakeContext.conContext.fatal(Alert.ILLEGAL_PARAMETER,
|
|
|
64 |
"Error parsing extension (" + extId +
|
|
|
65 |
"): no sufficient data");
|
|
|
66 |
}
|
|
|
67 |
|
|
|
68 |
SSLHandshake handshakeType = hm.handshakeType();
|
|
|
69 |
if (SSLExtension.isConsumable(extId) &&
|
|
|
70 |
SSLExtension.valueOf(handshakeType, extId) == null) {
|
|
|
71 |
hm.handshakeContext.conContext.fatal(
|
|
|
72 |
Alert.UNSUPPORTED_EXTENSION,
|
|
|
73 |
"extension (" + extId +
|
|
|
74 |
") should not be presented in " + handshakeType.name);
|
|
|
75 |
}
|
|
|
76 |
|
|
|
77 |
boolean isSupported = false;
|
|
|
78 |
for (SSLExtension extension : extensions) {
|
|
|
79 |
if ((extension.id != extId) ||
|
|
|
80 |
(extension.onLoadConsumer == null)) {
|
|
|
81 |
continue;
|
|
|
82 |
}
|
|
|
83 |
|
|
|
84 |
if (extension.handshakeType != handshakeType) {
|
|
|
85 |
hm.handshakeContext.conContext.fatal(
|
|
|
86 |
Alert.UNSUPPORTED_EXTENSION,
|
|
|
87 |
"extension (" + extId + ") should not be " +
|
|
|
88 |
"presented in " + handshakeType.name);
|
|
|
89 |
}
|
|
|
90 |
|
|
|
91 |
byte[] extData = new byte[extLen];
|
|
|
92 |
m.get(extData);
|
|
|
93 |
extMap.put(extension, extData);
|
|
|
94 |
if (logMap != null) {
|
|
|
95 |
logMap.put(extId, extData);
|
|
|
96 |
}
|
|
|
97 |
|
|
|
98 |
isSupported = true;
|
|
|
99 |
break;
|
|
2
|
100 |
}
|
|
50768
|
101 |
|
|
|
102 |
if (!isSupported) {
|
|
|
103 |
if (logMap != null) {
|
|
|
104 |
// cache the extension for debug logging
|
|
|
105 |
byte[] extData = new byte[extLen];
|
|
|
106 |
m.get(extData);
|
|
|
107 |
logMap.put(extId, extData);
|
|
|
108 |
|
|
|
109 |
if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
110 |
SSLLogger.fine(
|
|
|
111 |
"Ignore unknown or unsupported extension",
|
|
|
112 |
toString(extId, extData));
|
|
|
113 |
}
|
|
|
114 |
} else {
|
|
|
115 |
// ignore the extension
|
|
|
116 |
int pos = m.position() + extLen;
|
|
|
117 |
m.position(pos);
|
|
|
118 |
}
|
|
|
119 |
}
|
|
|
120 |
|
|
|
121 |
len -= extLen + 4;
|
|
2
|
122 |
}
|
|
50768
|
123 |
}
|
|
|
124 |
|
|
|
125 |
byte[] get(SSLExtension ext) {
|
|
|
126 |
return extMap.get(ext);
|
|
|
127 |
}
|
|
|
128 |
|
|
|
129 |
/**
|
|
|
130 |
* Consume the specified extensions.
|
|
|
131 |
*/
|
|
|
132 |
void consumeOnLoad(HandshakeContext context,
|
|
|
133 |
SSLExtension[] extensions) throws IOException {
|
|
|
134 |
for (SSLExtension extension : extensions) {
|
|
|
135 |
if (context.negotiatedProtocol != null &&
|
|
|
136 |
!extension.isAvailable(context.negotiatedProtocol)) {
|
|
|
137 |
if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
138 |
SSLLogger.fine(
|
|
|
139 |
"Ignore unsupported extension: " + extension.name);
|
|
|
140 |
}
|
|
|
141 |
continue;
|
|
|
142 |
}
|
|
|
143 |
|
|
|
144 |
if (!extMap.containsKey(extension)) {
|
|
|
145 |
if (extension.onLoadAbsence != null) {
|
|
|
146 |
extension.absentOnLoad(context, handshakeMessage);
|
|
|
147 |
} else if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
148 |
SSLLogger.fine(
|
|
|
149 |
"Ignore unavailable extension: " + extension.name);
|
|
|
150 |
}
|
|
|
151 |
continue;
|
|
|
152 |
}
|
|
|
153 |
|
|
|
154 |
|
|
|
155 |
if (extension.onLoadConsumer == null) {
|
|
|
156 |
if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
157 |
SSLLogger.warning(
|
|
|
158 |
"Ignore unsupported extension: " + extension.name);
|
|
|
159 |
}
|
|
|
160 |
continue;
|
|
|
161 |
}
|
|
|
162 |
|
|
|
163 |
ByteBuffer m = ByteBuffer.wrap(extMap.get(extension));
|
|
|
164 |
extension.consumeOnLoad(context, handshakeMessage, m);
|
|
|
165 |
|
|
|
166 |
if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
167 |
SSLLogger.fine("Consumed extension: " + extension.name);
|
|
|
168 |
}
|
|
2
|
169 |
}
|
|
|
170 |
}
|
|
|
171 |
|
|
50768
|
172 |
/**
|
|
|
173 |
* Consider impact of the specified extensions.
|
|
|
174 |
*/
|
|
|
175 |
void consumeOnTrade(HandshakeContext context,
|
|
|
176 |
SSLExtension[] extensions) throws IOException {
|
|
|
177 |
for (SSLExtension extension : extensions) {
|
|
|
178 |
if (!extMap.containsKey(extension)) {
|
|
|
179 |
if (extension.onTradeAbsence != null) {
|
|
|
180 |
extension.absentOnTrade(context, handshakeMessage);
|
|
|
181 |
} else if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
182 |
SSLLogger.fine(
|
|
|
183 |
"Ignore unavailable extension: " + extension.name);
|
|
|
184 |
}
|
|
|
185 |
continue;
|
|
|
186 |
}
|
|
2
|
187 |
|
|
50768
|
188 |
if (extension.onTradeConsumer == null) {
|
|
|
189 |
if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
190 |
SSLLogger.warning(
|
|
|
191 |
"Ignore impact of unsupported extension: " +
|
|
|
192 |
extension.name);
|
|
|
193 |
}
|
|
|
194 |
continue;
|
|
|
195 |
}
|
|
2
|
196 |
|
|
50768
|
197 |
extension.consumeOnTrade(context, handshakeMessage);
|
|
|
198 |
if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
199 |
SSLLogger.fine("Populated with extension: " + extension.name);
|
|
2
|
200 |
}
|
|
|
201 |
}
|
|
|
202 |
}
|
|
|
203 |
|
|
50768
|
204 |
/**
|
|
|
205 |
* Produce extension values for the specified extensions.
|
|
|
206 |
*/
|
|
|
207 |
void produce(HandshakeContext context,
|
|
|
208 |
SSLExtension[] extensions) throws IOException {
|
|
|
209 |
for (SSLExtension extension : extensions) {
|
|
|
210 |
if (extMap.containsKey(extension)) {
|
|
|
211 |
if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
212 |
SSLLogger.fine(
|
|
|
213 |
"Ignore, duplicated extension: " +
|
|
|
214 |
extension.name);
|
|
|
215 |
}
|
|
|
216 |
continue;
|
|
2
|
217 |
}
|
|
50768
|
218 |
|
|
|
219 |
if (extension.networkProducer == null) {
|
|
|
220 |
if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
221 |
SSLLogger.warning(
|
|
|
222 |
"Ignore, no extension producer defined: " +
|
|
|
223 |
extension.name);
|
|
|
224 |
}
|
|
|
225 |
continue;
|
|
|
226 |
}
|
|
2
|
227 |
|
|
50768
|
228 |
byte[] encoded = extension.produce(context, handshakeMessage);
|
|
|
229 |
if (encoded != null) {
|
|
|
230 |
extMap.put(extension, encoded);
|
|
|
231 |
encodedLength += encoded.length + 4; // extension_type (2)
|
|
|
232 |
// extension_data length(2)
|
|
|
233 |
} else if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
234 |
// The extension is not available in the context.
|
|
|
235 |
SSLLogger.fine(
|
|
|
236 |
"Ignore, context unavailable extension: " +
|
|
|
237 |
extension.name);
|
|
|
238 |
}
|
|
2
|
239 |
}
|
|
|
240 |
}
|
|
|
241 |
|
|
50768
|
242 |
/**
|
|
|
243 |
* Produce extension values for the specified extensions, replacing if
|
|
|
244 |
* there is an existing extension value for a specified extension.
|
|
|
245 |
*/
|
|
|
246 |
void reproduce(HandshakeContext context,
|
|
|
247 |
SSLExtension[] extensions) throws IOException {
|
|
|
248 |
for (SSLExtension extension : extensions) {
|
|
|
249 |
if (extension.networkProducer == null) {
|
|
|
250 |
if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
251 |
SSLLogger.warning(
|
|
|
252 |
"Ignore, no extension producer defined: " +
|
|
|
253 |
extension.name);
|
|
|
254 |
}
|
|
|
255 |
continue;
|
|
|
256 |
}
|
|
|
257 |
|
|
|
258 |
byte[] encoded = extension.produce(context, handshakeMessage);
|
|
|
259 |
if (encoded != null) {
|
|
|
260 |
if (extMap.containsKey(extension)) {
|
|
|
261 |
byte[] old = extMap.replace(extension, encoded);
|
|
|
262 |
if (old != null) {
|
|
|
263 |
encodedLength -= old.length + 4;
|
|
|
264 |
}
|
|
|
265 |
encodedLength += encoded.length + 4;
|
|
|
266 |
} else {
|
|
|
267 |
extMap.put(extension, encoded);
|
|
|
268 |
encodedLength += encoded.length + 4;
|
|
|
269 |
// extension_type (2)
|
|
|
270 |
// extension_data length(2)
|
|
|
271 |
}
|
|
|
272 |
} else if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {
|
|
|
273 |
// The extension is not available in the context.
|
|
|
274 |
SSLLogger.fine(
|
|
|
275 |
"Ignore, context unavailable extension: " +
|
|
|
276 |
extension.name);
|
|
|
277 |
}
|
|
|
278 |
}
|
|
|
279 |
}
|
|
|
280 |
|
|
|
281 |
// Note that TLS 1.3 may use empty extensions. Please consider it while
|
|
|
282 |
// using this method.
|
|
|
283 |
int length() {
|
|
|
284 |
if (extMap.isEmpty()) {
|
|
|
285 |
return 0;
|
|
|
286 |
} else {
|
|
|
287 |
return encodedLength;
|
|
2
|
288 |
}
|
|
|
289 |
}
|
|
50768
|
290 |
|
|
|
291 |
// Note that TLS 1.3 may use empty extensions. Please consider it while
|
|
|
292 |
// using this method.
|
|
|
293 |
void send(HandshakeOutStream hos) throws IOException {
|
|
|
294 |
int extsLen = length();
|
|
|
295 |
if (extsLen == 0) {
|
|
|
296 |
return;
|
|
|
297 |
}
|
|
|
298 |
hos.putInt16(extsLen - 2);
|
|
|
299 |
// extensions must be sent in the order they appear in the enum
|
|
|
300 |
for (SSLExtension ext : SSLExtension.values()) {
|
|
|
301 |
byte[] extData = extMap.get(ext);
|
|
|
302 |
if (extData != null) {
|
|
|
303 |
hos.putInt16(ext.id);
|
|
|
304 |
hos.putBytes16(extData);
|
|
|
305 |
}
|
|
|
306 |
}
|
|
|
307 |
}
|
|
|
308 |
|
|
|
309 |
@Override
|
|
|
310 |
public String toString() {
|
|
|
311 |
if (extMap.isEmpty() && (logMap == null || logMap.isEmpty())) {
|
|
|
312 |
return "<no extension>";
|
|
|
313 |
} else {
|
|
|
314 |
StringBuilder builder = new StringBuilder(512);
|
|
|
315 |
if (logMap != null) {
|
|
|
316 |
for (Map.Entry<Integer, byte[]> en : logMap.entrySet()) {
|
|
|
317 |
SSLExtension ext = SSLExtension.valueOf(
|
|
|
318 |
handshakeMessage.handshakeType(), en.getKey());
|
|
|
319 |
if (builder.length() != 0) {
|
|
|
320 |
builder.append(",\n");
|
|
|
321 |
}
|
|
|
322 |
if (ext != null) {
|
|
|
323 |
builder.append(
|
|
|
324 |
ext.toString(ByteBuffer.wrap(en.getValue())));
|
|
|
325 |
} else {
|
|
|
326 |
builder.append(toString(en.getKey(), en.getValue()));
|
|
|
327 |
}
|
|
|
328 |
}
|
|
|
329 |
|
|
|
330 |
return builder.toString();
|
|
|
331 |
} else {
|
|
|
332 |
for (Map.Entry<SSLExtension, byte[]> en : extMap.entrySet()) {
|
|
|
333 |
if (builder.length() != 0) {
|
|
|
334 |
builder.append(",\n");
|
|
|
335 |
}
|
|
|
336 |
builder.append(
|
|
|
337 |
en.getKey().toString(ByteBuffer.wrap(en.getValue())));
|
|
|
338 |
}
|
|
|
339 |
|
|
|
340 |
return builder.toString();
|
|
|
341 |
}
|
|
|
342 |
}
|
|
|
343 |
}
|
|
|
344 |
|
|
|
345 |
private static String toString(int extId, byte[] extData) {
|
|
|
346 |
MessageFormat messageFormat = new MessageFormat(
|
|
|
347 |
"\"unknown extension ({0})\": '{'\n" +
|
|
|
348 |
"{1}\n" +
|
|
|
349 |
"'}'",
|
|
|
350 |
Locale.ENGLISH);
|
|
|
351 |
|
|
|
352 |
HexDumpEncoder hexEncoder = new HexDumpEncoder();
|
|
|
353 |
String encoded = hexEncoder.encodeBuffer(extData);
|
|
|
354 |
|
|
|
355 |
Object[] messageFields = {
|
|
|
356 |
extId,
|
|
|
357 |
Utilities.indent(encoded)
|
|
|
358 |
};
|
|
|
359 |
|
|
|
360 |
return messageFormat.format(messageFields);
|
|
|
361 |
}
|
|
2
|
362 |
}
|