Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ internal object NetworkResumePolicy {
expectedRequest == currentRequest &&
hasNetworkTimeoutError &&
sameServer &&
availability == UnderlyingNetworkAvailability.VALIDATED
UnderlyingNetworkPolicy.canAttemptTunnelProbe(availability)
}
28 changes: 19 additions & 9 deletions app/src/main/java/com/tobevpn/app/vpn/ToBeVpnService.kt
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,6 @@ class ToBeVpnService : VpnService(), CoreCallbackHandler {
val cm = getSystemService(ConnectivityManager::class.java) ?: return
val request = NetworkRequest.Builder()
.addCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)
.addCapability(NetworkCapabilities.NET_CAPABILITY_NOT_RESTRICTED)
.addCapability(NetworkCapabilities.NET_CAPABILITY_NOT_VPN)
.build()

Expand Down Expand Up @@ -650,7 +649,8 @@ class ToBeVpnService : VpnService(), CoreCallbackHandler {
PhysicalNetworkSelector.ChangeType.UNAVAILABLE -> {
SafeDiagnostics.warn(
TAG,
"Validated physical network unavailable: " +
"No validated physical network selected; " +
"tunnel liveness checks remain enabled: " +
"previous=${lastUnderlyingNetworkSummary ?: "UNKNOWN"}",
)
cancelNetworkHandover()
Expand Down Expand Up @@ -692,7 +692,11 @@ class ToBeVpnService : VpnService(), CoreCallbackHandler {
networkBaselineReady = true
val selected = physicalNetworkSelector.selectedOrNull()
if (selected == null) {
SafeDiagnostics.warn(TAG, "Physical-network baseline has no validated network")
SafeDiagnostics.trace(
TAG,
"Physical-network baseline has no validated network; " +
"tunnel liveness checks remain enabled",
)
scheduleUnderlyingNetworkTimeout(cm, "BASELINE_EMPTY")
} else {
val summary = cm.getNetworkCapabilities(selected)?.let(::networkSummary)
Expand Down Expand Up @@ -756,10 +760,15 @@ class ToBeVpnService : VpnService(), CoreCallbackHandler {
if (cleanedUp || activeConnectionGeneration < 0) return
val generation = activeConnectionGeneration
val startedAtMs = SystemClock.elapsedRealtime()
val initialAvailability = underlyingNetworkAvailability(cm)
val initialTimeoutMs =
UnderlyingNetworkPolicy.teardownTimeoutMs(initialAvailability)
if (initialTimeoutMs == null) {
cancelUnderlyingNetworkTimeout()
return
}
synchronized(networkJobLock) {
if (underlyingNetworkTimeoutJob?.isCompleted == false) return
val initialAvailability = underlyingNetworkAvailability(cm)
val initialTimeoutMs = UnderlyingNetworkPolicy.timeoutMs(initialAvailability)
SafeDiagnostics.trace(
TAG,
"Underlying-network timeout scheduled: generation=$generation " +
Expand All @@ -769,14 +778,15 @@ class ToBeVpnService : VpnService(), CoreCallbackHandler {
val job = serviceScope.launch(start = CoroutineStart.LAZY) {
while (!cleanedUp && generation == activeConnectionGeneration) {
val availability = underlyingNetworkAvailability(cm)
if (availability == UnderlyingNetworkAvailability.VALIDATED) {
val timeoutMs = UnderlyingNetworkPolicy.teardownTimeoutMs(availability)
if (timeoutMs == null) {
SafeDiagnostics.trace(
TAG,
"Underlying-network timeout cancelled by final validation",
"Underlying-network timeout cancelled after physical network returned: " +
"availability=${availability.name}",
)
return@launch
}
val timeoutMs = UnderlyingNetworkPolicy.timeoutMs(availability)
val nowMs = SystemClock.elapsedRealtime()
val deadline = NetworkAvailabilityDeadline(
startedAtMs = startedAtMs,
Expand All @@ -785,7 +795,7 @@ class ToBeVpnService : VpnService(), CoreCallbackHandler {
if (deadline.isExpired(nowMs)) {
SafeDiagnostics.warn(
TAG,
"Validated physical network unavailable: generation=$generation " +
"Physical network unavailable: generation=$generation " +
"source=$source availability=${availability.name} " +
"timeout_ms=$timeoutMs",
)
Expand Down
18 changes: 10 additions & 8 deletions app/src/main/java/com/tobevpn/app/vpn/UnderlyingNetworkPolicy.kt
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ package com.tobevpn.app.vpn

/**
* Distinguishes a complete loss of physical connectivity from Android's
* temporary internet-validation state. A TUN must not be kept indefinitely,
* but captive-portal checks and Wi-Fi revalidation need more than 15 seconds.
* general-internet validation state. An unvalidated carrier network can still
* carry a working VPN tunnel (for example on an operator allowlist), so only
* complete physical-network loss receives a teardown deadline.
*/
internal enum class UnderlyingNetworkAvailability {
VALIDATED,
Expand All @@ -13,11 +14,12 @@ internal enum class UnderlyingNetworkAvailability {

internal object UnderlyingNetworkPolicy {
const val NO_NETWORK_TIMEOUT_MS = 15_000L
const val UNVALIDATED_NETWORK_TIMEOUT_MS = 45_000L

fun timeoutMs(availability: UnderlyingNetworkAvailability): Long = when (availability) {
UnderlyingNetworkAvailability.VALIDATED -> 0L
UnderlyingNetworkAvailability.UNVALIDATED -> UNVALIDATED_NETWORK_TIMEOUT_MS
UnderlyingNetworkAvailability.UNAVAILABLE -> NO_NETWORK_TIMEOUT_MS
}
fun canAttemptTunnelProbe(availability: UnderlyingNetworkAvailability): Boolean =
availability != UnderlyingNetworkAvailability.UNAVAILABLE

fun teardownTimeoutMs(availability: UnderlyingNetworkAvailability): Long? =
NO_NETWORK_TIMEOUT_MS.takeIf {
availability == UnderlyingNetworkAvailability.UNAVAILABLE
}
}
89 changes: 51 additions & 38 deletions app/src/main/java/com/tobevpn/app/vpn/VpnConnectionManager.kt
Original file line number Diff line number Diff line change
Expand Up @@ -1064,9 +1064,10 @@ class VpnConnectionManager @Inject constructor(
}

/**
* A physical network did not become validated within the service grace
* period. Tear down the TUN instead of leaving Android routing traffic into
* a dead VPN until the process or phone is restarted.
* The physical network disappeared for the full service grace period.
* Tear down the TUN instead of leaving Android routing traffic into a dead
* VPN until the process or phone is restarted. Merely missing Android's
* general-internet validation is not treated as physical-network loss.
*/
fun handleUnderlyingNetworkUnavailable(generation: Int) {
cancelPendingRecovery("UNDERLYING_NETWORK_UNAVAILABLE")
Expand All @@ -1085,7 +1086,7 @@ class VpnConnectionManager @Inject constructor(
val resumeRequest = requestedOperation.get()
SafeDiagnostics.warn(
TAG,
"VPN stopped after validated physical network timeout: generation=$generation",
"VPN stopped after physical network loss timeout: generation=$generation",
)
val waitingServiceKept = stopForUnderlyingNetworkTimeout(generation)
?: return@launch
Expand Down Expand Up @@ -1182,13 +1183,12 @@ class VpnConnectionManager @Inject constructor(
val cm = context.getSystemService(ConnectivityManager::class.java) ?: return false
val networkRequest = NetworkRequest.Builder()
.addCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)
.addCapability(NetworkCapabilities.NET_CAPABILITY_NOT_RESTRICTED)
.addCapability(NetworkCapabilities.NET_CAPABILITY_NOT_VPN)
.build()
lateinit var callback: ConnectivityManager.NetworkCallback
callback = object : ConnectivityManager.NetworkCallback() {
override fun onAvailable(network: Network) {
resumeAfterValidatedNetwork(
resumeAfterAvailableNetwork(
callback = callback,
cm = cm,
server = server,
Expand All @@ -1201,18 +1201,13 @@ class VpnConnectionManager @Inject constructor(
network: Network,
networkCapabilities: NetworkCapabilities,
) {
if (networkCapabilities.hasCapability(
NetworkCapabilities.NET_CAPABILITY_VALIDATED,
)
) {
resumeAfterValidatedNetwork(
callback = callback,
cm = cm,
server = server,
request = request,
waitingServiceGeneration = waitingServiceGeneration,
)
}
resumeAfterAvailableNetwork(
callback = callback,
cm = cm,
server = server,
request = request,
waitingServiceGeneration = waitingServiceGeneration,
)
}
}
val timeoutJob = scope.launch(start = CoroutineStart.LAZY) {
Expand All @@ -1233,10 +1228,10 @@ class VpnConnectionManager @Inject constructor(
timeoutJob.start()
SafeDiagnostics.info(
TAG,
"VPN waiting for validated physical network before same-server resume: " +
"VPN waiting for physical network before same-server resume: " +
"timeout_ms=$NETWORK_RESUME_WAIT_TIMEOUT_MS",
)
resumeAfterValidatedNetwork(
resumeAfterAvailableNetwork(
callback = callback,
cm = cm,
server = server,
Expand Down Expand Up @@ -1264,15 +1259,15 @@ class VpnConnectionManager @Inject constructor(
}
}

private fun resumeAfterValidatedNetwork(
private fun resumeAfterAvailableNetwork(
callback: ConnectivityManager.NetworkCallback,
cm: ConnectivityManager,
server: Server,
request: Int,
waitingServiceGeneration: Int,
) {
val availability = underlyingNetworkAvailability()
if (availability != UnderlyingNetworkAvailability.VALIDATED) return
if (!UnderlyingNetworkPolicy.canAttemptTunnelProbe(availability)) return
val (accepted, timeoutJob) = synchronized(networkResumeLock) {
if (networkResumeCallback !== callback) {
false to null
Expand Down Expand Up @@ -1319,7 +1314,8 @@ class VpnConnectionManager @Inject constructor(
}
SafeDiagnostics.info(
TAG,
"Validated physical network returned; resuming the same VPN server: " +
"Physical network returned; resuming the same VPN server: " +
"availability=${availability.name} " +
diagnosticServerDescriptor(server),
)
startVpnInternal(
Expand Down Expand Up @@ -1370,7 +1366,7 @@ class VpnConnectionManager @Inject constructor(
runCatching { cm.unregisterNetworkCallback(callback) }
SafeDiagnostics.warn(
TAG,
"Validated physical network wait expired: " +
"Physical network wait expired: " +
"timeout_ms=$NETWORK_RESUME_WAIT_TIMEOUT_MS",
)
finishNetworkResumeWait(
Expand Down Expand Up @@ -1967,22 +1963,24 @@ class VpnConnectionManager @Inject constructor(
_connectionState.value is ConnectionState.Connecting
) {
val availability = underlyingNetworkAvailability()
if (availability != UnderlyingNetworkAvailability.VALIDATED) {
val networkLossTimeoutMs =
UnderlyingNetworkPolicy.teardownTimeoutMs(availability)
if (networkLossTimeoutMs != null) {
val now = SystemClock.elapsedRealtime()
val unavailableSince = networkUnavailableStartedAtMs ?: now.also {
networkUnavailableStartedAtMs = it
}
val timeoutMs = UnderlyingNetworkPolicy.timeoutMs(availability)
val networkDeadline = NetworkAvailabilityDeadline(
startedAtMs = unavailableSince,
timeoutMs = timeoutMs,
timeoutMs = networkLossTimeoutMs,
)
if (networkDeadline.isExpired(now)) {
SafeDiagnostics.warn(
TAG,
"Startup tunnel validation aborted: no validated physical network " +
"Startup tunnel validation aborted: no physical network " +
"generation=$generation " +
"availability=${availability.name} timeout_ms=$timeoutMs",
"availability=${availability.name} " +
"timeout_ms=$networkLossTimeoutMs",
)
// This coroutine is the active healthCheckJob and
// performStop() cancels that job. Delegate the stop to
Expand All @@ -1993,8 +1991,9 @@ class VpnConnectionManager @Inject constructor(
}
SafeDiagnostics.trace(
TAG,
"Startup tunnel validation waiting for validated underlying internet: " +
"availability=${availability.name} timeout_ms=$timeoutMs",
"Startup tunnel validation waiting for physical network: " +
"availability=${availability.name} " +
"timeout_ms=$networkLossTimeoutMs",
)
delay(
networkDeadline.nextCheckDelayMs(
Expand All @@ -2005,6 +2004,12 @@ class VpnConnectionManager @Inject constructor(
continue
}
networkUnavailableStartedAtMs = null
if (availability == UnderlyingNetworkAvailability.UNVALIDATED) {
SafeDiagnostics.trace(
TAG,
"Startup tunnel validation probing through unvalidated physical network",
)
}

val probeStartedAt = SystemClock.elapsedRealtime()
val probe = withTimeoutOrNull(TUNNEL_STARTUP_VALIDATION_TIMEOUT_MS) {
Expand Down Expand Up @@ -2123,7 +2128,9 @@ class VpnConnectionManager @Inject constructor(
var networkUnavailableStartedAtMs: Long? = null
while (gen == latestConnectionGeneration.get() && _connectionState.value is ConnectionState.Connected) {
val availability = underlyingNetworkAvailability()
if (availability != UnderlyingNetworkAvailability.VALIDATED) {
val networkLossTimeoutMs =
UnderlyingNetworkPolicy.teardownTimeoutMs(availability)
if (networkLossTimeoutMs != null) {
val now = SystemClock.elapsedRealtime()
val unavailableSince = networkUnavailableStartedAtMs ?: now.also {
networkUnavailableStartedAtMs = it
Expand All @@ -2133,17 +2140,16 @@ class VpnConnectionManager @Inject constructor(
"generation=$gen availability=${availability.name}",
)
}
val timeoutMs = UnderlyingNetworkPolicy.timeoutMs(availability)
val deadline = NetworkAvailabilityDeadline(
startedAtMs = unavailableSince,
timeoutMs = timeoutMs,
timeoutMs = networkLossTimeoutMs,
)
if (deadline.isExpired(now)) {
SafeDiagnostics.warn(
TAG,
"Tunnel watchdog stopped VPN without validated physical network: " +
"Tunnel watchdog stopped VPN without a physical network: " +
"generation=$gen availability=${availability.name} " +
"timeout_ms=$timeoutMs",
"timeout_ms=$networkLossTimeoutMs",
)
// The service callback normally reaches the same
// deadline first. This independent guard covers a rare
Expand All @@ -2154,8 +2160,9 @@ class VpnConnectionManager @Inject constructor(
}
SafeDiagnostics.trace(
TAG,
"Tunnel health cycle skipped: availability=${availability.name} " +
"timeout_ms=$timeoutMs",
"Tunnel health cycle skipped without physical network: " +
"availability=${availability.name} " +
"timeout_ms=$networkLossTimeoutMs",
)
delay(
deadline.nextCheckDelayMs(
Expand All @@ -2166,6 +2173,12 @@ class VpnConnectionManager @Inject constructor(
continue
}
networkUnavailableStartedAtMs = null
if (availability == UnderlyingNetworkAvailability.UNVALIDATED) {
SafeDiagnostics.trace(
TAG,
"Tunnel health probe proceeding through unvalidated physical network",
)
}

// Freeze liveness evidence before the watchdog sends anything.
// Otherwise the failed probe's own uplink (or handshake bytes)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,18 @@ class NetworkAvailabilityDeadlineTest {
}

@Test
fun `unvalidated physical network uses forty five second boundary`() {
fun `physical network loss uses policy deadline`() {
val deadline = NetworkAvailabilityDeadline(
startedAtMs = 1_000L,
timeoutMs = UnderlyingNetworkPolicy.timeoutMs(
UnderlyingNetworkAvailability.UNVALIDATED,
timeoutMs = requireNotNull(
UnderlyingNetworkPolicy.teardownTimeoutMs(
UnderlyingNetworkAvailability.UNAVAILABLE,
),
),
)

assertFalse(deadline.isExpired(45_999L))
assertTrue(deadline.isExpired(46_000L))
assertFalse(deadline.isExpired(15_999L))
assertTrue(deadline.isExpired(16_000L))
}

@Test
Expand Down
17 changes: 15 additions & 2 deletions app/src/test/java/com/tobevpn/app/vpn/NetworkResumePolicyTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ class NetworkResumePolicyTest {
}

@Test
fun `unvalidated network cannot restart vpn`() {
assertFalse(
fun `unvalidated carrier network can restart vpn for tunnel validation`() {
assertTrue(
NetworkResumePolicy.shouldResume(
expectedRequest = 7,
currentRequest = 7,
Expand All @@ -54,4 +54,17 @@ class NetworkResumePolicyTest {
),
)
}

@Test
fun `missing physical network cannot restart vpn`() {
assertFalse(
NetworkResumePolicy.shouldResume(
expectedRequest = 7,
currentRequest = 7,
hasNetworkTimeoutError = true,
sameServer = true,
availability = UnderlyingNetworkAvailability.UNAVAILABLE,
),
)
}
}
Loading
Loading