service/src/com/android/server/BpfNetMaps.java

/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.server;

import android.os.ServiceSpecificException;
import android.system.Os;
import android.util.Log;

/**
 * BpfNetMaps is responsible for providing traffic controller relevant functionality.
 *
 * {@hide}
 */
public class BpfNetMaps {
    private static final String TAG = "BpfNetMaps";

   /**
    * Add naughty app bandwidth rule for specific app
    *
    * @param uid uid of target app
    * @throws ServiceSpecificException in case of failure, with an error code indicating the
    *         cause of the failure.
    */
    public void addNaughtyApp(final int uid) {
        final int err = native_addNaughtyApp(uid);
        if (err != 0) {
            throw new ServiceSpecificException(-err, "Unable to add naughty app: "
                            + Os.strerror(-err));
        }
    }

   /**
    * Remove naughty app bandwidth rule for specific app
    *
    * @param uid uid of target app
    * @throws ServiceSpecificException in case of failure, with an error code indicating the
    *         cause of the failure.
    */
    public void removeNaughtyApp(final int uid) {
        final int err = native_removeNaughtyApp(uid);
        if (err != 0) {
            throw new ServiceSpecificException(-err, "Unable to remove naughty app: "
                            + Os.strerror(-err));
        }
    }

   /**
    * Add nice app bandwidth rule for specific app
    *
    * @param uid uid of target app
    * @throws ServiceSpecificException in case of failure, with an error code indicating the
    *         cause of the failure.
    */
    public void addNiceApp(final int uid) {
        final int err = native_addNiceApp(uid);
        if (err != 0) {
            throw new ServiceSpecificException(-err, "Unable to add nice app: "
                            + Os.strerror(-err));
        }
    }

   /**
    * Remove nice app bandwidth rule for specific app
    *
    * @param uid uid of target app
    * @throws ServiceSpecificException in case of failure, with an error code indicating the
    *         cause of the failure.
    */
    public void removeNiceApp(final int uid) {
        final int err = native_removeNiceApp(uid);
        if (err != 0) {
            throw new ServiceSpecificException(-err, "Unable to remove nice app: "
                            + Os.strerror(-err));
        }
    }

   /**
    * Set target firewall child chain
    *
    * @param childChain target chain to enable
    * @param enable whether to enable or disable child chain.
    * @throws ServiceSpecificException in case of failure, with an error code indicating the
    *         cause of the failure.
    */
    public void setChildChain(final int childChain, final boolean enable) {
        final int err = native_setChildChain(childChain, enable);
        if (err != 0) {
            throw new ServiceSpecificException(-err, "Unable to set child chain: "
                            + Os.strerror(-err));
        }
    }

    /**
     * Replaces the contents of the specified UID-based firewall chain.
     *
     * The chain may be an allowlist chain or a denylist chain. A denylist chain contains DROP
     * rules for the specified UIDs and a RETURN rule at the end. An allowlist chain contains RETURN
     * rules for the system UID range (0 to {@code UID_APP} - 1), RETURN rules for for the specified
     * UIDs, and a DROP rule at the end. The chain will be created if it does not exist.
     *
     * @param chainName The name of the chain to replace.
     * @param isAllowlist Whether this is an allowlist or denylist chain.
     * @param uids The list of UIDs to allow/deny.
     * @return true if the chain was successfully replaced, false otherwise.
     */
    public int replaceUidChain(final String chainName, final boolean isAllowlist,
            final int[] uids) {
        final int err = native_replaceUidChain(chainName, isAllowlist, uids);
        if (err != 0) {
            Log.e(TAG, "replaceUidChain failed: " + Os.strerror(-err));
        }
        return -err;
    }

   /**
    * Set firewall rule for uid
    *
    * @param childChain target chain
    * @param uid uid to allow/deny
    * @param firewallRule either FIREWALL_RULE_ALLOW or FIREWALL_RULE_DENY
    * @throws ServiceSpecificException in case of failure, with an error code indicating the
    *         cause of the failure.
    */
    public void setUidRule(final int childChain, final int uid,
            final int firewallRule) {
        final int err = native_setUidRule(childChain, uid, firewallRule);
        if (err != 0) {
            throw new ServiceSpecificException(-err, "Unable to set uid rule: "
                            + Os.strerror(-err));
        }
    }

