/
PortForwarderWebsocket.java
396 lines (347 loc) · 12.4 KB
/
PortForwarderWebsocket.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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
/**
* Copyright (C) 2015 Red Hat, Inc.
*
* 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://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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 io.fabric8.kubernetes.client.dsl.internal;
import java.io.Closeable;
import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.URL;
import java.nio.ByteBuffer;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.ServerSocketChannel;
import java.nio.channels.SocketChannel;
import java.nio.channels.WritableByteChannel;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import io.fabric8.kubernetes.client.LocalPortForward;
import io.fabric8.kubernetes.client.PortForward;
import io.fabric8.kubernetes.client.utils.URLUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.WebSocket;
import okhttp3.WebSocketListener;
import okio.ByteString;
/**
* A port-forwarder using the websocket protocol.
* It requires Kubernetes 1.6+ (previous versions support the SPDY protocol only).
*/
public class PortForwarderWebsocket implements PortForwarder {
private static final Logger LOG = LoggerFactory.getLogger(PortForwarderWebsocket.class);
private OkHttpClient client;
public PortForwarderWebsocket(OkHttpClient client) {
this.client = client;
}
@Override
public LocalPortForward forward(URL resourceBaseUrl, int port) {
return forward(resourceBaseUrl, port, 0);
}
@Override
public LocalPortForward forward(URL resourceBaseUrl, int port, int localPort) {
return forward(resourceBaseUrl, port, null, localPort);
}
@Override
public LocalPortForward forward(final URL resourceBaseUrl, final int port, final InetAddress localHost, final int localPort) {
try {
final ServerSocketChannel server;
if (localHost == null) {
server = ServerSocketChannel.open().bind(new InetSocketAddress(localPort));
} else {
server = ServerSocketChannel.open().bind(new InetSocketAddress(localHost, localPort));
}
final AtomicBoolean alive = new AtomicBoolean(true);
final CopyOnWriteArrayList<PortForward> handles = new CopyOnWriteArrayList<>();
final ExecutorService executorService = Executors.newSingleThreadExecutor();
// Create a handle that can be used to retrieve information and stop the port-forward
final LocalPortForward localPortForwardHandle = new LocalPortForward() {
@Override
public void close() throws IOException {
alive.set(false);
try {
server.close();
} finally {
closeQuietly(handles.toArray(new Closeable[]{}));
closeExecutor(executorService);
}
}
@Override
public boolean isAlive() {
return alive.get();
}
@Override
public boolean errorOccurred() {
for (PortForward handle : handles) {
if (handle.errorOccurred()) {
return true;
}
}
return false;
}
@Override
public InetAddress getLocalAddress() {
try {
return ((InetSocketAddress) server.getLocalAddress()).getAddress();
} catch (IOException e) {
throw new IllegalStateException("Cannot determine local address", e);
}
}
@Override
public int getLocalPort() {
try {
return ((InetSocketAddress) server.getLocalAddress()).getPort();
} catch (IOException e) {
throw new IllegalStateException("Cannot determine local address", e);
}
}
@Override
public Collection<Throwable> getClientThrowables() {
Collection<Throwable> clientThrowables = new ArrayList<>();
for (PortForward handle : handles) {
clientThrowables.addAll(handle.getClientThrowables());
}
return clientThrowables;
}
@Override
public Collection<Throwable> getServerThrowables() {
Collection<Throwable> serverThrowables = new ArrayList<>();
for (PortForward handle : handles) {
serverThrowables.addAll(handle.getServerThrowables());
}
return serverThrowables;
}
};
// Start listening on localhost for new connections.
// Every new connection will open its own stream on the remote resource.
executorService.execute(() -> {
// accept cycle
while (alive.get()) {
try {
SocketChannel socket = server.accept();
handles.add(forward(resourceBaseUrl, port, socket, socket));
} catch (IOException e) {
if (alive.get()) {
LOG.error("Error while listening for connections", e);
}
closeQuietly(localPortForwardHandle);
}
}
});
return localPortForwardHandle;
} catch (IOException e) {
throw new IllegalStateException("Unable to port forward", e);
}
}
@Override
public PortForward forward(URL resourceBaseUrl, int port, final ReadableByteChannel in, final WritableByteChannel out) {
final AtomicBoolean alive = new AtomicBoolean(true);
final AtomicBoolean errorOccurred = new AtomicBoolean(false);
final Collection<Throwable> clientThrowables = Collections.synchronizedCollection(new ArrayList<>());
final Collection<Throwable> serverThrowables = Collections.synchronizedCollection(new ArrayList<>());
final String logPrefix = "FWD";
Request request = new Request.Builder()
.get()
.url(URLUtils.join(resourceBaseUrl.toString(), "portforward?ports=" + port))
.build();
final WebSocket socket = client.newWebSocket(request, new WebSocketListener() {
private int messagesRead = 0;
private ExecutorService pumperService = Executors.newSingleThreadExecutor();
@Override
public void onOpen(final WebSocket webSocket, Response response) {
LOG.debug("{}: onOpen", logPrefix);
if (in != null) {
pumperService.execute(() -> {
ByteBuffer buffer = ByteBuffer.allocate(4096);
int read;
try {
do {
buffer.clear();
buffer.put((byte) 0); // channel byte
read = in.read(buffer);
if (read > 0) {
buffer.flip();
ByteString data = ByteString.of(buffer);
webSocket.send(data);
}
} while (alive.get() && read >= 0);
} catch (IOException e) {
if (alive.get()) {
clientThrowables.add(e);
LOG.error("Error while writing client data");
closeBothWays(webSocket, 1001, "Client error");
}
}
});
}
}
@Override
public void onMessage(WebSocket webSocket, String text) {
LOG.debug("{}: onMessage(String)", logPrefix);
onMessage(webSocket, ByteBuffer.wrap(text.getBytes(StandardCharsets.UTF_8)));
}
@Override
public void onMessage(WebSocket webSocket, ByteString bytes) {
LOG.debug("{}: onMessage(ByteString)", logPrefix);
onMessage(webSocket, bytes.asByteBuffer());
}
private void onMessage(WebSocket webSocket, ByteBuffer buffer) {
messagesRead++;
if (messagesRead <= 2) {
// skip the first two messages, containing the ports used internally
return;
}
if (!buffer.hasRemaining()) {
errorOccurred.set(true);
LOG.error("Received an empty message");
closeBothWays(webSocket, 1002, "Protocol error");
}
byte channel = buffer.get();
if (channel < 0 || channel > 1) {
errorOccurred.set(true);
LOG.error("Received a wrong channel from the remote socket: {}", channel);
closeBothWays(webSocket, 1002, "Protocol error");
} else if (channel == 1) {
// Error channel
errorOccurred.set(true);
LOG.error("Received an error from the remote socket");
closeForwarder();
} else {
// Data
if (out != null) {
try {
out.write(buffer); // channel byte already skipped
} catch (IOException e) {
if (alive.get()) {
clientThrowables.add(e);
LOG.error("Error while forwarding data to the client", e);
closeBothWays(webSocket, 1002, "Protocol error");
}
}
}
}
}
@Override
public void onClosing(WebSocket webSocket, int code, String reason) {
LOG.debug("{}: onClosing. Code={}, Reason={}", logPrefix, code, reason);
if (alive.get()) {
closeForwarder();
}
}
@Override
public void onClosed(WebSocket webSocket, int code, String reason) {
LOG.debug("{}: onClosed. Code={}, Reason={}", logPrefix, code, reason);
if (alive.get()) {
closeForwarder();
}
}
@Override
public void onFailure(WebSocket webSocket, Throwable t, Response response) {
LOG.debug("{}: onFailure", logPrefix);
if (alive.get()) {
serverThrowables.add(t);
LOG.error(logPrefix + ": Throwable received from websocket", t);
closeForwarder();
}
}
private void closeBothWays(WebSocket webSocket, int code, String message) {
LOG.debug("{}: Closing with code {} and reason: {}", logPrefix, code, message);
alive.set(false);
try {
webSocket.close(code, message);
} catch (Exception e) {
serverThrowables.add(e);
LOG.error("Error while closing the websocket", e);
}
closeForwarder();
}
private void closeForwarder() {
alive.set(false);
if (in != null) {
try {
in.close();
} catch (IOException e) {
LOG.error(logPrefix + ": Error while closing the client input channel", e);
}
}
if (out != null && out != in) {
try {
out.close();
} catch (IOException e) {
LOG.error(logPrefix + ": Error while closing the client output channel", e);
}
}
closeExecutor(pumperService);
}
});
return new PortForward() {
@Override
public void close() throws IOException {
socket.close(1001, "User closing");
}
@Override
public boolean isAlive() {
return alive.get();
}
@Override
public boolean errorOccurred() {
return errorOccurred.get() || !clientThrowables.isEmpty() || !serverThrowables.isEmpty();
}
@Override
public Collection<Throwable> getClientThrowables() {
return clientThrowables;
}
@Override
public Collection<Throwable> getServerThrowables() {
return serverThrowables;
}
};
}
private void closeExecutor(ExecutorService executor) {
try {
executor.shutdown();
if (!executor.awaitTermination(5, TimeUnit.SECONDS)) {
executor.shutdownNow();
if (!executor.awaitTermination(10, TimeUnit.SECONDS)) {
LOG.error("The executor service did not terminate");
}
}
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
} catch (Exception e) {
LOG.error("Error while closing the executor", e);
}
}
public static void closeQuietly(Closeable... cloaseables) {
if(cloaseables != null) {
for(Closeable c : cloaseables) {
try {
if(c != null) {
c.close();
}
} catch (IOException ioe) {
}
}
}
}
}