1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 package io.netty.handler.codec.http.websocketx;
17
18 import io.netty.handler.codec.http.DefaultFullHttpRequest;
19 import io.netty.handler.codec.http.FullHttpRequest;
20 import io.netty.handler.codec.http.FullHttpResponse;
21 import io.netty.handler.codec.http.HttpHeaderNames;
22 import io.netty.handler.codec.http.HttpHeaderValues;
23 import io.netty.handler.codec.http.HttpHeaders;
24 import io.netty.handler.codec.http.HttpMethod;
25 import io.netty.handler.codec.http.HttpResponseStatus;
26 import io.netty.handler.codec.http.HttpVersion;
27 import io.netty.util.CharsetUtil;
28 import io.netty.util.internal.logging.InternalLogger;
29 import io.netty.util.internal.logging.InternalLoggerFactory;
30
31 import java.net.URI;
32
33
34
35
36
37
38
39
40 public class WebSocketClientHandshaker07 extends WebSocketClientHandshaker {
41
42 private static final InternalLogger logger = InternalLoggerFactory.getInstance(WebSocketClientHandshaker07.class);
43 public static final String MAGIC_GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
44
45 private String expectedChallengeResponseString;
46
47 private final boolean allowExtensions;
48 private final boolean performMasking;
49 private final boolean allowMaskMismatch;
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68 public WebSocketClientHandshaker07(URI webSocketURL, WebSocketVersion version, String subprotocol,
69 boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength) {
70 this(webSocketURL, version, subprotocol, allowExtensions, customHeaders, maxFramePayloadLength, true, false);
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 public WebSocketClientHandshaker07(URI webSocketURL, WebSocketVersion version, String subprotocol,
98 boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength,
99 boolean performMasking, boolean allowMaskMismatch) {
100 super(webSocketURL, version, subprotocol, customHeaders, maxFramePayloadLength);
101 this.allowExtensions = allowExtensions;
102 this.performMasking = performMasking;
103 this.allowMaskMismatch = allowMaskMismatch;
104 }
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124 @Override
125 protected FullHttpRequest newHandshakeRequest() {
126
127 URI wsURL = uri();
128 String path = rawPath(wsURL);
129
130
131 byte[] nonce = WebSocketUtil.randomBytes(16);
132 String key = WebSocketUtil.base64(nonce);
133
134 String acceptSeed = key + MAGIC_GUID;
135 byte[] sha1 = WebSocketUtil.sha1(acceptSeed.getBytes(CharsetUtil.US_ASCII));
136 expectedChallengeResponseString = WebSocketUtil.base64(sha1);
137
138 if (logger.isDebugEnabled()) {
139 logger.debug(
140 "WebSocket version 07 client handshake key: {}, expected response: {}",
141 key, expectedChallengeResponseString);
142 }
143
144
145 FullHttpRequest request = new DefaultFullHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.GET, path);
146 HttpHeaders headers = request.headers();
147
148 if (customHeaders != null) {
149 headers.add(customHeaders);
150 }
151
152 headers.set(HttpHeaderNames.UPGRADE, HttpHeaderValues.WEBSOCKET)
153 .set(HttpHeaderNames.CONNECTION, HttpHeaderValues.UPGRADE)
154 .set(HttpHeaderNames.SEC_WEBSOCKET_KEY, key)
155 .set(HttpHeaderNames.HOST, websocketHostValue(wsURL))
156 .set(HttpHeaderNames.SEC_WEBSOCKET_ORIGIN, websocketOriginValue(wsURL));
157
158 String expectedSubprotocol = expectedSubprotocol();
159 if (expectedSubprotocol != null && !expectedSubprotocol.isEmpty()) {
160 headers.set(HttpHeaderNames.SEC_WEBSOCKET_PROTOCOL, expectedSubprotocol);
161 }
162
163 headers.set(HttpHeaderNames.SEC_WEBSOCKET_VERSION, "7");
164 return request;
165 }
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184 @Override
185 protected void verify(FullHttpResponse response) {
186 final HttpResponseStatus status = HttpResponseStatus.SWITCHING_PROTOCOLS;
187 final HttpHeaders headers = response.headers();
188
189 if (!response.status().equals(status)) {
190 throw new WebSocketHandshakeException("Invalid handshake response getStatus: " + response.status());
191 }
192
193 CharSequence upgrade = headers.get(HttpHeaderNames.UPGRADE);
194 if (!HttpHeaderValues.WEBSOCKET.contentEqualsIgnoreCase(upgrade)) {
195 throw new WebSocketHandshakeException("Invalid handshake response upgrade: " + upgrade);
196 }
197
198 if (!headers.containsValue(HttpHeaderNames.CONNECTION, HttpHeaderValues.UPGRADE, true)) {
199 throw new WebSocketHandshakeException("Invalid handshake response connection: "
200 + headers.get(HttpHeaderNames.CONNECTION));
201 }
202
203 CharSequence accept = headers.get(HttpHeaderNames.SEC_WEBSOCKET_ACCEPT);
204 if (accept == null || !accept.equals(expectedChallengeResponseString)) {
205 throw new WebSocketHandshakeException(String.format(
206 "Invalid challenge. Actual: %s. Expected: %s", accept, expectedChallengeResponseString));
207 }
208 }
209
210 @Override
211 protected WebSocketFrameDecoder newWebsocketDecoder() {
212 return new WebSocket07FrameDecoder(false, allowExtensions, maxFramePayloadLength(), allowMaskMismatch);
213 }
214
215 @Override
216 protected WebSocketFrameEncoder newWebSocketEncoder() {
217 return new WebSocket07FrameEncoder(performMasking);
218 }
219 }