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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
package com.vauth.foxyvpn.vpn.socks
import com.vauth.foxyvpn.data.AppLogger
import com.vauth.foxyvpn.vpn.RelayDispatchers
import com.vauth.foxyvpn.vpn.tun.HevSocks5TunnelConfig
import com.vauth.foxyvpn.vpn.upstream.UpstreamConnectRejectedException
import com.vauth.foxyvpn.vpn.upstream.UpstreamConnectTimeoutException
import com.vauth.foxyvpn.vpn.upstream.UpstreamHealthTracker
import com.vauth.foxyvpn.vpn.upstream.UpstreamSession
import kotlinx.coroutines.CoroutineExceptionHandler
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.cancel
import kotlinx.coroutines.delay
import kotlinx.coroutines.launch
import kotlinx.coroutines.sync.Semaphore
import kotlinx.coroutines.withTimeoutOrNull
import java.io.DataInputStream
import java.io.EOFException
import java.io.IOException
import java.io.OutputStream
import java.net.InetAddress
import java.net.InetSocketAddress
import java.net.ServerSocket
import java.net.Socket
import java.net.SocketException
import java.util.concurrent.atomic.AtomicInteger
import java.util.concurrent.atomic.AtomicLong
private const val TAG = "LocalSocks5Server"
private const val SESSION_WAIT_TIMEOUT_MS = 4_000L
private const val SESSION_WAIT_POLL_INTERVAL_MS = 100L
private const val OPEN_STREAM_TIMEOUT_MS = 30_000L
private const val HANDSHAKE_TIMEOUT_MS = 10_000
private const val HALF_CLOSE_DRAIN_TIMEOUT_MS = 2 * 60_000L
private const val MAX_CONCURRENT_CLIENT_CONNECTIONS = 512
private const val ACCEPT_BACKLOG = 256
private const val ACCEPT_ERROR_BACKOFF_MS = 100L
private const val RELAY_BUFFER_BYTES = 32 * 1024
private const val FAILURE_SUMMARY_INTERVAL_MS = 15_000L
private const val UNREACHABLE_TARGET_TTL_MS = 30_000L
private const val UNREACHABLE_TARGET_TTL_CAP_MS = 10 * 60_000L
private const val REFUSALS_BEFORE_TREATING_AS_POLICY = 3
private const val UNREACHABLE_TARGET_CACHE_CAP = 256
class LocalSocks5Server(
private val bindAddress: String,
private val port: Int,
private val rejectFakeDnsAddresses: Boolean,
private val dohUrl: String? = null,
private val sessionProvider: () -> UpstreamSession?,
private val onSessionUnhealthy: () -> Unit = {},
) {
private var serverSocket: ServerSocket? = null
private val exceptionHandler = CoroutineExceptionHandler { _, throwable ->
AppLogger.w(
TAG,
"unhandled exception in a SOCKS5 connection coroutine (that connection was dropped; app keeps running)",
throwable,
)
}
private val scope = CoroutineScope(RelayDispatchers.relay + SupervisorJob() + exceptionHandler)
private val connectionSlots = Semaphore(MAX_CONCURRENT_CLIENT_CONNECTIONS)
private val upstreamFailures = AtomicInteger(0)
private val lastFailureSummaryAt = AtomicLong(System.currentTimeMillis())
private val staleFakeIpRejections = AtomicInteger(0)
private val localNetworkRejections = AtomicInteger(0)
private val cachedRefusalRejections = AtomicInteger(0)
private val declinedDestinations = AtomicInteger(0)
private val sessionAuthRejections = AtomicInteger(0)
@Volatile private var unauthenticatedSession: UpstreamSession? = null
private val health = UpstreamHealthTracker()
private class RefusalRecord {
var strikes: Int = 0
var expiresAt: Long = 0L
}
private val unreachableTargets = object : LinkedHashMap<String, RefusalRecord>(64, 0.75f, false) {
override fun removeEldestEntry(eldest: MutableMap.MutableEntry<String, RefusalRecord>): Boolean =
size > UNREACHABLE_TARGET_CACHE_CAP
}
fun start() {
val server = ServerSocket()
runCatching { server.reuseAddress = true }
server.bind(InetSocketAddress(InetAddress.getByName(bindAddress), port), ACCEPT_BACKLOG)
serverSocket = server
AppLogger.i(TAG, "started local SOCKS5 proxy on $bindAddress:$port")
scope.launch {
while (!server.isClosed) {
val accepted = runCatching { server.accept() }
val client = accepted.getOrNull()
if (client == null) {
if (server.isClosed) break
AppLogger.d(
TAG,
"accept() failed on an open listening socket: " +
"${accepted.exceptionOrNull()?.message}",
)
delay(ACCEPT_ERROR_BACKOFF_MS)
continue
}
runCatching { client.tcpNoDelay = true }
if (!connectionSlots.tryAcquire()) {
AppLogger.w(TAG, "rejecting SOCKS5 client: connection limit ($MAX_CONCURRENT_CLIENT_CONNECTIONS) reached")
runCatching { client.close() }
continue
}
scope.launch {
try {
handleClient(client)
} finally {
connectionSlots.release()
}
}
}
}
}
fun stop() {
runCatching { serverSocket?.close() }
AppLogger.i(TAG, "stopped local SOCKS5 proxy on $bindAddress:$port")
DohDnsClient.shutdown()
scope.cancel()
synchronized(unreachableTargets) { unreachableTargets.clear() }
health.reset()
unauthenticatedSession = null
val stale = staleFakeIpRejections.getAndSet(0)
if (stale > 0) {
AppLogger.i(
TAG,
"$stale connection(s) were refused during this session because they targeted a " +
"synthetic DNS address with no live mapping",
)
}
val local = localNetworkRejections.getAndSet(0)
if (local > 0) {
AppLogger.i(
TAG,
"$local connection(s) to local-network addresses were refused on-device during this " +
"session (they were never sent through the tunnel)",
)
}
val cached = cachedRefusalRejections.getAndSet(0)
if (cached > 0) {
AppLogger.d(
TAG,
"$cached connection(s) were refused immediately during this session because the edge had " +
"recently refused the same destination (saving one round trip each)",
)
}
val declined = declinedDestinations.getAndSet(0)
if (declined > 0) {
AppLogger.d(
TAG,
"$declined connection(s) were declined by the edge during this session (destinations it " +
"does not proxy, such as non-web ports; an edge policy, not a tunnel fault)",
)
}
val unauthenticated = sessionAuthRejections.getAndSet(0)
if (unauthenticated > 0) {
AppLogger.i(
TAG,
"$unauthenticated connection(s) were refused on-device during this session while the " +
"tunnel's proxy pass was being rejected by the edge (each one saved a round trip " +
"that could only have returned another 401)",
)
}
val failures = upstreamFailures.getAndSet(0)
if (failures > 0) {
AppLogger.w(TAG, "$failures connection(s) failed upstream before this session ended")
}
}
private suspend fun awaitUsableSession(): UpstreamSession? {
val deadline = System.currentTimeMillis() + SESSION_WAIT_TIMEOUT_MS
while (true) {
val session = sessionProvider()
if (session != null && session.isConnected) return session
if (System.currentTimeMillis() >= deadline) return null
delay(SESSION_WAIT_POLL_INTERVAL_MS)
}
}
private fun recordUpstreamFailure(target: String, cause: Throwable?, declinedByEdge: Boolean = false) {
AppLogger.d(TAG, "opening upstream stream failed for $target: ${cause?.message ?: "timed out"}")
if (declinedByEdge) {
declinedDestinations.incrementAndGet()
return
}
upstreamFailures.incrementAndGet()
val now = System.currentTimeMillis()
val since = lastFailureSummaryAt.get()
if (now - since < FAILURE_SUMMARY_INTERVAL_MS) return
if (!lastFailureSummaryAt.compareAndSet(since, now)) return
val total = upstreamFailures.getAndSet(0)
if (total <= 0) return
AppLogger.w(
TAG,
"$total connection(s) failed upstream in the last ${(now - since) / 1_000}s " +
"(most recent: $target -- ${cause?.message ?: "timed out"})",
)
}
private suspend fun handleClient(client: Socket) {
try {
handleClientOrThrow(client)
} catch (e: EOFException) {
AppLogger.d(TAG, "SOCKS5 client disconnected before completing its request (EOF)")
} catch (e: SocketException) {
AppLogger.d(TAG, "SOCKS5 client socket closed unexpectedly: ${e.message}")
} catch (e: IOException) {
AppLogger.d(TAG, "I/O error handling SOCKS5 client: ${e.message}")
}
}
private suspend fun handleClientOrThrow(client: Socket) {
client.use { socket ->
socket.soTimeout = HANDSHAKE_TIMEOUT_MS
val input = DataInputStream(socket.getInputStream())
val output = socket.getOutputStream()
val ver = input.readUnsignedByte()
if (ver != 0x05) {
AppLogger.d(TAG, "rejecting client: unsupported SOCKS version $ver in greeting")
return
}
val nMethods = input.readUnsignedByte()
val methods = ByteArray(nMethods)
if (nMethods > 0) input.readFully(methods)
if (methods.none { it.toInt() == 0x00 }) {
output.write(byteArrayOf(0x05, 0xFF.toByte()))
output.flush()
return
}
output.write(byteArrayOf(0x05, 0x00))
output.flush()
val reqVer = input.readUnsignedByte()
if (reqVer != 0x05) {
AppLogger.d(TAG, "rejecting request: unsupported SOCKS version $reqVer")
output.write(socksReply(0x07))
output.flush()
return
}
val cmd = input.readUnsignedByte()
input.readUnsignedByte()
when (cmd) {
0x01 -> handleConnect(socket, input, output)
0x03 -> handleUdpAssociate(socket, input, output)
else -> {
output.write(socksReply(0x07))
output.flush()
}
}
}
}
private suspend fun handleConnect(socket: Socket, input: DataInputStream, output: OutputStream) {
val target = runCatching { readTargetAddress(input) }.getOrNull()
if (target == null) {
output.write(socksReply(0x08))
output.flush()
return
}
socket.soTimeout = 0
val targetHost = target.host
val targetPort = target.port
val targetKey = "$targetHost:$targetPort"
if (rejectFakeDnsAddresses && HevSocks5TunnelConfig.isFakeDnsAddress(targetHost)) {
staleFakeIpRejections.incrementAndGet()
AppLogger.d(
TAG,
"refusing $targetKey: synthetic DNS address with no live hostname mapping " +
"(stale cached DNS answer from before the tunnel restarted)",
)
output.write(socksReply(0x04))
output.flush()
return
}
val literal = target.literal
if (literal != null && literal.isLocalNetworkDestination()) {
localNetworkRejections.incrementAndGet()
AppLogger.d(TAG, "refusing $targetKey: local-network address, not carried by the tunnel")
output.write(socksReply(0x02))
output.flush()
return
}
if (isKnownUnreachable(targetKey)) {
cachedRefusalRejections.incrementAndGet()
AppLogger.d(TAG, "refusing $targetKey: the edge refused this destination moments ago")
output.write(socksReply(0x04))
output.flush()
return
}
val session = awaitUsableSession()
if (session == null) {
output.write(socksReply(0x05))
output.flush()
return
}
if (session === unauthenticatedSession) {
sessionAuthRejections.incrementAndGet()
AppLogger.d(
TAG,
"refusing $targetKey: the edge is rejecting this session's proxy pass, so no destination " +
"can succeed until the tunnel is redialed",
)
output.write(socksReply(0x01))
output.flush()
return
}
val tunnelResult = runCatching {
withTimeoutOrNull(OPEN_STREAM_TIMEOUT_MS) { session.openStream(targetHost, targetPort) }
}
val tunneled = tunnelResult.getOrNull()
if (tunneled == null) {
val cause = tunnelResult.exceptionOrNull()
val declinedByEdge = shouldRememberRefusal(cause)
if (declinedByEdge) rememberUnreachable(targetKey, targetPort)
recordUpstreamFailure(targetKey, cause, declinedByEdge = declinedByEdge)
when (health.observeFailure(targetKey, cause)) {
UpstreamHealthTracker.Verdict.TARGET_FAILURE -> Unit
UpstreamHealthTracker.Verdict.SESSION_UNHEALTHY -> {
AppLogger.w(
TAG,
"upstream session looks unhealthy: several unrelated destinations failed without a " +
"single success between them, so the tunnel is the likelier cause than any one " +
"destination; asking for a redial",
)
runCatching { onSessionUnhealthy() }
}
UpstreamHealthTracker.Verdict.SESSION_UNAUTHENTICATED -> {
val alreadyLatched = session === unauthenticatedSession
unauthenticatedSession = session
if (!alreadyLatched) {
AppLogger.w(
TAG,
"the edge rejected this session's proxy pass (${cause?.message}); refusing further " +
"flows on this session locally and asking for a redial with a fresh pass",
)
}
runCatching { onSessionUnhealthy() }
}
}
output.write(socksReply(replyCodeFor(cause)))
output.flush()
return
}
health.observeSuccess()
forgetUnreachable(targetKey)
if (unauthenticatedSession != null && session !== unauthenticatedSession) {
unauthenticatedSession = null
}
output.write(socksReply(0x00, socket.localAddress, socket.localPort))
output.flush()
val clientToUpstream = scope.launch {
runCatching { socket.getInputStream().copyTo(tunneled.output, RELAY_BUFFER_BYTES) }
runCatching { tunneled.output.close() }
}
runCatching { tunneled.input.copyTo(output, RELAY_BUFFER_BYTES) }
runCatching { socket.shutdownOutput() }
if (clientToUpstream.isActive) {
val drained = withTimeoutOrNull(HALF_CLOSE_DRAIN_TIMEOUT_MS) { clientToUpstream.join() }
if (drained == null) {
AppLogger.d(TAG, "closing half-closed tunnel after drain timeout=${HALF_CLOSE_DRAIN_TIMEOUT_MS}ms")
runCatching { socket.close() }
runCatching { tunneled.close() }
clientToUpstream.join()
}
}
tunneled.close()
}
private suspend fun handleUdpAssociate(socket: Socket, input: DataInputStream, output: OutputStream) {
val target = runCatching { readTargetAddress(input) }.getOrNull()
if (target == null) {
output.write(socksReply(0x08))
output.flush()
return
}
val requestedPort = target.port
if (requestedPort != DNS_PORT && requestedPort != 0) {
output.write(socksReply(0x02))
output.flush()
return
}
val session = awaitUsableSession()
if (session == null) {
output.write(socksReply(0x05))
output.flush()
return
}
if (session === unauthenticatedSession) {
sessionAuthRejections.incrementAndGet()
output.write(socksReply(0x01))
output.flush()
return
}
val relay = runCatching {
Socks5UdpDnsRelay(
socket.localAddress,
socket.inetAddress,
InetSocketAddress(socket.localAddress, port),
dohUrl,
sessionProvider,
) {
AppLogger.d(
TAG,
"a UDP association carried traffic this tunnel cannot relay; the association was kept " +
"open for DNS and the unsupported datagrams were dropped",
)
}
}.getOrNull()
if (relay == null) {
output.write(socksReply(0x01))
output.flush()
return
}
try {
relay.start()
output.write(socksReply(0x00, relay.boundAddress, relay.boundPort))
output.flush()
socket.soTimeout = 0
val drain = ByteArray(64)
while (true) {
val read = runCatching { input.read(drain) }.getOrDefault(-1)
if (read < 0) break
}
} finally {
relay.stop()
}
}
private data class Socks5Target(
val host: String,
val port: Int,
val literal: InetAddress?,
)
private fun readTargetAddress(input: DataInputStream): Socks5Target {
val addrType = input.readUnsignedByte()
var literal: InetAddress? = null
val host = when (addrType) {
0x01 -> {
val bytes = ByteArray(4)
input.readFully(bytes)
literal = InetAddress.getByAddress(bytes)
bytes.joinToString(".") { (it.toInt() and 0xFF).toString() }
}
0x03 -> {
val len = input.readUnsignedByte()
if (len == 0) error("empty SOCKS5 domain name")
val bytes = ByteArray(len)
input.readFully(bytes)
String(bytes, Charsets.US_ASCII)
}
0x04 -> {
val bytes = ByteArray(16)
input.readFully(bytes)
val parsed = InetAddress.getByAddress(bytes)
literal = parsed
parsed.hostAddress ?: ""
}
else -> error("unsupported SOCKS5 address type $addrType")
}
val port = input.readUnsignedShort()
return Socks5Target(host, port, literal)
}
private fun InetAddress.isLocalNetworkDestination(): Boolean {
if (isAnyLocalAddress ||
isLoopbackAddress ||
isLinkLocalAddress ||
isMulticastAddress ||
isSiteLocalAddress
) {
return true
}
val raw = address
if (raw.size == 16) return (raw[0].toInt() and 0xFE) == 0xFC
if (raw.size == 4) return raw.all { it.toInt() and 0xFF == 0xFF }
return false
}
private fun replyCodeFor(cause: Throwable?): Int {
if (cause == null || cause is UpstreamConnectTimeoutException) {
return 0x06
}
val rejection = cause as? UpstreamConnectRejectedException ?: return 0x01
val status = rejection.statusCode ?: return 0x01
return when (status) {
in UpstreamHealthTracker.TARGET_UNREACHABLE_STATUS_CODES -> 0x04
in UpstreamHealthTracker.SESSION_FATAL_STATUS_CODES -> 0x01
else -> 0x01
}
}
private fun shouldRememberRefusal(cause: Throwable?): Boolean {
val status = (cause as? UpstreamConnectRejectedException)?.statusCode ?: return false
return status in UpstreamHealthTracker.TARGET_UNREACHABLE_STATUS_CODES
}
private fun isKnownUnreachable(key: String): Boolean = synchronized(unreachableTargets) {
val record = unreachableTargets[key] ?: return false
return System.currentTimeMillis() < record.expiresAt
}
private fun rememberUnreachable(key: String, targetPort: Int): Int = synchronized(unreachableTargets) {
val record = unreachableTargets.getOrPut(key) { RefusalRecord() }
record.strikes += 1
val backoffMs = (UNREACHABLE_TARGET_TTL_MS shl (record.strikes - 1).coerceAtMost(16))
.coerceAtMost(UNREACHABLE_TARGET_TTL_CAP_MS)
record.expiresAt = System.currentTimeMillis() + backoffMs
if (record.strikes == REFUSALS_BEFORE_TREATING_AS_POLICY) {
AppLogger.d(
TAG,
"the edge has refused $key ${record.strikes} times in a row; it does not appear to proxy " +
"port $targetPort, so further attempts will be refused on-device with an increasing " +
"backoff (up to ${UNREACHABLE_TARGET_TTL_CAP_MS / 1_000}s) instead of costing a round trip",
)
}
return record.strikes
}
private fun forgetUnreachable(key: String) {
synchronized(unreachableTargets) {
if (unreachableTargets.remove(key) != null) {
AppLogger.d(TAG, "$key succeeded; clearing its refusal backoff")
}
}
}
private fun socksReply(
replyCode: Int,
boundAddress: InetAddress? = null,
boundPort: Int = 0,
): ByteArray {
val addressBytes = boundAddress?.address ?: ByteArray(4)
val addressType = if (addressBytes.size == 16) 0x04 else 0x01
return byteArrayOf(0x05, replyCode.toByte(), 0x00, addressType.toByte()) +
addressBytes +
byteArrayOf((boundPort ushr 8).toByte(), boundPort.toByte())
}
}