Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f7f67dc5 authored by yuemingw's avatar yuemingw
Browse files

Add a new WipeData API that allows an input string for the reason to wipe user. 

Test: bit FrameworksServicesTests:com.android.server.devicepolicy.DevicePolicyManagerTest

Fix: 31177807

Change-Id: I0b46f4d029d285d5018875f03285551f6b822376
parent 466df70c

api/current.txt

+1 −0
Original line number Diff line number Diff line
@@ -6449,6 +6449,7 @@ package android.app.admin { 
    method public void uninstallAllUserCaCerts(android.content.ComponentName);

    method public void uninstallCaCert(android.content.ComponentName, byte[]);

    method public void wipeData(int);

    method public void wipeDataWithReason(int, java.lang.CharSequence);

    field public static final java.lang.String ACTION_ADD_DEVICE_ADMIN = "android.app.action.ADD_DEVICE_ADMIN";

    field public static final java.lang.String ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED = "android.app.action.APPLICATION_DELEGATION_SCOPES_CHANGED";

    field public static final java.lang.String ACTION_DEVICE_ADMIN_SERVICE = "android.app.action.DEVICE_ADMIN_SERVICE";

api/system-current.txt

+1 −0
Original line number Diff line number Diff line
@@ -6683,6 +6683,7 @@ package android.app.admin { 
    method public void uninstallAllUserCaCerts(android.content.ComponentName);

    method public void uninstallCaCert(android.content.ComponentName, byte[]);

    method public void wipeData(int);

    method public void wipeDataWithReason(int, java.lang.CharSequence);

    field public static final java.lang.String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED = "android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED";

    field public static final java.lang.String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED = "android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED";

    field public static final java.lang.String ACTION_ADD_DEVICE_ADMIN = "android.app.action.ADD_DEVICE_ADMIN";

api/test-current.txt

+1 −0
Original line number Diff line number Diff line
@@ -6517,6 +6517,7 @@ package android.app.admin { 
    method public void uninstallAllUserCaCerts(android.content.ComponentName);

    method public void uninstallCaCert(android.content.ComponentName, byte[]);

    method public void wipeData(int);

    method public void wipeDataWithReason(int, java.lang.CharSequence);

    field public static final java.lang.String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED = "android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED";

    field public static final java.lang.String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED = "android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED";

    field public static final java.lang.String ACTION_ADD_DEVICE_ADMIN = "android.app.action.ADD_DEVICE_ADMIN";

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

+42 −2
Original line number Diff line number Diff line
@@ -63,7 +63,9 @@ import android.telephony.TelephonyManager; 
import android.util.ArraySet;

import android.util.Log;



import com.android.internal.R;

import com.android.internal.annotations.VisibleForTesting;

import com.android.internal.util.Preconditions;

import com.android.org.conscrypt.TrustedCertificateStore;



import java.io.ByteArrayInputStream;
@@ -3142,6 +3144,7 @@ public class DevicePolicyManager { 
     */

    public static final int WIPE_EUICC = 0x0004;





    /**

     * Ask that all user data be wiped. If called as a secondary user, the user will be removed and

     * other users will remain unaffected. Calling from the primary user will cause the device to
@@ -3157,10 +3160,47 @@ public class DevicePolicyManager { 
     *             that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}

     */

    public void wipeData(int flags) {

        throwIfParentInstance("wipeData");

        final String wipeReasonForUser = mContext.getString(

                R.string.work_profile_deleted_description_dpm_wipe);

        wipeDataInternal(flags, wipeReasonForUser);

    }



    /**

     * Ask that all user data be wiped. If called as a secondary user, the user will be removed and

     * other users will remain unaffected, the provided reason for wiping data can be shown to

     * user. Calling from the primary user will cause the device to reboot, erasing all device data

     * - including all the secondary users and their data - while booting up. In this case, we don't

     * show the reason to the user since the device would be factory reset.

     * <p>

     * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to

     * be able to call this method; if it has not, a security exception will be thrown.

     *

     * @param flags Bit mask of additional options: currently supported flags are

     *            {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.

     * @param reason a string that contains the reason for wiping data, which can be

     *                          presented to the user.

     * @throws SecurityException if the calling application does not own an active administrator

     *             that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}

     * @throws IllegalArgumentException if the input reason string is null or empty.

     */

    public void wipeDataWithReason(int flags, @NonNull CharSequence reason) {

        Preconditions.checkNotNull(reason, "CharSequence is null");

        wipeDataInternal(flags, reason.toString());

    }



    /**

     * Internal function for both {@link #wipeData(int)} and

     * {@link #wipeDataWithReason(int, CharSequence)} to call.

     *

     * @see #wipeData(int)

     * @see #wipeDataWithReason(int, CharSequence)

     * @hide

     */

    private void wipeDataInternal(int flags, @NonNull String wipeReasonForUser) {

        throwIfParentInstance("wipeDataWithReason");

        if (mService != null) {

            try {

                mService.wipeData(flags);

                mService.wipeDataWithReason(flags, wipeReasonForUser);

            } catch (RemoteException e) {

                throw e.rethrowFromSystemServer();

            }

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

+1 −1
Original line number Diff line number Diff line
@@ -95,7 +95,7 @@ interface IDevicePolicyManager { 


    void lockNow(int flags, boolean parent);



    void wipeData(int flags);

    void wipeDataWithReason(int flags, String wipeReasonForUser);



    ComponentName setGlobalProxy(in ComponentName admin, String proxySpec, String exclusionList);

    ComponentName getGlobalProxyAdmin(int userHandle);