Merge "DPM API to set the SSID restriction list" (11bd34ce) · Commits · e / os / android_frameworks_base

core/api/current.txt

+14 −0

Original line number	Original line	Diff line number	Diff line
	@@ -7356,6 +7356,7 @@ package android.app.admin {
	method @NonNull public java.util.List<java.lang.String> getUserControlDisabledPackages(@NonNull android.content.ComponentName);		method @NonNull public java.util.List<java.lang.String> getUserControlDisabledPackages(@NonNull android.content.ComponentName);
	method @NonNull public android.os.Bundle getUserRestrictions(@NonNull android.content.ComponentName);		method @NonNull public android.os.Bundle getUserRestrictions(@NonNull android.content.ComponentName);
	method @Nullable public String getWifiMacAddress(@NonNull android.content.ComponentName);		method @Nullable public String getWifiMacAddress(@NonNull android.content.ComponentName);
			method @Nullable public android.app.admin.WifiSsidPolicy getWifiSsidPolicy();
	method public boolean grantKeyPairToApp(@Nullable android.content.ComponentName, @NonNull String, @NonNull String);		method public boolean grantKeyPairToApp(@Nullable android.content.ComponentName, @NonNull String, @NonNull String);
	method public boolean grantKeyPairToWifiAuth(@NonNull String);		method public boolean grantKeyPairToWifiAuth(@NonNull String);
	method public boolean hasCaCertInstalled(@Nullable android.content.ComponentName, byte[]);		method public boolean hasCaCertInstalled(@Nullable android.content.ComponentName, byte[]);
	@@ -7509,6 +7510,7 @@ package android.app.admin {
	method public void setUsbDataSignalingEnabled(boolean);		method public void setUsbDataSignalingEnabled(boolean);
	method public void setUserControlDisabledPackages(@NonNull android.content.ComponentName, @NonNull java.util.List<java.lang.String>);		method public void setUserControlDisabledPackages(@NonNull android.content.ComponentName, @NonNull java.util.List<java.lang.String>);
	method public void setUserIcon(@NonNull android.content.ComponentName, android.graphics.Bitmap);		method public void setUserIcon(@NonNull android.content.ComponentName, android.graphics.Bitmap);
			method public void setWifiSsidPolicy(@Nullable android.app.admin.WifiSsidPolicy);
	method public int startUserInBackground(@NonNull android.content.ComponentName, @NonNull android.os.UserHandle);		method public int startUserInBackground(@NonNull android.content.ComponentName, @NonNull android.os.UserHandle);
	method public int stopUser(@NonNull android.content.ComponentName, @NonNull android.os.UserHandle);		method public int stopUser(@NonNull android.content.ComponentName, @NonNull android.os.UserHandle);
	method public boolean switchUser(@NonNull android.content.ComponentName, @Nullable android.os.UserHandle);		method public boolean switchUser(@NonNull android.content.ComponentName, @Nullable android.os.UserHandle);
	@@ -7870,6 +7872,18 @@ package android.app.admin {
	field @NonNull public static final android.os.Parcelable.Creator<android.app.admin.UnsafeStateException> CREATOR;		field @NonNull public static final android.os.Parcelable.Creator<android.app.admin.UnsafeStateException> CREATOR;
	}		}

			public final class WifiSsidPolicy implements android.os.Parcelable {
			method @NonNull public static android.app.admin.WifiSsidPolicy createAllowlistPolicy(@NonNull java.util.Set<java.lang.String>);
			method @NonNull public static android.app.admin.WifiSsidPolicy createDenylistPolicy(@NonNull java.util.Set<java.lang.String>);
			method public int describeContents();
			method public int getPolicyType();
			method @NonNull public java.util.Set<java.lang.String> getSsids();
			method public void writeToParcel(@NonNull android.os.Parcel, int);
			field @NonNull public static final android.os.Parcelable.Creator<android.app.admin.WifiSsidPolicy> CREATOR;
			field public static final int WIFI_SSID_POLICY_TYPE_ALLOWLIST = 0; // 0x0
			field public static final int WIFI_SSID_POLICY_TYPE_DENYLIST = 1; // 0x1
			}

	}		}

	package android.app.assist {		package android.app.assist {

core/java/android/app/admin/DevicePolicyManager.java

+60 −0

Original line number	Original line	Diff line number	Diff line
	@@ -14670,6 +14670,66 @@ public class DevicePolicyManager {
	}		}
	}		}

			/**
			* Called by device owner or profile owner of an organization-owned managed profile to
			* specify the Wi-Fi SSID policy ({@link WifiSsidPolicy}).
			* Wi-Fi SSID policy specifies the SSID restriction the network must satisfy
			* in order to be eligible for a connection. Providing a null policy results in the
			* deactivation of the SSID restriction
			*
			* @param policy Wi-Fi SSID policy
			* @throws SecurityException if the caller is not a device owner or a profile owner on
			* an organization-owned managed profile.
			*/
			public void setWifiSsidPolicy(@Nullable WifiSsidPolicy policy) {
			throwIfParentInstance("setWifiSsidPolicy");
			if (mService != null) {
			try {
			if (policy == null) {
			mService.setSsidAllowlist(new ArrayList<>());
			} else {
			int policyType = policy.getPolicyType();
			if (policyType == WifiSsidPolicy.WIFI_SSID_POLICY_TYPE_ALLOWLIST) {
			mService.setSsidAllowlist(new ArrayList<>(policy.getSsids()));
			} else {
			mService.setSsidDenylist(new ArrayList<>(policy.getSsids()));
			}
			}
			} catch (RemoteException e) {
			throw e.rethrowFromSystemServer();
			}
			}
			}

			/**
			* Returns the current Wi-Fi SSID policy.
			* If the policy has not been set, it will return NULL.
			*
			* @see #setWifiSsidPolicy(WifiSsidPolicy)
			* @throws SecurityException if the caller is not a device owner or a profile owner on
			* an organization-owned managed profile or a system app.
			*/
			@Nullable
			public WifiSsidPolicy getWifiSsidPolicy() {
			throwIfParentInstance("getWifiSsidPolicy");
			if (mService == null) {
			return null;
			}
			try {
			List<String> allowlist = mService.getSsidAllowlist();
			if (!allowlist.isEmpty()) {
			return WifiSsidPolicy.createAllowlistPolicy(new ArraySet<>(allowlist));
			}
			List<String> denylist = mService.getSsidDenylist();
			if (!denylist.isEmpty()) {
			return WifiSsidPolicy.createDenylistPolicy(new ArraySet<>(denylist));
			}
			} catch (RemoteException e) {
			throw e.rethrowFromSystemServer();
			}
			return null;
			}

	/**		/**
	* For each {@link DevicePolicyDrawableResource} item in {@code drawables}, if		* For each {@link DevicePolicyDrawableResource} item in {@code drawables}, if
	* {@link DevicePolicyDrawableResource#getDrawableSource()} is not set or is set to		* {@link DevicePolicyDrawableResource#getDrawableSource()} is not set or is set to

core/java/android/app/admin/IDevicePolicyManager.aidl

+5 −0

Original line number	Original line	Diff line number	Diff line
	@@ -536,6 +536,11 @@ interface IDevicePolicyManager {
	void setMinimumRequiredWifiSecurityLevel(int level);		void setMinimumRequiredWifiSecurityLevel(int level);
	int getMinimumRequiredWifiSecurityLevel();		int getMinimumRequiredWifiSecurityLevel();

			void setSsidAllowlist(in List<String> ssids);
			List<String> getSsidAllowlist();
			void setSsidDenylist(in List<String> ssids);
			List<String> getSsidDenylist();

	List<UserHandle> listForegroundAffiliatedUsers();		List<UserHandle> listForegroundAffiliatedUsers();
	void setDrawables(in List<DevicePolicyDrawableResource> drawables);		void setDrawables(in List<DevicePolicyDrawableResource> drawables);
	void resetDrawables(in int[] drawableIds);		void resetDrawables(in int[] drawableIds);

core/java/android/app/admin/WifiSsidPolicy.java

0 → 100644

+153 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* 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 android.app.admin;

			import android.annotation.IntDef;
			import android.annotation.NonNull;
			import android.os.Parcel;
			import android.os.Parcelable;
			import android.util.ArraySet;

			import java.lang.annotation.Retention;
			import java.lang.annotation.RetentionPolicy;
			import java.util.Set;

			/**
			* Used to indicate the Wi-Fi SSID restriction policy the network must satisfy
			* in order to be eligible for a connection.
			*
			* If the policy type is a denylist, the device may not connect to networks on the denylist.
			* If the policy type is an allowlist, the device may only connect to networks on the allowlist.
			* Admin configured networks are not exempt from this restriction.
			* This policy only prohibits connecting to a restricted network and
			* does not affect adding a restricted network.
			* If the current network is present in the denylist or not present in the allowlist,
			* it will be disconnected.
			*/
			public final class WifiSsidPolicy implements Parcelable {
			/**
			* SSID policy type indicator for {@link WifiSsidPolicy}.
			*
			* <p> When returned from {@link WifiSsidPolicy#getPolicyType()}, the constant
			* indicates that the SSID policy type is an allowlist.
			*
			* @see #WIFI_SSID_POLICY_TYPE_DENYLIST
			*/
			public static final int WIFI_SSID_POLICY_TYPE_ALLOWLIST = 0;

			/**
			* SSID policy type indicator for {@link WifiSsidPolicy}.
			*
			* <p> When returned from {@link WifiSsidPolicy#getPolicyType()}, the constant
			* indicates that the SSID policy type is a denylist.
			*
			* @see #WIFI_SSID_POLICY_TYPE_ALLOWLIST
			*/
			public static final int WIFI_SSID_POLICY_TYPE_DENYLIST = 1;

			/**
			* Possible SSID policy types
			*
			* @hide */
			@Retention(RetentionPolicy.SOURCE)
			@IntDef(prefix = {"WIFI_SSID_POLICY_TYPE_"}, value = {
			WIFI_SSID_POLICY_TYPE_ALLOWLIST,
			WIFI_SSID_POLICY_TYPE_DENYLIST})
			public @interface WifiSsidPolicyType {}

			private @WifiSsidPolicyType int mPolicyType;
			private ArraySet<String> mSsids;

			private WifiSsidPolicy(@WifiSsidPolicyType int policyType, @NonNull Set<String> ssids) {
			mPolicyType = policyType;
			mSsids = new ArraySet<>(ssids);
			}

			private WifiSsidPolicy(Parcel in) {
			mPolicyType = in.readInt();
			mSsids = (ArraySet<String>) in.readArraySet(null);
			}
			/**
			* Create the allowlist Wi-Fi SSID Policy.
			*
			* @param ssids allowlist of SSIDs in UTF-8 without double quotes format
			* @throws IllegalArgumentException if the input ssids list is empty
			*/
			@NonNull
			public static WifiSsidPolicy createAllowlistPolicy(@NonNull Set<String> ssids) {
			if (ssids.isEmpty()) {
			throw new IllegalArgumentException("SSID list cannot be empty");
			}
			return new WifiSsidPolicy(WIFI_SSID_POLICY_TYPE_ALLOWLIST, ssids);
			}

			/**
			* Create the denylist Wi-Fi SSID Policy.
			*
			* @param ssids denylist of SSIDs in UTF-8 without double quotes format
			* @throws IllegalArgumentException if the input ssids list is empty
			*/
			@NonNull
			public static WifiSsidPolicy createDenylistPolicy(@NonNull Set<String> ssids) {
			if (ssids.isEmpty()) {
			throw new IllegalArgumentException("SSID list cannot be empty");
			}
			return new WifiSsidPolicy(WIFI_SSID_POLICY_TYPE_DENYLIST, ssids);
			}

			/**
			* Returns the set of SSIDs in UTF-8 without double quotes format.
			*/
			@NonNull
			public Set<String> getSsids() {
			return mSsids;
			}

			/**
			* Returns the policy type.
			*/
			public @WifiSsidPolicyType int getPolicyType() {
			return mPolicyType;
			}

			/**
			* @see Parcelable.Creator
			*/
			@NonNull
			public static final Creator<WifiSsidPolicy> CREATOR = new Creator<WifiSsidPolicy>() {
			@Override
			public WifiSsidPolicy createFromParcel(Parcel source) {
			return new WifiSsidPolicy(source);
			}

			@Override
			public WifiSsidPolicy[] newArray(int size) {
			return new WifiSsidPolicy[size];
			}
			};

			@Override
			public void writeToParcel(@NonNull Parcel dest, int flags) {
			dest.writeInt(mPolicyType);
			dest.writeArraySet(mSsids);
			}

			@Override
			public int describeContents() {
			return 0;
			}
			}