    /**
     * Add ingress interface filtering rules to a list of UIDs
     *
     * For a given uid, once a filtering rule is added, the kernel will only allow packets from the
     * allowed interface and loopback to be sent to the list of UIDs.
     *
     * Calling this method on one or more UIDs with an existing filtering rule but a different
     * interface name will result in the filtering rule being updated to allow the new interface
     * instead. Otherwise calling this method will not affect existing rules set on other UIDs.
     *
     * @param ifName the name of the interface on which the filtering rules will allow packets to
              be received.
     * @param uids an array of UIDs which the filtering rules will be set
     * @throws ServiceSpecificException in case of failure, with an error code indicating the
     *         cause of the failure.
     */
    public void addUidInterfaceRules(final String ifName, final int[] uids) {
        final int err = native_addUidInterfaceRules(ifName, uids);
        if (err != 0) {
            throw new ServiceSpecificException(-err, "Unable to add uid interface rules: "
                            + Os.strerror(-err));
        }
    }

    /**
     * Remove ingress interface filtering rules from a list of UIDs
     *
     * Clear the ingress interface filtering rules from the list of UIDs which were previously set
     * by addUidInterfaceRules(). Ignore any uid which does not have filtering rule.
     *
     * @param uids an array of UIDs from which the filtering rules will be removed
     * @throws ServiceSpecificException in case of failure, with an error code indicating the
     *         cause of the failure.
     */
    public void removeUidInterfaceRules(final int[] uids) {
        final int err = native_removeUidInterfaceRules(uids);
        if (err != 0) {
            throw new ServiceSpecificException(-err, "Unable to remove uid interface rules: "
                            + Os.strerror(-err));
        }
    }

   /**
    * Request netd to change the current active network stats map.
    * @throws ServiceSpecificException in case of failure, with an error code indicating the
    *         cause of the failure.
    */
    public void swapActiveStatsMap() {
        final int err = native_swapActiveStatsMap();
        if (err != 0) {
            throw new ServiceSpecificException(-err, "Unable to swap active stats map: "
                            + Os.strerror(-err));
        }
    }

   /**
    * Assigns android.permission.INTERNET and/or android.permission.UPDATE_DEVICE_STATS to the uids
    * specified. Or remove all permissions from the uids.
    *
    * @param permission The permission to grant, it could be either PERMISSION_INTERNET and/or
    *                   PERMISSION_UPDATE_DEVICE_STATS. If the permission is NO_PERMISSIONS, then
    *                   revoke all permissions for the uids.
    * @param uids uid of users to grant permission
    */
    public void setNetPermForUids(final int permission, final int[] uids) {
        native_setPermissionForUids(permission, uids);
    }

    /**
     * Set counter set for uid
     *
     * @param counterSet either SET_DEFAULT or SET_FOREGROUND
     * @param uid uid to foreground/background
     */
    public int setCounterSet(final int counterSet, final int uid) {
        final int err = native_setCounterSet(counterSet, uid);
        if (err != 0) {
            Log.e(TAG, "setCounterSet failed: " + Os.strerror(-err));
        }
        return -err;
    }

    /**
     * Reset Uid stats
     * @param tag default 0
     * @param uid given uid to be clear
     */
    public int deleteTagData(final int tag, final int uid) {
        final int err = native_deleteTagData(tag, uid);
        if (err != 0) {
            Log.e(TAG, "deleteTagData failed: " + Os.strerror(-err));
        }
        return -err;
    }

    private native int native_addNaughtyApp(int uid);
    private native int native_removeNaughtyApp(int uid);
    private native int native_addNiceApp(int uid);
    private native int native_removeNiceApp(int uid);
    private native int native_setChildChain(int childChain, boolean enable);
    private native int native_replaceUidChain(String name, boolean isAllowlist, int[] uids);
    private native int native_setUidRule(int childChain, int uid, int firewallRule);
    private native int native_addUidInterfaceRules(String ifName, int[] uids);
    private native int native_removeUidInterfaceRules(int[] uids);
    private native int native_swapActiveStatsMap();
    private native void native_setPermissionForUids(int permission, int[] uids);
    private native int native_setCounterSet(int counterSet, int uid);
    private native int native_deleteTagData(int tag, int uid);
}