blob: 2fda08e2a57592cb55b4a4bd727fbc0538003447 [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;
Chad Brubakerc2865192013-07-10 14:46:23 -0700175 private VpnConfig mConfig;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400176 private NetworkAgent mNetworkAgent;
177 private final Looper mLooper;
178 private final NetworkCapabilities mNetworkCapabilities;
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000179 private final SystemServices mSystemServices;
Chad Brubakerc2865192013-07-10 14:46:23 -0700180
Robin Lee4d03abc2016-05-09 12:32:27 +0100181 /**
Robin Lee17e61832016-05-09 13:46:28 +0100182 * Whether to keep the connection active after rebooting, or upgrading or reinstalling. This
183 * only applies to {@link VpnService} connections.
184 */
185 private boolean mAlwaysOn = false;
186
187 /**
188 * Whether to disable traffic outside of this VPN even when the VPN is not connected. System
189 * apps can still bypass by choosing explicit networks. Has no effect if {@link mAlwaysOn} is
190 * not set.
191 */
192 private boolean mLockdown = false;
193
194 /**
Robin Lee17e61832016-05-09 13:46:28 +0100195 * List of UIDs for which networking should be blocked until VPN is ready, during brief periods
196 * when VPN is not running. For example, during system startup or after a crash.
197 * @see mLockdown
198 */
199 @GuardedBy("this")
200 private Set<UidRange> mBlockedUsers = new ArraySet<>();
201
Chalard Jeandd59ece2017-12-20 13:23:32 +0900202 // Handle of the user initiating VPN.
Paul Jensen0784eea2014-08-19 16:00:24 -0400203 private final int mUserHandle;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700204
Chalard Jeandd59ece2017-12-20 13:23:32 +0900205 // Listen to package removal and change events (update/uninstall) for this user
Robin Lee812800c2016-05-13 15:38:08 +0100206 private final BroadcastReceiver mPackageIntentReceiver = new BroadcastReceiver() {
207 @Override
208 public void onReceive(Context context, Intent intent) {
209 final Uri data = intent.getData();
210 final String packageName = data == null ? null : data.getSchemeSpecificPart();
211 if (packageName == null) {
212 return;
213 }
214
215 synchronized (Vpn.this) {
Chalard Jeandd59ece2017-12-20 13:23:32 +0900216 // Avoid race where always-on package has been unset
Robin Lee812800c2016-05-13 15:38:08 +0100217 if (!packageName.equals(getAlwaysOnPackage())) {
218 return;
219 }
220
221 final String action = intent.getAction();
Chalard Jeandd59ece2017-12-20 13:23:32 +0900222 Log.i(TAG, "Received broadcast " + action + " for always-on VPN package "
223 + packageName + " in user " + mUserHandle);
Robin Lee812800c2016-05-13 15:38:08 +0100224
225 switch(action) {
226 case Intent.ACTION_PACKAGE_REPLACED:
227 // Start vpn after app upgrade
228 startAlwaysOnVpn();
229 break;
230 case Intent.ACTION_PACKAGE_REMOVED:
231 final boolean isPackageRemoved = !intent.getBooleanExtra(
232 Intent.EXTRA_REPLACING, false);
233 if (isPackageRemoved) {
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000234 setAlwaysOnPackage(null, false);
Robin Lee812800c2016-05-13 15:38:08 +0100235 }
236 break;
237 }
238 }
239 }
240 };
241
242 private boolean mIsPackageIntentReceiverRegistered = false;
243
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400244 public Vpn(Looper looper, Context context, INetworkManagementService netService,
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000245 @UserIdInt int userHandle) {
246 this(looper, context, netService, userHandle, new SystemServices(context));
247 }
248
249 @VisibleForTesting
250 protected Vpn(Looper looper, Context context, INetworkManagementService netService,
251 int userHandle, SystemServices systemServices) {
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700252 mContext = context;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400253 mNetd = netService;
Paul Jensen0784eea2014-08-19 16:00:24 -0400254 mUserHandle = userHandle;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400255 mLooper = looper;
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000256 mSystemServices = systemServices;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400257
258 mPackage = VpnConfig.LEGACY_VPN;
Paul Jensen0784eea2014-08-19 16:00:24 -0400259 mOwnerUID = getAppUid(mPackage, mUserHandle);
Jeff Sharkey899223b2012-08-04 15:24:58 -0700260
261 try {
262 netService.registerObserver(mObserver);
263 } catch (RemoteException e) {
264 Log.wtf(TAG, "Problem registering observer", e);
265 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400266
Chalard Jeandd59ece2017-12-20 13:23:32 +0900267 mNetworkInfo = new NetworkInfo(ConnectivityManager.TYPE_VPN, 0 /* subtype */, NETWORKTYPE,
268 "" /* subtypeName */);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400269 mNetworkCapabilities = new NetworkCapabilities();
270 mNetworkCapabilities.addTransportType(NetworkCapabilities.TRANSPORT_VPN);
271 mNetworkCapabilities.removeCapability(NetworkCapabilities.NET_CAPABILITY_NOT_VPN);
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600272 updateCapabilities();
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000273
274 loadAlwaysOnPackage();
Jeff Sharkey899223b2012-08-04 15:24:58 -0700275 }
276
Jeff Sharkey57666932013-04-30 17:01:57 -0700277 /**
Chalard Jeandd59ece2017-12-20 13:23:32 +0900278 * Set whether this object is responsible for watching for {@link NetworkInfo}
Jeff Sharkey57666932013-04-30 17:01:57 -0700279 * teardown. When {@code false}, teardown is handled externally by someone
280 * else.
281 */
282 public void setEnableTeardown(boolean enableTeardown) {
283 mEnableTeardown = enableTeardown;
284 }
285
Jeff Sharkey899223b2012-08-04 15:24:58 -0700286 /**
287 * Update current state, dispaching event to listeners.
288 */
Tony Mak1a405fe2016-06-30 11:19:20 +0100289 @VisibleForTesting
290 protected void updateState(DetailedState detailedState, String reason) {
Jeff Sharkey899223b2012-08-04 15:24:58 -0700291 if (LOGD) Log.d(TAG, "setting state=" + detailedState + ", reason=" + reason);
292 mNetworkInfo.setDetailedState(detailedState, reason, null);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400293 if (mNetworkAgent != null) {
294 mNetworkAgent.sendNetworkInfo(mNetworkInfo);
295 }
Tony Mak1a405fe2016-06-30 11:19:20 +0100296 updateAlwaysOnNotification(detailedState);
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700297 }
298
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600299 public void updateCapabilities() {
300 final Network[] underlyingNetworks = (mConfig != null) ? mConfig.underlyingNetworks : null;
301 updateCapabilities(mContext.getSystemService(ConnectivityManager.class), underlyingNetworks,
302 mNetworkCapabilities);
303
304 if (mNetworkAgent != null) {
305 mNetworkAgent.sendNetworkCapabilities(mNetworkCapabilities);
306 }
307 }
308
309 @VisibleForTesting
310 public static void updateCapabilities(ConnectivityManager cm, Network[] underlyingNetworks,
311 NetworkCapabilities caps) {
312 int[] transportTypes = new int[] { NetworkCapabilities.TRANSPORT_VPN };
313 int downKbps = NetworkCapabilities.LINK_BANDWIDTH_UNSPECIFIED;
314 int upKbps = NetworkCapabilities.LINK_BANDWIDTH_UNSPECIFIED;
315 boolean metered = false;
316 boolean roaming = false;
Jeff Sharkey9b2a10f2018-01-17 13:27:03 +0900317 boolean congested = false;
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600318
319 if (ArrayUtils.isEmpty(underlyingNetworks)) {
320 // No idea what the underlying networks are; assume sane defaults
321 metered = true;
322 roaming = false;
Jeff Sharkey9b2a10f2018-01-17 13:27:03 +0900323 congested = false;
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600324 } else {
325 for (Network underlying : underlyingNetworks) {
326 final NetworkCapabilities underlyingCaps = cm.getNetworkCapabilities(underlying);
Jeff Sharkey4f5e6262018-01-02 11:46:32 -0700327 if (underlyingCaps == null) continue;
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 }
343
344 caps.setTransportTypes(transportTypes);
345 caps.setLinkDownstreamBandwidthKbps(downKbps);
346 caps.setLinkUpstreamBandwidthKbps(upKbps);
Jeff Sharkey9b2a10f2018-01-17 13:27:03 +0900347 caps.setCapability(NET_CAPABILITY_NOT_METERED, !metered);
348 caps.setCapability(NET_CAPABILITY_NOT_ROAMING, !roaming);
349 caps.setCapability(NET_CAPABILITY_NOT_CONGESTED, !congested);
Jeff Sharkey72f9c422017-10-27 17:22:59 -0600350 }
351
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700352 /**
Robin Leec3736bc2017-03-10 16:19:54 +0000353 * Chooses whether to force all connections to go though VPN.
354 *
355 * Used to enable/disable legacy VPN lockdown.
356 *
357 * This uses the same ip rule mechanism as {@link #setAlwaysOnPackage(String, boolean)};
358 * previous settings from calling that function will be replaced and saved with the
359 * always-on state.
360 *
361 * @param lockdown whether to prevent all traffic outside of a VPN.
362 */
363 public synchronized void setLockdown(boolean lockdown) {
364 enforceControlPermissionOrInternalCaller();
365
366 setVpnForcedLocked(lockdown);
367 mLockdown = lockdown;
368
369 // Update app lockdown setting if it changed. Legacy VPN lockdown status is controlled by
370 // LockdownVpnTracker.isEnabled() which keeps track of its own state.
371 if (mAlwaysOn) {
372 saveAlwaysOnPackage();
373 }
374 }
375
376 /**
Charles Hea0a87e82017-05-15 17:07:18 +0100377 * Checks if a VPN app supports always-on mode.
378 *
379 * In order to support the always-on feature, an app has to
380 * <ul>
381 * <li>target {@link VERSION_CODES#N API 24} or above, and
Charles He5da5ae32017-08-15 15:30:22 +0100382 * <li>not opt out through the {@link VpnService#SERVICE_META_DATA_SUPPORTS_ALWAYS_ON}
383 * meta-data field.
Charles Hea0a87e82017-05-15 17:07:18 +0100384 * </ul>
385 *
386 * @param packageName the canonical package name of the VPN app
387 * @return {@code true} if and only if the VPN app exists and supports always-on mode
388 */
389 public boolean isAlwaysOnPackageSupported(String packageName) {
390 enforceSettingsPermission();
391
392 if (packageName == null) {
393 return false;
394 }
395
396 PackageManager pm = mContext.getPackageManager();
397 ApplicationInfo appInfo = null;
398 try {
399 appInfo = pm.getApplicationInfoAsUser(packageName, 0 /*flags*/, mUserHandle);
400 } catch (NameNotFoundException unused) {
401 Log.w(TAG, "Can't find \"" + packageName + "\" when checking always-on support");
402 }
403 if (appInfo == null || appInfo.targetSdkVersion < VERSION_CODES.N) {
404 return false;
405 }
406
407 final Intent intent = new Intent(VpnConfig.SERVICE_INTERFACE);
408 intent.setPackage(packageName);
409 List<ResolveInfo> services =
410 pm.queryIntentServicesAsUser(intent, PackageManager.GET_META_DATA, mUserHandle);
411 if (services == null || services.size() == 0) {
412 return false;
413 }
414
415 for (ResolveInfo rInfo : services) {
416 final Bundle metaData = rInfo.serviceInfo.metaData;
Charles He5da5ae32017-08-15 15:30:22 +0100417 if (metaData != null &&
418 !metaData.getBoolean(VpnService.SERVICE_META_DATA_SUPPORTS_ALWAYS_ON, true)) {
Charles Hea0a87e82017-05-15 17:07:18 +0100419 return false;
420 }
421 }
422
423 return true;
424 }
425
426 /**
Robin Lee244ce8e2016-01-05 18:03:46 +0000427 * Configures an always-on VPN connection through a specific application.
428 * This connection is automatically granted and persisted after a reboot.
429 *
430 * <p>The designated package should exist and declare a {@link VpnService} in its
431 * manifest guarded by {@link android.Manifest.permission.BIND_VPN_SERVICE},
432 * otherwise the call will fail.
433 *
Charles Hea0a87e82017-05-15 17:07:18 +0100434 * <p>Note that this method does not check if the VPN app supports always-on mode. The check is
435 * delayed to {@link #startAlwaysOnVpn()}, which is always called immediately after this
436 * method in {@link android.net.IConnectivityManager#setAlwaysOnVpnPackage}.
437 *
Robin Lee17e61832016-05-09 13:46:28 +0100438 * @param packageName the package to designate as always-on VPN supplier.
439 * @param lockdown whether to prevent traffic outside of a VPN, for example while connecting.
Robin Lee9ff1a582016-06-10 16:41:10 +0100440 * @return {@code true} if the package has been set as always-on, {@code false} otherwise.
Robin Lee244ce8e2016-01-05 18:03:46 +0000441 */
Robin Lee17e61832016-05-09 13:46:28 +0100442 public synchronized boolean setAlwaysOnPackage(String packageName, boolean lockdown) {
Robin Lee244ce8e2016-01-05 18:03:46 +0000443 enforceControlPermissionOrInternalCaller();
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000444
445 if (setAlwaysOnPackageInternal(packageName, lockdown)) {
446 saveAlwaysOnPackage();
447 return true;
448 }
449 return false;
450 }
451
452 /**
453 * Configures an always-on VPN connection through a specific application, the same as
454 * {@link #setAlwaysOnPackage}.
455 *
456 * Does not perform permission checks. Does not persist any of the changes to storage.
457 *
458 * @param packageName the package to designate as always-on VPN supplier.
459 * @param lockdown whether to prevent traffic outside of a VPN, for example while connecting.
460 * @return {@code true} if the package has been set as always-on, {@code false} otherwise.
461 */
462 @GuardedBy("this")
463 private boolean setAlwaysOnPackageInternal(String packageName, boolean lockdown) {
Robin Lee9ff1a582016-06-10 16:41:10 +0100464 if (VpnConfig.LEGACY_VPN.equals(packageName)) {
465 Log.w(TAG, "Not setting legacy VPN \"" + packageName + "\" as always-on.");
466 return false;
467 }
Robin Lee244ce8e2016-01-05 18:03:46 +0000468
Robin Lee244ce8e2016-01-05 18:03:46 +0000469 if (packageName != null) {
Robin Lee9ff1a582016-06-10 16:41:10 +0100470 // Pre-authorize new always-on VPN package.
Robin Lee244ce8e2016-01-05 18:03:46 +0000471 if (!setPackageAuthorization(packageName, true)) {
472 return false;
473 }
Robin Lee9ff1a582016-06-10 16:41:10 +0100474 mAlwaysOn = true;
475 } else {
476 packageName = VpnConfig.LEGACY_VPN;
477 mAlwaysOn = false;
Robin Lee244ce8e2016-01-05 18:03:46 +0000478 }
479
Robin Lee17e61832016-05-09 13:46:28 +0100480 mLockdown = (mAlwaysOn && lockdown);
Tony Mak1a405fe2016-06-30 11:19:20 +0100481 if (isCurrentPreparedPackage(packageName)) {
482 updateAlwaysOnNotification(mNetworkInfo.getDetailedState());
483 } else {
484 // Prepare this app. The notification will update as a side-effect of updateState().
Robin Lee9ff1a582016-06-10 16:41:10 +0100485 prepareInternal(packageName);
486 }
Robin Lee812800c2016-05-13 15:38:08 +0100487 maybeRegisterPackageChangeReceiverLocked(packageName);
Robin Lee17e61832016-05-09 13:46:28 +0100488 setVpnForcedLocked(mLockdown);
Robin Lee244ce8e2016-01-05 18:03:46 +0000489 return true;
490 }
491
Robin Lee9ff1a582016-06-10 16:41:10 +0100492 private static boolean isNullOrLegacyVpn(String packageName) {
493 return packageName == null || VpnConfig.LEGACY_VPN.equals(packageName);
494 }
495
Robin Lee812800c2016-05-13 15:38:08 +0100496 private void unregisterPackageChangeReceiverLocked() {
Robin Lee812800c2016-05-13 15:38:08 +0100497 if (mIsPackageIntentReceiverRegistered) {
498 mContext.unregisterReceiver(mPackageIntentReceiver);
499 mIsPackageIntentReceiverRegistered = false;
500 }
501 }
502
503 private void maybeRegisterPackageChangeReceiverLocked(String packageName) {
504 // Unregister IntentFilter listening for previous always-on package change
505 unregisterPackageChangeReceiverLocked();
506
Robin Lee9ff1a582016-06-10 16:41:10 +0100507 if (!isNullOrLegacyVpn(packageName)) {
Robin Lee812800c2016-05-13 15:38:08 +0100508 mIsPackageIntentReceiverRegistered = true;
509
510 IntentFilter intentFilter = new IntentFilter();
511 // Protected intent can only be sent by system. No permission required in register.
512 intentFilter.addAction(Intent.ACTION_PACKAGE_REPLACED);
513 intentFilter.addAction(Intent.ACTION_PACKAGE_REMOVED);
514 intentFilter.addDataScheme("package");
515 intentFilter.addDataSchemeSpecificPart(packageName, PatternMatcher.PATTERN_LITERAL);
516 mContext.registerReceiverAsUser(
517 mPackageIntentReceiver, UserHandle.of(mUserHandle), intentFilter, null, null);
518 }
519 }
520
Robin Lee244ce8e2016-01-05 18:03:46 +0000521 /**
522 * @return the package name of the VPN controller responsible for always-on VPN,
523 * or {@code null} if none is set or always-on VPN is controlled through
524 * lockdown instead.
525 * @hide
526 */
527 public synchronized String getAlwaysOnPackage() {
528 enforceControlPermissionOrInternalCaller();
Robin Lee17e61832016-05-09 13:46:28 +0100529 return (mAlwaysOn ? mPackage : null);
Robin Lee244ce8e2016-01-05 18:03:46 +0000530 }
531
532 /**
Robin Lee812800c2016-05-13 15:38:08 +0100533 * Save the always-on package and lockdown config into Settings.Secure
534 */
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000535 @GuardedBy("this")
536 private void saveAlwaysOnPackage() {
Robin Lee812800c2016-05-13 15:38:08 +0100537 final long token = Binder.clearCallingIdentity();
538 try {
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000539 mSystemServices.settingsSecurePutStringForUser(Settings.Secure.ALWAYS_ON_VPN_APP,
Robin Lee812800c2016-05-13 15:38:08 +0100540 getAlwaysOnPackage(), mUserHandle);
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000541 mSystemServices.settingsSecurePutIntForUser(Settings.Secure.ALWAYS_ON_VPN_LOCKDOWN,
Robin Leec3736bc2017-03-10 16:19:54 +0000542 (mAlwaysOn && mLockdown ? 1 : 0), mUserHandle);
Robin Lee812800c2016-05-13 15:38:08 +0100543 } finally {
544 Binder.restoreCallingIdentity(token);
545 }
546 }
547
548 /**
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000549 * Load the always-on package and lockdown config from Settings.Secure
Robin Lee812800c2016-05-13 15:38:08 +0100550 */
Robin Leeb8c2a2b2017-03-10 16:17:06 +0000551 @GuardedBy("this")
552 private void loadAlwaysOnPackage() {
553 final long token = Binder.clearCallingIdentity();
554 try {
555 final String alwaysOnPackage = mSystemServices.settingsSecureGetStringForUser(
556 Settings.Secure.ALWAYS_ON_VPN_APP, mUserHandle);
557 final boolean alwaysOnLockdown = mSystemServices.settingsSecureGetIntForUser(
558 Settings.Secure.ALWAYS_ON_VPN_LOCKDOWN, 0 /*default*/, mUserHandle) != 0;
559 setAlwaysOnPackageInternal(alwaysOnPackage, alwaysOnLockdown);
560 } finally {
561 Binder.restoreCallingIdentity(token);
Robin Lee812800c2016-05-13 15:38:08 +0100562 }
563 }
564
565 /**
566 * @return {@code true} if the service was started, the service was already connected, or there
567 * was no always-on VPN to start. {@code false} otherwise.
568 */
569 public boolean startAlwaysOnVpn() {
570 final String alwaysOnPackage;
571 synchronized (this) {
572 alwaysOnPackage = getAlwaysOnPackage();
573 // Skip if there is no service to start.
574 if (alwaysOnPackage == null) {
575 return true;
576 }
Charles Hea0a87e82017-05-15 17:07:18 +0100577 // Remove always-on VPN if it's not supported.
578 if (!isAlwaysOnPackageSupported(alwaysOnPackage)) {
579 setAlwaysOnPackage(null, false);
580 return false;
581 }
Robin Lee812800c2016-05-13 15:38:08 +0100582 // Skip if the service is already established. This isn't bulletproof: it's not bound
583 // until after establish(), so if it's mid-setup onStartCommand will be sent twice,
584 // which may restart the connection.
585 if (getNetworkInfo().isConnected()) {
586 return true;
587 }
588 }
589
Christopher Tatee0be7e82017-02-08 17:38:20 -0800590 // Tell the OS that background services in this app need to be allowed for
591 // a short time, so we can bootstrap the VPN service.
592 final long oldId = Binder.clearCallingIdentity();
Robin Lee812800c2016-05-13 15:38:08 +0100593 try {
Christopher Tatee0be7e82017-02-08 17:38:20 -0800594 DeviceIdleController.LocalService idleController =
595 LocalServices.getService(DeviceIdleController.LocalService.class);
596 idleController.addPowerSaveTempWhitelistApp(Process.myUid(), alwaysOnPackage,
Chalard Jeandd59ece2017-12-20 13:23:32 +0900597 VPN_LAUNCH_IDLE_WHITELIST_DURATION_MS, mUserHandle, false, "vpn");
Christopher Tatee0be7e82017-02-08 17:38:20 -0800598
599 // Start the VPN service declared in the app's manifest.
600 Intent serviceIntent = new Intent(VpnConfig.SERVICE_INTERFACE);
601 serviceIntent.setPackage(alwaysOnPackage);
602 try {
603 return mContext.startServiceAsUser(serviceIntent, UserHandle.of(mUserHandle)) != null;
604 } catch (RuntimeException e) {
605 Log.e(TAG, "VpnService " + serviceIntent + " failed to start", e);
606 return false;
607 }
608 } finally {
609 Binder.restoreCallingIdentity(oldId);
Robin Lee812800c2016-05-13 15:38:08 +0100610 }
611 }
612
613 /**
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700614 * Prepare for a VPN application. This method is designed to solve
615 * race conditions. It first compares the current prepared package
616 * with {@code oldPackage}. If they are the same, the prepared
617 * package is revoked and replaced with {@code newPackage}. If
618 * {@code oldPackage} is {@code null}, the comparison is omitted.
619 * If {@code newPackage} is the same package or {@code null}, the
620 * revocation is omitted. This method returns {@code true} if the
621 * operation is succeeded.
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700622 *
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700623 * Legacy VPN is handled specially since it is not a real package.
624 * It uses {@link VpnConfig#LEGACY_VPN} as its package name, and
625 * it can be revoked by itself.
626 *
Chalard Jeandd59ece2017-12-20 13:23:32 +0900627 * Note: when we added VPN pre-consent in
628 * https://android.googlesource.com/platform/frameworks/base/+/0554260
629 * the names oldPackage and newPackage became misleading, because when
630 * an app is pre-consented, we actually prepare oldPackage, not newPackage.
Victor Chang98a633a2016-05-27 17:30:49 +0100631 *
632 * Their meanings actually are:
633 *
634 * - oldPackage non-null, newPackage null: App calling VpnService#prepare().
635 * - oldPackage null, newPackage non-null: ConfirmDialog calling prepareVpn().
Robin Lee812800c2016-05-13 15:38:08 +0100636 * - oldPackage null, newPackage=LEGACY_VPN: Used internally to disconnect
Victor Chang98a633a2016-05-27 17:30:49 +0100637 * and revoke any current app VPN and re-prepare legacy vpn.
638 *
Robin Lee812800c2016-05-13 15:38:08 +0100639 * TODO: Rename the variables - or split this method into two - and end this confusion.
640 * TODO: b/29032008 Migrate code from prepare(oldPackage=non-null, newPackage=LEGACY_VPN)
641 * to prepare(oldPackage=null, newPackage=LEGACY_VPN)
Victor Chang98a633a2016-05-27 17:30:49 +0100642 *
643 * @param oldPackage The package name of the old VPN application
644 * @param newPackage The package name of the new VPN application
645 *
Chalard Jeandd59ece2017-12-20 13:23:32 +0900646 * @return true if the operation succeeded.
Chia-chi Yehe9107902011-07-02 01:48:50 -0700647 */
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700648 public synchronized boolean prepare(String oldPackage, String newPackage) {
Jeff Davidson0a775ce2015-04-27 15:02:48 -0700649 if (oldPackage != null) {
Victor Chang98a633a2016-05-27 17:30:49 +0100650 // Stop an existing always-on VPN from being dethroned by other apps.
Robin Lee812800c2016-05-13 15:38:08 +0100651 if (mAlwaysOn && !isCurrentPreparedPackage(oldPackage)) {
Victor Chang98a633a2016-05-27 17:30:49 +0100652 return false;
653 }
654
Chalard Jeandd59ece2017-12-20 13:23:32 +0900655 // Package is not the same or old package was reinstalled.
Victor Chang98a633a2016-05-27 17:30:49 +0100656 if (!isCurrentPreparedPackage(oldPackage)) {
Jeff Davidson0a775ce2015-04-27 15:02:48 -0700657 // The package doesn't match. We return false (to obtain user consent) unless the
658 // user has already consented to that VPN package.
659 if (!oldPackage.equals(VpnConfig.LEGACY_VPN) && isVpnUserPreConsented(oldPackage)) {
660 prepareInternal(oldPackage);
661 return true;
662 }
663 return false;
664 } else if (!oldPackage.equals(VpnConfig.LEGACY_VPN)
665 && !isVpnUserPreConsented(oldPackage)) {
666 // Currently prepared VPN is revoked, so unprepare it and return false.
667 prepareInternal(VpnConfig.LEGACY_VPN);
668 return false;
Jeff Davidson05542602014-08-11 14:07:27 -0700669 }
Chia-chi Yehe9107902011-07-02 01:48:50 -0700670 }
671
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700672 // Return true if we do not need to revoke.
Jeff Davidsonbe085872014-10-24 10:35:53 -0700673 if (newPackage == null || (!newPackage.equals(VpnConfig.LEGACY_VPN) &&
Victor Chang98a633a2016-05-27 17:30:49 +0100674 isCurrentPreparedPackage(newPackage))) {
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700675 return true;
676 }
677
Robin Lee1b1bcd72016-02-12 18:11:30 +0000678 // Check that the caller is authorized.
Chia-chi Yehdadc8572012-06-08 13:05:58 -0700679 enforceControlPermission();
Chia-chi Yehe9107902011-07-02 01:48:50 -0700680
Victor Chang98a633a2016-05-27 17:30:49 +0100681 // Stop an existing always-on VPN from being dethroned by other apps.
Robin Lee812800c2016-05-13 15:38:08 +0100682 if (mAlwaysOn && !isCurrentPreparedPackage(newPackage)) {
Victor Chang98a633a2016-05-27 17:30:49 +0100683 return false;
684 }
685
Jeff Davidson11008a72014-11-20 13:12:46 -0800686 prepareInternal(newPackage);
687 return true;
688 }
Chia-chi Yehe9107902011-07-02 01:48:50 -0700689
Victor Chang98a633a2016-05-27 17:30:49 +0100690 private boolean isCurrentPreparedPackage(String packageName) {
691 // We can't just check that packageName matches mPackage, because if the app was uninstalled
692 // and reinstalled it will no longer be prepared. Instead check the UID.
693 return getAppUid(packageName, mUserHandle) == mOwnerUID;
694 }
695
Jeff Davidson11008a72014-11-20 13:12:46 -0800696 /** Prepare the VPN for the given package. Does not perform permission checks. */
697 private void prepareInternal(String newPackage) {
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400698 long token = Binder.clearCallingIdentity();
699 try {
Jeff Davidson11008a72014-11-20 13:12:46 -0800700 // Reset the interface.
701 if (mInterface != null) {
702 mStatusIntent = null;
703 agentDisconnect();
704 jniReset(mInterface);
705 mInterface = null;
Chalard Jeanecacd5e2017-12-27 14:23:31 +0900706 mNetworkCapabilities.setUids(null);
Jeff Davidson11008a72014-11-20 13:12:46 -0800707 }
708
709 // Revoke the connection or stop LegacyVpnRunner.
710 if (mConnection != null) {
711 try {
712 mConnection.mService.transact(IBinder.LAST_CALL_TRANSACTION,
713 Parcel.obtain(), null, IBinder.FLAG_ONEWAY);
714 } catch (Exception e) {
715 // ignore
716 }
717 mContext.unbindService(mConnection);
718 mConnection = null;
719 } else if (mLegacyVpnRunner != null) {
720 mLegacyVpnRunner.exit();
721 mLegacyVpnRunner = null;
722 }
723
724 try {
725 mNetd.denyProtect(mOwnerUID);
726 } catch (Exception e) {
727 Log.wtf(TAG, "Failed to disallow UID " + mOwnerUID + " to call protect() " + e);
728 }
729
730 Log.i(TAG, "Switched from " + mPackage + " to " + newPackage);
731 mPackage = newPackage;
732 mOwnerUID = getAppUid(newPackage, mUserHandle);
733 try {
734 mNetd.allowProtect(mOwnerUID);
735 } catch (Exception e) {
736 Log.wtf(TAG, "Failed to allow UID " + mOwnerUID + " to call protect() " + e);
737 }
738 mConfig = null;
739
740 updateState(DetailedState.IDLE, "prepare");
Robin Leec3736bc2017-03-10 16:19:54 +0000741 setVpnForcedLocked(mLockdown);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400742 } finally {
743 Binder.restoreCallingIdentity(token);
744 }
Chia-chi Yehe9107902011-07-02 01:48:50 -0700745 }
746
Jeff Davidson05542602014-08-11 14:07:27 -0700747 /**
Robin Lee3b3dd942015-05-12 18:14:58 +0100748 * Set whether a package has the ability to launch VPNs without user intervention.
Jeff Davidson05542602014-08-11 14:07:27 -0700749 */
Robin Lee244ce8e2016-01-05 18:03:46 +0000750 public boolean setPackageAuthorization(String packageName, boolean authorized) {
Jeff Davidson05542602014-08-11 14:07:27 -0700751 // Check if the caller is authorized.
Robin Lee244ce8e2016-01-05 18:03:46 +0000752 enforceControlPermissionOrInternalCaller();
Jeff Davidson05542602014-08-11 14:07:27 -0700753
Robin Lee3b3dd942015-05-12 18:14:58 +0100754 int uid = getAppUid(packageName, mUserHandle);
755 if (uid == -1 || VpnConfig.LEGACY_VPN.equals(packageName)) {
756 // Authorization for nonexistent packages (or fake ones) can't be updated.
Robin Lee244ce8e2016-01-05 18:03:46 +0000757 return false;
Jeff Davidson05542602014-08-11 14:07:27 -0700758 }
759
760 long token = Binder.clearCallingIdentity();
761 try {
762 AppOpsManager appOps =
763 (AppOpsManager) mContext.getSystemService(Context.APP_OPS_SERVICE);
Robin Lee3b3dd942015-05-12 18:14:58 +0100764 appOps.setMode(AppOpsManager.OP_ACTIVATE_VPN, uid, packageName,
Jeff Davidson05542602014-08-11 14:07:27 -0700765 authorized ? AppOpsManager.MODE_ALLOWED : AppOpsManager.MODE_IGNORED);
Robin Lee244ce8e2016-01-05 18:03:46 +0000766 return true;
Jeff Davidson05542602014-08-11 14:07:27 -0700767 } catch (Exception e) {
Robin Lee3b3dd942015-05-12 18:14:58 +0100768 Log.wtf(TAG, "Failed to set app ops for package " + packageName + ", uid " + uid, e);
Jeff Davidson05542602014-08-11 14:07:27 -0700769 } finally {
770 Binder.restoreCallingIdentity(token);
771 }
Robin Lee244ce8e2016-01-05 18:03:46 +0000772 return false;
Jeff Davidson05542602014-08-11 14:07:27 -0700773 }
774
775 private boolean isVpnUserPreConsented(String packageName) {
776 AppOpsManager appOps =
777 (AppOpsManager) mContext.getSystemService(Context.APP_OPS_SERVICE);
778
779 // Verify that the caller matches the given package and has permission to activate VPNs.
780 return appOps.noteOpNoThrow(AppOpsManager.OP_ACTIVATE_VPN, Binder.getCallingUid(),
781 packageName) == AppOpsManager.MODE_ALLOWED;
782 }
783
Paul Jensen0784eea2014-08-19 16:00:24 -0400784 private int getAppUid(String app, int userHandle) {
Jeff Davidson05542602014-08-11 14:07:27 -0700785 if (VpnConfig.LEGACY_VPN.equals(app)) {
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400786 return Process.myUid();
Chia-chi Yehfcc1b412011-08-03 15:39:59 -0700787 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400788 PackageManager pm = mContext.getPackageManager();
789 int result;
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700790 try {
Jeff Sharkeye06b4d12016-01-06 14:51:50 -0700791 result = pm.getPackageUidAsUser(app, userHandle);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400792 } catch (NameNotFoundException e) {
793 result = -1;
794 }
795 return result;
796 }
797
798 public NetworkInfo getNetworkInfo() {
799 return mNetworkInfo;
800 }
801
Paul Jensen31a94f42015-02-13 14:18:39 -0500802 public int getNetId() {
803 return mNetworkAgent != null ? mNetworkAgent.netId : NETID_UNSET;
804 }
805
Lorenzo Colitti60446162014-09-20 00:14:31 +0900806 private LinkProperties makeLinkProperties() {
807 boolean allowIPv4 = mConfig.allowIPv4;
808 boolean allowIPv6 = mConfig.allowIPv6;
809
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400810 LinkProperties lp = new LinkProperties();
Lorenzo Colitti60446162014-09-20 00:14:31 +0900811
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400812 lp.setInterfaceName(mInterface);
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700813
Lorenzo Colitti60446162014-09-20 00:14:31 +0900814 if (mConfig.addresses != null) {
815 for (LinkAddress address : mConfig.addresses) {
816 lp.addLinkAddress(address);
817 allowIPv4 |= address.getAddress() instanceof Inet4Address;
818 allowIPv6 |= address.getAddress() instanceof Inet6Address;
819 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400820 }
Lorenzo Colitti60446162014-09-20 00:14:31 +0900821
822 if (mConfig.routes != null) {
823 for (RouteInfo route : mConfig.routes) {
824 lp.addRoute(route);
825 InetAddress address = route.getDestination().getAddress();
826 allowIPv4 |= address instanceof Inet4Address;
827 allowIPv6 |= address instanceof Inet6Address;
828 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400829 }
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700830
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400831 if (mConfig.dnsServers != null) {
832 for (String dnsServer : mConfig.dnsServers) {
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700833 InetAddress address = InetAddress.parseNumericAddress(dnsServer);
834 lp.addDnsServer(address);
Lorenzo Colitti60446162014-09-20 00:14:31 +0900835 allowIPv4 |= address instanceof Inet4Address;
836 allowIPv6 |= address instanceof Inet6Address;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400837 }
838 }
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700839
Lorenzo Colitti60446162014-09-20 00:14:31 +0900840 if (!allowIPv4) {
841 lp.addRoute(new RouteInfo(new IpPrefix(Inet4Address.ANY, 0), RTN_UNREACHABLE));
842 }
843 if (!allowIPv6) {
844 lp.addRoute(new RouteInfo(new IpPrefix(Inet6Address.ANY, 0), RTN_UNREACHABLE));
845 }
846
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400847 // Concatenate search domains into a string.
848 StringBuilder buffer = new StringBuilder();
849 if (mConfig.searchDomains != null) {
850 for (String domain : mConfig.searchDomains) {
851 buffer.append(domain).append(' ');
852 }
853 }
854 lp.setDomains(buffer.toString().trim());
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700855
Lorenzo Colitti60446162014-09-20 00:14:31 +0900856 // TODO: Stop setting the MTU in jniCreate and set it here.
857
858 return lp;
859 }
860
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900861 /**
862 * Analyzes the passed LinkedProperties to figure out whether it routes to most of the IP space.
863 *
864 * This returns true if the passed LinkedProperties contains routes to either most of the IPv4
865 * space or to most of the IPv6 address space, where "most" is defined by the value of the
866 * MOST_IPV{4,6}_ADDRESSES_COUNT constants : if more than this number of addresses are matched
867 * by any of the routes, then it's decided that most of the space is routed.
868 * @hide
869 */
870 @VisibleForTesting
871 static boolean providesRoutesToMostDestinations(LinkProperties lp) {
Chalard Jeane0d26f62018-03-29 14:10:44 +0900872 final List<RouteInfo> routes = lp.getAllRoutes();
873 if (routes.size() > MAX_ROUTES_TO_EVALUATE) return true;
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900874 final Comparator<IpPrefix> prefixLengthComparator = IpPrefix.lengthComparator();
875 TreeSet<IpPrefix> ipv4Prefixes = new TreeSet<>(prefixLengthComparator);
876 TreeSet<IpPrefix> ipv6Prefixes = new TreeSet<>(prefixLengthComparator);
Chalard Jeane0d26f62018-03-29 14:10:44 +0900877 for (final RouteInfo route : routes) {
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900878 IpPrefix destination = route.getDestination();
879 if (destination.isIPv4()) {
880 ipv4Prefixes.add(destination);
881 } else {
882 ipv6Prefixes.add(destination);
883 }
884 }
885 if (NetworkUtils.routedIPv4AddressCount(ipv4Prefixes) > MOST_IPV4_ADDRESSES_COUNT) {
886 return true;
887 }
888 return NetworkUtils.routedIPv6AddressCount(ipv6Prefixes)
889 .compareTo(MOST_IPV6_ADDRESSES_COUNT) >= 0;
890 }
891
Lorenzo Colitti60446162014-09-20 00:14:31 +0900892 private void agentConnect() {
893 LinkProperties lp = makeLinkProperties();
894
Chalard Jeanadbf1d02018-02-26 11:52:46 +0900895 if (providesRoutesToMostDestinations(lp)) {
Lorenzo Colitti60446162014-09-20 00:14:31 +0900896 mNetworkCapabilities.addCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET);
897 } else {
898 mNetworkCapabilities.removeCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET);
899 }
900
Robin Lee323f29d2016-05-04 16:38:06 +0100901 mNetworkInfo.setDetailedState(DetailedState.CONNECTING, null, null);
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700902
Sreeram Ramachandran8cd33ed2014-07-23 15:23:15 -0700903 NetworkMisc networkMisc = new NetworkMisc();
Robin Lee17e61832016-05-09 13:46:28 +0100904 networkMisc.allowBypass = mConfig.allowBypass && !mLockdown;
Sreeram Ramachandran42065ac2014-07-27 00:37:35 -0700905
Chalard Jeanf474fc32018-01-17 15:10:05 +0900906 mNetworkCapabilities.setEstablishingVpnAppUid(Binder.getCallingUid());
Chalard Jeanecacd5e2017-12-27 14:23:31 +0900907 mNetworkCapabilities.setUids(createUserAndRestrictedProfilesRanges(mUserHandle,
908 mConfig.allowedApplications, mConfig.disallowedApplications));
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400909 long token = Binder.clearCallingIdentity();
910 try {
Chalard Jeandd59ece2017-12-20 13:23:32 +0900911 mNetworkAgent = new NetworkAgent(mLooper, mContext, NETWORKTYPE /* logtag */,
Chalard Jeandda156a2018-01-10 21:19:32 +0900912 mNetworkInfo, mNetworkCapabilities, lp,
913 ConnectivityConstants.VPN_DEFAULT_SCORE, networkMisc) {
Jeff Davidson05542602014-08-11 14:07:27 -0700914 @Override
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400915 public void unwanted() {
916 // We are user controlled, not driven by NetworkRequest.
Jeff Davidson05542602014-08-11 14:07:27 -0700917 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400918 };
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700919 } finally {
920 Binder.restoreCallingIdentity(token);
921 }
Robin Lee323f29d2016-05-04 16:38:06 +0100922 mNetworkInfo.setIsAvailable(true);
923 updateState(DetailedState.CONNECTED, "agentConnect");
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400924 }
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700925
Fyodor Kupolov1c363152015-09-02 13:27:21 -0700926 private boolean canHaveRestrictedProfile(int userId) {
927 long token = Binder.clearCallingIdentity();
928 try {
929 return UserManager.get(mContext).canHaveRestrictedProfile(userId);
930 } finally {
931 Binder.restoreCallingIdentity(token);
932 }
933 }
934
Tony Mak1a405fe2016-06-30 11:19:20 +0100935 private void agentDisconnect(NetworkAgent networkAgent) {
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400936 if (networkAgent != null) {
Tony Mak1a405fe2016-06-30 11:19:20 +0100937 NetworkInfo networkInfo = new NetworkInfo(mNetworkInfo);
938 networkInfo.setIsAvailable(false);
939 networkInfo.setDetailedState(DetailedState.DISCONNECTED, null, null);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400940 networkAgent.sendNetworkInfo(networkInfo);
941 }
942 }
943
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400944 private void agentDisconnect() {
945 if (mNetworkInfo.isConnected()) {
Tony Mak1a405fe2016-06-30 11:19:20 +0100946 mNetworkInfo.setIsAvailable(false);
947 updateState(DetailedState.DISCONNECTED, "agentDisconnect");
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400948 mNetworkAgent = null;
949 }
Chia-chi Yehfcc1b412011-08-03 15:39:59 -0700950 }
951
952 /**
Chia-chi Yehe9107902011-07-02 01:48:50 -0700953 * Establish a VPN network and return the file descriptor of the VPN
954 * interface. This methods returns {@code null} if the application is
Chia-chi Yeh100155a2011-07-03 16:52:38 -0700955 * revoked or not prepared.
Chia-chi Yehe9107902011-07-02 01:48:50 -0700956 *
957 * @param config The parameters to configure the network.
958 * @return The file descriptor of the VPN interface.
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700959 */
Chia-chi Yeh04ba25c2011-06-15 17:07:27 -0700960 public synchronized ParcelFileDescriptor establish(VpnConfig config) {
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700961 // Check if the caller is already prepared.
Chad Brubakerc2865192013-07-10 14:46:23 -0700962 UserManager mgr = UserManager.get(mContext);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400963 if (Binder.getCallingUid() != mOwnerUID) {
Chia-chi Yeh7b0b8342011-06-17 14:34:11 -0700964 return null;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -0700965 }
Jeff Davidson0a775ce2015-04-27 15:02:48 -0700966 // Check to ensure consent hasn't been revoked since we were prepared.
967 if (!isVpnUserPreConsented(mPackage)) {
968 return null;
969 }
Chia-chi Yehfcc1b412011-08-03 15:39:59 -0700970 // Check if the service is properly declared.
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -0700971 Intent intent = new Intent(VpnConfig.SERVICE_INTERFACE);
972 intent.setClassName(mPackage, config.user);
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700973 long token = Binder.clearCallingIdentity();
974 try {
Chad Brubakerc2865192013-07-10 14:46:23 -0700975 // Restricted users are not allowed to create VPNs, they are tied to Owner
Paul Jensen0784eea2014-08-19 16:00:24 -0400976 UserInfo user = mgr.getUserInfo(mUserHandle);
Robin Lee628ae0d2016-05-20 14:53:48 +0100977 if (user.isRestricted()) {
Chad Brubakerc2865192013-07-10 14:46:23 -0700978 throw new SecurityException("Restricted users cannot establish VPNs");
979 }
980
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700981 ResolveInfo info = AppGlobals.getPackageManager().resolveService(intent,
Chalard Jeandd59ece2017-12-20 13:23:32 +0900982 null, 0, mUserHandle);
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700983 if (info == null) {
984 throw new SecurityException("Cannot find " + config.user);
985 }
986 if (!BIND_VPN_SERVICE.equals(info.serviceInfo.permission)) {
987 throw new SecurityException(config.user + " does not require " + BIND_VPN_SERVICE);
988 }
989 } catch (RemoteException e) {
Chalard Jeandd59ece2017-12-20 13:23:32 +0900990 throw new SecurityException("Cannot find " + config.user);
Chad Brubaker4ca19e82013-06-14 11:16:51 -0700991 } finally {
992 Binder.restoreCallingIdentity(token);
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -0700993 }
Chia-chi Yehfcc1b412011-08-03 15:39:59 -0700994
Chad Brubaker850eb672014-03-21 21:02:47 +0000995 // Save the old config in case we need to go back.
996 VpnConfig oldConfig = mConfig;
997 String oldInterface = mInterface;
998 Connection oldConnection = mConnection;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -0400999 NetworkAgent oldNetworkAgent = mNetworkAgent;
1000 mNetworkAgent = null;
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001001 Set<UidRange> oldUsers = mNetworkCapabilities.getUids();
Chad Brubaker850eb672014-03-21 21:02:47 +00001002
Chia-chi Yehe9107902011-07-02 01:48:50 -07001003 // Configure the interface. Abort if any of these steps fails.
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001004 ParcelFileDescriptor tun = ParcelFileDescriptor.adoptFd(jniCreate(config.mtu));
Chia-chi Yehff3bdca2011-05-23 17:26:46 -07001005 try {
Jeff Sharkey899223b2012-08-04 15:24:58 -07001006 updateState(DetailedState.CONNECTING, "establish");
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001007 String interfaze = jniGetName(tun.getFd());
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001008
Chad Brubakerc2865192013-07-10 14:46:23 -07001009 // TEMP use the old jni calls until there is support for netd address setting
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001010 StringBuilder builder = new StringBuilder();
1011 for (LinkAddress address : config.addresses) {
1012 builder.append(" " + address);
1013 }
1014 if (jniSetAddresses(interfaze, builder.toString()) < 1) {
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001015 throw new IllegalArgumentException("At least one address must be specified");
1016 }
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001017 Connection connection = new Connection();
Dianne Hackbornd69e4c12015-04-24 09:54:54 -07001018 if (!mContext.bindServiceAsUser(intent, connection,
1019 Context.BIND_AUTO_CREATE | Context.BIND_FOREGROUND_SERVICE,
1020 new UserHandle(mUserHandle))) {
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001021 throw new IllegalStateException("Cannot bind " + config.user);
1022 }
Chad Brubaker850eb672014-03-21 21:02:47 +00001023
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001024 mConnection = connection;
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001025 mInterface = interfaze;
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001026
1027 // Fill more values.
1028 config.user = mPackage;
1029 config.interfaze = mInterface;
Chad Brubakerc2865192013-07-10 14:46:23 -07001030 config.startTime = SystemClock.elapsedRealtime();
1031 mConfig = config;
Chad Brubaker850eb672014-03-21 21:02:47 +00001032
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001033 // Set up forwarding and DNS rules.
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001034 agentConnect();
Chad Brubaker850eb672014-03-21 21:02:47 +00001035
1036 if (oldConnection != null) {
1037 mContext.unbindService(oldConnection);
1038 }
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001039 // Remove the old tun's user forwarding rules
1040 // The new tun's user rules have already been added so they will take over
1041 // as rules are deleted. This prevents data leakage as the rules are moved over.
1042 agentDisconnect(oldNetworkAgent);
Chad Brubaker850eb672014-03-21 21:02:47 +00001043 if (oldInterface != null && !oldInterface.equals(interfaze)) {
Chad Brubaker850eb672014-03-21 21:02:47 +00001044 jniReset(oldInterface);
1045 }
Jeff Davidson6bbf39c2014-07-23 10:14:53 -07001046
1047 try {
1048 IoUtils.setBlocking(tun.getFileDescriptor(), config.blocking);
1049 } catch (IOException e) {
1050 throw new IllegalStateException(
1051 "Cannot set tunnel's fd as blocking=" + config.blocking, e);
1052 }
Chad Brubaker850eb672014-03-21 21:02:47 +00001053 } catch (RuntimeException e) {
Chad Brubaker850eb672014-03-21 21:02:47 +00001054 IoUtils.closeQuietly(tun);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001055 agentDisconnect();
Chad Brubaker850eb672014-03-21 21:02:47 +00001056 // restore old state
1057 mConfig = oldConfig;
1058 mConnection = oldConnection;
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001059 mNetworkCapabilities.setUids(oldUsers);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001060 mNetworkAgent = oldNetworkAgent;
Chad Brubaker850eb672014-03-21 21:02:47 +00001061 mInterface = oldInterface;
1062 throw e;
Chad Brubakerc2865192013-07-10 14:46:23 -07001063 }
Chad Brubaker850eb672014-03-21 21:02:47 +00001064 Log.i(TAG, "Established by " + config.user + " on " + mInterface);
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001065 return tun;
Chia-chi Yehff3bdca2011-05-23 17:26:46 -07001066 }
1067
Chad Brubakerc2865192013-07-10 14:46:23 -07001068 private boolean isRunningLocked() {
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001069 return mNetworkAgent != null && mInterface != null;
1070 }
1071
1072 // Returns true if the VPN has been established and the calling UID is its owner. Used to check
1073 // that a call to mutate VPN state is admissible.
1074 private boolean isCallerEstablishedOwnerLocked() {
1075 return isRunningLocked() && Binder.getCallingUid() == mOwnerUID;
Chad Brubakerc2865192013-07-10 14:46:23 -07001076 }
1077
Paul Jensen0784eea2014-08-19 16:00:24 -04001078 // Note: Return type guarantees results are deduped and sorted, which callers require.
1079 private SortedSet<Integer> getAppsUids(List<String> packageNames, int userHandle) {
1080 SortedSet<Integer> uids = new TreeSet<Integer>();
1081 for (String app : packageNames) {
1082 int uid = getAppUid(app, userHandle);
1083 if (uid != -1) uids.add(uid);
1084 }
1085 return uids;
1086 }
1087
Robin Lee4d03abc2016-05-09 12:32:27 +01001088 /**
1089 * Creates a {@link Set} of non-intersecting {@link UidRange} objects including all UIDs
1090 * associated with one user, and any restricted profiles attached to that user.
1091 *
1092 * <p>If one of {@param allowedApplications} or {@param disallowedApplications} is provided,
1093 * the UID ranges will match the app whitelist or blacklist specified there. Otherwise, all UIDs
1094 * in each user and profile will be included.
1095 *
1096 * @param userHandle The userId to create UID ranges for along with any of its restricted
1097 * profiles.
1098 * @param allowedApplications (optional) whitelist of applications to include.
1099 * @param disallowedApplications (optional) blacklist of applications to exclude.
1100 */
1101 @VisibleForTesting
1102 Set<UidRange> createUserAndRestrictedProfilesRanges(@UserIdInt int userHandle,
1103 @Nullable List<String> allowedApplications,
1104 @Nullable List<String> disallowedApplications) {
1105 final Set<UidRange> ranges = new ArraySet<>();
Robert Greenwalt69887e82013-09-24 11:05:57 -07001106
Robin Lee4d03abc2016-05-09 12:32:27 +01001107 // Assign the top-level user to the set of ranges
1108 addUserToRanges(ranges, userHandle, allowedApplications, disallowedApplications);
1109
1110 // If the user can have restricted profiles, assign all its restricted profiles too
1111 if (canHaveRestrictedProfile(userHandle)) {
1112 final long token = Binder.clearCallingIdentity();
1113 List<UserInfo> users;
1114 try {
Robin Lee17e61832016-05-09 13:46:28 +01001115 users = UserManager.get(mContext).getUsers(true);
Robin Lee4d03abc2016-05-09 12:32:27 +01001116 } finally {
1117 Binder.restoreCallingIdentity(token);
1118 }
1119 for (UserInfo user : users) {
1120 if (user.isRestricted() && (user.restrictedProfileParentId == userHandle)) {
1121 addUserToRanges(ranges, user.id, allowedApplications, disallowedApplications);
1122 }
1123 }
1124 }
1125 return ranges;
1126 }
1127
1128 /**
1129 * Updates a {@link Set} of non-intersecting {@link UidRange} objects to include all UIDs
1130 * associated with one user.
1131 *
1132 * <p>If one of {@param allowedApplications} or {@param disallowedApplications} is provided,
1133 * the UID ranges will match the app whitelist or blacklist specified there. Otherwise, all UIDs
1134 * in the user will be included.
1135 *
1136 * @param ranges {@link Set} of {@link UidRange}s to which to add.
1137 * @param userHandle The userId to add to {@param ranges}.
1138 * @param allowedApplications (optional) whitelist of applications to include.
1139 * @param disallowedApplications (optional) blacklist of applications to exclude.
1140 */
1141 @VisibleForTesting
1142 void addUserToRanges(@NonNull Set<UidRange> ranges, @UserIdInt int userHandle,
1143 @Nullable List<String> allowedApplications,
1144 @Nullable List<String> disallowedApplications) {
1145 if (allowedApplications != null) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001146 // Add ranges covering all UIDs for allowedApplications.
1147 int start = -1, stop = -1;
Robin Lee4d03abc2016-05-09 12:32:27 +01001148 for (int uid : getAppsUids(allowedApplications, userHandle)) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001149 if (start == -1) {
1150 start = uid;
1151 } else if (uid != stop + 1) {
Robin Lee4d03abc2016-05-09 12:32:27 +01001152 ranges.add(new UidRange(start, stop));
Paul Jensen0784eea2014-08-19 16:00:24 -04001153 start = uid;
1154 }
1155 stop = uid;
1156 }
Robin Lee4d03abc2016-05-09 12:32:27 +01001157 if (start != -1) ranges.add(new UidRange(start, stop));
1158 } else if (disallowedApplications != null) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001159 // Add all ranges for user skipping UIDs for disallowedApplications.
1160 final UidRange userRange = UidRange.createForUser(userHandle);
1161 int start = userRange.start;
Robin Lee4d03abc2016-05-09 12:32:27 +01001162 for (int uid : getAppsUids(disallowedApplications, userHandle)) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001163 if (uid == start) {
1164 start++;
1165 } else {
Robin Lee4d03abc2016-05-09 12:32:27 +01001166 ranges.add(new UidRange(start, uid - 1));
Paul Jensen0784eea2014-08-19 16:00:24 -04001167 start = uid + 1;
1168 }
1169 }
Robin Lee4d03abc2016-05-09 12:32:27 +01001170 if (start <= userRange.stop) ranges.add(new UidRange(start, userRange.stop));
Paul Jensen0784eea2014-08-19 16:00:24 -04001171 } else {
1172 // Add all UIDs for the user.
Robin Lee4d03abc2016-05-09 12:32:27 +01001173 ranges.add(UidRange.createForUser(userHandle));
Paul Jensen0784eea2014-08-19 16:00:24 -04001174 }
Chad Brubakerc2865192013-07-10 14:46:23 -07001175 }
1176
Paul Jensen0784eea2014-08-19 16:00:24 -04001177 // Returns the subset of the full list of active UID ranges the VPN applies to (mVpnUsers) that
1178 // apply to userHandle.
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001179 static private List<UidRange> uidRangesForUser(int userHandle, Set<UidRange> existingRanges) {
1180 // UidRange#createForUser returns the entire range of UIDs available to a macro-user.
1181 // This is something like 0-99999 ; {@see UserHandle#PER_USER_RANGE}
Paul Jensen0784eea2014-08-19 16:00:24 -04001182 final UidRange userRange = UidRange.createForUser(userHandle);
1183 final List<UidRange> ranges = new ArrayList<UidRange>();
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001184 for (UidRange range : existingRanges) {
Robin Lee4d03abc2016-05-09 12:32:27 +01001185 if (userRange.containsRange(range)) {
Paul Jensen0784eea2014-08-19 16:00:24 -04001186 ranges.add(range);
1187 }
1188 }
1189 return ranges;
1190 }
1191
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001192 public void onUserAdded(int userHandle) {
1193 // If the user is restricted tie them to the parent user's VPN
1194 UserInfo user = UserManager.get(mContext).getUserInfo(userHandle);
Robin Lee17e61832016-05-09 13:46:28 +01001195 if (user.isRestricted() && user.restrictedProfileParentId == mUserHandle) {
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001196 synchronized(Vpn.this) {
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001197 final Set<UidRange> existingRanges = mNetworkCapabilities.getUids();
1198 if (existingRanges != null) {
Robin Lee17e61832016-05-09 13:46:28 +01001199 try {
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001200 addUserToRanges(existingRanges, userHandle, mConfig.allowedApplications,
Robin Lee17e61832016-05-09 13:46:28 +01001201 mConfig.disallowedApplications);
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001202 mNetworkCapabilities.setUids(existingRanges);
Chalard Jeanf213ca12018-01-16 18:43:05 +09001203 updateCapabilities();
Robin Lee17e61832016-05-09 13:46:28 +01001204 } catch (Exception e) {
1205 Log.wtf(TAG, "Failed to add restricted user to owner", e);
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001206 }
Robin Lee17e61832016-05-09 13:46:28 +01001207 }
Robin Leec3736bc2017-03-10 16:19:54 +00001208 setVpnForcedLocked(mLockdown);
Chad Brubakerc2865192013-07-10 14:46:23 -07001209 }
1210 }
1211 }
1212
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001213 public void onUserRemoved(int userHandle) {
Chad Brubakerc2865192013-07-10 14:46:23 -07001214 // clean up if restricted
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001215 UserInfo user = UserManager.get(mContext).getUserInfo(userHandle);
Robin Lee17e61832016-05-09 13:46:28 +01001216 if (user.isRestricted() && user.restrictedProfileParentId == mUserHandle) {
Fyodor Kupolov1c363152015-09-02 13:27:21 -07001217 synchronized(Vpn.this) {
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001218 final Set<UidRange> existingRanges = mNetworkCapabilities.getUids();
1219 if (existingRanges != null) {
Robin Lee17e61832016-05-09 13:46:28 +01001220 try {
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001221 final List<UidRange> removedRanges =
1222 uidRangesForUser(userHandle, existingRanges);
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001223 existingRanges.removeAll(removedRanges);
1224 mNetworkCapabilities.setUids(existingRanges);
Chalard Jeanf213ca12018-01-16 18:43:05 +09001225 updateCapabilities();
Robin Lee17e61832016-05-09 13:46:28 +01001226 } catch (Exception e) {
1227 Log.wtf(TAG, "Failed to remove restricted user to owner", e);
1228 }
1229 }
Robin Leec3736bc2017-03-10 16:19:54 +00001230 setVpnForcedLocked(mLockdown);
Chad Brubakerc2865192013-07-10 14:46:23 -07001231 }
1232 }
1233 }
1234
Chad Brubakerbf6ff2c2013-07-16 18:59:12 -07001235 /**
Robin Lee17e61832016-05-09 13:46:28 +01001236 * Called when the user associated with this VPN has just been stopped.
1237 */
1238 public synchronized void onUserStopped() {
1239 // Switch off networking lockdown (if it was enabled)
Robin Leec3736bc2017-03-10 16:19:54 +00001240 setLockdown(false);
Robin Lee17e61832016-05-09 13:46:28 +01001241 mAlwaysOn = false;
1242
Robin Lee812800c2016-05-13 15:38:08 +01001243 unregisterPackageChangeReceiverLocked();
Robin Lee17e61832016-05-09 13:46:28 +01001244 // Quit any active connections
1245 agentDisconnect();
1246 }
1247
1248 /**
1249 * Restrict network access from all UIDs affected by this {@link Vpn}, apart from the VPN
1250 * service app itself, to only sockets that have had {@code protect()} called on them. All
1251 * non-VPN traffic is blocked via a {@code PROHIBIT} response from the kernel.
1252 *
1253 * The exception for the VPN UID isn't technically necessary -- setup should use protected
1254 * sockets -- but in practice it saves apps that don't protect their sockets from breaking.
1255 *
1256 * Calling multiple times with {@param enforce} = {@code true} will recreate the set of UIDs to
1257 * block every time, and if anything has changed update using {@link #setAllowOnlyVpnForUids}.
1258 *
1259 * @param enforce {@code true} to require that all traffic under the jurisdiction of this
1260 * {@link Vpn} goes through a VPN connection or is blocked until one is
1261 * available, {@code false} to lift the requirement.
1262 *
1263 * @see #mBlockedUsers
1264 */
1265 @GuardedBy("this")
1266 private void setVpnForcedLocked(boolean enforce) {
Robin Leec3736bc2017-03-10 16:19:54 +00001267 final List<String> exemptedPackages =
1268 isNullOrLegacyVpn(mPackage) ? null : Collections.singletonList(mPackage);
Robin Lee17e61832016-05-09 13:46:28 +01001269 final Set<UidRange> removedRanges = new ArraySet<>(mBlockedUsers);
Robin Leec3736bc2017-03-10 16:19:54 +00001270
1271 Set<UidRange> addedRanges = Collections.emptySet();
Robin Lee17e61832016-05-09 13:46:28 +01001272 if (enforce) {
Robin Leec3736bc2017-03-10 16:19:54 +00001273 addedRanges = createUserAndRestrictedProfilesRanges(mUserHandle,
Robin Lee17e61832016-05-09 13:46:28 +01001274 /* allowedApplications */ null,
Robin Leec3736bc2017-03-10 16:19:54 +00001275 /* disallowedApplications */ exemptedPackages);
Robin Lee17e61832016-05-09 13:46:28 +01001276
1277 removedRanges.removeAll(addedRanges);
1278 addedRanges.removeAll(mBlockedUsers);
Robin Lee17e61832016-05-09 13:46:28 +01001279 }
Robin Leec3736bc2017-03-10 16:19:54 +00001280
1281 setAllowOnlyVpnForUids(false, removedRanges);
1282 setAllowOnlyVpnForUids(true, addedRanges);
Robin Lee17e61832016-05-09 13:46:28 +01001283 }
1284
1285 /**
1286 * Either add or remove a list of {@link UidRange}s to the list of UIDs that are only allowed
1287 * to make connections through sockets that have had {@code protect()} called on them.
1288 *
1289 * @param enforce {@code true} to add to the blacklist, {@code false} to remove.
1290 * @param ranges {@link Collection} of {@link UidRange}s to add (if {@param enforce} is
1291 * {@code true}) or to remove.
1292 * @return {@code true} if all of the UIDs were added/removed. {@code false} otherwise,
1293 * including added ranges that already existed or removed ones that didn't.
1294 */
1295 @GuardedBy("this")
1296 private boolean setAllowOnlyVpnForUids(boolean enforce, Collection<UidRange> ranges) {
1297 if (ranges.size() == 0) {
1298 return true;
1299 }
1300 final UidRange[] rangesArray = ranges.toArray(new UidRange[ranges.size()]);
1301 try {
1302 mNetd.setAllowOnlyVpnForUids(enforce, rangesArray);
1303 } catch (RemoteException | RuntimeException e) {
1304 Log.e(TAG, "Updating blocked=" + enforce
1305 + " for UIDs " + Arrays.toString(ranges.toArray()) + " failed", e);
1306 return false;
1307 }
1308 if (enforce) {
1309 mBlockedUsers.addAll(ranges);
1310 } else {
1311 mBlockedUsers.removeAll(ranges);
1312 }
1313 return true;
1314 }
1315
1316 /**
Chad Brubakerbf6ff2c2013-07-16 18:59:12 -07001317 * Return the configuration of the currently running VPN.
1318 */
1319 public VpnConfig getVpnConfig() {
1320 enforceControlPermission();
1321 return mConfig;
1322 }
1323
Jeff Sharkey899223b2012-08-04 15:24:58 -07001324 @Deprecated
1325 public synchronized void interfaceStatusChanged(String iface, boolean up) {
1326 try {
1327 mObserver.interfaceStatusChanged(iface, up);
1328 } catch (RemoteException e) {
1329 // ignored; target is local
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001330 }
1331 }
1332
Jeff Sharkey899223b2012-08-04 15:24:58 -07001333 private INetworkManagementEventObserver mObserver = new BaseNetworkObserver() {
1334 @Override
1335 public void interfaceStatusChanged(String interfaze, boolean up) {
1336 synchronized (Vpn.this) {
1337 if (!up && mLegacyVpnRunner != null) {
1338 mLegacyVpnRunner.check(interfaze);
1339 }
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001340 }
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001341 }
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001342
Jeff Sharkey899223b2012-08-04 15:24:58 -07001343 @Override
1344 public void interfaceRemoved(String interfaze) {
1345 synchronized (Vpn.this) {
1346 if (interfaze.equals(mInterface) && jniCheck(interfaze) == 0) {
Jeff Davidson90b1b9f2014-08-22 13:05:43 -07001347 mStatusIntent = null;
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001348 mNetworkCapabilities.setUids(null);
Paul Jensenc4c72312014-12-08 14:04:51 -05001349 mConfig = null;
Jeff Sharkey899223b2012-08-04 15:24:58 -07001350 mInterface = null;
1351 if (mConnection != null) {
1352 mContext.unbindService(mConnection);
1353 mConnection = null;
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001354 agentDisconnect();
Jeff Sharkey899223b2012-08-04 15:24:58 -07001355 } else if (mLegacyVpnRunner != null) {
1356 mLegacyVpnRunner.exit();
1357 mLegacyVpnRunner = null;
1358 }
1359 }
1360 }
1361 }
1362 };
Haoyu Baidb3c8672012-06-20 14:29:57 -07001363
Chia-chi Yehdadc8572012-06-08 13:05:58 -07001364 private void enforceControlPermission() {
Jeff Davidsonbc19c182014-11-11 13:20:01 -08001365 mContext.enforceCallingPermission(Manifest.permission.CONTROL_VPN, "Unauthorized Caller");
Chia-chi Yehdadc8572012-06-08 13:05:58 -07001366 }
1367
Robin Lee244ce8e2016-01-05 18:03:46 +00001368 private void enforceControlPermissionOrInternalCaller() {
Chalard Jeandd59ece2017-12-20 13:23:32 +09001369 // Require the caller to be either an application with CONTROL_VPN permission or a process
Robin Lee244ce8e2016-01-05 18:03:46 +00001370 // in the system server.
1371 mContext.enforceCallingOrSelfPermission(Manifest.permission.CONTROL_VPN,
1372 "Unauthorized Caller");
1373 }
1374
Charles Hea0a87e82017-05-15 17:07:18 +01001375 private void enforceSettingsPermission() {
1376 mContext.enforceCallingOrSelfPermission(Manifest.permission.NETWORK_SETTINGS,
1377 "Unauthorized Caller");
1378 }
1379
Chia-chi Yeh199ed6e2011-08-03 17:38:49 -07001380 private class Connection implements ServiceConnection {
1381 private IBinder mService;
1382
1383 @Override
1384 public void onServiceConnected(ComponentName name, IBinder service) {
1385 mService = service;
1386 }
1387
1388 @Override
1389 public void onServiceDisconnected(ComponentName name) {
1390 mService = null;
1391 }
1392 }
1393
Jeff Davidson90b1b9f2014-08-22 13:05:43 -07001394 private void prepareStatusIntent() {
1395 final long token = Binder.clearCallingIdentity();
1396 try {
1397 mStatusIntent = VpnConfig.getIntentForStatusPanel(mContext);
1398 } finally {
1399 Binder.restoreCallingIdentity(token);
1400 }
1401 }
1402
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001403 public synchronized boolean addAddress(String address, int prefixLength) {
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001404 if (!isCallerEstablishedOwnerLocked()) {
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001405 return false;
1406 }
1407 boolean success = jniAddAddress(mInterface, address, prefixLength);
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001408 mNetworkAgent.sendLinkProperties(makeLinkProperties());
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001409 return success;
1410 }
1411
1412 public synchronized boolean removeAddress(String address, int prefixLength) {
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001413 if (!isCallerEstablishedOwnerLocked()) {
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001414 return false;
1415 }
1416 boolean success = jniDelAddress(mInterface, address, prefixLength);
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001417 mNetworkAgent.sendLinkProperties(makeLinkProperties());
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001418 return success;
1419 }
1420
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001421 public synchronized boolean setUnderlyingNetworks(Network[] networks) {
1422 if (!isCallerEstablishedOwnerLocked()) {
1423 return false;
1424 }
1425 if (networks == null) {
1426 mConfig.underlyingNetworks = null;
1427 } else {
1428 mConfig.underlyingNetworks = new Network[networks.length];
1429 for (int i = 0; i < networks.length; ++i) {
1430 if (networks[i] == null) {
1431 mConfig.underlyingNetworks[i] = null;
1432 } else {
1433 mConfig.underlyingNetworks[i] = new Network(networks[i].netId);
1434 }
1435 }
1436 }
Jeff Sharkey72f9c422017-10-27 17:22:59 -06001437 updateCapabilities();
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001438 return true;
1439 }
1440
1441 public synchronized Network[] getUnderlyingNetworks() {
1442 if (!isRunningLocked()) {
1443 return null;
1444 }
1445 return mConfig.underlyingNetworks;
1446 }
1447
Wenchao Tongf5ea3402015-03-04 13:26:38 -08001448 /**
Chalard Jeandd59ece2017-12-20 13:23:32 +09001449 * This method should only be called by ConnectivityService because it doesn't
Wenchao Tongf5ea3402015-03-04 13:26:38 -08001450 * have enough data to fill VpnInfo.primaryUnderlyingIface field.
1451 */
1452 public synchronized VpnInfo getVpnInfo() {
1453 if (!isRunningLocked()) {
1454 return null;
1455 }
1456
1457 VpnInfo info = new VpnInfo();
1458 info.ownerUid = mOwnerUID;
1459 info.vpnIface = mInterface;
1460 return info;
1461 }
1462
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001463 public synchronized boolean appliesToUid(int uid) {
1464 if (!isRunningLocked()) {
1465 return false;
1466 }
Chalard Jeanecacd5e2017-12-27 14:23:31 +09001467 return mNetworkCapabilities.appliesToUid(uid);
Sreeram Ramachandranc2c0bea2014-11-11 16:09:21 -08001468 }
1469
Robin Lee17e61832016-05-09 13:46:28 +01001470 /**
Robin Leeebbcb542016-05-24 16:35:10 +01001471 * @return {@code true} if {@param uid} is blocked by an always-on VPN.
1472 * A UID is blocked if it's included in one of the mBlockedUsers ranges and the VPN is
1473 * not connected, or if the VPN is connected but does not apply to the UID.
Robin Lee17e61832016-05-09 13:46:28 +01001474 *
1475 * @see #mBlockedUsers
1476 */
1477 public synchronized boolean isBlockingUid(int uid) {
Robin Leeebbcb542016-05-24 16:35:10 +01001478 if (!mLockdown) {
1479 return false;
Robin Lee17e61832016-05-09 13:46:28 +01001480 }
Robin Leeebbcb542016-05-24 16:35:10 +01001481
1482 if (mNetworkInfo.isConnected()) {
1483 return !appliesToUid(uid);
1484 } else {
1485 for (UidRange uidRange : mBlockedUsers) {
1486 if (uidRange.contains(uid)) {
1487 return true;
1488 }
1489 }
1490 return false;
1491 }
Robin Lee17e61832016-05-09 13:46:28 +01001492 }
1493
Tony Mak1a405fe2016-06-30 11:19:20 +01001494 private void updateAlwaysOnNotification(DetailedState networkState) {
1495 final boolean visible = (mAlwaysOn && networkState != DetailedState.CONNECTED);
Tony Mak1a405fe2016-06-30 11:19:20 +01001496
Tony Mak1a405fe2016-06-30 11:19:20 +01001497 final UserHandle user = UserHandle.of(mUserHandle);
1498 final long token = Binder.clearCallingIdentity();
1499 try {
1500 final NotificationManager notificationManager = NotificationManager.from(mContext);
1501 if (!visible) {
Charles He15297a62017-04-08 22:03:42 +01001502 notificationManager.cancelAsUser(TAG, SystemMessage.NOTE_VPN_DISCONNECTED, user);
Tony Mak1a405fe2016-06-30 11:19:20 +01001503 return;
1504 }
Charles Heab6f2f62017-07-12 15:30:00 +01001505 final Intent intent = new Intent();
1506 intent.setComponent(ComponentName.unflattenFromString(mContext.getString(
1507 R.string.config_customVpnAlwaysOnDisconnectedDialogComponent)));
1508 intent.putExtra("lockdown", mLockdown);
1509 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
Robin Leeb8c2a2b2017-03-10 16:17:06 +00001510 final PendingIntent configIntent = mSystemServices.pendingIntentGetActivityAsUser(
1511 intent, PendingIntent.FLAG_IMMUTABLE | PendingIntent.FLAG_UPDATE_CURRENT, user);
Geoffrey Pitschaf759c52017-02-15 09:35:38 -05001512 final Notification.Builder builder =
1513 new Notification.Builder(mContext, SystemNotificationChannels.VPN)
1514 .setSmallIcon(R.drawable.vpn_connected)
1515 .setContentTitle(mContext.getString(R.string.vpn_lockdown_disconnected))
1516 .setContentText(mContext.getString(R.string.vpn_lockdown_config))
1517 .setContentIntent(configIntent)
1518 .setCategory(Notification.CATEGORY_SYSTEM)
1519 .setVisibility(Notification.VISIBILITY_PUBLIC)
1520 .setOngoing(true)
1521 .setColor(mContext.getColor(R.color.system_notification_accent_color));
Chris Wren282cfef2017-03-27 15:01:44 -04001522 notificationManager.notifyAsUser(TAG, SystemMessage.NOTE_VPN_DISCONNECTED,
1523 builder.build(), user);
Tony Mak1a405fe2016-06-30 11:19:20 +01001524 } finally {
1525 Binder.restoreCallingIdentity(token);
1526 }
1527 }
1528
Robin Leeb8c2a2b2017-03-10 16:17:06 +00001529 /**
1530 * Facade for system service calls that change, or depend on, state outside of
1531 * {@link ConnectivityService} and have hard-to-mock interfaces.
1532 *
1533 * @see com.android.server.connectivity.VpnTest
1534 */
1535 @VisibleForTesting
1536 public static class SystemServices {
1537 private final Context mContext;
1538
1539 public SystemServices(@NonNull Context context) {
1540 mContext = context;
1541 }
1542
1543 /**
1544 * @see PendingIntent#getActivityAsUser()
1545 */
1546 public PendingIntent pendingIntentGetActivityAsUser(
1547 Intent intent, int flags, UserHandle user) {
1548 return PendingIntent.getActivityAsUser(mContext, 0 /*request*/, intent, flags,
1549 null /*options*/, user);
1550 }
1551
1552 /**
1553 * @see Settings.Secure#putStringForUser
1554 */
1555 public void settingsSecurePutStringForUser(String key, String value, int userId) {
1556 Settings.Secure.putStringForUser(mContext.getContentResolver(), key, value, userId);
1557 }
1558
1559 /**
1560 * @see Settings.Secure#putIntForUser
1561 */
1562 public void settingsSecurePutIntForUser(String key, int value, int userId) {
1563 Settings.Secure.putIntForUser(mContext.getContentResolver(), key, value, userId);
1564 }
1565
1566 /**
1567 * @see Settings.Secure#getStringForUser
1568 */
1569 public String settingsSecureGetStringForUser(String key, int userId) {
1570 return Settings.Secure.getStringForUser(mContext.getContentResolver(), key, userId);
1571 }
1572
1573 /**
1574 * @see Settings.Secure#getIntForUser
1575 */
1576 public int settingsSecureGetIntForUser(String key, int def, int userId) {
1577 return Settings.Secure.getIntForUser(mContext.getContentResolver(), key, def, userId);
1578 }
1579 }
1580
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001581 private native int jniCreate(int mtu);
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001582 private native String jniGetName(int tun);
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001583 private native int jniSetAddresses(String interfaze, String addresses);
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07001584 private native void jniReset(String interfaze);
1585 private native int jniCheck(String interfaze);
Sreeram Ramachandranf4e0c0c2014-07-27 14:18:26 -07001586 private native boolean jniAddAddress(String interfaze, String address, int prefixLen);
1587 private native boolean jniDelAddress(String interfaze, String address, int prefixLen);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001588
Lorenzo Colitti41fb98c2013-06-28 17:26:21 +09001589 private static RouteInfo findIPv4DefaultRoute(LinkProperties prop) {
1590 for (RouteInfo route : prop.getAllRoutes()) {
Jeff Sharkey82f85212012-08-24 11:17:25 -07001591 // Currently legacy VPN only works on IPv4.
1592 if (route.isDefaultRoute() && route.getGateway() instanceof Inet4Address) {
Lorenzo Colitti41fb98c2013-06-28 17:26:21 +09001593 return route;
Jeff Sharkey82f85212012-08-24 11:17:25 -07001594 }
1595 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07001596
Lorenzo Colitti41fb98c2013-06-28 17:26:21 +09001597 throw new IllegalStateException("Unable to find IPv4 default gateway");
Jeff Sharkey82f85212012-08-24 11:17:25 -07001598 }
1599
1600 /**
1601 * Start legacy VPN, controlling native daemons as needed. Creates a
1602 * secondary thread to perform connection work, returning quickly.
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001603 *
1604 * Should only be called to respond to Binder requests as this enforces caller permission. Use
1605 * {@link #startLegacyVpnPrivileged(VpnProfile, KeyStore, LinkProperties)} to skip the
1606 * permission check only when the caller is trusted (or the call is initiated by the system).
Jeff Sharkey82f85212012-08-24 11:17:25 -07001607 */
1608 public void startLegacyVpn(VpnProfile profile, KeyStore keyStore, LinkProperties egress) {
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001609 enforceControlPermission();
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001610 long token = Binder.clearCallingIdentity();
1611 try {
1612 startLegacyVpnPrivileged(profile, keyStore, egress);
1613 } finally {
1614 Binder.restoreCallingIdentity(token);
1615 }
1616 }
1617
1618 /**
1619 * Like {@link #startLegacyVpn(VpnProfile, KeyStore, LinkProperties)}, but does not check
1620 * permissions under the assumption that the caller is the system.
1621 *
1622 * Callers are responsible for checking permissions if needed.
1623 */
1624 public void startLegacyVpnPrivileged(VpnProfile profile, KeyStore keyStore,
1625 LinkProperties egress) {
Julia Reynoldsf5116d02014-07-01 11:10:41 -04001626 UserManager mgr = UserManager.get(mContext);
Paul Jensen0784eea2014-08-19 16:00:24 -04001627 UserInfo user = mgr.getUserInfo(mUserHandle);
Nicolas Prevot95778ff2015-01-06 15:43:05 +00001628 if (user.isRestricted() || mgr.hasUserRestriction(UserManager.DISALLOW_CONFIG_VPN,
1629 new UserHandle(mUserHandle))) {
Julia Reynoldsf5116d02014-07-01 11:10:41 -04001630 throw new SecurityException("Restricted users cannot establish VPNs");
1631 }
Jeff Sharkey82f85212012-08-24 11:17:25 -07001632
Lorenzo Colitti41fb98c2013-06-28 17:26:21 +09001633 final RouteInfo ipv4DefaultRoute = findIPv4DefaultRoute(egress);
1634 final String gateway = ipv4DefaultRoute.getGateway().getHostAddress();
1635 final String iface = ipv4DefaultRoute.getInterface();
Jeff Sharkey82f85212012-08-24 11:17:25 -07001636
1637 // Load certificates.
1638 String privateKey = "";
1639 String userCert = "";
1640 String caCert = "";
1641 String serverCert = "";
1642 if (!profile.ipsecUserCert.isEmpty()) {
1643 privateKey = Credentials.USER_PRIVATE_KEY + profile.ipsecUserCert;
1644 byte[] value = keyStore.get(Credentials.USER_CERTIFICATE + profile.ipsecUserCert);
Elliott Hughesd396a442013-06-28 16:24:48 -07001645 userCert = (value == null) ? null : new String(value, StandardCharsets.UTF_8);
Jeff Sharkey82f85212012-08-24 11:17:25 -07001646 }
1647 if (!profile.ipsecCaCert.isEmpty()) {
1648 byte[] value = keyStore.get(Credentials.CA_CERTIFICATE + profile.ipsecCaCert);
Elliott Hughesd396a442013-06-28 16:24:48 -07001649 caCert = (value == null) ? null : new String(value, StandardCharsets.UTF_8);
Jeff Sharkey82f85212012-08-24 11:17:25 -07001650 }
1651 if (!profile.ipsecServerCert.isEmpty()) {
1652 byte[] value = keyStore.get(Credentials.USER_CERTIFICATE + profile.ipsecServerCert);
Elliott Hughesd396a442013-06-28 16:24:48 -07001653 serverCert = (value == null) ? null : new String(value, StandardCharsets.UTF_8);
Jeff Sharkey82f85212012-08-24 11:17:25 -07001654 }
1655 if (privateKey == null || userCert == null || caCert == null || serverCert == null) {
1656 throw new IllegalStateException("Cannot load credentials");
1657 }
1658
1659 // Prepare arguments for racoon.
1660 String[] racoon = null;
1661 switch (profile.type) {
1662 case VpnProfile.TYPE_L2TP_IPSEC_PSK:
1663 racoon = new String[] {
1664 iface, profile.server, "udppsk", profile.ipsecIdentifier,
1665 profile.ipsecSecret, "1701",
1666 };
1667 break;
1668 case VpnProfile.TYPE_L2TP_IPSEC_RSA:
1669 racoon = new String[] {
1670 iface, profile.server, "udprsa", privateKey, userCert,
1671 caCert, serverCert, "1701",
1672 };
1673 break;
1674 case VpnProfile.TYPE_IPSEC_XAUTH_PSK:
1675 racoon = new String[] {
1676 iface, profile.server, "xauthpsk", profile.ipsecIdentifier,
1677 profile.ipsecSecret, profile.username, profile.password, "", gateway,
1678 };
1679 break;
1680 case VpnProfile.TYPE_IPSEC_XAUTH_RSA:
1681 racoon = new String[] {
1682 iface, profile.server, "xauthrsa", privateKey, userCert,
1683 caCert, serverCert, profile.username, profile.password, "", gateway,
1684 };
1685 break;
1686 case VpnProfile.TYPE_IPSEC_HYBRID_RSA:
1687 racoon = new String[] {
1688 iface, profile.server, "hybridrsa",
1689 caCert, serverCert, profile.username, profile.password, "", gateway,
1690 };
1691 break;
1692 }
1693
1694 // Prepare arguments for mtpd.
1695 String[] mtpd = null;
1696 switch (profile.type) {
1697 case VpnProfile.TYPE_PPTP:
1698 mtpd = new String[] {
1699 iface, "pptp", profile.server, "1723",
1700 "name", profile.username, "password", profile.password,
1701 "linkname", "vpn", "refuse-eap", "nodefaultroute",
1702 "usepeerdns", "idle", "1800", "mtu", "1400", "mru", "1400",
1703 (profile.mppe ? "+mppe" : "nomppe"),
1704 };
1705 break;
1706 case VpnProfile.TYPE_L2TP_IPSEC_PSK:
1707 case VpnProfile.TYPE_L2TP_IPSEC_RSA:
1708 mtpd = new String[] {
1709 iface, "l2tp", profile.server, "1701", profile.l2tpSecret,
1710 "name", profile.username, "password", profile.password,
1711 "linkname", "vpn", "refuse-eap", "nodefaultroute",
1712 "usepeerdns", "idle", "1800", "mtu", "1400", "mru", "1400",
1713 };
1714 break;
1715 }
1716
1717 VpnConfig config = new VpnConfig();
Jeff Sharkey899223b2012-08-04 15:24:58 -07001718 config.legacy = true;
Jeff Sharkey82f85212012-08-24 11:17:25 -07001719 config.user = profile.key;
1720 config.interfaze = iface;
1721 config.session = profile.name;
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001722
1723 config.addLegacyRoutes(profile.routes);
Jeff Sharkey82f85212012-08-24 11:17:25 -07001724 if (!profile.dnsServers.isEmpty()) {
1725 config.dnsServers = Arrays.asList(profile.dnsServers.split(" +"));
1726 }
1727 if (!profile.searchDomains.isEmpty()) {
1728 config.searchDomains = Arrays.asList(profile.searchDomains.split(" +"));
1729 }
Jeff Sharkey82f85212012-08-24 11:17:25 -07001730 startLegacyVpn(config, racoon, mtpd);
1731 }
1732
1733 private synchronized void startLegacyVpn(VpnConfig config, String[] racoon, String[] mtpd) {
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001734 stopLegacyVpnPrivileged();
Jeff Sharkey899223b2012-08-04 15:24:58 -07001735
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001736 // Prepare for the new request.
1737 prepareInternal(VpnConfig.LEGACY_VPN);
Jeff Sharkey899223b2012-08-04 15:24:58 -07001738 updateState(DetailedState.CONNECTING, "startLegacyVpn");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001739
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001740 // Start a new LegacyVpnRunner and we are done!
Chia-chi Yeh100155a2011-07-03 16:52:38 -07001741 mLegacyVpnRunner = new LegacyVpnRunner(config, racoon, mtpd);
1742 mLegacyVpnRunner.start();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001743 }
1744
Jeff Davidsonb21298a2015-02-10 10:02:11 -08001745 /** Stop legacy VPN. Permissions must be checked by callers. */
1746 public synchronized void stopLegacyVpnPrivileged() {
Jeff Sharkey899223b2012-08-04 15:24:58 -07001747 if (mLegacyVpnRunner != null) {
1748 mLegacyVpnRunner.exit();
1749 mLegacyVpnRunner = null;
1750
1751 synchronized (LegacyVpnRunner.TAG) {
1752 // wait for old thread to completely finish before spinning up
1753 // new instance, otherwise state updates can be out of order.
1754 }
1755 }
1756 }
1757
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001758 /**
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001759 * Return the information of the current ongoing legacy VPN.
1760 */
1761 public synchronized LegacyVpnInfo getLegacyVpnInfo() {
Chia-chi Yehdadc8572012-06-08 13:05:58 -07001762 // Check if the caller is authorized.
1763 enforceControlPermission();
sj.cha08bbca02015-03-23 11:35:24 +09001764 return getLegacyVpnInfoPrivileged();
1765 }
1766
1767 /**
1768 * Return the information of the current ongoing legacy VPN.
1769 * Callers are responsible for checking permissions if needed.
1770 */
1771 public synchronized LegacyVpnInfo getLegacyVpnInfoPrivileged() {
Jeff Sharkey899223b2012-08-04 15:24:58 -07001772 if (mLegacyVpnRunner == null) return null;
1773
1774 final LegacyVpnInfo info = new LegacyVpnInfo();
Chad Brubakerc2865192013-07-10 14:46:23 -07001775 info.key = mConfig.user;
Jeff Sharkey899223b2012-08-04 15:24:58 -07001776 info.state = LegacyVpnInfo.stateFromNetworkInfo(mNetworkInfo);
Jeff Davidson90b1b9f2014-08-22 13:05:43 -07001777 if (mNetworkInfo.isConnected()) {
1778 info.intent = mStatusIntent;
1779 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07001780 return info;
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001781 }
1782
Jeff Sharkey69ddab42012-08-25 00:05:46 -07001783 public VpnConfig getLegacyVpnConfig() {
1784 if (mLegacyVpnRunner != null) {
Chad Brubakerc2865192013-07-10 14:46:23 -07001785 return mConfig;
Jeff Sharkey69ddab42012-08-25 00:05:46 -07001786 } else {
1787 return null;
1788 }
1789 }
1790
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001791 /**
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001792 * Bringing up a VPN connection takes time, and that is all this thread
1793 * does. Here we have plenty of time. The only thing we need to take
1794 * care of is responding to interruptions as soon as possible. Otherwise
Chalard Jeandd59ece2017-12-20 13:23:32 +09001795 * requests will pile up. This could be done in a Handler as a state
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001796 * machine, but it is much easier to read in the current form.
1797 */
1798 private class LegacyVpnRunner extends Thread {
1799 private static final String TAG = "LegacyVpnRunner";
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001800
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001801 private final String[] mDaemons;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001802 private final String[][] mArguments;
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001803 private final LocalSocket[] mSockets;
Robert Greenwalt53c04bd2012-10-12 17:02:45 -07001804 private final String mOuterInterface;
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001805 private final AtomicInteger mOuterConnection =
1806 new AtomicInteger(ConnectivityManager.TYPE_NONE);
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001807
Chalard Jeandd59ece2017-12-20 13:23:32 +09001808 private long mBringupStartTime = -1;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001809
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001810 /**
1811 * Watch for the outer connection (passing in the constructor) going away.
1812 */
1813 private final BroadcastReceiver mBroadcastReceiver = new BroadcastReceiver() {
1814 @Override
1815 public void onReceive(Context context, Intent intent) {
Jeff Sharkey57666932013-04-30 17:01:57 -07001816 if (!mEnableTeardown) return;
1817
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001818 if (intent.getAction().equals(ConnectivityManager.CONNECTIVITY_ACTION)) {
1819 if (intent.getIntExtra(ConnectivityManager.EXTRA_NETWORK_TYPE,
1820 ConnectivityManager.TYPE_NONE) == mOuterConnection.get()) {
1821 NetworkInfo info = (NetworkInfo)intent.getExtra(
1822 ConnectivityManager.EXTRA_NETWORK_INFO);
1823 if (info != null && !info.isConnectedOrConnecting()) {
1824 try {
1825 mObserver.interfaceStatusChanged(mOuterInterface, false);
1826 } catch (RemoteException e) {}
1827 }
1828 }
1829 }
1830 }
1831 };
1832
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001833 public LegacyVpnRunner(VpnConfig config, String[] racoon, String[] mtpd) {
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001834 super(TAG);
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001835 mConfig = config;
1836 mDaemons = new String[] {"racoon", "mtpd"};
Jeff Sharkey899223b2012-08-04 15:24:58 -07001837 // TODO: clear arguments from memory once launched
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001838 mArguments = new String[][] {racoon, mtpd};
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001839 mSockets = new LocalSocket[mDaemons.length];
Robert Greenwalt53c04bd2012-10-12 17:02:45 -07001840
1841 // This is the interface which VPN is running on,
1842 // mConfig.interfaze will change to point to OUR
1843 // internal interface soon. TODO - add inner/outer to mconfig
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001844 // TODO - we have a race - if the outer iface goes away/disconnects before we hit this
Chad Brubaker4ca19e82013-06-14 11:16:51 -07001845 // we will leave the VPN up. We should check that it's still there/connected after
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001846 // registering
Robert Greenwalt53c04bd2012-10-12 17:02:45 -07001847 mOuterInterface = mConfig.interfaze;
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001848
Paul Jensene75b9e32015-04-06 11:54:53 -04001849 if (!TextUtils.isEmpty(mOuterInterface)) {
1850 final ConnectivityManager cm = ConnectivityManager.from(mContext);
1851 for (Network network : cm.getAllNetworks()) {
1852 final LinkProperties lp = cm.getLinkProperties(network);
Lorenzo Colitti1b60d112015-07-02 13:03:03 +09001853 if (lp != null && lp.getAllInterfaceNames().contains(mOuterInterface)) {
Paul Jensene75b9e32015-04-06 11:54:53 -04001854 final NetworkInfo networkInfo = cm.getNetworkInfo(network);
1855 if (networkInfo != null) mOuterConnection.set(networkInfo.getType());
1856 }
1857 }
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001858 }
1859
1860 IntentFilter filter = new IntentFilter();
1861 filter.addAction(ConnectivityManager.CONNECTIVITY_ACTION);
1862 mContext.registerReceiver(mBroadcastReceiver, filter);
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001863 }
1864
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001865 public void check(String interfaze) {
Robert Greenwalt53c04bd2012-10-12 17:02:45 -07001866 if (interfaze.equals(mOuterInterface)) {
Chia-chi Yehaa1727f2011-07-14 18:55:33 -07001867 Log.i(TAG, "Legacy VPN is going down with " + interfaze);
1868 exit();
1869 }
1870 }
1871
Chia-chi Yeh41d16852011-07-01 02:12:06 -07001872 public void exit() {
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001873 // We assume that everything is reset after stopping the daemons.
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001874 interrupt();
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001875 agentDisconnect();
Robert Greenwalt1b0ca9d2013-04-22 11:13:02 -07001876 try {
1877 mContext.unregisterReceiver(mBroadcastReceiver);
1878 } catch (IllegalArgumentException e) {}
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001879 }
1880
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001881 @Override
1882 public void run() {
1883 // Wait for the previous thread since it has been interrupted.
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001884 Log.v(TAG, "Waiting");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001885 synchronized (TAG) {
Chia-chi Yeh2e467642011-07-04 03:23:12 -07001886 Log.v(TAG, "Executing");
Hisanobu Watanabe047454c2016-06-07 19:55:41 +09001887 try {
Chalard Jeandd59ece2017-12-20 13:23:32 +09001888 bringup();
1889 waitForDaemonsToStop();
Hisanobu Watanabe047454c2016-06-07 19:55:41 +09001890 interrupted(); // Clear interrupt flag if execute called exit.
1891 } catch (InterruptedException e) {
1892 } finally {
1893 for (LocalSocket socket : mSockets) {
1894 IoUtils.closeQuietly(socket);
1895 }
1896 // This sleep is necessary for racoon to successfully complete sending delete
1897 // message to server.
1898 try {
1899 Thread.sleep(50);
1900 } catch (InterruptedException e) {
1901 }
1902 for (String daemon : mDaemons) {
1903 SystemService.stop(daemon);
1904 }
1905 }
1906 agentDisconnect();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001907 }
1908 }
1909
Chalard Jeandd59ece2017-12-20 13:23:32 +09001910 private void checkInterruptAndDelay(boolean sleepLonger) throws InterruptedException {
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001911 long now = SystemClock.elapsedRealtime();
Chalard Jeandd59ece2017-12-20 13:23:32 +09001912 if (now - mBringupStartTime <= 60000) {
1913 Thread.sleep(sleepLonger ? 200 : 1);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001914 } else {
Jeff Sharkey899223b2012-08-04 15:24:58 -07001915 updateState(DetailedState.FAILED, "checkpoint");
Chalard Jeandd59ece2017-12-20 13:23:32 +09001916 throw new IllegalStateException("VPN bringup took too long");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001917 }
1918 }
1919
Chalard Jeandd59ece2017-12-20 13:23:32 +09001920 private void bringup() {
1921 // Catch all exceptions so we can clean up a few things.
Jeff Sharkey899223b2012-08-04 15:24:58 -07001922 boolean initFinished = false;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001923 try {
1924 // Initialize the timer.
Chalard Jeandd59ece2017-12-20 13:23:32 +09001925 mBringupStartTime = SystemClock.elapsedRealtime();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001926
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001927 // Wait for the daemons to stop.
1928 for (String daemon : mDaemons) {
Jeff Sharkey088f29f2012-08-05 14:55:04 -07001929 while (!SystemService.isStopped(daemon)) {
Chalard Jeandd59ece2017-12-20 13:23:32 +09001930 checkInterruptAndDelay(true);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001931 }
1932 }
1933
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001934 // Clear the previous state.
1935 File state = new File("/data/misc/vpn/state");
1936 state.delete();
1937 if (state.exists()) {
1938 throw new IllegalStateException("Cannot delete the state");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001939 }
Chia-chi Yehc1872732011-12-08 16:51:41 -08001940 new File("/data/misc/vpn/abort").delete();
Jeff Sharkey899223b2012-08-04 15:24:58 -07001941 initFinished = true;
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001942
Chia-chi Yehe9107902011-07-02 01:48:50 -07001943 // Check if we need to restart any of the daemons.
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001944 boolean restart = false;
1945 for (String[] arguments : mArguments) {
1946 restart = restart || (arguments != null);
1947 }
1948 if (!restart) {
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04001949 agentDisconnect();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001950 return;
1951 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07001952 updateState(DetailedState.CONNECTING, "execute");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001953
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001954 // Start the daemon with arguments.
1955 for (int i = 0; i < mDaemons.length; ++i) {
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001956 String[] arguments = mArguments[i];
1957 if (arguments == null) {
1958 continue;
1959 }
1960
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001961 // Start the daemon.
1962 String daemon = mDaemons[i];
Jeff Sharkey088f29f2012-08-05 14:55:04 -07001963 SystemService.start(daemon);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001964
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001965 // Wait for the daemon to start.
Jeff Sharkey088f29f2012-08-05 14:55:04 -07001966 while (!SystemService.isRunning(daemon)) {
Chalard Jeandd59ece2017-12-20 13:23:32 +09001967 checkInterruptAndDelay(true);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001968 }
1969
1970 // Create the control socket.
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001971 mSockets[i] = new LocalSocket();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001972 LocalSocketAddress address = new LocalSocketAddress(
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001973 daemon, LocalSocketAddress.Namespace.RESERVED);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001974
1975 // Wait for the socket to connect.
1976 while (true) {
1977 try {
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001978 mSockets[i].connect(address);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001979 break;
1980 } catch (Exception e) {
1981 // ignore
1982 }
Chalard Jeandd59ece2017-12-20 13:23:32 +09001983 checkInterruptAndDelay(true);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001984 }
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001985 mSockets[i].setSoTimeout(500);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001986
1987 // Send over the arguments.
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001988 OutputStream out = mSockets[i].getOutputStream();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001989 for (String argument : arguments) {
Elliott Hughesd396a442013-06-28 16:24:48 -07001990 byte[] bytes = argument.getBytes(StandardCharsets.UTF_8);
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001991 if (bytes.length >= 0xFFFF) {
Chia-chi Yeh97a61562011-07-14 15:05:05 -07001992 throw new IllegalArgumentException("Argument is too large");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001993 }
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07001994 out.write(bytes.length >> 8);
1995 out.write(bytes.length);
1996 out.write(bytes);
Chalard Jeandd59ece2017-12-20 13:23:32 +09001997 checkInterruptAndDelay(false);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07001998 }
Chia-chi Yeh5317f032011-08-22 13:09:49 -07001999 out.write(0xFF);
2000 out.write(0xFF);
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07002001 out.flush();
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002002
2003 // Wait for End-of-File.
Chia-chi Yeh5317f032011-08-22 13:09:49 -07002004 InputStream in = mSockets[i].getInputStream();
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002005 while (true) {
2006 try {
2007 if (in.read() == -1) {
2008 break;
2009 }
2010 } catch (Exception e) {
2011 // ignore
2012 }
Chalard Jeandd59ece2017-12-20 13:23:32 +09002013 checkInterruptAndDelay(true);
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002014 }
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002015 }
2016
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002017 // Wait for the daemons to create the new state.
2018 while (!state.exists()) {
Chia-chi Yeh1f7746b2011-07-01 00:29:06 -07002019 // Check if a running daemon is dead.
2020 for (int i = 0; i < mDaemons.length; ++i) {
2021 String daemon = mDaemons[i];
Jeff Sharkey088f29f2012-08-05 14:55:04 -07002022 if (mArguments[i] != null && !SystemService.isRunning(daemon)) {
Chia-chi Yeh2e467642011-07-04 03:23:12 -07002023 throw new IllegalStateException(daemon + " is dead");
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002024 }
2025 }
Chalard Jeandd59ece2017-12-20 13:23:32 +09002026 checkInterruptAndDelay(true);
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002027 }
2028
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002029 // Now we are connected. Read and parse the new state.
Chia-chi Yehc1bac3a2011-12-16 15:00:31 -08002030 String[] parameters = FileUtils.readTextFile(state, 0, null).split("\n", -1);
Lorenzo Colitti50262792014-09-19 01:53:35 +09002031 if (parameters.length != 7) {
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002032 throw new IllegalStateException("Cannot parse the state");
2033 }
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002034
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002035 // Set the interface and the addresses in the config.
2036 mConfig.interfaze = parameters[0].trim();
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002037
Chad Brubaker4ca19e82013-06-14 11:16:51 -07002038 mConfig.addLegacyAddresses(parameters[1]);
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002039 // Set the routes if they are not set in the config.
2040 if (mConfig.routes == null || mConfig.routes.isEmpty()) {
Chad Brubaker4ca19e82013-06-14 11:16:51 -07002041 mConfig.addLegacyRoutes(parameters[2]);
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002042 }
2043
2044 // Set the DNS servers if they are not set in the config.
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002045 if (mConfig.dnsServers == null || mConfig.dnsServers.size() == 0) {
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002046 String dnsServers = parameters[3].trim();
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002047 if (!dnsServers.isEmpty()) {
2048 mConfig.dnsServers = Arrays.asList(dnsServers.split(" "));
2049 }
2050 }
2051
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002052 // Set the search domains if they are not set in the config.
2053 if (mConfig.searchDomains == null || mConfig.searchDomains.size() == 0) {
2054 String searchDomains = parameters[4].trim();
2055 if (!searchDomains.isEmpty()) {
2056 mConfig.searchDomains = Arrays.asList(searchDomains.split(" "));
2057 }
2058 }
Chia-chi Yehe9107902011-07-02 01:48:50 -07002059
Lorenzo Colitti50262792014-09-19 01:53:35 +09002060 // Add a throw route for the VPN server endpoint, if one was specified.
2061 String endpoint = parameters[5];
2062 if (!endpoint.isEmpty()) {
2063 try {
2064 InetAddress addr = InetAddress.parseNumericAddress(endpoint);
2065 if (addr instanceof Inet4Address) {
2066 mConfig.routes.add(new RouteInfo(new IpPrefix(addr, 32), RTN_THROW));
2067 } else if (addr instanceof Inet6Address) {
2068 mConfig.routes.add(new RouteInfo(new IpPrefix(addr, 128), RTN_THROW));
2069 } else {
2070 Log.e(TAG, "Unknown IP address family for VPN endpoint: " + endpoint);
2071 }
2072 } catch (IllegalArgumentException e) {
2073 Log.e(TAG, "Exception constructing throw route to " + endpoint + ": " + e);
2074 }
2075 }
2076
Chia-chi Yeh97a61562011-07-14 15:05:05 -07002077 // Here is the last step and it must be done synchronously.
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002078 synchronized (Vpn.this) {
Vinit Deshapnde2b862e52013-10-02 11:50:39 -07002079 // Set the start time
2080 mConfig.startTime = SystemClock.elapsedRealtime();
2081
Chalard Jeandd59ece2017-12-20 13:23:32 +09002082 // Check if the thread was interrupted while we were waiting on the lock.
2083 checkInterruptAndDelay(false);
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002084
Chia-chi Yehe9107902011-07-02 01:48:50 -07002085 // Check if the interface is gone while we are waiting.
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07002086 if (jniCheck(mConfig.interfaze) == 0) {
Chia-chi Yeh34e78132011-07-03 03:07:07 -07002087 throw new IllegalStateException(mConfig.interfaze + " is gone");
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002088 }
Chia-chi Yehe9107902011-07-02 01:48:50 -07002089
2090 // Now INetworkManagementEventObserver is watching our back.
Chia-chi Yehc2b8aa02011-07-03 18:00:47 -07002091 mInterface = mConfig.interfaze;
Robin Lee4d03abc2016-05-09 12:32:27 +01002092 prepareStatusIntent();
Chad Brubaker4ca19e82013-06-14 11:16:51 -07002093
Paul Jensen6bc2c2c2014-05-07 15:27:40 -04002094 agentConnect();
Chia-chi Yeh2e467642011-07-04 03:23:12 -07002095
2096 Log.i(TAG, "Connected!");
Chia-chi Yeh41d16852011-07-01 02:12:06 -07002097 }
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002098 } catch (Exception e) {
Chia-chi Yeh2e467642011-07-04 03:23:12 -07002099 Log.i(TAG, "Aborting", e);
Lorenzo Colitti43840602014-08-20 16:01:44 -07002100 updateState(DetailedState.FAILED, e.getMessage());
Chia-chi Yehe9107902011-07-02 01:48:50 -07002101 exit();
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002102 }
2103 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07002104
2105 /**
Chalard Jeandd59ece2017-12-20 13:23:32 +09002106 * Check all daemons every two seconds. Return when one of them is stopped.
2107 * The caller will move to the disconnected state when this function returns,
2108 * which can happen if a daemon failed or if the VPN was torn down.
Jeff Sharkey899223b2012-08-04 15:24:58 -07002109 */
Chalard Jeandd59ece2017-12-20 13:23:32 +09002110 private void waitForDaemonsToStop() throws InterruptedException {
Jeff Sharkey899223b2012-08-04 15:24:58 -07002111 if (!mNetworkInfo.isConnected()) {
2112 return;
2113 }
Hisanobu Watanabe047454c2016-06-07 19:55:41 +09002114 while (true) {
2115 Thread.sleep(2000);
2116 for (int i = 0; i < mDaemons.length; i++) {
2117 if (mArguments[i] != null && SystemService.isStopped(mDaemons[i])) {
2118 return;
Jeff Sharkey899223b2012-08-04 15:24:58 -07002119 }
2120 }
Jeff Sharkey899223b2012-08-04 15:24:58 -07002121 }
2122 }
Chia-chi Yeh85a7ce02011-06-29 16:05:58 -07002123 }
Chia-chi Yehff3bdca2011-05-23 17:26:46 -07002124}