blob: a91989838521356554f943d77447e6fcb70c234c [file] [log] [blame]
Chia-chi Yehff3bdca2011-05-23 17:26:46 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.server.connectivity;
18
Jeff Sharkey899223b2012-08-04 15:24:58 -070019import static android.Manifest.permission.BIND_VPN_SERVICE;
Paul Jensen31a94f42015-02-13 14:18:39 -050020import static android.net.ConnectivityManager.NETID_UNSET;
Jeff Sharkey9b2a10f2018-01-17 13:27:03 +090021import static android.net.NetworkCapabilities.NET_CAPABILITY_NOT_CONGESTED;
Jeff Sharkey72f9c422017-10-27 17:22:59 -060022import static android.net.NetworkCapabilities.NET_CAPABILITY_NOT_METERED;
23import static android.net.NetworkCapabilities.NET_CAPABILITY_NOT_ROAMING;
Lorenzo Colitti50262792014-09-19 01:53:35 +090024import static android.net.RouteInfo.RTN_THROW;
Lorenzo Colitti60446162014-09-20 00:14:31 +090025import static android.net.RouteInfo.RTN_UNREACHABLE;
Jeff Sharkey899223b2012-08-04 15:24:58 -070026
Jeff Davidsonbc19c182014-11-11 13:20:01 -080027import android.Manifest;
Robin Lee4d03abc2016-05-09 12:32:27 +010028import android.annotation.NonNull;
29import android.annotation.Nullable;
30import android.annotation.UserIdInt;
Chad Brubaker4ca19e82013-06-14 11:16:51 -070031import android.app.AppGlobals;
Jeff Davidson05542602014-08-11 14:07:27 -070032import android.app.AppOpsManager;
Tony Mak1a405fe2016-06-30 11:19:20 +010033import android.app.Notification;
34import android.app.NotificationManager;
Jeff Davidson90b1b9f2014-08-22 13:05:43 -070035import android.app.PendingIntent;
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -070036import android.content.BroadcastReceiver;
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -070037import android.content.ComponentName;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -070038import android.content.Context;
39import android.content.Intent;
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -070040import android.content.IntentFilter;
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -070041import android.content.ServiceConnection;
Charles Hea0a87e82017-05-15 17:07:18 +010042import android.content.pm.ApplicationInfo;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -070043import android.content.pm.PackageManager;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -040044import android.content.pm.PackageManager.NameNotFoundException;
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -070045import android.content.pm.ResolveInfo;
Chad Brubakerc2865192013-07-10 14:46:23 -070046import android.content.pm.UserInfo;
Jeff Sharkey899223b2012-08-04 15:24:58 -070047import android.net.ConnectivityManager;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -070048import android.net.INetworkManagementEventObserver;
Lorenzo Colitti50262792014-09-19 01:53:35 +090049import android.net.IpPrefix;
Chad Brubaker4ca19e82013-06-14 11:16:51 -070050import android.net.LinkAddress;
Jeff Sharkey82f85212012-08-24 11:17:25 -070051import android.net.LinkProperties;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -070052import android.net.LocalSocket;
53import android.net.LocalSocketAddress;
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -080054import android.net.Network;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -040055import android.net.NetworkAgent;
56import android.net.NetworkCapabilities;
Jeff Sharkey899223b2012-08-04 15:24:58 -070057import android.net.NetworkInfo;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -040058import android.net.NetworkInfo.DetailedState;
Sreeram Ramachandran8cd33ed2014-07-23 15:23:15 -070059import android.net.NetworkMisc;
Chalard Jeanadbf1d02018-02-26 11:52:46 +090060import android.net.NetworkUtils;
Jeff Sharkey82f85212012-08-24 11:17:25 -070061import android.net.RouteInfo;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -040062import android.net.UidRange;
Robin Lee812800c2016-05-13 15:38:08 +010063import android.net.Uri;
Charles Hea0a87e82017-05-15 17:07:18 +010064import android.net.VpnService;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -070065import android.os.Binder;
Charles Hea0a87e82017-05-15 17:07:18 +010066import android.os.Build.VERSION_CODES;
67import android.os.Bundle;
Chia-chi Yehc1bac3a2011-12-16 15:00:31 -080068import android.os.FileUtils;
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -070069import android.os.IBinder;
Jeff Sharkey899223b2012-08-04 15:24:58 -070070import android.os.INetworkManagementService;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -040071import android.os.Looper;
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -070072import android.os.Parcel;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -070073import android.os.ParcelFileDescriptor;
Robin Lee812800c2016-05-13 15:38:08 +010074import android.os.PatternMatcher;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -070075import android.os.Process;
Jeff Sharkey899223b2012-08-04 15:24:58 -070076import android.os.RemoteException;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -070077import android.os.SystemClock;
Jeff Sharkey088f29f2012-08-05 14:55:04 -070078import android.os.SystemService;
Dianne Hackborn50cdf7c32012-09-23 17:08:57 -070079import android.os.UserHandle;
Chad Brubakerc2865192013-07-10 14:46:23 -070080import android.os.UserManager;
Robin Lee812800c2016-05-13 15:38:08 +010081import android.provider.Settings;
Jeff Sharkey82f85212012-08-24 11:17:25 -070082import android.security.Credentials;
83import android.security.KeyStore;
Paul Jensene75b9e32015-04-06 11:54:53 -040084import android.text.TextUtils;
Robin Lee4d03abc2016-05-09 12:32:27 +010085import android.util.ArraySet;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -070086import android.util.Log;
87
Tony Mak1a405fe2016-06-30 11:19:20 +010088import com.android.internal.R;
Chad Brubakerc2865192013-07-10 14:46:23 -070089import com.android.internal.annotations.GuardedBy;
Robin Lee4d03abc2016-05-09 12:32:27 +010090import com.android.internal.annotations.VisibleForTesting;
Chris Wren282cfef2017-03-27 15:01:44 -040091import com.android.internal.messages.nano.SystemMessageProto.SystemMessage;
Chia-chi Yeh2e467642011-07-04 03:23:12 -070092import com.android.internal.net.LegacyVpnInfo;
Chia-chi Yeh04ba25c2011-06-15 17:07:27 -070093import com.android.internal.net.VpnConfig;
Wenchao Tongf5ea3402015-03-04 13:26:38 -080094import com.android.internal.net.VpnInfo;
Jeff Sharkey82f85212012-08-24 11:17:25 -070095import com.android.internal.net.VpnProfile;
Geoffrey Pitschaf759c52017-02-15 09:35:38 -050096import com.android.internal.notification.SystemNotificationChannels;
Jeff Sharkey72f9c422017-10-27 17:22:59 -060097import com.android.internal.util.ArrayUtils;
98import com.android.server.ConnectivityService;
Christopher Tatee0be7e82017-02-08 17:38:20 -080099import com.android.server.DeviceIdleController;
100import com.android.server.LocalServices;
Jeff Sharkey899223b2012-08-04 15:24:58 -0700101import com.android.server.net.BaseNetworkObserver;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700102
Jeff Davidson05542602014-08-11 14:07:27 -0700103import libcore.io.IoUtils;
104
Chia-chi Yeh97a61562011-07-14 15:05:05 -0700105import java.io.File;
Jeff Davidson6bbf39c2014-07-23 10:14:53 -0700106import java.io.IOException;
Chia-chi Yeh97a61562011-07-14 15:05:05 -0700107import java.io.InputStream;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -0700108import java.io.OutputStream;
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900109import java.math.BigInteger;
Jeff Sharkey82f85212012-08-24 11:17:25 -0700110import java.net.Inet4Address;
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -0700111import java.net.Inet6Address;
112import java.net.InetAddress;
Elliott Hughesd396a442013-06-28 16:24:48 -0700113import java.nio.charset.StandardCharsets;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400114import java.util.ArrayList;
Chia-chi Yeh41d16852011-07-01 02:12:06 -0700115import java.util.Arrays;
Robin Lee4d03abc2016-05-09 12:32:27 +0100116import java.util.Collection;
117import java.util.Collections;
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900118import java.util.Comparator;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400119import java.util.List;
Robin Lee4d03abc2016-05-09 12:32:27 +0100120import java.util.Set;
Paul Jensen0784eea2014-08-19 16:00:24 -0400121import java.util.SortedSet;
122import java.util.TreeSet;
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -0700123import java.util.concurrent.atomic.AtomicInteger;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -0700124
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700125/**
126 * @hide
127 */
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400128public class Vpn {
129 private static final String NETWORKTYPE = "VPN";
Jeff Sharkey899223b2012-08-04 15:24:58 -0700130 private static final String TAG = "Vpn";
131 private static final boolean LOGD = true;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400132
Christopher Tatee0be7e82017-02-08 17:38:20 -0800133 // Length of time (in milliseconds) that an app hosting an always-on VPN is placed on
134 // the device idle whitelist during service launch and VPN bootstrap.
Chalard Jeandd59ece2017-12-20 13:23:32 +0900135 private static final long VPN_LAUNCH_IDLE_WHITELIST_DURATION_MS = 60 * 1000;
Christopher Tatee0be7e82017-02-08 17:38:20 -0800136
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900137 // Settings for how much of the address space should be routed so that Vpn considers
138 // "most" of the address space is routed. This is used to determine whether this Vpn
139 // should be marked with the INTERNET capability.
140 private static final long MOST_IPV4_ADDRESSES_COUNT;
141 private static final BigInteger MOST_IPV6_ADDRESSES_COUNT;
142 static {
143 // 85% of the address space must be routed for Vpn to consider this VPN to provide
144 // INTERNET access.
145 final int howManyPercentIsMost = 85;
146
147 final long twoPower32 = 1L << 32;
148 MOST_IPV4_ADDRESSES_COUNT = twoPower32 * howManyPercentIsMost / 100;
149 final BigInteger twoPower128 = BigInteger.ONE.shiftLeft(128);
150 MOST_IPV6_ADDRESSES_COUNT = twoPower128
151 .multiply(BigInteger.valueOf(howManyPercentIsMost))
152 .divide(BigInteger.valueOf(100));
153 }
Chalard Jeane0d26f62018-03-29 14:10:44 +0900154 // How many routes to evaluate before bailing and declaring this Vpn should provide
155 // the INTERNET capability. This is necessary because computing the adress space is
156 // O(n²) and this is running in the system service, so a limit is needed to alleviate
157 // the risk of attack.
158 // This is taken as a total of IPv4 + IPV6 routes for simplicity, but the algorithm
159 // is actually O(n²)+O(n²).
160 private static final int MAX_ROUTES_TO_EVALUATE = 150;
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900161
Jeff Sharkey899223b2012-08-04 15:24:58 -0700162 // TODO: create separate trackers for each unique VPN to support
163 // automated reconnection
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700164
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400165 private Context mContext;
166 private NetworkInfo mNetworkInfo;
167 private String mPackage;
168 private int mOwnerUID;
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -0700169 private String mInterface;
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -0700170 private Connection mConnection;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -0700171 private LegacyVpnRunner mLegacyVpnRunner;
Jeff Davidson90b1b9f2014-08-22 13:05:43 -0700172 private PendingIntent mStatusIntent;
Jeff Sharkey57666932013-04-30 17:01:57 -0700173 private volatile boolean mEnableTeardown = true;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400174 private final INetworkManagementService mNetd;
Chalard Jeanf666d0a2018-05-18 21:47:45 +0900175 @VisibleForTesting
176 protected VpnConfig mConfig;
177 @VisibleForTesting
178 protected NetworkAgent mNetworkAgent;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400179 private final Looper mLooper;
Chalard Jeanf666d0a2018-05-18 21:47:45 +0900180 @VisibleForTesting
181 protected final NetworkCapabilities mNetworkCapabilities;
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000182 private final SystemServices mSystemServices;
Chad Brubakerc2865192013-07-10 14:46:23 -0700183
Robin Lee4d03abc2016-05-09 12:32:27 +0100184 /**
Robin Lee17e61832016-05-09 13:46:28 +0100185 * Whether to keep the connection active after rebooting, or upgrading or reinstalling. This
186 * only applies to {@link VpnService} connections.
187 */
188 private boolean mAlwaysOn = false;
189
190 /**
191 * Whether to disable traffic outside of this VPN even when the VPN is not connected. System
192 * apps can still bypass by choosing explicit networks. Has no effect if {@link mAlwaysOn} is
193 * not set.
194 */
195 private boolean mLockdown = false;
196
197 /**
Robin Lee17e61832016-05-09 13:46:28 +0100198 * List of UIDs for which networking should be blocked until VPN is ready, during brief periods
199 * when VPN is not running. For example, during system startup or after a crash.
200 * @see mLockdown
201 */
202 @GuardedBy("this")
203 private Set<UidRange> mBlockedUsers = new ArraySet<>();
204
Chalard Jeandd59ece2017-12-20 13:23:32 +0900205 // Handle of the user initiating VPN.
Paul Jensen0784eea2014-08-19 16:00:24 -0400206 private final int mUserHandle;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700207
Chalard Jeandd59ece2017-12-20 13:23:32 +0900208 // Listen to package removal and change events (update/uninstall) for this user
Robin Lee812800c2016-05-13 15:38:08 +0100209 private final BroadcastReceiver mPackageIntentReceiver = new BroadcastReceiver() {
210 @Override
211 public void onReceive(Context context, Intent intent) {
212 final Uri data = intent.getData();
213 final String packageName = data == null ? null : data.getSchemeSpecificPart();
214 if (packageName == null) {
215 return;
216 }
217
218 synchronized (Vpn.this) {
Chalard Jeandd59ece2017-12-20 13:23:32 +0900219 // Avoid race where always-on package has been unset
Robin Lee812800c2016-05-13 15:38:08 +0100220 if (!packageName.equals(getAlwaysOnPackage())) {
221 return;
222 }
223
224 final String action = intent.getAction();
Chalard Jeandd59ece2017-12-20 13:23:32 +0900225 Log.i(TAG, "Received broadcast " + action + " for always-on VPN package "
226 + packageName + " in user " + mUserHandle);
Robin Lee812800c2016-05-13 15:38:08 +0100227
228 switch(action) {
229 case Intent.ACTION_PACKAGE_REPLACED:
230 // Start vpn after app upgrade
231 startAlwaysOnVpn();
232 break;
233 case Intent.ACTION_PACKAGE_REMOVED:
234 final boolean isPackageRemoved = !intent.getBooleanExtra(
235 Intent.EXTRA_REPLACING, false);
236 if (isPackageRemoved) {
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000237 setAlwaysOnPackage(null, false);
Robin Lee812800c2016-05-13 15:38:08 +0100238 }
239 break;
240 }
241 }
242 }
243 };
244
245 private boolean mIsPackageIntentReceiverRegistered = false;
246
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400247 public Vpn(Looper looper, Context context, INetworkManagementService netService,
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000248 @UserIdInt int userHandle) {
249 this(looper, context, netService, userHandle, new SystemServices(context));
250 }
251
252 @VisibleForTesting
253 protected Vpn(Looper looper, Context context, INetworkManagementService netService,
254 int userHandle, SystemServices systemServices) {
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700255 mContext = context;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400256 mNetd = netService;
Paul Jensen0784eea2014-08-19 16:00:24 -0400257 mUserHandle = userHandle;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400258 mLooper = looper;
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000259 mSystemServices = systemServices;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400260
261 mPackage = VpnConfig.LEGACY_VPN;
Paul Jensen0784eea2014-08-19 16:00:24 -0400262 mOwnerUID = getAppUid(mPackage, mUserHandle);
Jeff Sharkey899223b2012-08-04 15:24:58 -0700263
264 try {
265 netService.registerObserver(mObserver);
266 } catch (RemoteException e) {
267 Log.wtf(TAG, "Problem registering observer", e);
268 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400269
Chalard Jeandd59ece2017-12-20 13:23:32 +0900270 mNetworkInfo = new NetworkInfo(ConnectivityManager.TYPE_VPN, 0 /* subtype */, NETWORKTYPE,
271 "" /* subtypeName */);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400272 mNetworkCapabilities = new NetworkCapabilities();
273 mNetworkCapabilities.addTransportType(NetworkCapabilities.TRANSPORT_VPN);
274 mNetworkCapabilities.removeCapability(NetworkCapabilities.NET_CAPABILITY_NOT_VPN);
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600275 updateCapabilities();
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000276
277 loadAlwaysOnPackage();
Jeff Sharkey899223b2012-08-04 15:24:58 -0700278 }
279
Jeff Sharkey57666932013-04-30 17:01:57 -0700280 /**
Chalard Jeandd59ece2017-12-20 13:23:32 +0900281 * Set whether this object is responsible for watching for {@link NetworkInfo}
Jeff Sharkey57666932013-04-30 17:01:57 -0700282 * teardown. When {@code false}, teardown is handled externally by someone
283 * else.
284 */
285 public void setEnableTeardown(boolean enableTeardown) {
286 mEnableTeardown = enableTeardown;
287 }
288
Jeff Sharkey899223b2012-08-04 15:24:58 -0700289 /**
290 * Update current state, dispaching event to listeners.
291 */
Tony Mak1a405fe2016-06-30 11:19:20 +0100292 @VisibleForTesting
293 protected void updateState(DetailedState detailedState, String reason) {
Jeff Sharkey899223b2012-08-04 15:24:58 -0700294 if (LOGD) Log.d(TAG, "setting state=" + detailedState + ", reason=" + reason);
295 mNetworkInfo.setDetailedState(detailedState, reason, null);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400296 if (mNetworkAgent != null) {
297 mNetworkAgent.sendNetworkInfo(mNetworkInfo);
298 }
Tony Mak1a405fe2016-06-30 11:19:20 +0100299 updateAlwaysOnNotification(detailedState);
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700300 }
301
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600302 public void updateCapabilities() {
303 final Network[] underlyingNetworks = (mConfig != null) ? mConfig.underlyingNetworks : null;
304 updateCapabilities(mContext.getSystemService(ConnectivityManager.class), underlyingNetworks,
305 mNetworkCapabilities);
306
307 if (mNetworkAgent != null) {
308 mNetworkAgent.sendNetworkCapabilities(mNetworkCapabilities);
309 }
310 }
311
312 @VisibleForTesting
313 public static void updateCapabilities(ConnectivityManager cm, Network[] underlyingNetworks,
314 NetworkCapabilities caps) {
315 int[] transportTypes = new int[] { NetworkCapabilities.TRANSPORT_VPN };
316 int downKbps = NetworkCapabilities.LINK_BANDWIDTH_UNSPECIFIED;
317 int upKbps = NetworkCapabilities.LINK_BANDWIDTH_UNSPECIFIED;
318 boolean metered = false;
319 boolean roaming = false;
Jeff Sharkey9b2a10f2018-01-17 13:27:03 +0900320 boolean congested = false;
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600321
Chalard Jean3bd57052018-05-21 15:30:56 +0900322 boolean hadUnderlyingNetworks = false;
323 if (null != underlyingNetworks) {
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600324 for (Network underlying : underlyingNetworks) {
325 final NetworkCapabilities underlyingCaps = cm.getNetworkCapabilities(underlying);
Jeff Sharkey4f5e6262018-01-02 11:46:32 -0700326 if (underlyingCaps == null) continue;
Chalard Jean3bd57052018-05-21 15:30:56 +0900327 hadUnderlyingNetworks = true;
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600328 for (int underlyingType : underlyingCaps.getTransportTypes()) {
329 transportTypes = ArrayUtils.appendInt(transportTypes, underlyingType);
330 }
331
332 // When we have multiple networks, we have to assume the
333 // worst-case link speed and restrictions.
334 downKbps = NetworkCapabilities.minBandwidth(downKbps,
335 underlyingCaps.getLinkDownstreamBandwidthKbps());
336 upKbps = NetworkCapabilities.minBandwidth(upKbps,
337 underlyingCaps.getLinkUpstreamBandwidthKbps());
338 metered |= !underlyingCaps.hasCapability(NET_CAPABILITY_NOT_METERED);
339 roaming |= !underlyingCaps.hasCapability(NET_CAPABILITY_NOT_ROAMING);
Jeff Sharkey9b2a10f2018-01-17 13:27:03 +0900340 congested |= !underlyingCaps.hasCapability(NET_CAPABILITY_NOT_CONGESTED);
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600341 }
342 }
Chalard Jean3bd57052018-05-21 15:30:56 +0900343 if (!hadUnderlyingNetworks) {
344 // No idea what the underlying networks are; assume sane defaults
345 metered = true;
346 roaming = false;
347 congested = false;
348 }
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600349
350 caps.setTransportTypes(transportTypes);
351 caps.setLinkDownstreamBandwidthKbps(downKbps);
352 caps.setLinkUpstreamBandwidthKbps(upKbps);
Jeff Sharkey9b2a10f2018-01-17 13:27:03 +0900353 caps.setCapability(NET_CAPABILITY_NOT_METERED, !metered);
354 caps.setCapability(NET_CAPABILITY_NOT_ROAMING, !roaming);
355 caps.setCapability(NET_CAPABILITY_NOT_CONGESTED, !congested);
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600356 }
357
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700358 /**
Robin Leec3736bc2017-03-10 16:19:54 +0000359 * Chooses whether to force all connections to go though VPN.
360 *
361 * Used to enable/disable legacy VPN lockdown.
362 *
363 * This uses the same ip rule mechanism as {@link #setAlwaysOnPackage(String, boolean)};
364 * previous settings from calling that function will be replaced and saved with the
365 * always-on state.
366 *
367 * @param lockdown whether to prevent all traffic outside of a VPN.
368 */
369 public synchronized void setLockdown(boolean lockdown) {
370 enforceControlPermissionOrInternalCaller();
371
372 setVpnForcedLocked(lockdown);
373 mLockdown = lockdown;
374
375 // Update app lockdown setting if it changed. Legacy VPN lockdown status is controlled by
376 // LockdownVpnTracker.isEnabled() which keeps track of its own state.
377 if (mAlwaysOn) {
378 saveAlwaysOnPackage();
379 }
380 }
381
382 /**
Charles Hea0a87e82017-05-15 17:07:18 +0100383 * Checks if a VPN app supports always-on mode.
384 *
385 * In order to support the always-on feature, an app has to
386 * <ul>
387 * <li>target {@link VERSION_CODES#N API 24} or above, and
Charles He5da5ae32017-08-15 15:30:22 +0100388 * <li>not opt out through the {@link VpnService#SERVICE_META_DATA_SUPPORTS_ALWAYS_ON}
389 * meta-data field.
Charles Hea0a87e82017-05-15 17:07:18 +0100390 * </ul>
391 *
392 * @param packageName the canonical package name of the VPN app
393 * @return {@code true} if and only if the VPN app exists and supports always-on mode
394 */
395 public boolean isAlwaysOnPackageSupported(String packageName) {
396 enforceSettingsPermission();
397
398 if (packageName == null) {
399 return false;
400 }
401
402 PackageManager pm = mContext.getPackageManager();
403 ApplicationInfo appInfo = null;
404 try {
405 appInfo = pm.getApplicationInfoAsUser(packageName, 0 /*flags*/, mUserHandle);
406 } catch (NameNotFoundException unused) {
407 Log.w(TAG, "Can't find \"" + packageName + "\" when checking always-on support");
408 }
409 if (appInfo == null || appInfo.targetSdkVersion < VERSION_CODES.N) {
410 return false;
411 }
412
413 final Intent intent = new Intent(VpnConfig.SERVICE_INTERFACE);
414 intent.setPackage(packageName);
415 List<ResolveInfo> services =
416 pm.queryIntentServicesAsUser(intent, PackageManager.GET_META_DATA, mUserHandle);
417 if (services == null || services.size() == 0) {
418 return false;
419 }
420
421 for (ResolveInfo rInfo : services) {
422 final Bundle metaData = rInfo.serviceInfo.metaData;
Charles He5da5ae32017-08-15 15:30:22 +0100423 if (metaData != null &&
424 !metaData.getBoolean(VpnService.SERVICE_META_DATA_SUPPORTS_ALWAYS_ON, true)) {
Charles Hea0a87e82017-05-15 17:07:18 +0100425 return false;
426 }
427 }
428
429 return true;
430 }
431
432 /**
Robin Lee244ce8e2016-01-05 18:03:46 +0000433 * Configures an always-on VPN connection through a specific application.
434 * This connection is automatically granted and persisted after a reboot.
435 *
436 * <p>The designated package should exist and declare a {@link VpnService} in its
437 * manifest guarded by {@link android.Manifest.permission.BIND_VPN_SERVICE},
438 * otherwise the call will fail.
439 *
Charles Hea0a87e82017-05-15 17:07:18 +0100440 * <p>Note that this method does not check if the VPN app supports always-on mode. The check is
441 * delayed to {@link #startAlwaysOnVpn()}, which is always called immediately after this
442 * method in {@link android.net.IConnectivityManager#setAlwaysOnVpnPackage}.
443 *
Robin Lee17e61832016-05-09 13:46:28 +0100444 * @param packageName the package to designate as always-on VPN supplier.
445 * @param lockdown whether to prevent traffic outside of a VPN, for example while connecting.
Robin Lee9ff1a582016-06-10 16:41:10 +0100446 * @return {@code true} if the package has been set as always-on, {@code false} otherwise.
Robin Lee244ce8e2016-01-05 18:03:46 +0000447 */
Robin Lee17e61832016-05-09 13:46:28 +0100448 public synchronized boolean setAlwaysOnPackage(String packageName, boolean lockdown) {
Robin Lee244ce8e2016-01-05 18:03:46 +0000449 enforceControlPermissionOrInternalCaller();
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000450
451 if (setAlwaysOnPackageInternal(packageName, lockdown)) {
452 saveAlwaysOnPackage();
453 return true;
454 }
455 return false;
456 }
457
458 /**
459 * Configures an always-on VPN connection through a specific application, the same as
460 * {@link #setAlwaysOnPackage}.
461 *
462 * Does not perform permission checks. Does not persist any of the changes to storage.
463 *
464 * @param packageName the package to designate as always-on VPN supplier.
465 * @param lockdown whether to prevent traffic outside of a VPN, for example while connecting.
466 * @return {@code true} if the package has been set as always-on, {@code false} otherwise.
467 */
468 @GuardedBy("this")
469 private boolean setAlwaysOnPackageInternal(String packageName, boolean lockdown) {
Robin Lee9ff1a582016-06-10 16:41:10 +0100470 if (VpnConfig.LEGACY_VPN.equals(packageName)) {
471 Log.w(TAG, "Not setting legacy VPN \"" + packageName + "\" as always-on.");
472 return false;
473 }
Robin Lee244ce8e2016-01-05 18:03:46 +0000474
Robin Lee244ce8e2016-01-05 18:03:46 +0000475 if (packageName != null) {
Robin Lee9ff1a582016-06-10 16:41:10 +0100476 // Pre-authorize new always-on VPN package.
Robin Lee244ce8e2016-01-05 18:03:46 +0000477 if (!setPackageAuthorization(packageName, true)) {
478 return false;
479 }
Robin Lee9ff1a582016-06-10 16:41:10 +0100480 mAlwaysOn = true;
481 } else {
482 packageName = VpnConfig.LEGACY_VPN;
483 mAlwaysOn = false;
Robin Lee244ce8e2016-01-05 18:03:46 +0000484 }
485
Robin Lee17e61832016-05-09 13:46:28 +0100486 mLockdown = (mAlwaysOn && lockdown);
Tony Mak1a405fe2016-06-30 11:19:20 +0100487 if (isCurrentPreparedPackage(packageName)) {
488 updateAlwaysOnNotification(mNetworkInfo.getDetailedState());
489 } else {
490 // Prepare this app. The notification will update as a side-effect of updateState().
Robin Lee9ff1a582016-06-10 16:41:10 +0100491 prepareInternal(packageName);
492 }
Robin Lee812800c2016-05-13 15:38:08 +0100493 maybeRegisterPackageChangeReceiverLocked(packageName);
Robin Lee17e61832016-05-09 13:46:28 +0100494 setVpnForcedLocked(mLockdown);
Robin Lee244ce8e2016-01-05 18:03:46 +0000495 return true;
496 }
497
Robin Lee9ff1a582016-06-10 16:41:10 +0100498 private static boolean isNullOrLegacyVpn(String packageName) {
499 return packageName == null || VpnConfig.LEGACY_VPN.equals(packageName);
500 }
501
Robin Lee812800c2016-05-13 15:38:08 +0100502 private void unregisterPackageChangeReceiverLocked() {
Robin Lee812800c2016-05-13 15:38:08 +0100503 if (mIsPackageIntentReceiverRegistered) {
504 mContext.unregisterReceiver(mPackageIntentReceiver);
505 mIsPackageIntentReceiverRegistered = false;
506 }
507 }
508
509 private void maybeRegisterPackageChangeReceiverLocked(String packageName) {
510 // Unregister IntentFilter listening for previous always-on package change
511 unregisterPackageChangeReceiverLocked();
512
Robin Lee9ff1a582016-06-10 16:41:10 +0100513 if (!isNullOrLegacyVpn(packageName)) {
Robin Lee812800c2016-05-13 15:38:08 +0100514 mIsPackageIntentReceiverRegistered = true;
515
516 IntentFilter intentFilter = new IntentFilter();
517 // Protected intent can only be sent by system. No permission required in register.
518 intentFilter.addAction(Intent.ACTION_PACKAGE_REPLACED);
519 intentFilter.addAction(Intent.ACTION_PACKAGE_REMOVED);
520 intentFilter.addDataScheme("package");
521 intentFilter.addDataSchemeSpecificPart(packageName, PatternMatcher.PATTERN_LITERAL);
522 mContext.registerReceiverAsUser(
523 mPackageIntentReceiver, UserHandle.of(mUserHandle), intentFilter, null, null);
524 }
525 }
526
Robin Lee244ce8e2016-01-05 18:03:46 +0000527 /**
528 * @return the package name of the VPN controller responsible for always-on VPN,
529 * or {@code null} if none is set or always-on VPN is controlled through
530 * lockdown instead.
531 * @hide
532 */
533 public synchronized String getAlwaysOnPackage() {
534 enforceControlPermissionOrInternalCaller();
Robin Lee17e61832016-05-09 13:46:28 +0100535 return (mAlwaysOn ? mPackage : null);
Robin Lee244ce8e2016-01-05 18:03:46 +0000536 }
537
538 /**
Robin Lee812800c2016-05-13 15:38:08 +0100539 * Save the always-on package and lockdown config into Settings.Secure
540 */
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000541 @GuardedBy("this")
542 private void saveAlwaysOnPackage() {
Robin Lee812800c2016-05-13 15:38:08 +0100543 final long token = Binder.clearCallingIdentity();
544 try {
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000545 mSystemServices.settingsSecurePutStringForUser(Settings.Secure.ALWAYS_ON_VPN_APP,
Robin Lee812800c2016-05-13 15:38:08 +0100546 getAlwaysOnPackage(), mUserHandle);
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000547 mSystemServices.settingsSecurePutIntForUser(Settings.Secure.ALWAYS_ON_VPN_LOCKDOWN,
Robin Leec3736bc2017-03-10 16:19:54 +0000548 (mAlwaysOn && mLockdown ? 1 : 0), mUserHandle);
Robin Lee812800c2016-05-13 15:38:08 +0100549 } finally {
550 Binder.restoreCallingIdentity(token);
551 }
552 }
553
554 /**
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000555 * Load the always-on package and lockdown config from Settings.Secure
Robin Lee812800c2016-05-13 15:38:08 +0100556 */
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000557 @GuardedBy("this")
558 private void loadAlwaysOnPackage() {
559 final long token = Binder.clearCallingIdentity();
560 try {
561 final String alwaysOnPackage = mSystemServices.settingsSecureGetStringForUser(
562 Settings.Secure.ALWAYS_ON_VPN_APP, mUserHandle);
563 final boolean alwaysOnLockdown = mSystemServices.settingsSecureGetIntForUser(
564 Settings.Secure.ALWAYS_ON_VPN_LOCKDOWN, 0 /*default*/, mUserHandle) != 0;
565 setAlwaysOnPackageInternal(alwaysOnPackage, alwaysOnLockdown);
566 } finally {
567 Binder.restoreCallingIdentity(token);
Robin Lee812800c2016-05-13 15:38:08 +0100568 }
569 }
570
571 /**
572 * @return {@code true} if the service was started, the service was already connected, or there
573 * was no always-on VPN to start. {@code false} otherwise.
574 */
575 public boolean startAlwaysOnVpn() {
576 final String alwaysOnPackage;
577 synchronized (this) {
578 alwaysOnPackage = getAlwaysOnPackage();
579 // Skip if there is no service to start.
580 if (alwaysOnPackage == null) {
581 return true;
582 }
Charles Hea0a87e82017-05-15 17:07:18 +0100583 // Remove always-on VPN if it's not supported.
584 if (!isAlwaysOnPackageSupported(alwaysOnPackage)) {
585 setAlwaysOnPackage(null, false);
586 return false;
587 }
Robin Lee812800c2016-05-13 15:38:08 +0100588 // Skip if the service is already established. This isn't bulletproof: it's not bound
589 // until after establish(), so if it's mid-setup onStartCommand will be sent twice,
590 // which may restart the connection.
591 if (getNetworkInfo().isConnected()) {
592 return true;
593 }
594 }
595
Christopher Tatee0be7e82017-02-08 17:38:20 -0800596 // Tell the OS that background services in this app need to be allowed for
597 // a short time, so we can bootstrap the VPN service.
598 final long oldId = Binder.clearCallingIdentity();
Robin Lee812800c2016-05-13 15:38:08 +0100599 try {
Christopher Tatee0be7e82017-02-08 17:38:20 -0800600 DeviceIdleController.LocalService idleController =
601 LocalServices.getService(DeviceIdleController.LocalService.class);
602 idleController.addPowerSaveTempWhitelistApp(Process.myUid(), alwaysOnPackage,
Chalard Jeandd59ece2017-12-20 13:23:32 +0900603 VPN_LAUNCH_IDLE_WHITELIST_DURATION_MS, mUserHandle, false, "vpn");
Christopher Tatee0be7e82017-02-08 17:38:20 -0800604
605 // Start the VPN service declared in the app's manifest.
606 Intent serviceIntent = new Intent(VpnConfig.SERVICE_INTERFACE);
607 serviceIntent.setPackage(alwaysOnPackage);
608 try {
609 return mContext.startServiceAsUser(serviceIntent, UserHandle.of(mUserHandle)) != null;
610 } catch (RuntimeException e) {
611 Log.e(TAG, "VpnService " + serviceIntent + " failed to start", e);
612 return false;
613 }
614 } finally {
615 Binder.restoreCallingIdentity(oldId);
Robin Lee812800c2016-05-13 15:38:08 +0100616 }
617 }
618
619 /**
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700620 * Prepare for a VPN application. This method is designed to solve
621 * race conditions. It first compares the current prepared package
622 * with {@code oldPackage}. If they are the same, the prepared
623 * package is revoked and replaced with {@code newPackage}. If
624 * {@code oldPackage} is {@code null}, the comparison is omitted.
625 * If {@code newPackage} is the same package or {@code null}, the
626 * revocation is omitted. This method returns {@code true} if the
627 * operation is succeeded.
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700628 *
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700629 * Legacy VPN is handled specially since it is not a real package.
630 * It uses {@link VpnConfig#LEGACY_VPN} as its package name, and
631 * it can be revoked by itself.
632 *
Chalard Jeandd59ece2017-12-20 13:23:32 +0900633 * Note: when we added VPN pre-consent in
634 * https://android.googlesource.com/platform/frameworks/base/+/0554260
635 * the names oldPackage and newPackage became misleading, because when
636 * an app is pre-consented, we actually prepare oldPackage, not newPackage.
Victor Chang98a633a2016-05-27 17:30:49 +0100637 *
638 * Their meanings actually are:
639 *
640 * - oldPackage non-null, newPackage null: App calling VpnService#prepare().
641 * - oldPackage null, newPackage non-null: ConfirmDialog calling prepareVpn().
Robin Lee812800c2016-05-13 15:38:08 +0100642 * - oldPackage null, newPackage=LEGACY_VPN: Used internally to disconnect
Victor Chang98a633a2016-05-27 17:30:49 +0100643 * and revoke any current app VPN and re-prepare legacy vpn.
644 *
Robin Lee812800c2016-05-13 15:38:08 +0100645 * TODO: Rename the variables - or split this method into two - and end this confusion.
646 * TODO: b/29032008 Migrate code from prepare(oldPackage=non-null, newPackage=LEGACY_VPN)
647 * to prepare(oldPackage=null, newPackage=LEGACY_VPN)
Victor Chang98a633a2016-05-27 17:30:49 +0100648 *
649 * @param oldPackage The package name of the old VPN application
650 * @param newPackage The package name of the new VPN application
651 *
Chalard Jeandd59ece2017-12-20 13:23:32 +0900652 * @return true if the operation succeeded.
Chia-chi Yehe9107902011-07-02 01:48:50 -0700653 */
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700654 public synchronized boolean prepare(String oldPackage, String newPackage) {
Jeff Davidson0a775ce2015-04-27 15:02:48 -0700655 if (oldPackage != null) {
Victor Chang98a633a2016-05-27 17:30:49 +0100656 // Stop an existing always-on VPN from being dethroned by other apps.
Robin Lee812800c2016-05-13 15:38:08 +0100657 if (mAlwaysOn && !isCurrentPreparedPackage(oldPackage)) {
Victor Chang98a633a2016-05-27 17:30:49 +0100658 return false;
659 }
660
Chalard Jeandd59ece2017-12-20 13:23:32 +0900661 // Package is not the same or old package was reinstalled.
Victor Chang98a633a2016-05-27 17:30:49 +0100662 if (!isCurrentPreparedPackage(oldPackage)) {
Jeff Davidson0a775ce2015-04-27 15:02:48 -0700663 // The package doesn't match. We return false (to obtain user consent) unless the
664 // user has already consented to that VPN package.
665 if (!oldPackage.equals(VpnConfig.LEGACY_VPN) && isVpnUserPreConsented(oldPackage)) {
666 prepareInternal(oldPackage);
667 return true;
668 }
669 return false;
670 } else if (!oldPackage.equals(VpnConfig.LEGACY_VPN)
671 && !isVpnUserPreConsented(oldPackage)) {
672 // Currently prepared VPN is revoked, so unprepare it and return false.
673 prepareInternal(VpnConfig.LEGACY_VPN);
674 return false;
Jeff Davidson05542602014-08-11 14:07:27 -0700675 }
Chia-chi Yehe9107902011-07-02 01:48:50 -0700676 }
677
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700678 // Return true if we do not need to revoke.
Jeff Davidsonbe085872014-10-24 10:35:53 -0700679 if (newPackage == null || (!newPackage.equals(VpnConfig.LEGACY_VPN) &&
Victor Chang98a633a2016-05-27 17:30:49 +0100680 isCurrentPreparedPackage(newPackage))) {
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700681 return true;
682 }
683
Robin Lee1b1bcd72016-02-12 18:11:30 +0000684 // Check that the caller is authorized.
Chia-chi Yehdadc8572012-06-08 13:05:58 -0700685 enforceControlPermission();
Chia-chi Yehe9107902011-07-02 01:48:50 -0700686
Victor Chang98a633a2016-05-27 17:30:49 +0100687 // Stop an existing always-on VPN from being dethroned by other apps.
Robin Lee812800c2016-05-13 15:38:08 +0100688 if (mAlwaysOn && !isCurrentPreparedPackage(newPackage)) {
Victor Chang98a633a2016-05-27 17:30:49 +0100689 return false;
690 }
691
Jeff Davidson11008a72014-11-20 13:12:46 -0800692 prepareInternal(newPackage);
693 return true;
694 }
Chia-chi Yehe9107902011-07-02 01:48:50 -0700695
Victor Chang98a633a2016-05-27 17:30:49 +0100696 private boolean isCurrentPreparedPackage(String packageName) {
697 // We can't just check that packageName matches mPackage, because if the app was uninstalled
698 // and reinstalled it will no longer be prepared. Instead check the UID.
699 return getAppUid(packageName, mUserHandle) == mOwnerUID;
700 }
701
Jeff Davidson11008a72014-11-20 13:12:46 -0800702 /** Prepare the VPN for the given package. Does not perform permission checks. */
703 private void prepareInternal(String newPackage) {
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400704 long token = Binder.clearCallingIdentity();
705 try {
Jeff Davidson11008a72014-11-20 13:12:46 -0800706 // Reset the interface.
707 if (mInterface != null) {
708 mStatusIntent = null;
709 agentDisconnect();
710 jniReset(mInterface);
711 mInterface = null;
Chalard Jeanecacd5e2017-12-27 14:23:31 +0900712 mNetworkCapabilities.setUids(null);
Jeff Davidson11008a72014-11-20 13:12:46 -0800713 }
714
715 // Revoke the connection or stop LegacyVpnRunner.
716 if (mConnection != null) {
717 try {
718 mConnection.mService.transact(IBinder.LAST_CALL_TRANSACTION,
719 Parcel.obtain(), null, IBinder.FLAG_ONEWAY);
720 } catch (Exception e) {
721 // ignore
722 }
723 mContext.unbindService(mConnection);
724 mConnection = null;
725 } else if (mLegacyVpnRunner != null) {
726 mLegacyVpnRunner.exit();
727 mLegacyVpnRunner = null;
728 }
729
730 try {
731 mNetd.denyProtect(mOwnerUID);
732 } catch (Exception e) {
733 Log.wtf(TAG, "Failed to disallow UID " + mOwnerUID + " to call protect() " + e);
734 }
735
736 Log.i(TAG, "Switched from " + mPackage + " to " + newPackage);
737 mPackage = newPackage;
738 mOwnerUID = getAppUid(newPackage, mUserHandle);
739 try {
740 mNetd.allowProtect(mOwnerUID);
741 } catch (Exception e) {
742 Log.wtf(TAG, "Failed to allow UID " + mOwnerUID + " to call protect() " + e);
743 }
744 mConfig = null;
745
746 updateState(DetailedState.IDLE, "prepare");
Robin Leec3736bc2017-03-10 16:19:54 +0000747 setVpnForcedLocked(mLockdown);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400748 } finally {
749 Binder.restoreCallingIdentity(token);
750 }
Chia-chi Yehe9107902011-07-02 01:48:50 -0700751 }
752
Jeff Davidson05542602014-08-11 14:07:27 -0700753 /**
Robin Lee3b3dd942015-05-12 18:14:58 +0100754 * Set whether a package has the ability to launch VPNs without user intervention.
Jeff Davidson05542602014-08-11 14:07:27 -0700755 */
Robin Lee244ce8e2016-01-05 18:03:46 +0000756 public boolean setPackageAuthorization(String packageName, boolean authorized) {
Jeff Davidson05542602014-08-11 14:07:27 -0700757 // Check if the caller is authorized.
Robin Lee244ce8e2016-01-05 18:03:46 +0000758 enforceControlPermissionOrInternalCaller();
Jeff Davidson05542602014-08-11 14:07:27 -0700759
Robin Lee3b3dd942015-05-12 18:14:58 +0100760 int uid = getAppUid(packageName, mUserHandle);
761 if (uid == -1 || VpnConfig.LEGACY_VPN.equals(packageName)) {
762 // Authorization for nonexistent packages (or fake ones) can't be updated.
Robin Lee244ce8e2016-01-05 18:03:46 +0000763 return false;
Jeff Davidson05542602014-08-11 14:07:27 -0700764 }
765
766 long token = Binder.clearCallingIdentity();
767 try {
768 AppOpsManager appOps =
769 (AppOpsManager) mContext.getSystemService(Context.APP_OPS_SERVICE);
Robin Lee3b3dd942015-05-12 18:14:58 +0100770 appOps.setMode(AppOpsManager.OP_ACTIVATE_VPN, uid, packageName,
Jeff Davidson05542602014-08-11 14:07:27 -0700771 authorized ? AppOpsManager.MODE_ALLOWED : AppOpsManager.MODE_IGNORED);
Robin Lee244ce8e2016-01-05 18:03:46 +0000772 return true;
Jeff Davidson05542602014-08-11 14:07:27 -0700773 } catch (Exception e) {
Robin Lee3b3dd942015-05-12 18:14:58 +0100774 Log.wtf(TAG, "Failed to set app ops for package " + packageName + ", uid " + uid, e);
Jeff Davidson05542602014-08-11 14:07:27 -0700775 } finally {
776 Binder.restoreCallingIdentity(token);
777 }
Robin Lee244ce8e2016-01-05 18:03:46 +0000778 return false;
Jeff Davidson05542602014-08-11 14:07:27 -0700779 }
780
781 private boolean isVpnUserPreConsented(String packageName) {
782 AppOpsManager appOps =
783 (AppOpsManager) mContext.getSystemService(Context.APP_OPS_SERVICE);
784
785 // Verify that the caller matches the given package and has permission to activate VPNs.
786 return appOps.noteOpNoThrow(AppOpsManager.OP_ACTIVATE_VPN, Binder.getCallingUid(),
787 packageName) == AppOpsManager.MODE_ALLOWED;
788 }
789
Paul Jensen0784eea2014-08-19 16:00:24 -0400790 private int getAppUid(String app, int userHandle) {
Jeff Davidson05542602014-08-11 14:07:27 -0700791 if (VpnConfig.LEGACY_VPN.equals(app)) {
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400792 return Process.myUid();
Chia-chi Yehfcc1b412011-08-03 15:39:59 -0700793 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400794 PackageManager pm = mContext.getPackageManager();
795 int result;
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700796 try {
Jeff Sharkeye06b4d12016-01-06 14:51:50 -0700797 result = pm.getPackageUidAsUser(app, userHandle);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400798 } catch (NameNotFoundException e) {
799 result = -1;
800 }
801 return result;
802 }
803
804 public NetworkInfo getNetworkInfo() {
805 return mNetworkInfo;
806 }
807
Paul Jensen31a94f42015-02-13 14:18:39 -0500808 public int getNetId() {
809 return mNetworkAgent != null ? mNetworkAgent.netId : NETID_UNSET;
810 }
811
Lorenzo Colitti60446162014-09-20 00:14:31 +0900812 private LinkProperties makeLinkProperties() {
813 boolean allowIPv4 = mConfig.allowIPv4;
814 boolean allowIPv6 = mConfig.allowIPv6;
815
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400816 LinkProperties lp = new LinkProperties();
Lorenzo Colitti60446162014-09-20 00:14:31 +0900817
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400818 lp.setInterfaceName(mInterface);
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700819
Lorenzo Colitti60446162014-09-20 00:14:31 +0900820 if (mConfig.addresses != null) {
821 for (LinkAddress address : mConfig.addresses) {
822 lp.addLinkAddress(address);
823 allowIPv4 |= address.getAddress() instanceof Inet4Address;
824 allowIPv6 |= address.getAddress() instanceof Inet6Address;
825 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400826 }
Lorenzo Colitti60446162014-09-20 00:14:31 +0900827
828 if (mConfig.routes != null) {
829 for (RouteInfo route : mConfig.routes) {
830 lp.addRoute(route);
831 InetAddress address = route.getDestination().getAddress();
832 allowIPv4 |= address instanceof Inet4Address;
833 allowIPv6 |= address instanceof Inet6Address;
834 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400835 }
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700836
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400837 if (mConfig.dnsServers != null) {
838 for (String dnsServer : mConfig.dnsServers) {
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700839 InetAddress address = InetAddress.parseNumericAddress(dnsServer);
840 lp.addDnsServer(address);
Lorenzo Colitti60446162014-09-20 00:14:31 +0900841 allowIPv4 |= address instanceof Inet4Address;
842 allowIPv6 |= address instanceof Inet6Address;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400843 }
844 }
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700845
Lorenzo Colitti60446162014-09-20 00:14:31 +0900846 if (!allowIPv4) {
847 lp.addRoute(new RouteInfo(new IpPrefix(Inet4Address.ANY, 0), RTN_UNREACHABLE));
848 }
849 if (!allowIPv6) {
850 lp.addRoute(new RouteInfo(new IpPrefix(Inet6Address.ANY, 0), RTN_UNREACHABLE));
851 }
852
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400853 // Concatenate search domains into a string.
854 StringBuilder buffer = new StringBuilder();
855 if (mConfig.searchDomains != null) {
856 for (String domain : mConfig.searchDomains) {
857 buffer.append(domain).append(' ');
858 }
859 }
860 lp.setDomains(buffer.toString().trim());
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700861
Lorenzo Colitti60446162014-09-20 00:14:31 +0900862 // TODO: Stop setting the MTU in jniCreate and set it here.
863
864 return lp;
865 }
866
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900867 /**
868 * Analyzes the passed LinkedProperties to figure out whether it routes to most of the IP space.
869 *
870 * This returns true if the passed LinkedProperties contains routes to either most of the IPv4
871 * space or to most of the IPv6 address space, where "most" is defined by the value of the
872 * MOST_IPV{4,6}_ADDRESSES_COUNT constants : if more than this number of addresses are matched
873 * by any of the routes, then it's decided that most of the space is routed.
874 * @hide
875 */
876 @VisibleForTesting
877 static boolean providesRoutesToMostDestinations(LinkProperties lp) {
Chalard Jeane0d26f62018-03-29 14:10:44 +0900878 final List<RouteInfo> routes = lp.getAllRoutes();
879 if (routes.size() > MAX_ROUTES_TO_EVALUATE) return true;
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900880 final Comparator<IpPrefix> prefixLengthComparator = IpPrefix.lengthComparator();
881 TreeSet<IpPrefix> ipv4Prefixes = new TreeSet<>(prefixLengthComparator);
882 TreeSet<IpPrefix> ipv6Prefixes = new TreeSet<>(prefixLengthComparator);
Chalard Jeane0d26f62018-03-29 14:10:44 +0900883 for (final RouteInfo route : routes) {
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900884 IpPrefix destination = route.getDestination();
885 if (destination.isIPv4()) {
886 ipv4Prefixes.add(destination);
887 } else {
888 ipv6Prefixes.add(destination);
889 }
890 }
891 if (NetworkUtils.routedIPv4AddressCount(ipv4Prefixes) > MOST_IPV4_ADDRESSES_COUNT) {
892 return true;
893 }
894 return NetworkUtils.routedIPv6AddressCount(ipv6Prefixes)
895 .compareTo(MOST_IPV6_ADDRESSES_COUNT) >= 0;
896 }
897
Lorenzo Colitti60446162014-09-20 00:14:31 +0900898 private void agentConnect() {
899 LinkProperties lp = makeLinkProperties();
900
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900901 if (providesRoutesToMostDestinations(lp)) {
Lorenzo Colitti60446162014-09-20 00:14:31 +0900902 mNetworkCapabilities.addCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET);
903 } else {
904 mNetworkCapabilities.removeCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET);
905 }
906
Robin Lee323f29d2016-05-04 16:38:06 +0100907 mNetworkInfo.setDetailedState(DetailedState.CONNECTING, null, null);
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700908
Sreeram Ramachandran8cd33ed2014-07-23 15:23:15 -0700909 NetworkMisc networkMisc = new NetworkMisc();
Robin Lee17e61832016-05-09 13:46:28 +0100910 networkMisc.allowBypass = mConfig.allowBypass && !mLockdown;
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700911
Chalard Jeanf474fc32018-01-17 15:10:05 +0900912 mNetworkCapabilities.setEstablishingVpnAppUid(Binder.getCallingUid());
Chalard Jeanecacd5e2017-12-27 14:23:31 +0900913 mNetworkCapabilities.setUids(createUserAndRestrictedProfilesRanges(mUserHandle,
914 mConfig.allowedApplications, mConfig.disallowedApplications));
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400915 long token = Binder.clearCallingIdentity();
916 try {
Chalard Jeandd59ece2017-12-20 13:23:32 +0900917 mNetworkAgent = new NetworkAgent(mLooper, mContext, NETWORKTYPE /* logtag */,
Chalard Jeandda156a2018-01-10 21:19:32 +0900918 mNetworkInfo, mNetworkCapabilities, lp,
919 ConnectivityConstants.VPN_DEFAULT_SCORE, networkMisc) {
Jeff Davidson05542602014-08-11 14:07:27 -0700920 @Override
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400921 public void unwanted() {
922 // We are user controlled, not driven by NetworkRequest.
Jeff Davidson05542602014-08-11 14:07:27 -0700923 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400924 };
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700925 } finally {
926 Binder.restoreCallingIdentity(token);
927 }
Robin Lee323f29d2016-05-04 16:38:06 +0100928 mNetworkInfo.setIsAvailable(true);
929 updateState(DetailedState.CONNECTED, "agentConnect");
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400930 }
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700931
Fyodor Kupolov1c363152015-09-02 13:27:21 -0700932 private boolean canHaveRestrictedProfile(int userId) {
933 long token = Binder.clearCallingIdentity();
934 try {
935 return UserManager.get(mContext).canHaveRestrictedProfile(userId);
936 } finally {
937 Binder.restoreCallingIdentity(token);
938 }
939 }
940
Tony Mak1a405fe2016-06-30 11:19:20 +0100941 private void agentDisconnect(NetworkAgent networkAgent) {
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400942 if (networkAgent != null) {
Tony Mak1a405fe2016-06-30 11:19:20 +0100943 NetworkInfo networkInfo = new NetworkInfo(mNetworkInfo);
944 networkInfo.setIsAvailable(false);
945 networkInfo.setDetailedState(DetailedState.DISCONNECTED, null, null);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400946 networkAgent.sendNetworkInfo(networkInfo);
947 }
948 }
949
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400950 private void agentDisconnect() {
951 if (mNetworkInfo.isConnected()) {
Tony Mak1a405fe2016-06-30 11:19:20 +0100952 mNetworkInfo.setIsAvailable(false);
953 updateState(DetailedState.DISCONNECTED, "agentDisconnect");
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400954 mNetworkAgent = null;
955 }
Chia-chi Yehfcc1b412011-08-03 15:39:59 -0700956 }
957
958 /**
Chia-chi Yehe9107902011-07-02 01:48:50 -0700959 * Establish a VPN network and return the file descriptor of the VPN
960 * interface. This methods returns {@code null} if the application is
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700961 * revoked or not prepared.
Chia-chi Yehe9107902011-07-02 01:48:50 -0700962 *
963 * @param config The parameters to configure the network.
964 * @return The file descriptor of the VPN interface.
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700965 */
Chia-chi Yeh04ba25c2011-06-15 17:07:27 -0700966 public synchronized ParcelFileDescriptor establish(VpnConfig config) {
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700967 // Check if the caller is already prepared.
Chad Brubakerc2865192013-07-10 14:46:23 -0700968 UserManager mgr = UserManager.get(mContext);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400969 if (Binder.getCallingUid() != mOwnerUID) {
Chia-chi Yeh7b0b8342011-06-17 14:34:11 -0700970 return null;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700971 }
Jeff Davidson0a775ce2015-04-27 15:02:48 -0700972 // Check to ensure consent hasn't been revoked since we were prepared.
973 if (!isVpnUserPreConsented(mPackage)) {
974 return null;
975 }
Chia-chi Yehfcc1b412011-08-03 15:39:59 -0700976 // Check if the service is properly declared.
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -0700977 Intent intent = new Intent(VpnConfig.SERVICE_INTERFACE);
978 intent.setClassName(mPackage, config.user);
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700979 long token = Binder.clearCallingIdentity();
980 try {
Chad Brubakerc2865192013-07-10 14:46:23 -0700981 // Restricted users are not allowed to create VPNs, they are tied to Owner
Paul Jensen0784eea2014-08-19 16:00:24 -0400982 UserInfo user = mgr.getUserInfo(mUserHandle);
Robin Lee628ae0d2016-05-20 14:53:48 +0100983 if (user.isRestricted()) {
Chad Brubakerc2865192013-07-10 14:46:23 -0700984 throw new SecurityException("Restricted users cannot establish VPNs");
985 }
986
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700987 ResolveInfo info = AppGlobals.getPackageManager().resolveService(intent,
Chalard Jeandd59ece2017-12-20 13:23:32 +0900988 null, 0, mUserHandle);
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700989 if (info == null) {
990 throw new SecurityException("Cannot find " + config.user);
991 }
992 if (!BIND_VPN_SERVICE.equals(info.serviceInfo.permission)) {
993 throw new SecurityException(config.user + " does not require " + BIND_VPN_SERVICE);
994 }
995 } catch (RemoteException e) {
Chalard Jeandd59ece2017-12-20 13:23:32 +0900996 throw new SecurityException("Cannot find " + config.user);
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700997 } finally {
998 Binder.restoreCallingIdentity(token);
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -0700999 }
Chia-chi Yehfcc1b412011-08-03 15:39:59 -07001000
Chad Brubaker850eb672014-03-21 21:02:47 +00001001 // Save the old config in case we need to go back.
1002 VpnConfig oldConfig = mConfig;
1003 String oldInterface = mInterface;
1004 Connection oldConnection = mConnection;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001005 NetworkAgent oldNetworkAgent = mNetworkAgent;
1006 mNetworkAgent = null;
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001007 Set<UidRange> oldUsers = mNetworkCapabilities.getUids();
Chad Brubaker850eb672014-03-21 21:02:47 +00001008
Chia-chi Yehe9107902011-07-02 01:48:50 -07001009 // Configure the interface. Abort if any of these steps fails.
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001010 ParcelFileDescriptor tun = ParcelFileDescriptor.adoptFd(jniCreate(config.mtu));
Chia-chi Yehff3bdca2011-05-23 17:26:46 -07001011 try {
Jeff Sharkey899223b2012-08-04 15:24:58 -07001012 updateState(DetailedState.CONNECTING, "establish");
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001013 String interfaze = jniGetName(tun.getFd());
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001014
Chad Brubakerc2865192013-07-10 14:46:23 -07001015 // TEMP use the old jni calls until there is support for netd address setting
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001016 StringBuilder builder = new StringBuilder();
1017 for (LinkAddress address : config.addresses) {
1018 builder.append(" " + address);
1019 }
1020 if (jniSetAddresses(interfaze, builder.toString()) < 1) {
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001021 throw new IllegalArgumentException("At least one address must be specified");
1022 }
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001023 Connection connection = new Connection();
Dianne Hackbornd69e4c12015-04-24 09:54:54 -07001024 if (!mContext.bindServiceAsUser(intent, connection,
1025 Context.BIND_AUTO_CREATE | Context.BIND_FOREGROUND_SERVICE,
1026 new UserHandle(mUserHandle))) {
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001027 throw new IllegalStateException("Cannot bind " + config.user);
1028 }
Chad Brubaker850eb672014-03-21 21:02:47 +00001029
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001030 mConnection = connection;
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001031 mInterface = interfaze;
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001032
1033 // Fill more values.
1034 config.user = mPackage;
1035 config.interfaze = mInterface;
Chad Brubakerc2865192013-07-10 14:46:23 -07001036 config.startTime = SystemClock.elapsedRealtime();
1037 mConfig = config;
Chad Brubaker850eb672014-03-21 21:02:47 +00001038
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001039 // Set up forwarding and DNS rules.
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001040 agentConnect();
Chad Brubaker850eb672014-03-21 21:02:47 +00001041
1042 if (oldConnection != null) {
1043 mContext.unbindService(oldConnection);
1044 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001045 // Remove the old tun's user forwarding rules
1046 // The new tun's user rules have already been added so they will take over
1047 // as rules are deleted. This prevents data leakage as the rules are moved over.
1048 agentDisconnect(oldNetworkAgent);
Chad Brubaker850eb672014-03-21 21:02:47 +00001049 if (oldInterface != null && !oldInterface.equals(interfaze)) {
Chad Brubaker850eb672014-03-21 21:02:47 +00001050 jniReset(oldInterface);
1051 }
Jeff Davidson6bbf39c2014-07-23 10:14:53 -07001052
1053 try {
1054 IoUtils.setBlocking(tun.getFileDescriptor(), config.blocking);
1055 } catch (IOException e) {
1056 throw new IllegalStateException(
1057 "Cannot set tunnel's fd as blocking=" + config.blocking, e);
1058 }
Chad Brubaker850eb672014-03-21 21:02:47 +00001059 } catch (RuntimeException e) {
Chad Brubaker850eb672014-03-21 21:02:47 +00001060 IoUtils.closeQuietly(tun);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001061 agentDisconnect();
Chad Brubaker850eb672014-03-21 21:02:47 +00001062 // restore old state
1063 mConfig = oldConfig;
1064 mConnection = oldConnection;
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001065 mNetworkCapabilities.setUids(oldUsers);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001066 mNetworkAgent = oldNetworkAgent;
Chad Brubaker850eb672014-03-21 21:02:47 +00001067 mInterface = oldInterface;
1068 throw e;
Chad Brubakerc2865192013-07-10 14:46:23 -07001069 }
Chad Brubaker850eb672014-03-21 21:02:47 +00001070 Log.i(TAG, "Established by " + config.user + " on " + mInterface);
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001071 return tun;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -07001072 }
1073
Chad Brubakerc2865192013-07-10 14:46:23 -07001074 private boolean isRunningLocked() {
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001075 return mNetworkAgent != null && mInterface != null;
1076 }
1077
1078 // Returns true if the VPN has been established and the calling UID is its owner. Used to check
1079 // that a call to mutate VPN state is admissible.
Chalard Jeanf666d0a2018-05-18 21:47:45 +09001080 @VisibleForTesting
1081 protected boolean isCallerEstablishedOwnerLocked() {
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001082 return isRunningLocked() && Binder.getCallingUid() == mOwnerUID;
Chad Brubakerc2865192013-07-10 14:46:23 -07001083 }
1084
Paul Jensen0784eea2014-08-19 16:00:24 -04001085 // Note: Return type guarantees results are deduped and sorted, which callers require.
1086 private SortedSet<Integer> getAppsUids(List<String> packageNames, int userHandle) {
1087 SortedSet<Integer> uids = new TreeSet<Integer>();
1088 for (String app : packageNames) {
1089 int uid = getAppUid(app, userHandle);
1090 if (uid != -1) uids.add(uid);
1091 }
1092 return uids;
1093 }
1094
Robin Lee4d03abc2016-05-09 12:32:27 +01001095 /**
1096 * Creates a {@link Set} of non-intersecting {@link UidRange} objects including all UIDs
1097 * associated with one user, and any restricted profiles attached to that user.
1098 *
1099 * <p>If one of {@param allowedApplications} or {@param disallowedApplications} is provided,
1100 * the UID ranges will match the app whitelist or blacklist specified there. Otherwise, all UIDs
1101 * in each user and profile will be included.
1102 *
1103 * @param userHandle The userId to create UID ranges for along with any of its restricted
1104 * profiles.
1105 * @param allowedApplications (optional) whitelist of applications to include.
1106 * @param disallowedApplications (optional) blacklist of applications to exclude.
1107 */
1108 @VisibleForTesting
1109 Set<UidRange> createUserAndRestrictedProfilesRanges(@UserIdInt int userHandle,
1110 @Nullable List<String> allowedApplications,
1111 @Nullable List<String> disallowedApplications) {
1112 final Set<UidRange> ranges = new ArraySet<>();
Robert Greenwalt69887e82013-09-24 11:05:57 -07001113
Robin Lee4d03abc2016-05-09 12:32:27 +01001114 // Assign the top-level user to the set of ranges
1115 addUserToRanges(ranges, userHandle, allowedApplications, disallowedApplications);
1116
1117 // If the user can have restricted profiles, assign all its restricted profiles too
1118 if (canHaveRestrictedProfile(userHandle)) {
1119 final long token = Binder.clearCallingIdentity();
1120 List<UserInfo> users;
1121 try {
Robin Lee17e61832016-05-09 13:46:28 +01001122 users = UserManager.get(mContext).getUsers(true);
Robin Lee4d03abc2016-05-09 12:32:27 +01001123 } finally {
1124 Binder.restoreCallingIdentity(token);
1125 }
1126 for (UserInfo user : users) {
1127 if (user.isRestricted() && (user.restrictedProfileParentId == userHandle)) {
1128 addUserToRanges(ranges, user.id, allowedApplications, disallowedApplications);
1129 }
1130 }
1131 }
1132 return ranges;
1133 }
1134
1135 /**
1136 * Updates a {@link Set} of non-intersecting {@link UidRange} objects to include all UIDs
1137 * associated with one user.
1138 *
1139 * <p>If one of {@param allowedApplications} or {@param disallowedApplications} is provided,
1140 * the UID ranges will match the app whitelist or blacklist specified there. Otherwise, all UIDs
1141 * in the user will be included.
1142 *
1143 * @param ranges {@link Set} of {@link UidRange}s to which to add.
1144 * @param userHandle The userId to add to {@param ranges}.
1145 * @param allowedApplications (optional) whitelist of applications to include.
1146 * @param disallowedApplications (optional) blacklist of applications to exclude.
1147 */
1148 @VisibleForTesting
1149 void addUserToRanges(@NonNull Set<UidRange> ranges, @UserIdInt int userHandle,
1150 @Nullable List<String> allowedApplications,
1151 @Nullable List<String> disallowedApplications) {
1152 if (allowedApplications != null) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001153 // Add ranges covering all UIDs for allowedApplications.
1154 int start = -1, stop = -1;
Robin Lee4d03abc2016-05-09 12:32:27 +01001155 for (int uid : getAppsUids(allowedApplications, userHandle)) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001156 if (start == -1) {
1157 start = uid;
1158 } else if (uid != stop + 1) {
Robin Lee4d03abc2016-05-09 12:32:27 +01001159 ranges.add(new UidRange(start, stop));
Paul Jensen0784eea2014-08-19 16:00:24 -04001160 start = uid;
1161 }
1162 stop = uid;
1163 }
Robin Lee4d03abc2016-05-09 12:32:27 +01001164 if (start != -1) ranges.add(new UidRange(start, stop));
1165 } else if (disallowedApplications != null) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001166 // Add all ranges for user skipping UIDs for disallowedApplications.
1167 final UidRange userRange = UidRange.createForUser(userHandle);
1168 int start = userRange.start;
Robin Lee4d03abc2016-05-09 12:32:27 +01001169 for (int uid : getAppsUids(disallowedApplications, userHandle)) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001170 if (uid == start) {
1171 start++;
1172 } else {
Robin Lee4d03abc2016-05-09 12:32:27 +01001173 ranges.add(new UidRange(start, uid - 1));
Paul Jensen0784eea2014-08-19 16:00:24 -04001174 start = uid + 1;
1175 }
1176 }
Robin Lee4d03abc2016-05-09 12:32:27 +01001177 if (start <= userRange.stop) ranges.add(new UidRange(start, userRange.stop));
Paul Jensen0784eea2014-08-19 16:00:24 -04001178 } else {
1179 // Add all UIDs for the user.
Robin Lee4d03abc2016-05-09 12:32:27 +01001180 ranges.add(UidRange.createForUser(userHandle));
Paul Jensen0784eea2014-08-19 16:00:24 -04001181 }
Chad Brubakerc2865192013-07-10 14:46:23 -07001182 }
1183
Paul Jensen0784eea2014-08-19 16:00:24 -04001184 // Returns the subset of the full list of active UID ranges the VPN applies to (mVpnUsers) that
1185 // apply to userHandle.
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001186 static private List<UidRange> uidRangesForUser(int userHandle, Set<UidRange> existingRanges) {
1187 // UidRange#createForUser returns the entire range of UIDs available to a macro-user.
1188 // This is something like 0-99999 ; {@see UserHandle#PER_USER_RANGE}
Paul Jensen0784eea2014-08-19 16:00:24 -04001189 final UidRange userRange = UidRange.createForUser(userHandle);
1190 final List<UidRange> ranges = new ArrayList<UidRange>();
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001191 for (UidRange range : existingRanges) {
Robin Lee4d03abc2016-05-09 12:32:27 +01001192 if (userRange.containsRange(range)) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001193 ranges.add(range);
1194 }
1195 }
1196 return ranges;
1197 }
1198
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001199 public void onUserAdded(int userHandle) {
1200 // If the user is restricted tie them to the parent user's VPN
1201 UserInfo user = UserManager.get(mContext).getUserInfo(userHandle);
Robin Lee17e61832016-05-09 13:46:28 +01001202 if (user.isRestricted() && user.restrictedProfileParentId == mUserHandle) {
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001203 synchronized(Vpn.this) {
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001204 final Set<UidRange> existingRanges = mNetworkCapabilities.getUids();
1205 if (existingRanges != null) {
Robin Lee17e61832016-05-09 13:46:28 +01001206 try {
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001207 addUserToRanges(existingRanges, userHandle, mConfig.allowedApplications,
Robin Lee17e61832016-05-09 13:46:28 +01001208 mConfig.disallowedApplications);
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001209 mNetworkCapabilities.setUids(existingRanges);
Chalard Jeanf213ca12018-01-16 18:43:05 +09001210 updateCapabilities();
Robin Lee17e61832016-05-09 13:46:28 +01001211 } catch (Exception e) {
1212 Log.wtf(TAG, "Failed to add restricted user to owner", e);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001213 }
Robin Lee17e61832016-05-09 13:46:28 +01001214 }
Robin Leec3736bc2017-03-10 16:19:54 +00001215 setVpnForcedLocked(mLockdown);
Chad Brubakerc2865192013-07-10 14:46:23 -07001216 }
1217 }
1218 }
1219
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001220 public void onUserRemoved(int userHandle) {
Chad Brubakerc2865192013-07-10 14:46:23 -07001221 // clean up if restricted
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001222 UserInfo user = UserManager.get(mContext).getUserInfo(userHandle);
Robin Lee17e61832016-05-09 13:46:28 +01001223 if (user.isRestricted() && user.restrictedProfileParentId == mUserHandle) {
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001224 synchronized(Vpn.this) {
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001225 final Set<UidRange> existingRanges = mNetworkCapabilities.getUids();
1226 if (existingRanges != null) {
Robin Lee17e61832016-05-09 13:46:28 +01001227 try {
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001228 final List<UidRange> removedRanges =
1229 uidRangesForUser(userHandle, existingRanges);
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001230 existingRanges.removeAll(removedRanges);
1231 mNetworkCapabilities.setUids(existingRanges);
Chalard Jeanf213ca12018-01-16 18:43:05 +09001232 updateCapabilities();
Robin Lee17e61832016-05-09 13:46:28 +01001233 } catch (Exception e) {
1234 Log.wtf(TAG, "Failed to remove restricted user to owner", e);
1235 }
1236 }
Robin Leec3736bc2017-03-10 16:19:54 +00001237 setVpnForcedLocked(mLockdown);
Chad Brubakerc2865192013-07-10 14:46:23 -07001238 }
1239 }
1240 }
1241
Chad Brubakerbf6ff2c2013-07-16 18:59:12 -07001242 /**
Robin Lee17e61832016-05-09 13:46:28 +01001243 * Called when the user associated with this VPN has just been stopped.
1244 */
1245 public synchronized void onUserStopped() {
1246 // Switch off networking lockdown (if it was enabled)
Robin Leec3736bc2017-03-10 16:19:54 +00001247 setLockdown(false);
Robin Lee17e61832016-05-09 13:46:28 +01001248 mAlwaysOn = false;
1249
Robin Lee812800c2016-05-13 15:38:08 +01001250 unregisterPackageChangeReceiverLocked();
Robin Lee17e61832016-05-09 13:46:28 +01001251 // Quit any active connections
1252 agentDisconnect();
1253 }
1254
1255 /**
1256 * Restrict network access from all UIDs affected by this {@link Vpn}, apart from the VPN
1257 * service app itself, to only sockets that have had {@code protect()} called on them. All
1258 * non-VPN traffic is blocked via a {@code PROHIBIT} response from the kernel.
1259 *
1260 * The exception for the VPN UID isn't technically necessary -- setup should use protected
1261 * sockets -- but in practice it saves apps that don't protect their sockets from breaking.
1262 *
1263 * Calling multiple times with {@param enforce} = {@code true} will recreate the set of UIDs to
1264 * block every time, and if anything has changed update using {@link #setAllowOnlyVpnForUids}.
1265 *
1266 * @param enforce {@code true} to require that all traffic under the jurisdiction of this
1267 * {@link Vpn} goes through a VPN connection or is blocked until one is
1268 * available, {@code false} to lift the requirement.
1269 *
1270 * @see #mBlockedUsers
1271 */
1272 @GuardedBy("this")
1273 private void setVpnForcedLocked(boolean enforce) {
Robin Leec3736bc2017-03-10 16:19:54 +00001274 final List<String> exemptedPackages =
1275 isNullOrLegacyVpn(mPackage) ? null : Collections.singletonList(mPackage);
Robin Lee17e61832016-05-09 13:46:28 +01001276 final Set<UidRange> removedRanges = new ArraySet<>(mBlockedUsers);
Robin Leec3736bc2017-03-10 16:19:54 +00001277
1278 Set<UidRange> addedRanges = Collections.emptySet();
Robin Lee17e61832016-05-09 13:46:28 +01001279 if (enforce) {
Robin Leec3736bc2017-03-10 16:19:54 +00001280 addedRanges = createUserAndRestrictedProfilesRanges(mUserHandle,
Robin Lee17e61832016-05-09 13:46:28 +01001281 /* allowedApplications */ null,
Robin Leec3736bc2017-03-10 16:19:54 +00001282 /* disallowedApplications */ exemptedPackages);
Robin Lee17e61832016-05-09 13:46:28 +01001283
1284 removedRanges.removeAll(addedRanges);
1285 addedRanges.removeAll(mBlockedUsers);
Robin Lee17e61832016-05-09 13:46:28 +01001286 }
Robin Leec3736bc2017-03-10 16:19:54 +00001287
1288 setAllowOnlyVpnForUids(false, removedRanges);
1289 setAllowOnlyVpnForUids(true, addedRanges);
Robin Lee17e61832016-05-09 13:46:28 +01001290 }
1291
1292 /**
1293 * Either add or remove a list of {@link UidRange}s to the list of UIDs that are only allowed
1294 * to make connections through sockets that have had {@code protect()} called on them.
1295 *
1296 * @param enforce {@code true} to add to the blacklist, {@code false} to remove.
1297 * @param ranges {@link Collection} of {@link UidRange}s to add (if {@param enforce} is
1298 * {@code true}) or to remove.
1299 * @return {@code true} if all of the UIDs were added/removed. {@code false} otherwise,
1300 * including added ranges that already existed or removed ones that didn't.
1301 */
1302 @GuardedBy("this")
1303 private boolean setAllowOnlyVpnForUids(boolean enforce, Collection<UidRange> ranges) {
1304 if (ranges.size() == 0) {
1305 return true;
1306 }
1307 final UidRange[] rangesArray = ranges.toArray(new UidRange[ranges.size()]);
1308 try {
1309 mNetd.setAllowOnlyVpnForUids(enforce, rangesArray);
1310 } catch (RemoteException | RuntimeException e) {
1311 Log.e(TAG, "Updating blocked=" + enforce
1312 + " for UIDs " + Arrays.toString(ranges.toArray()) + " failed", e);
1313 return false;
1314 }
1315 if (enforce) {
1316 mBlockedUsers.addAll(ranges);
1317 } else {
1318 mBlockedUsers.removeAll(ranges);
1319 }
1320 return true;
1321 }
1322
1323 /**
Chad Brubakerbf6ff2c2013-07-16 18:59:12 -07001324 * Return the configuration of the currently running VPN.
1325 */
1326 public VpnConfig getVpnConfig() {
1327 enforceControlPermission();
1328 return mConfig;
1329 }
1330
Jeff Sharkey899223b2012-08-04 15:24:58 -07001331 @Deprecated
1332 public synchronized void interfaceStatusChanged(String iface, boolean up) {
1333 try {
1334 mObserver.interfaceStatusChanged(iface, up);
1335 } catch (RemoteException e) {
1336 // ignored; target is local
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001337 }
1338 }
1339
Jeff Sharkey899223b2012-08-04 15:24:58 -07001340 private INetworkManagementEventObserver mObserver = new BaseNetworkObserver() {
1341 @Override
1342 public void interfaceStatusChanged(String interfaze, boolean up) {
1343 synchronized (Vpn.this) {
1344 if (!up && mLegacyVpnRunner != null) {
1345 mLegacyVpnRunner.check(interfaze);
1346 }
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001347 }
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001348 }
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001349
Jeff Sharkey899223b2012-08-04 15:24:58 -07001350 @Override
1351 public void interfaceRemoved(String interfaze) {
1352 synchronized (Vpn.this) {
1353 if (interfaze.equals(mInterface) && jniCheck(interfaze) == 0) {
Jeff Davidson90b1b9f2014-08-22 13:05:43 -07001354 mStatusIntent = null;
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001355 mNetworkCapabilities.setUids(null);
Paul Jensenc4c72312014-12-08 14:04:51 -05001356 mConfig = null;
Jeff Sharkey899223b2012-08-04 15:24:58 -07001357 mInterface = null;
1358 if (mConnection != null) {
1359 mContext.unbindService(mConnection);
1360 mConnection = null;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001361 agentDisconnect();
Jeff Sharkey899223b2012-08-04 15:24:58 -07001362 } else if (mLegacyVpnRunner != null) {
1363 mLegacyVpnRunner.exit();
1364 mLegacyVpnRunner = null;
1365 }
1366 }
1367 }
1368 }
1369 };
Haoyu Baidb3c8672012-06-20 14:29:57 -07001370
Chia-chi Yehdadc8572012-06-08 13:05:58 -07001371 private void enforceControlPermission() {
Jeff Davidsonbc19c182014-11-11 13:20:01 -08001372 mContext.enforceCallingPermission(Manifest.permission.CONTROL_VPN, "Unauthorized Caller");
Chia-chi Yehdadc8572012-06-08 13:05:58 -07001373 }
1374
Robin Lee244ce8e2016-01-05 18:03:46 +00001375 private void enforceControlPermissionOrInternalCaller() {
Chalard Jeandd59ece2017-12-20 13:23:32 +09001376 // Require the caller to be either an application with CONTROL_VPN permission or a process
Robin Lee244ce8e2016-01-05 18:03:46 +00001377 // in the system server.
1378 mContext.enforceCallingOrSelfPermission(Manifest.permission.CONTROL_VPN,
1379 "Unauthorized Caller");
1380 }
1381
Charles Hea0a87e82017-05-15 17:07:18 +01001382 private void enforceSettingsPermission() {
1383 mContext.enforceCallingOrSelfPermission(Manifest.permission.NETWORK_SETTINGS,
1384 "Unauthorized Caller");
1385 }
1386
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001387 private class Connection implements ServiceConnection {
1388 private IBinder mService;
1389
1390 @Override
1391 public void onServiceConnected(ComponentName name, IBinder service) {
1392 mService = service;
1393 }
1394
1395 @Override
1396 public void onServiceDisconnected(ComponentName name) {
1397 mService = null;
1398 }
1399 }
1400
Jeff Davidson90b1b9f2014-08-22 13:05:43 -07001401 private void prepareStatusIntent() {
1402 final long token = Binder.clearCallingIdentity();
1403 try {
1404 mStatusIntent = VpnConfig.getIntentForStatusPanel(mContext);
1405 } finally {
1406 Binder.restoreCallingIdentity(token);
1407 }
1408 }
1409
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001410 public synchronized boolean addAddress(String address, int prefixLength) {
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001411 if (!isCallerEstablishedOwnerLocked()) {
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001412 return false;
1413 }
1414 boolean success = jniAddAddress(mInterface, address, prefixLength);
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001415 mNetworkAgent.sendLinkProperties(makeLinkProperties());
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001416 return success;
1417 }
1418
1419 public synchronized boolean removeAddress(String address, int prefixLength) {
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001420 if (!isCallerEstablishedOwnerLocked()) {
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001421 return false;
1422 }
1423 boolean success = jniDelAddress(mInterface, address, prefixLength);
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001424 mNetworkAgent.sendLinkProperties(makeLinkProperties());
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001425 return success;
1426 }
1427
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001428 public synchronized boolean setUnderlyingNetworks(Network[] networks) {
1429 if (!isCallerEstablishedOwnerLocked()) {
1430 return false;
1431 }
1432 if (networks == null) {
1433 mConfig.underlyingNetworks = null;
1434 } else {
1435 mConfig.underlyingNetworks = new Network[networks.length];
1436 for (int i = 0; i < networks.length; ++i) {
1437 if (networks[i] == null) {
1438 mConfig.underlyingNetworks[i] = null;
1439 } else {
1440 mConfig.underlyingNetworks[i] = new Network(networks[i].netId);
1441 }
1442 }
1443 }
Jeff Sharkey72f9c422017-10-27 17:22:59 -06001444 updateCapabilities();
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001445 return true;
1446 }
1447
1448 public synchronized Network[] getUnderlyingNetworks() {
1449 if (!isRunningLocked()) {
1450 return null;
1451 }
1452 return mConfig.underlyingNetworks;
1453 }
1454
Wenchao Tongf5ea3402015-03-04 13:26:38 -08001455 /**
Chalard Jeandd59ece2017-12-20 13:23:32 +09001456 * This method should only be called by ConnectivityService because it doesn't
Wenchao Tongf5ea3402015-03-04 13:26:38 -08001457 * have enough data to fill VpnInfo.primaryUnderlyingIface field.
1458 */
1459 public synchronized VpnInfo getVpnInfo() {
1460 if (!isRunningLocked()) {
1461 return null;
1462 }
1463
1464 VpnInfo info = new VpnInfo();
1465 info.ownerUid = mOwnerUID;
1466 info.vpnIface = mInterface;
1467 return info;
1468 }
1469
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001470 public synchronized boolean appliesToUid(int uid) {
1471 if (!isRunningLocked()) {
1472 return false;
1473 }
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001474 return mNetworkCapabilities.appliesToUid(uid);
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001475 }
1476
Robin Lee17e61832016-05-09 13:46:28 +01001477 /**
Robin Leeebbcb542016-05-24 16:35:10 +01001478 * @return {@code true} if {@param uid} is blocked by an always-on VPN.
1479 * A UID is blocked if it's included in one of the mBlockedUsers ranges and the VPN is
1480 * not connected, or if the VPN is connected but does not apply to the UID.
Robin Lee17e61832016-05-09 13:46:28 +01001481 *
1482 * @see #mBlockedUsers
1483 */
1484 public synchronized boolean isBlockingUid(int uid) {
Robin Leeebbcb542016-05-24 16:35:10 +01001485 if (!mLockdown) {
1486 return false;
Robin Lee17e61832016-05-09 13:46:28 +01001487 }
Robin Leeebbcb542016-05-24 16:35:10 +01001488
1489 if (mNetworkInfo.isConnected()) {
1490 return !appliesToUid(uid);
1491 } else {
1492 for (UidRange uidRange : mBlockedUsers) {
1493 if (uidRange.contains(uid)) {
1494 return true;
1495 }
1496 }
1497 return false;
1498 }
Robin Lee17e61832016-05-09 13:46:28 +01001499 }
1500
Tony Mak1a405fe2016-06-30 11:19:20 +01001501 private void updateAlwaysOnNotification(DetailedState networkState) {
1502 final boolean visible = (mAlwaysOn && networkState != DetailedState.CONNECTED);
Tony Mak1a405fe2016-06-30 11:19:20 +01001503
Tony Mak1a405fe2016-06-30 11:19:20 +01001504 final UserHandle user = UserHandle.of(mUserHandle);
1505 final long token = Binder.clearCallingIdentity();
1506 try {
1507 final NotificationManager notificationManager = NotificationManager.from(mContext);
1508 if (!visible) {
Charles He15297a62017-04-08 22:03:42 +01001509 notificationManager.cancelAsUser(TAG, SystemMessage.NOTE_VPN_DISCONNECTED, user);
Tony Mak1a405fe2016-06-30 11:19:20 +01001510 return;
1511 }
Charles Heab6f2f62017-07-12 15:30:00 +01001512 final Intent intent = new Intent();
1513 intent.setComponent(ComponentName.unflattenFromString(mContext.getString(
1514 R.string.config_customVpnAlwaysOnDisconnectedDialogComponent)));
1515 intent.putExtra("lockdown", mLockdown);
1516 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
Robin Leeb8c2a2b2017-03-10 16:17:06 +00001517 final PendingIntent configIntent = mSystemServices.pendingIntentGetActivityAsUser(
1518 intent, PendingIntent.FLAG_IMMUTABLE | PendingIntent.FLAG_UPDATE_CURRENT, user);
Geoffrey Pitschaf759c52017-02-15 09:35:38 -05001519 final Notification.Builder builder =
1520 new Notification.Builder(mContext, SystemNotificationChannels.VPN)
1521 .setSmallIcon(R.drawable.vpn_connected)
1522 .setContentTitle(mContext.getString(R.string.vpn_lockdown_disconnected))
1523 .setContentText(mContext.getString(R.string.vpn_lockdown_config))
1524 .setContentIntent(configIntent)
1525 .setCategory(Notification.CATEGORY_SYSTEM)
1526 .setVisibility(Notification.VISIBILITY_PUBLIC)
1527 .setOngoing(true)
1528 .setColor(mContext.getColor(R.color.system_notification_accent_color));
Chris Wren282cfef2017-03-27 15:01:44 -04001529 notificationManager.notifyAsUser(TAG, SystemMessage.NOTE_VPN_DISCONNECTED,
1530 builder.build(), user);
Tony Mak1a405fe2016-06-30 11:19:20 +01001531 } finally {
1532 Binder.restoreCallingIdentity(token);
1533 }
1534 }
1535
Robin Leeb8c2a2b2017-03-10 16:17:06 +00001536 /**
1537 * Facade for system service calls that change, or depend on, state outside of
1538 * {@link ConnectivityService} and have hard-to-mock interfaces.
1539 *
1540 * @see com.android.server.connectivity.VpnTest
1541 */
1542 @VisibleForTesting
1543 public static class SystemServices {
1544 private final Context mContext;
1545
1546 public SystemServices(@NonNull Context context) {
1547 mContext = context;
1548 }
1549
1550 /**
1551 * @see PendingIntent#getActivityAsUser()
1552 */
1553 public PendingIntent pendingIntentGetActivityAsUser(
1554 Intent intent, int flags, UserHandle user) {
1555 return PendingIntent.getActivityAsUser(mContext, 0 /*request*/, intent, flags,
1556 null /*options*/, user);
1557 }
1558
1559 /**
1560 * @see Settings.Secure#putStringForUser
1561 */
1562 public void settingsSecurePutStringForUser(String key, String value, int userId) {
1563 Settings.Secure.putStringForUser(mContext.getContentResolver(), key, value, userId);
1564 }
1565
1566 /**
1567 * @see Settings.Secure#putIntForUser
1568 */
1569 public void settingsSecurePutIntForUser(String key, int value, int userId) {
1570 Settings.Secure.putIntForUser(mContext.getContentResolver(), key, value, userId);
1571 }
1572
1573 /**
1574 * @see Settings.Secure#getStringForUser
1575 */
1576 public String settingsSecureGetStringForUser(String key, int userId) {
1577 return Settings.Secure.getStringForUser(mContext.getContentResolver(), key, userId);
1578 }
1579
1580 /**
1581 * @see Settings.Secure#getIntForUser
1582 */
1583 public int settingsSecureGetIntForUser(String key, int def, int userId) {
1584 return Settings.Secure.getIntForUser(mContext.getContentResolver(), key, def, userId);
1585 }
1586 }
1587
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001588 private native int jniCreate(int mtu);
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001589 private native String jniGetName(int tun);
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001590 private native int jniSetAddresses(String interfaze, String addresses);
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001591 private native void jniReset(String interfaze);
1592 private native int jniCheck(String interfaze);
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001593 private native boolean jniAddAddress(String interfaze, String address, int prefixLen);
1594 private native boolean jniDelAddress(String interfaze, String address, int prefixLen);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001595
Lorenzo Colitti41fb98c2013-06-28 17:26:21 +09001596 private static RouteInfo findIPv4DefaultRoute(LinkProperties prop) {
1597 for (RouteInfo route : prop.getAllRoutes()) {
Jeff Sharkey82f85212012-08-24 11:17:25 -07001598 // Currently legacy VPN only works on IPv4.
1599 if (route.isDefaultRoute() && route.getGateway() instanceof Inet4Address) {
Lorenzo Colitti41fb98c2013-06-28 17:26:21 +09001600 return route;
Jeff Sharkey82f85212012-08-24 11:17:25 -07001601 }
1602 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07001603
Lorenzo Colitti41fb98c2013-06-28 17:26:21 +09001604 throw new IllegalStateException("Unable to find IPv4 default gateway");
Jeff Sharkey82f85212012-08-24 11:17:25 -07001605 }
1606
1607 /**
1608 * Start legacy VPN, controlling native daemons as needed. Creates a
1609 * secondary thread to perform connection work, returning quickly.
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001610 *
1611 * Should only be called to respond to Binder requests as this enforces caller permission. Use
1612 * {@link #startLegacyVpnPrivileged(VpnProfile, KeyStore, LinkProperties)} to skip the
1613 * permission check only when the caller is trusted (or the call is initiated by the system).
Jeff Sharkey82f85212012-08-24 11:17:25 -07001614 */
1615 public void startLegacyVpn(VpnProfile profile, KeyStore keyStore, LinkProperties egress) {
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001616 enforceControlPermission();
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001617 long token = Binder.clearCallingIdentity();
1618 try {
1619 startLegacyVpnPrivileged(profile, keyStore, egress);
1620 } finally {
1621 Binder.restoreCallingIdentity(token);
1622 }
1623 }
1624
1625 /**
1626 * Like {@link #startLegacyVpn(VpnProfile, KeyStore, LinkProperties)}, but does not check
1627 * permissions under the assumption that the caller is the system.
1628 *
1629 * Callers are responsible for checking permissions if needed.
1630 */
1631 public void startLegacyVpnPrivileged(VpnProfile profile, KeyStore keyStore,
1632 LinkProperties egress) {
Julia Reynoldsf5116d02014-07-01 11:10:41 -04001633 UserManager mgr = UserManager.get(mContext);
Paul Jensen0784eea2014-08-19 16:00:24 -04001634 UserInfo user = mgr.getUserInfo(mUserHandle);
Nicolas Prevot95778ff2015-01-06 15:43:05 +00001635 if (user.isRestricted() || mgr.hasUserRestriction(UserManager.DISALLOW_CONFIG_VPN,
1636 new UserHandle(mUserHandle))) {
Julia Reynoldsf5116d02014-07-01 11:10:41 -04001637 throw new SecurityException("Restricted users cannot establish VPNs");
1638 }
Jeff Sharkey82f85212012-08-24 11:17:25 -07001639
Lorenzo Colitti41fb98c2013-06-28 17:26:21 +09001640 final RouteInfo ipv4DefaultRoute = findIPv4DefaultRoute(egress);
1641 final String gateway = ipv4DefaultRoute.getGateway().getHostAddress();
1642 final String iface = ipv4DefaultRoute.getInterface();
Jeff Sharkey82f85212012-08-24 11:17:25 -07001643
1644 // Load certificates.
1645 String privateKey = "";
1646 String userCert = "";
1647 String caCert = "";
1648 String serverCert = "";
1649 if (!profile.ipsecUserCert.isEmpty()) {
1650 privateKey = Credentials.USER_PRIVATE_KEY + profile.ipsecUserCert;
1651 byte[] value = keyStore.get(Credentials.USER_CERTIFICATE + profile.ipsecUserCert);
Elliott Hughesd396a442013-06-28 16:24:48 -07001652 userCert = (value == null) ? null : new String(value, StandardCharsets.UTF_8);
Jeff Sharkey82f85212012-08-24 11:17:25 -07001653 }
1654 if (!profile.ipsecCaCert.isEmpty()) {
1655 byte[] value = keyStore.get(Credentials.CA_CERTIFICATE + profile.ipsecCaCert);
Elliott Hughesd396a442013-06-28 16:24:48 -07001656 caCert = (value == null) ? null : new String(value, StandardCharsets.UTF_8);
Jeff Sharkey82f85212012-08-24 11:17:25 -07001657 }
1658 if (!profile.ipsecServerCert.isEmpty()) {
1659 byte[] value = keyStore.get(Credentials.USER_CERTIFICATE + profile.ipsecServerCert);
Elliott Hughesd396a442013-06-28 16:24:48 -07001660 serverCert = (value == null) ? null : new String(value, StandardCharsets.UTF_8);
Jeff Sharkey82f85212012-08-24 11:17:25 -07001661 }
1662 if (privateKey == null || userCert == null || caCert == null || serverCert == null) {
1663 throw new IllegalStateException("Cannot load credentials");
1664 }
1665
1666 // Prepare arguments for racoon.
1667 String[] racoon = null;
1668 switch (profile.type) {
1669 case VpnProfile.TYPE_L2TP_IPSEC_PSK:
1670 racoon = new String[] {
1671 iface, profile.server, "udppsk", profile.ipsecIdentifier,
1672 profile.ipsecSecret, "1701",
1673 };
1674 break;
1675 case VpnProfile.TYPE_L2TP_IPSEC_RSA:
1676 racoon = new String[] {
1677 iface, profile.server, "udprsa", privateKey, userCert,
1678 caCert, serverCert, "1701",
1679 };
1680 break;
1681 case VpnProfile.TYPE_IPSEC_XAUTH_PSK:
1682 racoon = new String[] {
1683 iface, profile.server, "xauthpsk", profile.ipsecIdentifier,
1684 profile.ipsecSecret, profile.username, profile.password, "", gateway,
1685 };
1686 break;
1687 case VpnProfile.TYPE_IPSEC_XAUTH_RSA:
1688 racoon = new String[] {
1689 iface, profile.server, "xauthrsa", privateKey, userCert,
1690 caCert, serverCert, profile.username, profile.password, "", gateway,
1691 };
1692 break;
1693 case VpnProfile.TYPE_IPSEC_HYBRID_RSA:
1694 racoon = new String[] {
1695 iface, profile.server, "hybridrsa",
1696 caCert, serverCert, profile.username, profile.password, "", gateway,
1697 };
1698 break;
1699 }
1700
1701 // Prepare arguments for mtpd.
1702 String[] mtpd = null;
1703 switch (profile.type) {
1704 case VpnProfile.TYPE_PPTP:
1705 mtpd = new String[] {
1706 iface, "pptp", profile.server, "1723",
1707 "name", profile.username, "password", profile.password,
1708 "linkname", "vpn", "refuse-eap", "nodefaultroute",
1709 "usepeerdns", "idle", "1800", "mtu", "1400", "mru", "1400",
1710 (profile.mppe ? "+mppe" : "nomppe"),
1711 };
1712 break;
1713 case VpnProfile.TYPE_L2TP_IPSEC_PSK:
1714 case VpnProfile.TYPE_L2TP_IPSEC_RSA:
1715 mtpd = new String[] {
1716 iface, "l2tp", profile.server, "1701", profile.l2tpSecret,
1717 "name", profile.username, "password", profile.password,
1718 "linkname", "vpn", "refuse-eap", "nodefaultroute",
1719 "usepeerdns", "idle", "1800", "mtu", "1400", "mru", "1400",
1720 };
1721 break;
1722 }
1723
1724 VpnConfig config = new VpnConfig();
Jeff Sharkey899223b2012-08-04 15:24:58 -07001725 config.legacy = true;
Jeff Sharkey82f85212012-08-24 11:17:25 -07001726 config.user = profile.key;
1727 config.interfaze = iface;
1728 config.session = profile.name;
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001729
1730 config.addLegacyRoutes(profile.routes);
Jeff Sharkey82f85212012-08-24 11:17:25 -07001731 if (!profile.dnsServers.isEmpty()) {
1732 config.dnsServers = Arrays.asList(profile.dnsServers.split(" +"));
1733 }
1734 if (!profile.searchDomains.isEmpty()) {
1735 config.searchDomains = Arrays.asList(profile.searchDomains.split(" +"));
1736 }
Jeff Sharkey82f85212012-08-24 11:17:25 -07001737 startLegacyVpn(config, racoon, mtpd);
1738 }
1739
1740 private synchronized void startLegacyVpn(VpnConfig config, String[] racoon, String[] mtpd) {
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001741 stopLegacyVpnPrivileged();
Jeff Sharkey899223b2012-08-04 15:24:58 -07001742
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001743 // Prepare for the new request.
1744 prepareInternal(VpnConfig.LEGACY_VPN);
Jeff Sharkey899223b2012-08-04 15:24:58 -07001745 updateState(DetailedState.CONNECTING, "startLegacyVpn");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001746
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001747 // Start a new LegacyVpnRunner and we are done!
Chia-chi Yeh100155a2011-07-03 16:52:38 -07001748 mLegacyVpnRunner = new LegacyVpnRunner(config, racoon, mtpd);
1749 mLegacyVpnRunner.start();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001750 }
1751
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001752 /** Stop legacy VPN. Permissions must be checked by callers. */
1753 public synchronized void stopLegacyVpnPrivileged() {
Jeff Sharkey899223b2012-08-04 15:24:58 -07001754 if (mLegacyVpnRunner != null) {
1755 mLegacyVpnRunner.exit();
1756 mLegacyVpnRunner = null;
1757
1758 synchronized (LegacyVpnRunner.TAG) {
1759 // wait for old thread to completely finish before spinning up
1760 // new instance, otherwise state updates can be out of order.
1761 }
1762 }
1763 }
1764
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001765 /**
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001766 * Return the information of the current ongoing legacy VPN.
1767 */
1768 public synchronized LegacyVpnInfo getLegacyVpnInfo() {
Chia-chi Yehdadc8572012-06-08 13:05:58 -07001769 // Check if the caller is authorized.
1770 enforceControlPermission();
sj.cha08bbca02015-03-23 11:35:24 +09001771 return getLegacyVpnInfoPrivileged();
1772 }
1773
1774 /**
1775 * Return the information of the current ongoing legacy VPN.
1776 * Callers are responsible for checking permissions if needed.
1777 */
1778 public synchronized LegacyVpnInfo getLegacyVpnInfoPrivileged() {
Jeff Sharkey899223b2012-08-04 15:24:58 -07001779 if (mLegacyVpnRunner == null) return null;
1780
1781 final LegacyVpnInfo info = new LegacyVpnInfo();
Chad Brubakerc2865192013-07-10 14:46:23 -07001782 info.key = mConfig.user;
Jeff Sharkey899223b2012-08-04 15:24:58 -07001783 info.state = LegacyVpnInfo.stateFromNetworkInfo(mNetworkInfo);
Jeff Davidson90b1b9f2014-08-22 13:05:43 -07001784 if (mNetworkInfo.isConnected()) {
1785 info.intent = mStatusIntent;
1786 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07001787 return info;
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001788 }
1789
Jeff Sharkey69ddab42012-08-25 00:05:46 -07001790 public VpnConfig getLegacyVpnConfig() {
1791 if (mLegacyVpnRunner != null) {
Chad Brubakerc2865192013-07-10 14:46:23 -07001792 return mConfig;
Jeff Sharkey69ddab42012-08-25 00:05:46 -07001793 } else {
1794 return null;
1795 }
1796 }
1797
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001798 /**
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001799 * Bringing up a VPN connection takes time, and that is all this thread
1800 * does. Here we have plenty of time. The only thing we need to take
1801 * care of is responding to interruptions as soon as possible. Otherwise
Chalard Jeandd59ece2017-12-20 13:23:32 +09001802 * requests will pile up. This could be done in a Handler as a state
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001803 * machine, but it is much easier to read in the current form.
1804 */
1805 private class LegacyVpnRunner extends Thread {
1806 private static final String TAG = "LegacyVpnRunner";
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001807
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001808 private final String[] mDaemons;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001809 private final String[][] mArguments;
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001810 private final LocalSocket[] mSockets;
Robert Greenwalt53c04bd2012-10-12 17:02:45 -07001811 private final String mOuterInterface;
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001812 private final AtomicInteger mOuterConnection =
1813 new AtomicInteger(ConnectivityManager.TYPE_NONE);
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001814
Chalard Jeandd59ece2017-12-20 13:23:32 +09001815 private long mBringupStartTime = -1;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001816
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001817 /**
1818 * Watch for the outer connection (passing in the constructor) going away.
1819 */
1820 private final BroadcastReceiver mBroadcastReceiver = new BroadcastReceiver() {
1821 @Override
1822 public void onReceive(Context context, Intent intent) {
Jeff Sharkey57666932013-04-30 17:01:57 -07001823 if (!mEnableTeardown) return;
1824
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001825 if (intent.getAction().equals(ConnectivityManager.CONNECTIVITY_ACTION)) {
1826 if (intent.getIntExtra(ConnectivityManager.EXTRA_NETWORK_TYPE,
1827 ConnectivityManager.TYPE_NONE) == mOuterConnection.get()) {
1828 NetworkInfo info = (NetworkInfo)intent.getExtra(
1829 ConnectivityManager.EXTRA_NETWORK_INFO);
1830 if (info != null && !info.isConnectedOrConnecting()) {
1831 try {
1832 mObserver.interfaceStatusChanged(mOuterInterface, false);
1833 } catch (RemoteException e) {}
1834 }
1835 }
1836 }
1837 }
1838 };
1839
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001840 public LegacyVpnRunner(VpnConfig config, String[] racoon, String[] mtpd) {
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001841 super(TAG);
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001842 mConfig = config;
1843 mDaemons = new String[] {"racoon", "mtpd"};
Jeff Sharkey899223b2012-08-04 15:24:58 -07001844 // TODO: clear arguments from memory once launched
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001845 mArguments = new String[][] {racoon, mtpd};
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001846 mSockets = new LocalSocket[mDaemons.length];
Robert Greenwalt53c04bd2012-10-12 17:02:45 -07001847
1848 // This is the interface which VPN is running on,
1849 // mConfig.interfaze will change to point to OUR
1850 // internal interface soon. TODO - add inner/outer to mconfig
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001851 // TODO - we have a race - if the outer iface goes away/disconnects before we hit this
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001852 // we will leave the VPN up. We should check that it's still there/connected after
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001853 // registering
Robert Greenwalt53c04bd2012-10-12 17:02:45 -07001854 mOuterInterface = mConfig.interfaze;
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001855
Paul Jensene75b9e32015-04-06 11:54:53 -04001856 if (!TextUtils.isEmpty(mOuterInterface)) {
1857 final ConnectivityManager cm = ConnectivityManager.from(mContext);
1858 for (Network network : cm.getAllNetworks()) {
1859 final LinkProperties lp = cm.getLinkProperties(network);
Lorenzo Colitti1b60d112015-07-02 13:03:03 +09001860 if (lp != null && lp.getAllInterfaceNames().contains(mOuterInterface)) {
Paul Jensene75b9e32015-04-06 11:54:53 -04001861 final NetworkInfo networkInfo = cm.getNetworkInfo(network);
1862 if (networkInfo != null) mOuterConnection.set(networkInfo.getType());
1863 }
1864 }
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001865 }
1866
1867 IntentFilter filter = new IntentFilter();
1868 filter.addAction(ConnectivityManager.CONNECTIVITY_ACTION);
1869 mContext.registerReceiver(mBroadcastReceiver, filter);
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001870 }
1871
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001872 public void check(String interfaze) {
Robert Greenwalt53c04bd2012-10-12 17:02:45 -07001873 if (interfaze.equals(mOuterInterface)) {
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001874 Log.i(TAG, "Legacy VPN is going down with " + interfaze);
1875 exit();
1876 }
1877 }
1878
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001879 public void exit() {
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001880 // We assume that everything is reset after stopping the daemons.
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001881 interrupt();
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001882 agentDisconnect();
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001883 try {
1884 mContext.unregisterReceiver(mBroadcastReceiver);
1885 } catch (IllegalArgumentException e) {}
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001886 }
1887
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001888 @Override
1889 public void run() {
1890 // Wait for the previous thread since it has been interrupted.
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001891 Log.v(TAG, "Waiting");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001892 synchronized (TAG) {
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001893 Log.v(TAG, "Executing");
Hisanobu Watanabe047454c2016-06-07 19:55:41 +09001894 try {
Chalard Jeandd59ece2017-12-20 13:23:32 +09001895 bringup();
1896 waitForDaemonsToStop();
Hisanobu Watanabe047454c2016-06-07 19:55:41 +09001897 interrupted(); // Clear interrupt flag if execute called exit.
1898 } catch (InterruptedException e) {
1899 } finally {
1900 for (LocalSocket socket : mSockets) {
1901 IoUtils.closeQuietly(socket);
1902 }
1903 // This sleep is necessary for racoon to successfully complete sending delete
1904 // message to server.
1905 try {
1906 Thread.sleep(50);
1907 } catch (InterruptedException e) {
1908 }
1909 for (String daemon : mDaemons) {
1910 SystemService.stop(daemon);
1911 }
1912 }
1913 agentDisconnect();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001914 }
1915 }
1916
Chalard Jeandd59ece2017-12-20 13:23:32 +09001917 private void checkInterruptAndDelay(boolean sleepLonger) throws InterruptedException {
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001918 long now = SystemClock.elapsedRealtime();
Chalard Jeandd59ece2017-12-20 13:23:32 +09001919 if (now - mBringupStartTime <= 60000) {
1920 Thread.sleep(sleepLonger ? 200 : 1);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001921 } else {
Jeff Sharkey899223b2012-08-04 15:24:58 -07001922 updateState(DetailedState.FAILED, "checkpoint");
Chalard Jeandd59ece2017-12-20 13:23:32 +09001923 throw new IllegalStateException("VPN bringup took too long");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001924 }
1925 }
1926
Chalard Jeandd59ece2017-12-20 13:23:32 +09001927 private void bringup() {
1928 // Catch all exceptions so we can clean up a few things.
Jeff Sharkey899223b2012-08-04 15:24:58 -07001929 boolean initFinished = false;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001930 try {
1931 // Initialize the timer.
Chalard Jeandd59ece2017-12-20 13:23:32 +09001932 mBringupStartTime = SystemClock.elapsedRealtime();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001933
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001934 // Wait for the daemons to stop.
1935 for (String daemon : mDaemons) {
Jeff Sharkey088f29f2012-08-05 14:55:04 -07001936 while (!SystemService.isStopped(daemon)) {
Chalard Jeandd59ece2017-12-20 13:23:32 +09001937 checkInterruptAndDelay(true);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001938 }
1939 }
1940
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001941 // Clear the previous state.
1942 File state = new File("/data/misc/vpn/state");
1943 state.delete();
1944 if (state.exists()) {
1945 throw new IllegalStateException("Cannot delete the state");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001946 }
Chia-chi Yehc1872732011-12-08 16:51:41 -08001947 new File("/data/misc/vpn/abort").delete();
Jeff Sharkey899223b2012-08-04 15:24:58 -07001948 initFinished = true;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001949
Chia-chi Yehe9107902011-07-02 01:48:50 -07001950 // Check if we need to restart any of the daemons.
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001951 boolean restart = false;
1952 for (String[] arguments : mArguments) {
1953 restart = restart || (arguments != null);
1954 }
1955 if (!restart) {
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001956 agentDisconnect();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001957 return;
1958 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07001959 updateState(DetailedState.CONNECTING, "execute");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001960
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001961 // Start the daemon with arguments.
1962 for (int i = 0; i < mDaemons.length; ++i) {
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001963 String[] arguments = mArguments[i];
1964 if (arguments == null) {
1965 continue;
1966 }
1967
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001968 // Start the daemon.
1969 String daemon = mDaemons[i];
Jeff Sharkey088f29f2012-08-05 14:55:04 -07001970 SystemService.start(daemon);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001971
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001972 // Wait for the daemon to start.
Jeff Sharkey088f29f2012-08-05 14:55:04 -07001973 while (!SystemService.isRunning(daemon)) {
Chalard Jeandd59ece2017-12-20 13:23:32 +09001974 checkInterruptAndDelay(true);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001975 }
1976
1977 // Create the control socket.
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001978 mSockets[i] = new LocalSocket();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001979 LocalSocketAddress address = new LocalSocketAddress(
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001980 daemon, LocalSocketAddress.Namespace.RESERVED);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001981
1982 // Wait for the socket to connect.
1983 while (true) {
1984 try {
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001985 mSockets[i].connect(address);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001986 break;
1987 } catch (Exception e) {
1988 // ignore
1989 }
Chalard Jeandd59ece2017-12-20 13:23:32 +09001990 checkInterruptAndDelay(true);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001991 }
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001992 mSockets[i].setSoTimeout(500);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001993
1994 // Send over the arguments.
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001995 OutputStream out = mSockets[i].getOutputStream();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001996 for (String argument : arguments) {
Elliott Hughesd396a442013-06-28 16:24:48 -07001997 byte[] bytes = argument.getBytes(StandardCharsets.UTF_8);
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001998 if (bytes.length >= 0xFFFF) {
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001999 throw new IllegalArgumentException("Argument is too large");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002000 }
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07002001 out.write(bytes.length >> 8);
2002 out.write(bytes.length);
2003 out.write(bytes);
Chalard Jeandd59ece2017-12-20 13:23:32 +09002004 checkInterruptAndDelay(false);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002005 }
Chia-chi Yeh5317f032011-08-22 13:09:49 -07002006 out.write(0xFF);
2007 out.write(0xFF);
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07002008 out.flush();
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002009
2010 // Wait for End-of-File.
Chia-chi Yeh5317f032011-08-22 13:09:49 -07002011 InputStream in = mSockets[i].getInputStream();
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002012 while (true) {
2013 try {
2014 if (in.read() == -1) {
2015 break;
2016 }
2017 } catch (Exception e) {
2018 // ignore
2019 }
Chalard Jeandd59ece2017-12-20 13:23:32 +09002020 checkInterruptAndDelay(true);
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002021 }
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002022 }
2023
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002024 // Wait for the daemons to create the new state.
2025 while (!state.exists()) {
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07002026 // Check if a running daemon is dead.
2027 for (int i = 0; i < mDaemons.length; ++i) {
2028 String daemon = mDaemons[i];
Jeff Sharkey088f29f2012-08-05 14:55:04 -07002029 if (mArguments[i] != null && !SystemService.isRunning(daemon)) {
Chia-chi Yeh2e467642011-07-04 03:23:12 -07002030 throw new IllegalStateException(daemon + " is dead");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002031 }
2032 }
Chalard Jeandd59ece2017-12-20 13:23:32 +09002033 checkInterruptAndDelay(true);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002034 }
2035
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002036 // Now we are connected. Read and parse the new state.
Chia-chi Yehc1bac3a2011-12-16 15:00:31 -08002037 String[] parameters = FileUtils.readTextFile(state, 0, null).split("\n", -1);
Lorenzo Colitti50262792014-09-19 01:53:35 +09002038 if (parameters.length != 7) {
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002039 throw new IllegalStateException("Cannot parse the state");
2040 }
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002041
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002042 // Set the interface and the addresses in the config.
2043 mConfig.interfaze = parameters[0].trim();
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002044
Chad Brubaker4ca19e82013-06-14 11:16:51 -07002045 mConfig.addLegacyAddresses(parameters[1]);
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002046 // Set the routes if they are not set in the config.
2047 if (mConfig.routes == null || mConfig.routes.isEmpty()) {
Chad Brubaker4ca19e82013-06-14 11:16:51 -07002048 mConfig.addLegacyRoutes(parameters[2]);
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002049 }
2050
2051 // Set the DNS servers if they are not set in the config.
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002052 if (mConfig.dnsServers == null || mConfig.dnsServers.size() == 0) {
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002053 String dnsServers = parameters[3].trim();
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002054 if (!dnsServers.isEmpty()) {
2055 mConfig.dnsServers = Arrays.asList(dnsServers.split(" "));
2056 }
2057 }
2058
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002059 // Set the search domains if they are not set in the config.
2060 if (mConfig.searchDomains == null || mConfig.searchDomains.size() == 0) {
2061 String searchDomains = parameters[4].trim();
2062 if (!searchDomains.isEmpty()) {
2063 mConfig.searchDomains = Arrays.asList(searchDomains.split(" "));
2064 }
2065 }
Chia-chi Yehe9107902011-07-02 01:48:50 -07002066
Lorenzo Colitti50262792014-09-19 01:53:35 +09002067 // Add a throw route for the VPN server endpoint, if one was specified.
2068 String endpoint = parameters[5];
2069 if (!endpoint.isEmpty()) {
2070 try {
2071 InetAddress addr = InetAddress.parseNumericAddress(endpoint);
2072 if (addr instanceof Inet4Address) {
2073 mConfig.routes.add(new RouteInfo(new IpPrefix(addr, 32), RTN_THROW));
2074 } else if (addr instanceof Inet6Address) {
2075 mConfig.routes.add(new RouteInfo(new IpPrefix(addr, 128), RTN_THROW));
2076 } else {
2077 Log.e(TAG, "Unknown IP address family for VPN endpoint: " + endpoint);
2078 }
2079 } catch (IllegalArgumentException e) {
2080 Log.e(TAG, "Exception constructing throw route to " + endpoint + ": " + e);
2081 }
2082 }
2083
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002084 // Here is the last step and it must be done synchronously.
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002085 synchronized (Vpn.this) {
Vinit Deshapnde2b862e52013-10-02 11:50:39 -07002086 // Set the start time
2087 mConfig.startTime = SystemClock.elapsedRealtime();
2088
Chalard Jeandd59ece2017-12-20 13:23:32 +09002089 // Check if the thread was interrupted while we were waiting on the lock.
2090 checkInterruptAndDelay(false);
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002091
Chia-chi Yehe9107902011-07-02 01:48:50 -07002092 // Check if the interface is gone while we are waiting.
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07002093 if (jniCheck(mConfig.interfaze) == 0) {
Chia-chi Yeh34e78132011-07-03 03:07:07 -07002094 throw new IllegalStateException(mConfig.interfaze + " is gone");
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002095 }
Chia-chi Yehe9107902011-07-02 01:48:50 -07002096
2097 // Now INetworkManagementEventObserver is watching our back.
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07002098 mInterface = mConfig.interfaze;
Robin Lee4d03abc2016-05-09 12:32:27 +01002099 prepareStatusIntent();
Chad Brubaker4ca19e82013-06-14 11:16:51 -07002100
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04002101 agentConnect();
Chia-chi Yeh2e467642011-07-04 03:23:12 -07002102
2103 Log.i(TAG, "Connected!");
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002104 }
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002105 } catch (Exception e) {
Chia-chi Yeh2e467642011-07-04 03:23:12 -07002106 Log.i(TAG, "Aborting", e);
Lorenzo Colitti43840602014-08-20 16:01:44 -07002107 updateState(DetailedState.FAILED, e.getMessage());
Chia-chi Yehe9107902011-07-02 01:48:50 -07002108 exit();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002109 }
2110 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07002111
2112 /**
Chalard Jeandd59ece2017-12-20 13:23:32 +09002113 * Check all daemons every two seconds. Return when one of them is stopped.
2114 * The caller will move to the disconnected state when this function returns,
2115 * which can happen if a daemon failed or if the VPN was torn down.
Jeff Sharkey899223b2012-08-04 15:24:58 -07002116 */
Chalard Jeandd59ece2017-12-20 13:23:32 +09002117 private void waitForDaemonsToStop() throws InterruptedException {
Jeff Sharkey899223b2012-08-04 15:24:58 -07002118 if (!mNetworkInfo.isConnected()) {
2119 return;
2120 }
Hisanobu Watanabe047454c2016-06-07 19:55:41 +09002121 while (true) {
2122 Thread.sleep(2000);
2123 for (int i = 0; i < mDaemons.length; i++) {
2124 if (mArguments[i] != null && SystemService.isStopped(mDaemons[i])) {
2125 return;
Jeff Sharkey899223b2012-08-04 15:24:58 -07002126 }
2127 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07002128 }
2129 }
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002130 }
Chia-chi Yehff3bdca2011-05-23 17:26:46 -07002131}