services/devicepolicy/java/com/android/server/devicepolicy/ActiveAdmin.java

+29 −0

Original line number	Original line	Diff line number	Diff line
	@@ -146,6 +146,9 @@ class ActiveAdmin {
	"preferential-network-service-enabled";		"preferential-network-service-enabled";
	private static final String TAG_USB_DATA_SIGNALING = "usb-data-signaling";		private static final String TAG_USB_DATA_SIGNALING = "usb-data-signaling";
	private static final String TAG_WIFI_MIN_SECURITY = "wifi-min-security";		private static final String TAG_WIFI_MIN_SECURITY = "wifi-min-security";
			private static final String TAG_SSID_ALLOWLIST = "ssid-allowlist";
			private static final String TAG_SSID_DENYLIST = "ssid-denylist";
			private static final String TAG_SSID = "ssid";
	private static final String ATTR_VALUE = "value";		private static final String ATTR_VALUE = "value";
	private static final String ATTR_LAST_NETWORK_LOGGING_NOTIFICATION = "last-notification";		private static final String ATTR_LAST_NETWORK_LOGGING_NOTIFICATION = "last-notification";
	private static final String ATTR_NUM_NETWORK_LOGGING_NOTIFICATIONS = "num-notifications";		private static final String ATTR_NUM_NETWORK_LOGGING_NOTIFICATIONS = "num-notifications";
	@@ -238,6 +241,14 @@ class ActiveAdmin {
	// List of package names to keep cached.		// List of package names to keep cached.
	List<String> keepUninstalledPackages;		List<String> keepUninstalledPackages;

			// The allowlist of SSIDs the device may connect to.
			// By default, the allowlist restriction is deactivated.
			List<String> mSsidAllowlist;

			// The denylist of SSIDs the device may not connect to.
			// By default, the denylist restriction is deactivated.
			List<String> mSsidDenylist;

	// TODO: review implementation decisions with frameworks team		// TODO: review implementation decisions with frameworks team
	boolean specifiesGlobalProxy = false;		boolean specifiesGlobalProxy = false;
	String globalProxySpec = null;		String globalProxySpec = null;
	@@ -580,6 +591,12 @@ class ActiveAdmin {
	if (mWifiMinimumSecurityLevel != DevicePolicyManager.WIFI_SECURITY_OPEN) {		if (mWifiMinimumSecurityLevel != DevicePolicyManager.WIFI_SECURITY_OPEN) {
	writeAttributeValueToXml(out, TAG_WIFI_MIN_SECURITY, mWifiMinimumSecurityLevel);		writeAttributeValueToXml(out, TAG_WIFI_MIN_SECURITY, mWifiMinimumSecurityLevel);
	}		}
			if (mSsidAllowlist != null && !mSsidAllowlist.isEmpty()) {
			writeAttributeValuesToXml(out, TAG_SSID_ALLOWLIST, TAG_SSID, mSsidAllowlist);
			}
			if (mSsidDenylist != null && !mSsidDenylist.isEmpty()) {
			writeAttributeValuesToXml(out, TAG_SSID_DENYLIST, TAG_SSID, mSsidDenylist);
			}
	}		}

	void writeTextToXml(TypedXmlSerializer out, String tag, String text) throws IOException {		void writeTextToXml(TypedXmlSerializer out, String tag, String text) throws IOException {
	@@ -834,6 +851,12 @@ class ActiveAdmin {
	USB_DATA_SIGNALING_ENABLED_DEFAULT);		USB_DATA_SIGNALING_ENABLED_DEFAULT);
	} else if (TAG_WIFI_MIN_SECURITY.equals(tag)) {		} else if (TAG_WIFI_MIN_SECURITY.equals(tag)) {
	mWifiMinimumSecurityLevel = parser.getAttributeInt(null, ATTR_VALUE);		mWifiMinimumSecurityLevel = parser.getAttributeInt(null, ATTR_VALUE);
			} else if (TAG_SSID_ALLOWLIST.equals(tag)) {
			mSsidAllowlist = new ArrayList<>();
			readAttributeValues(parser, TAG_SSID, mSsidAllowlist);
			} else if (TAG_SSID_DENYLIST.equals(tag)) {
			mSsidDenylist = new ArrayList<>();
			readAttributeValues(parser, TAG_SSID, mSsidDenylist);
	} else {		} else {
	Slogf.w(LOG_TAG, "Unknown admin tag: %s", tag);		Slogf.w(LOG_TAG, "Unknown admin tag: %s", tag);
	XmlUtils.skipCurrentTag(parser);		XmlUtils.skipCurrentTag(parser);
	@@ -1195,5 +1218,11 @@ class ActiveAdmin {

	pw.print("mWifiMinimumSecurityLevel=");		pw.print("mWifiMinimumSecurityLevel=");
	pw.println(mWifiMinimumSecurityLevel);		pw.println(mWifiMinimumSecurityLevel);

			pw.print("mSsidAllowlist=");
			pw.println(mSsidAllowlist);

			pw.print("mSsidDenylist=");
			pw.println(mSsidDenylist);
	}		}
	}		}