blob: d77fb738a83e5c1fea2505643bfb3a3c665426d4 [file] [log] [blame]
Wayne Ma0ea3bdc2022-01-12 01:12:11 +08001/*
2 * Copyright (C) 2022 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;
18
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +000019import static android.net.ConnectivityManager.FIREWALL_CHAIN_DOZABLE;
20import static android.net.ConnectivityManager.FIREWALL_CHAIN_LOW_POWER_STANDBY;
21import static android.net.ConnectivityManager.FIREWALL_CHAIN_OEM_DENY_1;
22import static android.net.ConnectivityManager.FIREWALL_CHAIN_OEM_DENY_2;
23import static android.net.ConnectivityManager.FIREWALL_CHAIN_OEM_DENY_3;
24import static android.net.ConnectivityManager.FIREWALL_CHAIN_POWERSAVE;
25import static android.net.ConnectivityManager.FIREWALL_CHAIN_RESTRICTED;
26import static android.net.ConnectivityManager.FIREWALL_CHAIN_STANDBY;
Motomu Utsumi40230be2022-07-05 03:27:35 +000027import static android.net.ConnectivityManager.FIREWALL_RULE_ALLOW;
28import static android.net.ConnectivityManager.FIREWALL_RULE_DENY;
Motomu Utsumi18b287d2022-06-19 10:45:30 +000029import static android.system.OsConstants.EINVAL;
Motomu Utsumi5f52f4f2022-06-30 03:31:09 +000030import static android.system.OsConstants.ENODEV;
Motomu Utsumi60ed3be2022-06-24 10:38:57 +000031import static android.system.OsConstants.ENOENT;
Ken Chene6d511f2022-01-25 11:10:42 +080032import static android.system.OsConstants.EOPNOTSUPP;
33
Motomu Utsumif688eeb2022-07-22 03:47:35 +000034import android.content.Context;
Wayne Ma2fde98c2022-01-17 18:04:05 +080035import android.net.INetd;
36import android.os.RemoteException;
Wayne Ma0ea3bdc2022-01-12 01:12:11 +080037import android.os.ServiceSpecificException;
Motomu Utsumif688eeb2022-07-22 03:47:35 +000038import android.provider.DeviceConfig;
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +000039import android.system.ErrnoException;
Wayne Ma0ea3bdc2022-01-12 01:12:11 +080040import android.system.Os;
41import android.util.Log;
42
Motomu Utsumi5a68a212022-06-24 10:14:31 +000043import com.android.internal.annotations.GuardedBy;
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +000044import com.android.internal.annotations.VisibleForTesting;
Ken Chenf5f51332022-01-28 10:08:16 +080045import com.android.modules.utils.build.SdkLevel;
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +000046import com.android.net.module.util.BpfMap;
Motomu Utsumif688eeb2022-07-22 03:47:35 +000047import com.android.net.module.util.DeviceConfigUtils;
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +000048import com.android.net.module.util.Struct.U32;
Ken Chenf5f51332022-01-28 10:08:16 +080049
Ken Chene6d511f2022-01-25 11:10:42 +080050import java.io.FileDescriptor;
51import java.io.IOException;
Motomu Utsumi9be2ea02022-07-05 06:14:59 +000052import java.util.Arrays;
53import java.util.HashSet;
54import java.util.Set;
55import java.util.stream.Collectors;
Ken Chene6d511f2022-01-25 11:10:42 +080056
Wayne Ma0ea3bdc2022-01-12 01:12:11 +080057/**
58 * BpfNetMaps is responsible for providing traffic controller relevant functionality.
59 *
60 * {@hide}
61 */
62public class BpfNetMaps {
Motomu Utsumi305975f2022-06-27 09:24:32 +000063 private static final boolean PRE_T = !SdkLevel.isAtLeastT();
64 static {
65 if (!PRE_T) {
66 System.loadLibrary("service-connectivity");
67 }
68 }
69
Wayne Ma0ea3bdc2022-01-12 01:12:11 +080070 private static final String TAG = "BpfNetMaps";
Wayne Ma2fde98c2022-01-17 18:04:05 +080071 private final INetd mNetd;
Motomu Utsumi5f52f4f2022-06-30 03:31:09 +000072 private final Dependencies mDeps;
Ken Chenf5f51332022-01-28 10:08:16 +080073 // Use legacy netd for releases before T.
Ken Chenf5f51332022-01-28 10:08:16 +080074 private static boolean sInitialized = false;
Wayne Ma0ea3bdc2022-01-12 01:12:11 +080075
Motomu Utsumif688eeb2022-07-22 03:47:35 +000076 private static Boolean sEnableJavaBpfMap = null;
77 private static final String BPF_NET_MAPS_ENABLE_JAVA_BPF_MAP =
78 "bpf_net_maps_enable_java_bpf_map";
79
Motomu Utsumi18b287d2022-06-19 10:45:30 +000080 // Lock for sConfigurationMap entry for UID_RULES_CONFIGURATION_KEY.
81 // This entry is not accessed by others.
82 // BpfNetMaps acquires this lock while sequence of read, modify, and write.
83 private static final Object sUidRulesConfigBpfMapLock = new Object();
84
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +000085 private static final String CONFIGURATION_MAP_PATH =
86 "/sys/fs/bpf/netd_shared/map_netd_configuration_map";
Motomu Utsumi5a68a212022-06-24 10:14:31 +000087 private static final String UID_OWNER_MAP_PATH =
88 "/sys/fs/bpf/netd_shared/map_netd_uid_owner_map";
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +000089 private static final U32 UID_RULES_CONFIGURATION_KEY = new U32(0);
Motomu Utsumiba2fa152022-07-25 01:57:23 +000090 private static final U32 CURRENT_STATS_MAP_CONFIGURATION_KEY = new U32(1);
91 private static final long UID_RULES_DEFAULT_CONFIGURATION = 0;
92 private static final long STATS_SELECT_MAP_A = 0;
93 private static final long STATS_SELECT_MAP_B = 1;
94
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +000095 private static BpfMap<U32, U32> sConfigurationMap = null;
Motomu Utsumi5a68a212022-06-24 10:14:31 +000096 // BpfMap for UID_OWNER_MAP_PATH. This map is not accessed by others.
97 private static BpfMap<U32, UidOwnerValue> sUidOwnerMap = null;
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +000098
99 // LINT.IfChange(match_type)
Motomu Utsumi60ed3be2022-06-24 10:38:57 +0000100 @VisibleForTesting public static final long NO_MATCH = 0;
101 @VisibleForTesting public static final long HAPPY_BOX_MATCH = (1 << 0);
102 @VisibleForTesting public static final long PENALTY_BOX_MATCH = (1 << 1);
103 @VisibleForTesting public static final long DOZABLE_MATCH = (1 << 2);
104 @VisibleForTesting public static final long STANDBY_MATCH = (1 << 3);
105 @VisibleForTesting public static final long POWERSAVE_MATCH = (1 << 4);
106 @VisibleForTesting public static final long RESTRICTED_MATCH = (1 << 5);
107 @VisibleForTesting public static final long LOW_POWER_STANDBY_MATCH = (1 << 6);
108 @VisibleForTesting public static final long IIF_MATCH = (1 << 7);
109 @VisibleForTesting public static final long LOCKDOWN_VPN_MATCH = (1 << 8);
110 @VisibleForTesting public static final long OEM_DENY_1_MATCH = (1 << 9);
111 @VisibleForTesting public static final long OEM_DENY_2_MATCH = (1 << 10);
112 @VisibleForTesting public static final long OEM_DENY_3_MATCH = (1 << 11);
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000113 // LINT.ThenChange(packages/modules/Connectivity/bpf_progs/bpf_shared.h)
114
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000115 /**
Motomu Utsumif688eeb2022-07-22 03:47:35 +0000116 * Set sEnableJavaBpfMap for test.
117 */
118 @VisibleForTesting
119 public static void setEnableJavaBpfMapForTest(boolean enable) {
120 sEnableJavaBpfMap = enable;
121 }
122
123 /**
Motomu Utsumi305975f2022-06-27 09:24:32 +0000124 * Set configurationMap for test.
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000125 */
126 @VisibleForTesting
Motomu Utsumi305975f2022-06-27 09:24:32 +0000127 public static void setConfigurationMapForTest(BpfMap<U32, U32> configurationMap) {
128 sConfigurationMap = configurationMap;
129 }
130
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000131 /**
132 * Set uidOwnerMap for test.
133 */
134 @VisibleForTesting
135 public static void setUidOwnerMapForTest(BpfMap<U32, UidOwnerValue> uidOwnerMap) {
136 sUidOwnerMap = uidOwnerMap;
137 }
138
Motomu Utsumi305975f2022-06-27 09:24:32 +0000139 private static BpfMap<U32, U32> getConfigurationMap() {
140 try {
141 return new BpfMap<>(
142 CONFIGURATION_MAP_PATH, BpfMap.BPF_F_RDWR, U32.class, U32.class);
143 } catch (ErrnoException e) {
144 throw new IllegalStateException("Cannot open netd configuration map", e);
145 }
146 }
147
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000148 private static BpfMap<U32, UidOwnerValue> getUidOwnerMap() {
149 try {
150 return new BpfMap<>(
151 UID_OWNER_MAP_PATH, BpfMap.BPF_F_RDWR, U32.class, UidOwnerValue.class);
152 } catch (ErrnoException e) {
153 throw new IllegalStateException("Cannot open uid owner map", e);
154 }
155 }
156
Motomu Utsumiba2fa152022-07-25 01:57:23 +0000157 private static void initBpfMaps() {
Motomu Utsumi305975f2022-06-27 09:24:32 +0000158 if (sConfigurationMap == null) {
159 sConfigurationMap = getConfigurationMap();
160 }
Motomu Utsumiba2fa152022-07-25 01:57:23 +0000161 try {
162 sConfigurationMap.updateEntry(UID_RULES_CONFIGURATION_KEY,
163 new U32(UID_RULES_DEFAULT_CONFIGURATION));
164 } catch (ErrnoException e) {
165 throw new IllegalStateException("Failed to initialize uid rules configuration", e);
166 }
167 try {
168 sConfigurationMap.updateEntry(CURRENT_STATS_MAP_CONFIGURATION_KEY,
169 new U32(STATS_SELECT_MAP_A));
170 } catch (ErrnoException e) {
171 throw new IllegalStateException("Failed to initialize current stats configuration", e);
172 }
173
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000174 if (sUidOwnerMap == null) {
175 sUidOwnerMap = getUidOwnerMap();
176 }
Motomu Utsumiba2fa152022-07-25 01:57:23 +0000177 try {
178 sUidOwnerMap.clear();
179 } catch (ErrnoException e) {
180 throw new IllegalStateException("Failed to initialize uid owner map", e);
181 }
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000182 }
183
Ken Chenf5f51332022-01-28 10:08:16 +0800184 /**
185 * Initializes the class if it is not already initialized. This method will open maps but not
186 * cause any other effects. This method may be called multiple times on any thread.
187 */
Motomu Utsumif688eeb2022-07-22 03:47:35 +0000188 private static synchronized void ensureInitialized(final Context context) {
Ken Chenf5f51332022-01-28 10:08:16 +0800189 if (sInitialized) return;
Motomu Utsumif688eeb2022-07-22 03:47:35 +0000190 if (sEnableJavaBpfMap == null) {
191 sEnableJavaBpfMap = DeviceConfigUtils.isFeatureEnabled(context,
192 DeviceConfig.NAMESPACE_TETHERING, BPF_NET_MAPS_ENABLE_JAVA_BPF_MAP,
193 SdkLevel.isAtLeastU() /* defaultValue */);
194 }
195 Log.d(TAG, "BpfNetMaps is initialized with sEnableJavaBpfMap=" + sEnableJavaBpfMap);
196
Motomu Utsumiba2fa152022-07-25 01:57:23 +0000197 initBpfMaps();
Motomu Utsumi305975f2022-06-27 09:24:32 +0000198 native_init();
Ken Chenf5f51332022-01-28 10:08:16 +0800199 sInitialized = true;
Wayne Ma2fde98c2022-01-17 18:04:05 +0800200 }
201
Motomu Utsumi5f52f4f2022-06-30 03:31:09 +0000202 /**
203 * Dependencies of BpfNetMaps, for injection in tests.
204 */
205 @VisibleForTesting
206 public static class Dependencies {
207 /**
208 * Get interface index.
209 */
210 public int getIfIndex(final String ifName) {
211 return Os.if_nametoindex(ifName);
212 }
213 }
214
markchien49e944c2022-03-01 15:22:20 +0800215 /** Constructor used after T that doesn't need to use netd anymore. */
Motomu Utsumif688eeb2022-07-22 03:47:35 +0000216 public BpfNetMaps(final Context context) {
217 this(context, null);
markchien49e944c2022-03-01 15:22:20 +0800218
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000219 if (PRE_T) throw new IllegalArgumentException("BpfNetMaps need to use netd before T");
markchien49e944c2022-03-01 15:22:20 +0800220 }
221
Motomu Utsumif688eeb2022-07-22 03:47:35 +0000222 public BpfNetMaps(final Context context, final INetd netd) {
223 this(context, netd, new Dependencies());
Motomu Utsumi5f52f4f2022-06-30 03:31:09 +0000224 }
225
226 @VisibleForTesting
Motomu Utsumif688eeb2022-07-22 03:47:35 +0000227 public BpfNetMaps(final Context context, final INetd netd, final Dependencies deps) {
Motomu Utsumi305975f2022-06-27 09:24:32 +0000228 if (!PRE_T) {
Motomu Utsumif688eeb2022-07-22 03:47:35 +0000229 ensureInitialized(context);
Motomu Utsumi305975f2022-06-27 09:24:32 +0000230 }
Wayne Ma2fde98c2022-01-17 18:04:05 +0800231 mNetd = netd;
Motomu Utsumi5f52f4f2022-06-30 03:31:09 +0000232 mDeps = deps;
Wayne Ma790c83e2022-01-13 10:35:05 +0800233 }
234
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000235 /**
236 * Get corresponding match from firewall chain.
237 */
238 @VisibleForTesting
239 public long getMatchByFirewallChain(final int chain) {
Motomu Utsumi40230be2022-07-05 03:27:35 +0000240 switch (chain) {
241 case FIREWALL_CHAIN_DOZABLE:
242 return DOZABLE_MATCH;
243 case FIREWALL_CHAIN_STANDBY:
244 return STANDBY_MATCH;
245 case FIREWALL_CHAIN_POWERSAVE:
246 return POWERSAVE_MATCH;
247 case FIREWALL_CHAIN_RESTRICTED:
248 return RESTRICTED_MATCH;
249 case FIREWALL_CHAIN_LOW_POWER_STANDBY:
250 return LOW_POWER_STANDBY_MATCH;
251 case FIREWALL_CHAIN_OEM_DENY_1:
252 return OEM_DENY_1_MATCH;
253 case FIREWALL_CHAIN_OEM_DENY_2:
254 return OEM_DENY_2_MATCH;
255 case FIREWALL_CHAIN_OEM_DENY_3:
256 return OEM_DENY_3_MATCH;
257 default:
258 throw new ServiceSpecificException(EINVAL, "Invalid firewall chain: " + chain);
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000259 }
Motomu Utsumi40230be2022-07-05 03:27:35 +0000260 }
261
262 /**
263 * Get if the chain is allow list or not.
264 *
265 * ALLOWLIST means the firewall denies all by default, uids must be explicitly allowed
266 * DENYLIST means the firewall allows all by default, uids must be explicitly denyed
267 */
268 @VisibleForTesting
269 public boolean isFirewallAllowList(final int chain) {
270 switch (chain) {
271 case FIREWALL_CHAIN_DOZABLE:
272 case FIREWALL_CHAIN_POWERSAVE:
273 case FIREWALL_CHAIN_RESTRICTED:
274 case FIREWALL_CHAIN_LOW_POWER_STANDBY:
275 return true;
276 case FIREWALL_CHAIN_STANDBY:
277 case FIREWALL_CHAIN_OEM_DENY_1:
278 case FIREWALL_CHAIN_OEM_DENY_2:
279 case FIREWALL_CHAIN_OEM_DENY_3:
280 return false;
281 default:
282 throw new ServiceSpecificException(EINVAL, "Invalid firewall chain: " + chain);
283 }
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000284 }
285
Ken Chenf5f51332022-01-28 10:08:16 +0800286 private void maybeThrow(final int err, final String msg) {
287 if (err != 0) {
288 throw new ServiceSpecificException(err, msg + ": " + Os.strerror(err));
289 }
290 }
291
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000292 private void throwIfPreT(final String msg) {
293 if (PRE_T) {
Motomu Utsumi18b287d2022-06-19 10:45:30 +0000294 throw new UnsupportedOperationException(msg);
295 }
296 }
297
Motomu Utsumi60ed3be2022-06-24 10:38:57 +0000298 private void removeRule(final int uid, final long match, final String caller) {
299 try {
300 synchronized (sUidOwnerMap) {
301 final UidOwnerValue oldMatch = sUidOwnerMap.getValue(new U32(uid));
302
303 if (oldMatch == null) {
304 throw new ServiceSpecificException(ENOENT,
305 "sUidOwnerMap does not have entry for uid: " + uid);
306 }
307
308 final UidOwnerValue newMatch = new UidOwnerValue(
309 (match == IIF_MATCH) ? 0 : oldMatch.iif,
310 oldMatch.rule & ~match
311 );
312
313 if (newMatch.rule == 0) {
314 sUidOwnerMap.deleteEntry(new U32(uid));
315 } else {
316 sUidOwnerMap.updateEntry(new U32(uid), newMatch);
317 }
318 }
319 } catch (ErrnoException e) {
320 throw new ServiceSpecificException(e.errno,
321 caller + " failed to remove rule: " + Os.strerror(e.errno));
322 }
323 }
324
Motomu Utsumi389278e2022-06-28 07:05:05 +0000325 private void addRule(final int uid, final long match, final long iif, final String caller) {
326 if (match != IIF_MATCH && iif != 0) {
327 throw new ServiceSpecificException(EINVAL,
328 "Non-interface match must have zero interface index");
329 }
330
331 try {
332 synchronized (sUidOwnerMap) {
333 final UidOwnerValue oldMatch = sUidOwnerMap.getValue(new U32(uid));
334
335 final UidOwnerValue newMatch;
336 if (oldMatch != null) {
337 newMatch = new UidOwnerValue(
338 (match == IIF_MATCH) ? iif : oldMatch.iif,
339 oldMatch.rule | match
340 );
341 } else {
342 newMatch = new UidOwnerValue(
343 iif,
344 match
345 );
346 }
347 sUidOwnerMap.updateEntry(new U32(uid), newMatch);
348 }
349 } catch (ErrnoException e) {
350 throw new ServiceSpecificException(e.errno,
351 caller + " failed to add rule: " + Os.strerror(e.errno));
352 }
353 }
354
355 private void addRule(final int uid, final long match, final String caller) {
356 addRule(uid, match, 0 /* iif */, caller);
357 }
358
Ken Chenf5f51332022-01-28 10:08:16 +0800359 /**
360 * Add naughty app bandwidth rule for specific app
361 *
362 * @param uid uid of target app
Ken Chenf5f51332022-01-28 10:08:16 +0800363 * @throws ServiceSpecificException in case of failure, with an error code indicating the
364 * cause of the failure.
365 */
Lorenzo Colitti82244fd2022-03-04 23:15:00 +0900366 public void addNaughtyApp(final int uid) {
Motomu Utsumi389278e2022-06-28 07:05:05 +0000367 throwIfPreT("addNaughtyApp is not available on pre-T devices");
Motomu Utsumi55c282e2022-08-03 06:25:33 +0000368
369 if (sEnableJavaBpfMap) {
370 addRule(uid, PENALTY_BOX_MATCH, "addNaughtyApp");
371 } else {
372 final int err = native_addNaughtyApp(uid);
373 maybeThrow(err, "Unable to add naughty app");
374 }
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800375 }
376
Ken Chenf5f51332022-01-28 10:08:16 +0800377 /**
378 * Remove naughty app bandwidth rule for specific app
379 *
380 * @param uid uid of target app
Ken Chenf5f51332022-01-28 10:08:16 +0800381 * @throws ServiceSpecificException in case of failure, with an error code indicating the
382 * cause of the failure.
383 */
Lorenzo Colitti82244fd2022-03-04 23:15:00 +0900384 public void removeNaughtyApp(final int uid) {
Motomu Utsumi60ed3be2022-06-24 10:38:57 +0000385 throwIfPreT("removeNaughtyApp is not available on pre-T devices");
Motomu Utsumi878ce0d2022-08-03 06:22:42 +0000386
387 if (sEnableJavaBpfMap) {
388 removeRule(uid, PENALTY_BOX_MATCH, "removeNaughtyApp");
389 } else {
390 final int err = native_removeNaughtyApp(uid);
391 maybeThrow(err, "Unable to remove naughty app");
392 }
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800393 }
394
Ken Chenf5f51332022-01-28 10:08:16 +0800395 /**
396 * Add nice app bandwidth rule for specific app
397 *
398 * @param uid uid of target app
Ken Chenf5f51332022-01-28 10:08:16 +0800399 * @throws ServiceSpecificException in case of failure, with an error code indicating the
400 * cause of the failure.
401 */
Lorenzo Colitti82244fd2022-03-04 23:15:00 +0900402 public void addNiceApp(final int uid) {
Motomu Utsumi55630d02022-06-29 07:46:52 +0000403 throwIfPreT("addNiceApp is not available on pre-T devices");
Motomu Utsumi7f19df92022-08-03 06:29:59 +0000404
405 if (sEnableJavaBpfMap) {
406 addRule(uid, HAPPY_BOX_MATCH, "addNiceApp");
407 } else {
408 final int err = native_addNiceApp(uid);
409 maybeThrow(err, "Unable to add nice app");
410 }
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800411 }
412
Ken Chenf5f51332022-01-28 10:08:16 +0800413 /**
414 * Remove nice app bandwidth rule for specific app
415 *
416 * @param uid uid of target app
Ken Chenf5f51332022-01-28 10:08:16 +0800417 * @throws ServiceSpecificException in case of failure, with an error code indicating the
418 * cause of the failure.
419 */
Lorenzo Colitti82244fd2022-03-04 23:15:00 +0900420 public void removeNiceApp(final int uid) {
Motomu Utsumi7392eb42022-06-29 03:53:03 +0000421 throwIfPreT("removeNiceApp is not available on pre-T devices");
Motomu Utsumi5f15f752022-08-03 06:27:51 +0000422
423 if (sEnableJavaBpfMap) {
424 removeRule(uid, HAPPY_BOX_MATCH, "removeNiceApp");
425 } else {
426 final int err = native_removeNiceApp(uid);
427 maybeThrow(err, "Unable to remove nice app");
428 }
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800429 }
430
Ken Chenf5f51332022-01-28 10:08:16 +0800431 /**
432 * Set target firewall child chain
433 *
434 * @param childChain target chain to enable
435 * @param enable whether to enable or disable child chain.
Motomu Utsumi18b287d2022-06-19 10:45:30 +0000436 * @throws UnsupportedOperationException if called on pre-T devices.
Ken Chenf5f51332022-01-28 10:08:16 +0800437 * @throws ServiceSpecificException in case of failure, with an error code indicating the
438 * cause of the failure.
439 */
Lorenzo Colitti82244fd2022-03-04 23:15:00 +0900440 public void setChildChain(final int childChain, final boolean enable) {
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000441 throwIfPreT("setChildChain is not available on pre-T devices");
Motomu Utsumi18b287d2022-06-19 10:45:30 +0000442
443 final long match = getMatchByFirewallChain(childChain);
444 try {
445 synchronized (sUidRulesConfigBpfMapLock) {
446 final U32 config = sConfigurationMap.getValue(UID_RULES_CONFIGURATION_KEY);
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000447 final long newConfig = enable ? (config.val | match) : (config.val & ~match);
Motomu Utsumi18b287d2022-06-19 10:45:30 +0000448 sConfigurationMap.updateEntry(UID_RULES_CONFIGURATION_KEY, new U32(newConfig));
449 }
450 } catch (ErrnoException e) {
451 throw new ServiceSpecificException(e.errno,
452 "Unable to set child chain: " + Os.strerror(e.errno));
453 }
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800454 }
455
456 /**
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000457 * Get the specified firewall chain's status.
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000458 *
459 * @param childChain target chain
460 * @return {@code true} if chain is enabled, {@code false} if chain is not enabled.
461 * @throws UnsupportedOperationException if called on pre-T devices.
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000462 * @throws ServiceSpecificException in case of failure, with an error code indicating the
463 * cause of the failure.
464 */
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000465 public boolean isChainEnabled(final int childChain) {
466 throwIfPreT("isChainEnabled is not available on pre-T devices");
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000467
468 final long match = getMatchByFirewallChain(childChain);
469 try {
470 final U32 config = sConfigurationMap.getValue(UID_RULES_CONFIGURATION_KEY);
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +0000471 return (config.val & match) != 0;
472 } catch (ErrnoException e) {
473 throw new ServiceSpecificException(e.errno,
474 "Unable to get firewall chain status: " + Os.strerror(e.errno));
475 }
476 }
477
478 /**
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800479 * Replaces the contents of the specified UID-based firewall chain.
Motomu Utsumi9be2ea02022-07-05 06:14:59 +0000480 * Enables the chain for specified uids and disables the chain for non-specified uids.
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800481 *
Motomu Utsumi9be2ea02022-07-05 06:14:59 +0000482 * @param chain Target chain.
Ken Chenf5f51332022-01-28 10:08:16 +0800483 * @param uids The list of UIDs to allow/deny.
Motomu Utsumi9be2ea02022-07-05 06:14:59 +0000484 * @throws UnsupportedOperationException if called on pre-T devices.
485 * @throws IllegalArgumentException if {@code chain} is not a valid chain.
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800486 */
Motomu Utsumi9be2ea02022-07-05 06:14:59 +0000487 public void replaceUidChain(final int chain, final int[] uids) {
488 throwIfPreT("replaceUidChain is not available on pre-T devices");
489
490 final long match;
491 try {
492 match = getMatchByFirewallChain(chain);
493 } catch (ServiceSpecificException e) {
494 // Throws IllegalArgumentException to keep the behavior of
495 // ConnectivityManager#replaceFirewallChain API
496 throw new IllegalArgumentException("Invalid firewall chain: " + chain);
497 }
498 final Set<Integer> uidSet = Arrays.stream(uids).boxed().collect(Collectors.toSet());
499 final Set<Integer> uidSetToRemoveRule = new HashSet<>();
500 try {
501 synchronized (sUidOwnerMap) {
502 sUidOwnerMap.forEach((uid, config) -> {
503 // config could be null if there is a concurrent entry deletion.
504 // http://b/220084230.
505 if (config != null
506 && !uidSet.contains((int) uid.val) && (config.rule & match) != 0) {
507 uidSetToRemoveRule.add((int) uid.val);
508 }
509 });
510
511 for (final int uid : uidSetToRemoveRule) {
512 removeRule(uid, match, "replaceUidChain");
513 }
514 for (final int uid : uids) {
515 addRule(uid, match, "replaceUidChain");
516 }
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000517 }
Motomu Utsumi9be2ea02022-07-05 06:14:59 +0000518 } catch (ErrnoException | ServiceSpecificException e) {
519 Log.e(TAG, "replaceUidChain failed: " + e);
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800520 }
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800521 }
522
Ken Chenf5f51332022-01-28 10:08:16 +0800523 /**
524 * Set firewall rule for uid
525 *
526 * @param childChain target chain
527 * @param uid uid to allow/deny
528 * @param firewallRule either FIREWALL_RULE_ALLOW or FIREWALL_RULE_DENY
Ken Chenf5f51332022-01-28 10:08:16 +0800529 * @throws ServiceSpecificException in case of failure, with an error code indicating the
530 * cause of the failure.
531 */
Lorenzo Colitti82244fd2022-03-04 23:15:00 +0900532 public void setUidRule(final int childChain, final int uid, final int firewallRule) {
Motomu Utsumi40230be2022-07-05 03:27:35 +0000533 throwIfPreT("setUidRule is not available on pre-T devices");
534
535 final long match = getMatchByFirewallChain(childChain);
536 final boolean isAllowList = isFirewallAllowList(childChain);
537 final boolean add = (firewallRule == FIREWALL_RULE_ALLOW && isAllowList)
538 || (firewallRule == FIREWALL_RULE_DENY && !isAllowList);
539
540 if (add) {
541 addRule(uid, match, "setUidRule");
542 } else {
543 removeRule(uid, match, "setUidRule");
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000544 }
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800545 }
546
547 /**
548 * Add ingress interface filtering rules to a list of UIDs
549 *
550 * For a given uid, once a filtering rule is added, the kernel will only allow packets from the
551 * allowed interface and loopback to be sent to the list of UIDs.
552 *
553 * Calling this method on one or more UIDs with an existing filtering rule but a different
554 * interface name will result in the filtering rule being updated to allow the new interface
555 * instead. Otherwise calling this method will not affect existing rules set on other UIDs.
556 *
557 * @param ifName the name of the interface on which the filtering rules will allow packets to
Ken Chenf5f51332022-01-28 10:08:16 +0800558 * be received.
559 * @param uids an array of UIDs which the filtering rules will be set
560 * @throws RemoteException when netd has crashed.
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800561 * @throws ServiceSpecificException in case of failure, with an error code indicating the
Ken Chenf5f51332022-01-28 10:08:16 +0800562 * cause of the failure.
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800563 */
Ken Chenf5f51332022-01-28 10:08:16 +0800564 public void addUidInterfaceRules(final String ifName, final int[] uids) throws RemoteException {
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000565 if (PRE_T) {
Ken Chenf5f51332022-01-28 10:08:16 +0800566 mNetd.firewallAddUidInterfaceRules(ifName, uids);
Wayne Ma2fde98c2022-01-17 18:04:05 +0800567 return;
568 }
Motomu Utsumif794e7d2022-08-03 06:38:43 +0000569
570 if (sEnableJavaBpfMap) {
571 // Null ifName is a wildcard to allow apps to receive packets on all interfaces and
572 // ifIndex is set to 0.
573 final int ifIndex;
574 if (ifName == null) {
575 ifIndex = 0;
576 } else {
577 ifIndex = mDeps.getIfIndex(ifName);
578 if (ifIndex == 0) {
579 throw new ServiceSpecificException(ENODEV,
580 "Failed to get index of interface " + ifName);
581 }
582 }
583 for (final int uid : uids) {
584 try {
585 addRule(uid, IIF_MATCH, ifIndex, "addUidInterfaceRules");
586 } catch (ServiceSpecificException e) {
587 Log.e(TAG, "addRule failed uid=" + uid + " ifName=" + ifName + ", " + e);
588 }
589 }
Motomu Utsumi5f52f4f2022-06-30 03:31:09 +0000590 } else {
Motomu Utsumif794e7d2022-08-03 06:38:43 +0000591 final int err = native_addUidInterfaceRules(ifName, uids);
592 maybeThrow(err, "Unable to add uid interface rules");
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000593 }
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800594 }
595
596 /**
597 * Remove ingress interface filtering rules from a list of UIDs
598 *
599 * Clear the ingress interface filtering rules from the list of UIDs which were previously set
600 * by addUidInterfaceRules(). Ignore any uid which does not have filtering rule.
601 *
602 * @param uids an array of UIDs from which the filtering rules will be removed
Ken Chenf5f51332022-01-28 10:08:16 +0800603 * @throws RemoteException when netd has crashed.
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800604 * @throws ServiceSpecificException in case of failure, with an error code indicating the
Ken Chenf5f51332022-01-28 10:08:16 +0800605 * cause of the failure.
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800606 */
Ken Chenf5f51332022-01-28 10:08:16 +0800607 public void removeUidInterfaceRules(final int[] uids) throws RemoteException {
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000608 if (PRE_T) {
Ken Chenf5f51332022-01-28 10:08:16 +0800609 mNetd.firewallRemoveUidInterfaceRules(uids);
Wayne Ma2fde98c2022-01-17 18:04:05 +0800610 return;
611 }
Motomu Utsumi599c4e52022-06-30 03:37:18 +0000612 for (final int uid: uids) {
613 try {
614 removeRule(uid, IIF_MATCH, "removeUidInterfaceRules");
615 } catch (ServiceSpecificException e) {
616 Log.e(TAG, "removeRule failed uid=" + uid + ", " + e);
617 }
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000618 }
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800619 }
620
Ken Chenf5f51332022-01-28 10:08:16 +0800621 /**
Motomu Utsumi8b42e6d2022-05-19 06:23:40 +0000622 * Update lockdown rule for uid
623 *
624 * @param uid target uid to add/remove the rule
625 * @param add {@code true} to add the rule, {@code false} to remove the rule.
626 * @throws ServiceSpecificException in case of failure, with an error code indicating the
627 * cause of the failure.
628 */
629 public void updateUidLockdownRule(final int uid, final boolean add) {
Motomu Utsumi697b2992022-06-30 02:25:29 +0000630 throwIfPreT("updateUidLockdownRule is not available on pre-T devices");
Motomu Utsumib2d32b72022-08-03 06:31:58 +0000631
632 if (sEnableJavaBpfMap) {
633 if (add) {
634 addRule(uid, LOCKDOWN_VPN_MATCH, "updateUidLockdownRule");
635 } else {
636 removeRule(uid, LOCKDOWN_VPN_MATCH, "updateUidLockdownRule");
637 }
Motomu Utsumi697b2992022-06-30 02:25:29 +0000638 } else {
Motomu Utsumib2d32b72022-08-03 06:31:58 +0000639 final int err = native_updateUidLockdownRule(uid, add);
640 maybeThrow(err, "Unable to update lockdown rule");
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000641 }
Motomu Utsumi8b42e6d2022-05-19 06:23:40 +0000642 }
643
644 /**
Ken Chenf5f51332022-01-28 10:08:16 +0800645 * Request netd to change the current active network stats map.
646 *
Ken Chenf5f51332022-01-28 10:08:16 +0800647 * @throws ServiceSpecificException in case of failure, with an error code indicating the
648 * cause of the failure.
649 */
markchien49e944c2022-03-01 15:22:20 +0800650 public void swapActiveStatsMap() {
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800651 final int err = native_swapActiveStatsMap();
Ken Chenf5f51332022-01-28 10:08:16 +0800652 maybeThrow(err, "Unable to swap active stats map");
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800653 }
654
Ken Chenf5f51332022-01-28 10:08:16 +0800655 /**
656 * Assigns android.permission.INTERNET and/or android.permission.UPDATE_DEVICE_STATS to the uids
657 * specified. Or remove all permissions from the uids.
658 *
659 * @param permissions The permission to grant, it could be either PERMISSION_INTERNET and/or
660 * PERMISSION_UPDATE_DEVICE_STATS. If the permission is NO_PERMISSIONS, then
661 * revoke all permissions for the uids.
662 * @param uids uid of users to grant permission
663 * @throws RemoteException when netd has crashed.
664 */
665 public void setNetPermForUids(final int permissions, final int[] uids) throws RemoteException {
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000666 if (PRE_T) {
Ken Chenf5f51332022-01-28 10:08:16 +0800667 mNetd.trafficSetNetPermForUids(permissions, uids);
Wayne Ma2fde98c2022-01-17 18:04:05 +0800668 return;
669 }
670 native_setPermissionForUids(permissions, uids);
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800671 }
672
Ken Chene6d511f2022-01-25 11:10:42 +0800673 /**
674 * Dump BPF maps
675 *
676 * @param fd file descriptor to output
677 * @throws IOException when file descriptor is invalid.
678 * @throws ServiceSpecificException when the method is called on an unsupported device.
679 */
680 public void dump(final FileDescriptor fd, boolean verbose)
681 throws IOException, ServiceSpecificException {
Motomu Utsumi25cf86f2022-06-27 08:50:19 +0000682 if (PRE_T) {
Ken Chene6d511f2022-01-25 11:10:42 +0800683 throw new ServiceSpecificException(
684 EOPNOTSUPP, "dumpsys connectivity trafficcontroller dump not available on pre-T"
685 + " devices, use dumpsys netd trafficcontroller instead.");
686 }
687 native_dump(fd, verbose);
688 }
689
Wayne Ma790c83e2022-01-13 10:35:05 +0800690 private static native void native_init();
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800691 private native int native_addNaughtyApp(int uid);
692 private native int native_removeNaughtyApp(int uid);
693 private native int native_addNiceApp(int uid);
694 private native int native_removeNiceApp(int uid);
Motomu Utsumi114cd9c2022-08-01 02:08:35 +0000695 private native int native_setChildChain(int childChain, boolean enable);
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000696 @GuardedBy("sUidOwnerMap")
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800697 private native int native_replaceUidChain(String name, boolean isAllowlist, int[] uids);
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000698 @GuardedBy("sUidOwnerMap")
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800699 private native int native_setUidRule(int childChain, int uid, int firewallRule);
700 private native int native_addUidInterfaceRules(String ifName, int[] uids);
Motomu Utsumi5a68a212022-06-24 10:14:31 +0000701 @GuardedBy("sUidOwnerMap")
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800702 private native int native_removeUidInterfaceRules(int[] uids);
Motomu Utsumi8b42e6d2022-05-19 06:23:40 +0000703 private native int native_updateUidLockdownRule(int uid, boolean add);
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800704 private native int native_swapActiveStatsMap();
Wayne Ma2fde98c2022-01-17 18:04:05 +0800705 private native void native_setPermissionForUids(int permissions, int[] uids);
Ken Chene6d511f2022-01-25 11:10:42 +0800706 private native void native_dump(FileDescriptor fd, boolean verbose);
Wayne Ma0ea3bdc2022-01-12 01:12:11 +0800707}