Skip to content

Commit 91cf3af

Browse files
davfsadavfsa
committed
Add ability to select included/excluded apps from App Split Tunneling
1 parent 141b1cf commit 91cf3af

File tree

6 files changed

+230
-55
lines changed

6 files changed

+230
-55
lines changed

‎android/src/main/java/com/tailscale/ipn/App.kt‎

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,13 @@ open class UninitializedApp : Application() {
377377
// the VPN (i.e. we're logged in and machine is authorized).
378378
private const val ABLE_TO_START_VPN_KEY = "ableToStartVPN"
379379

380-
private const val DISALLOWED_APPS_KEY = "disallowedApps"
380+
// The value is 'disallowedApps' as it used to represent
381+
// only disallowed applications. This has been changed
382+
// and allowing/disallowing is based on ALLOW_SELECTED_APPS_KEY
383+
//
384+
// The value is kept the same to not reset everyone's configuration
385+
private const val SELECTED_APPS_KEY = "disallowedApps"
386+
private const val ALLOW_SELECTED_APPS_KEY = "allowSelectedApps"
381387

382388
// File for shared preferences that are not encrypted.
383389
private const val UNENCRYPTED_PREFERENCES = "unencrypted"
@@ -535,7 +541,7 @@ open class UninitializedApp : Application() {
535541
return builder.build()
536542
}
537543

538-
fun addUserDisallowedPackageName(packageName: String) {
544+
fun addUserSelectedPackage(packageName: String) {
539545
if (packageName.isEmpty()) {
540546
TSLog.e(TAG, "addUserDisallowedPackageName called with empty packageName")
541547
return
@@ -544,13 +550,13 @@ open class UninitializedApp : Application() {
544550
getUnencryptedPrefs()
545551
.edit()
546552
.putStringSet(
547-
DISALLOWED_APPS_KEY, disallowedPackageNames().toMutableSet().union(setOf(packageName)))
553+
SELECTED_APPS_KEY, selectedPackageNames().toMutableSet().union(setOf(packageName)))
548554
.apply()
549555

550556
this.restartVPN()
551557
}
552558

553-
fun removeUserDisallowedPackageName(packageName: String) {
559+
fun removeUserSelectedPackage(packageName: String) {
554560
if (packageName.isEmpty()) {
555561
TSLog.e(TAG, "removeUserDisallowedPackageName called with empty packageName")
556562
return
@@ -559,23 +565,29 @@ open class UninitializedApp : Application() {
559565
getUnencryptedPrefs()
560566
.edit()
561567
.putStringSet(
562-
DISALLOWED_APPS_KEY,
563-
disallowedPackageNames().toMutableSet().subtract(setOf(packageName)))
568+
SELECTED_APPS_KEY, selectedPackageNames().toMutableSet().subtract(setOf(packageName)))
564569
.apply()
565570

566571
this.restartVPN()
567572
}
568573

569-
fun disallowedPackageNames(): List<String> {
570-
val mdmDisallowed =
571-
MDMSettings.excludedPackages.flow.value.value?.split(",")?.map { it.trim() } ?: emptyList()
572-
if (mdmDisallowed.isNotEmpty()) {
573-
TSLog.d(TAG, "Excluded application packages were set via MDM: $mdmDisallowed")
574-
return builtInDisallowedPackageNames + mdmDisallowed
575-
}
576-
val userDisallowed =
577-
getUnencryptedPrefs().getStringSet(DISALLOWED_APPS_KEY, emptySet())?.toList() ?: emptyList()
578-
return builtInDisallowedPackageNames + userDisallowed
574+
fun switchUserSelectedPackages() {
575+
getUnencryptedPrefs()
576+
.edit()
577+
.putBoolean(ALLOW_SELECTED_APPS_KEY, !allowSelectedPackages())
578+
.apply()
579+
getUnencryptedPrefs().edit().putStringSet(SELECTED_APPS_KEY, setOf()).apply()
580+
581+
this.restartVPN()
582+
}
583+
584+
fun selectedPackageNames(): List<String> {
585+
return getUnencryptedPrefs().getStringSet(SELECTED_APPS_KEY, emptySet())?.toList()
586+
?: emptyList()
587+
}
588+
589+
fun allowSelectedPackages(): Boolean {
590+
return getUnencryptedPrefs().getBoolean(ALLOW_SELECTED_APPS_KEY, false)
579591
}
580592

581593
fun getAppScopedViewModel(): VpnViewModel {

‎android/src/main/java/com/tailscale/ipn/IPNService.kt‎

Lines changed: 47 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,14 @@ open class IPNService : VpnService(), libtailscale.IPNService {
132132
PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE)
133133
}
134134

135+
private fun allowApp(b: Builder, name: String) {
136+
try {
137+
b.addAllowedApplication(name)
138+
} catch (e: PackageManager.NameNotFoundException) {
139+
TSLog.d(TAG, "Failed to add allowed application: $e")
140+
}
141+
}
142+
135143
private fun disallowApp(b: Builder, name: String) {
136144
try {
137145
b.addDisallowedApplication(name)
@@ -151,23 +159,49 @@ open class IPNService : VpnService(), libtailscale.IPNService {
151159
}
152160
b.setUnderlyingNetworks(null) // Use all available networks.
153161

154-
val includedPackages: List<String> =
162+
val mdmAllowed =
155163
MDMSettings.includedPackages.flow.value.value?.split(",")?.map { it.trim() } ?: emptyList()
156-
if (includedPackages.isNotEmpty()) {
157-
// If an admin defined a list of packages that are exclusively allowed to be used via
158-
// Tailscale,
159-
// then only allow those apps.
160-
for (packageName in includedPackages) {
164+
val mdmDisallowed =
165+
MDMSettings.excludedPackages.flow.value.value?.split(",")?.map { it.trim() } ?: emptyList()
166+
167+
var packagesList: List<String>
168+
var allowPackages: Boolean
169+
if (mdmAllowed.isNotEmpty()) {
170+
// An admin defined a list of packages that are exclusively allowed to be used via
171+
// Tailscale, so only allow those.
172+
packagesList = mdmAllowed
173+
allowPackages = true
174+
TSLog.d(TAG, "Included application packages were set via MDM: $mdmAllowed")
175+
} else if (mdmDisallowed.isNotEmpty()) {
176+
// An admin defined a list of packages that are excluded from accessing Tailscale,
177+
// so ignore user definitions and only exclude those
178+
packagesList = mdmDisallowed
179+
allowPackages = false
180+
TSLog.d(TAG, "Excluded application packages were set via MDM: $mdmDisallowed")
181+
} else {
182+
// Otherwise, prevent user manually disallowed apps from getting their traffic + DNS routed
183+
// via Tailscale
184+
packagesList = UninitializedApp.get().selectedPackageNames()
185+
allowPackages = UninitializedApp.get().allowSelectedPackages()
186+
TSLog.d(TAG, "Application packages were set by user: $packagesList")
187+
}
188+
189+
if (allowPackages) {
190+
// There always needs to be at least one allowed application for the VPN service to filter the
191+
// traffic so add our own application by default to fulfill that requirement
192+
packagesList += "com.tailscale.ipn"
193+
194+
for (packageName in packagesList) {
161195
TSLog.d(TAG, "Including app: $packageName")
162-
b.addAllowedApplication(packageName)
196+
allowApp(b, packageName)
163197
}
164198
} else {
165-
// Otherwise, prevent certain apps from getting their traffic + DNS routed via Tailscale:
166-
// - any app that the user manually disallowed in the GUI
167-
// - any app that we disallowed via hard-coding
168-
for (disallowedPackageName in UninitializedApp.get().disallowedPackageNames()) {
169-
TSLog.d(TAG, "Disallowing app: $disallowedPackageName")
170-
disallowApp(b, disallowedPackageName)
199+
// Make sure to also exclude hard-coded apps that are known to cause issues
200+
packagesList += UninitializedApp.get().builtInDisallowedPackageNames
201+
202+
for (packageName in packagesList) {
203+
TSLog.d(TAG, "Disallowing app: $packageName")
204+
disallowApp(b, packageName)
171205
}
172206
}
173207

‎android/src/main/java/com/tailscale/ipn/ui/view/Buttons.kt‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ import androidx.compose.ui.platform.LocalUriHandler
1616
import androidx.compose.ui.text.style.TextDecoration
1717
import androidx.compose.ui.unit.dp
1818
import com.tailscale.ipn.ui.theme.link
19+
import com.tailscale.ipn.ui.theme.secondaryButton
20+
import com.tailscale.ipn.ui.theme.warningButton
1921

2022
@Composable
2123
fun PrimaryActionButton(onClick: () -> Unit, content: @Composable RowScope.() -> Unit) {
@@ -26,6 +28,28 @@ fun PrimaryActionButton(onClick: () -> Unit, content: @Composable RowScope.() ->
2628
content = content)
2729
}
2830

31+
@Composable
32+
fun WarningActionButton(onClick: () -> Unit, content: @Composable RowScope.() -> Unit) {
33+
Button(
34+
onClick = onClick,
35+
contentPadding = PaddingValues(vertical = 12.dp),
36+
modifier = Modifier.fillMaxWidth(),
37+
content = content,
38+
colors = MaterialTheme.colorScheme.warningButton,
39+
)
40+
}
41+
42+
@Composable
43+
fun DismissActionButton(onClick: () -> Unit, content: @Composable RowScope.() -> Unit) {
44+
Button(
45+
onClick = onClick,
46+
contentPadding = PaddingValues(vertical = 12.dp),
47+
modifier = Modifier.fillMaxWidth(),
48+
content = content,
49+
colors = MaterialTheme.colorScheme.secondaryButton,
50+
)
51+
}
52+
2953
@Composable
3054
fun OpenURLButton(title: String, url: String) {
3155
val handler = LocalUriHandler.current

‎android/src/main/java/com/tailscale/ipn/ui/view/SplitTunnelAppPickerView.kt‎

Lines changed: 91 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@
44
package com.tailscale.ipn.ui.view
55

66
import androidx.compose.foundation.Image
7+
import androidx.compose.foundation.background
8+
import androidx.compose.foundation.layout.Row
79
import androidx.compose.foundation.layout.height
810
import androidx.compose.foundation.layout.padding
911
import androidx.compose.foundation.layout.width
1012
import androidx.compose.foundation.lazy.LazyColumn
1113
import androidx.compose.foundation.lazy.items
14+
import androidx.compose.material.icons.Icons
15+
import androidx.compose.material.icons.filled.MoreVert
16+
import androidx.compose.material3.AlertDialog
1217
import androidx.compose.material3.Checkbox
18+
import androidx.compose.material3.DropdownMenu
19+
import androidx.compose.material3.Icon
20+
import androidx.compose.material3.IconButton
1321
import androidx.compose.material3.ListItem
1422
import androidx.compose.material3.MaterialTheme
1523
import androidx.compose.material3.Scaffold
@@ -27,6 +35,7 @@ import androidx.lifecycle.viewmodel.compose.viewModel
2735
import com.tailscale.ipn.App
2836
import com.tailscale.ipn.R
2937
import com.tailscale.ipn.ui.util.Lists
38+
import com.tailscale.ipn.ui.util.set
3039
import com.tailscale.ipn.ui.viewModel.SplitTunnelAppPickerViewModel
3140

3241
@Composable
@@ -35,23 +44,39 @@ fun SplitTunnelAppPickerView(
3544
model: SplitTunnelAppPickerViewModel = viewModel()
3645
) {
3746
val installedApps by model.installedApps.collectAsState()
38-
val excludedPackageNames by model.excludedPackageNames.collectAsState()
47+
val selectedPackageNames by model.selectedPackageNames.collectAsState()
48+
val allowSelected by model.allowSelected.collectAsState()
3949
val builtInDisallowedPackageNames: List<String> = App.get().builtInDisallowedPackageNames
4050
val mdmIncludedPackages by model.mdmIncludedPackages.collectAsState()
4151
val mdmExcludedPackages by model.mdmExcludedPackages.collectAsState()
52+
val showHeaderMenu by model.showHeaderMenu.collectAsState()
53+
val showSwitchDialog by model.showSwitchDialog.collectAsState()
4254

43-
Scaffold(topBar = { Header(titleRes = R.string.split_tunneling, onBack = backToSettings) }) {
44-
innerPadding ->
45-
LazyColumn(modifier = Modifier.padding(innerPadding)) {
46-
item(key = "header") {
47-
ListItem(
48-
headlineContent = {
49-
Text(
50-
stringResource(
51-
R.string
52-
.selected_apps_will_access_the_internet_directly_without_using_tailscale))
55+
if (showSwitchDialog) {
56+
SwitchAlertDialog(
57+
onConfirm = {
58+
model.showSwitchDialog.set(false)
59+
model.performSelectionSwitch()
60+
},
61+
onDismiss = { model.showSwitchDialog.set(false) })
62+
}
63+
64+
Scaffold(
65+
topBar = {
66+
Header(
67+
titleRes = R.string.split_tunneling,
68+
onBack = backToSettings,
69+
actions = {
70+
Row {
71+
FusMenu(viewModel = model, onSwitchClick = { model.showSwitchDialog.set(true) })
72+
IconButton(onClick = { model.showHeaderMenu.set(!showHeaderMenu) }) {
73+
Icon(Icons.Default.MoreVert, "menu")
74+
}
75+
}
5376
})
54-
}
77+
},
78+
) { innerPadding ->
79+
LazyColumn(modifier = Modifier.padding(innerPadding)) {
5580
if (mdmExcludedPackages.value?.isNotEmpty() == true) {
5681
item("mdmExcludedNotice") {
5782
ListItem(
@@ -67,9 +92,22 @@ fun SplitTunnelAppPickerView(
6792
})
6893
}
6994
} else {
95+
item("header") {
96+
ListItem(
97+
headlineContent = {
98+
Text(
99+
stringResource(
100+
if (allowSelected) R.string.selected_apps_will_access_tailscale
101+
else
102+
R.string
103+
.selected_apps_will_access_the_internet_directly_without_using_tailscale))
104+
})
105+
}
70106
item("resolversHeader") {
71107
Lists.SectionDivider(
72-
stringResource(R.string.count_excluded_apps, excludedPackageNames.count()))
108+
stringResource(
109+
if (allowSelected) R.string.count_included_apps else R.string.count_excluded_apps,
110+
selectedPackageNames.count()))
73111
}
74112
items(installedApps) { app ->
75113
ListItem(
@@ -93,13 +131,13 @@ fun SplitTunnelAppPickerView(
93131
},
94132
trailingContent = {
95133
Checkbox(
96-
checked = excludedPackageNames.contains(app.packageName),
134+
checked = selectedPackageNames.contains(app.packageName),
97135
enabled = !builtInDisallowedPackageNames.contains(app.packageName),
98136
onCheckedChange = { checked ->
99137
if (checked) {
100-
model.exclude(packageName = app.packageName)
138+
model.select(packageName = app.packageName)
101139
} else {
102-
model.unexclude(packageName = app.packageName)
140+
model.deselect(packageName = app.packageName)
103141
}
104142
})
105143
})
@@ -109,3 +147,40 @@ fun SplitTunnelAppPickerView(
109147
}
110148
}
111149
}
150+
151+
@Composable
152+
fun FusMenu(viewModel: SplitTunnelAppPickerViewModel, onSwitchClick: (() -> Unit)) {
153+
val expanded by viewModel.showHeaderMenu.collectAsState()
154+
val allowSelected by viewModel.allowSelected.collectAsState()
155+
156+
DropdownMenu(
157+
expanded = expanded,
158+
onDismissRequest = { viewModel.showHeaderMenu.set(false) },
159+
modifier = Modifier.background(MaterialTheme.colorScheme.surfaceContainer)) {
160+
MenuItem(
161+
onClick = {
162+
viewModel.showHeaderMenu.set(false)
163+
onSwitchClick()
164+
},
165+
text =
166+
stringResource(
167+
if (allowSelected) R.string.switch_to_select_to_exclude
168+
else R.string.switch_to_select_to_include))
169+
}
170+
}
171+
172+
@Composable
173+
fun SwitchAlertDialog(onConfirm: (() -> Unit), onDismiss: (() -> Unit)) {
174+
AlertDialog(
175+
title = { Text(text = stringResource(R.string.switch_warning_dialog_title)) },
176+
text = { Text(text = stringResource(R.string.switch_warning_dialog_description)) },
177+
onDismissRequest = onDismiss,
178+
confirmButton = {
179+
WarningActionButton(onClick = onConfirm) {
180+
Text(text = stringResource(R.string.confirm_switch))
181+
}
182+
},
183+
dismissButton = {
184+
DismissActionButton(onClick = onDismiss) { Text(text = stringResource(R.string.cancel)) }
185+
})
186+
}

0 commit comments

Comments
 (0)