DPM changes to support remote bugreports
Bug: 22860136
Change-Id: If984318e421f511d9b0fc7138aacd36d5334698f
diff --git a/core/java/android/app/admin/DeviceAdminReceiver.java b/core/java/android/app/admin/DeviceAdminReceiver.java
index 84b6d39..1c4dcf7 100644
--- a/core/java/android/app/admin/DeviceAdminReceiver.java
+++ b/core/java/android/app/admin/DeviceAdminReceiver.java
@@ -17,6 +17,7 @@
package android.app.admin;
import android.accounts.AccountManager;
+import android.annotation.IntDef;
import android.annotation.SdkConstant;
import android.annotation.SdkConstant.SdkConstantType;
import android.annotation.SystemApi;
@@ -29,6 +30,9 @@
import android.os.Bundle;
import android.security.KeyChain;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
/**
* Base class for implementing a device administration component. This
* class provides a convenience for interpreting the raw intent actions
@@ -227,6 +231,75 @@
public static final String ACTION_PROFILE_PROVISIONING_COMPLETE =
"android.app.action.PROFILE_PROVISIONING_COMPLETE";
+ /**
+ * Action sent to a device administrator to notify that the device user
+ * has declined sharing a bugreport.
+ *
+ * <p>The calling device admin must be the device owner to receive this broadcast.
+ * @see DevicePolicyManager#requestBugreport
+ * @hide
+ */
+ @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
+ public static final String ACTION_BUGREPORT_SHARING_DECLINED =
+ "android.app.action.BUGREPORT_SHARING_DECLINED";
+
+ /**
+ * Action sent to a device administrator to notify that the collection of a bugreport
+ * has failed.
+ *
+ * <p>The calling device admin must be the device owner to receive this broadcast.
+ * @see DevicePolicyManager#requestBugreport
+ * @hide
+ */
+ @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
+ public static final String ACTION_BUGREPORT_FAILED = "android.app.action.BUGREPORT_FAILED";
+
+ /**
+ * Action sent to a device administrator to share the bugreport.
+ *
+ * <p>The calling device admin must be the device owner to receive this broadcast.
+ * @see DevicePolicyManager#requestBugreport
+ * @hide
+ */
+ @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
+ public static final String ACTION_BUGREPORT_SHARE =
+ "android.app.action.BUGREPORT_SHARE";
+
+ /**
+ * A string containing the SHA-256 hash of the bugreport file.
+ *
+ * @see #ACTION_BUGREPORT_SHARE
+ * @hide
+ */
+ public static final String EXTRA_BUGREPORT_HASH = "android.app.extra.BUGREPORT_HASH";
+
+ /**
+ * An {@code int} failure code representing the reason of the bugreport failure.
+ *
+ * @see #ACTION_BUGREPORT_FAILED
+ * @see #BUGREPORT_FAILURE_FAILED_COMPLETING, #BUGREPORT_FAILURE_FILE_NO_LONGER_AVAILABLE
+ * @hide
+ */
+ public static final String EXTRA_BUGREPORT_FAILURE_REASON =
+ "android.app.extra.BUGREPORT_FAILURE_REASON";
+
+ @Retention(RetentionPolicy.SOURCE)
+ @IntDef({
+ BUGREPORT_FAILURE_FAILED_COMPLETING,
+ BUGREPORT_FAILURE_FILE_NO_LONGER_AVAILABLE
+ })
+ /**
+ * An interface representing reason of bugreport failure.
+ *
+ * @see #EXTRA_BUGREPORT_FAILURE_REASON
+ * @hide
+ */
+ public @interface BugreportFailureCode {}
+ /** Bugreport completion process failed. */
+ public static final int BUGREPORT_FAILURE_FAILED_COMPLETING = 0;
+ /** Bugreport is no longer available for collection. */
+ public static final int BUGREPORT_FAILURE_FILE_NO_LONGER_AVAILABLE = 1;
+
/** @hide */
public static final String ACTION_CHOOSE_PRIVATE_KEY_ALIAS = "android.app.action.CHOOSE_PRIVATE_KEY_ALIAS";
@@ -482,6 +555,48 @@
}
/**
+ * Called when sharing a bugreport has been cancelled by the user of the device.
+ *
+ * <p>This callback is only applicable to device owners.
+ *
+ * @param context The running context as per {@link #onReceive}.
+ * @param intent The received intent as per {@link #onReceive}.
+ * @see DevicePolicyManager#requestBugreport
+ */
+ public void onBugreportSharingDeclined(Context context, Intent intent) {
+ }
+
+ /**
+ * Called when the bugreport has been shared with the device administrator app.
+ *
+ * <p>This callback is only applicable to device owners.
+ *
+ * @param context The running context as per {@link #onReceive}.
+ * @param intent The received intent as per {@link #onReceive}. Contains the URI of
+ * the bugreport file (with MIME type "application/vnd.android.bugreport"), that can be accessed
+ * by calling {@link Intent#getData()}
+ * @param bugreportHash SHA-256 hash of the bugreport file.
+ * @see DevicePolicyManager#requestBugreport
+ */
+ public void onBugreportShared(Context context, Intent intent, String bugreportHash) {
+ }
+
+ /**
+ * Called when the bugreport collection flow has failed.
+ *
+ * <p>This callback is only applicable to device owners.
+ *
+ * @param context The running context as per {@link #onReceive}.
+ * @param intent The received intent as per {@link #onReceive}.
+ * @param failureCode int containing failure code. One of
+ * #BUGREPORT_FAILURE_FAILED_COMPLETING or #BUGREPORT_FAILURE_FILE_NO_LONGER_AVAILABLE
+ * @see DevicePolicyManager#requestBugreport
+ */
+ public void onBugreportFailed(Context context, Intent intent,
+ @BugreportFailureCode int failureCode) {
+ }
+
+ /**
* Intercept standard device administrator broadcasts. Implementations
* should not override this method; it is better to implement the
* convenience callbacks for each action.
@@ -524,6 +639,15 @@
} else if (ACTION_NOTIFY_PENDING_SYSTEM_UPDATE.equals(action)) {
long receivedTime = intent.getLongExtra(EXTRA_SYSTEM_UPDATE_RECEIVED_TIME, -1);
onSystemUpdatePending(context, intent, receivedTime);
+ } else if (ACTION_BUGREPORT_SHARING_DECLINED.equals(action)) {
+ onBugreportSharingDeclined(context, intent);
+ } else if (ACTION_BUGREPORT_SHARE.equals(action)) {
+ String bugreportFileHash = intent.getStringExtra(EXTRA_BUGREPORT_HASH);
+ onBugreportShared(context, intent, bugreportFileHash);
+ } else if (ACTION_BUGREPORT_FAILED.equals(action)) {
+ int failureCode = intent.getIntExtra(EXTRA_BUGREPORT_FAILURE_REASON,
+ BUGREPORT_FAILURE_FAILED_COMPLETING);
+ onBugreportFailed(context, intent, failureCode);
}
}
}
diff --git a/core/java/android/app/admin/DevicePolicyManager.java b/core/java/android/app/admin/DevicePolicyManager.java
index bebc8cf..ca5a923 100644
--- a/core/java/android/app/admin/DevicePolicyManager.java
+++ b/core/java/android/app/admin/DevicePolicyManager.java
@@ -2497,6 +2497,28 @@
}
/**
+ * Called by a device owner to request a bugreport.
+ *
+ * <p>There must be only one user on the device, managed by the device owner.
+ * Otherwise a security exception will be thrown.
+ *
+ * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
+ * @return {@code true} if the bugreport collection started successfully, or {@code false}
+ * if it wasn't triggered because a previous bugreport operation is still active
+ * (either the bugreport is still running or waiting for the user to share or decline)
+ */
+ public boolean requestBugreport(@NonNull ComponentName admin) {
+ if (mService != null) {
+ try {
+ return mService.requestBugreport(admin);
+ } catch (RemoteException e) {
+ Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
+ }
+ }
+ return false;
+ }
+
+ /**
* Determine whether or not creating a guest user has been disabled for the device
*
* @hide
diff --git a/core/java/android/app/admin/IDevicePolicyManager.aidl b/core/java/android/app/admin/IDevicePolicyManager.aidl
index 995ce00..2f33bb5 100644
--- a/core/java/android/app/admin/IDevicePolicyManager.aidl
+++ b/core/java/android/app/admin/IDevicePolicyManager.aidl
@@ -91,6 +91,8 @@
boolean getStorageEncryption(in ComponentName who, int userHandle);
int getStorageEncryptionStatus(int userHandle);
+ boolean requestBugreport(in ComponentName who);
+
void setCameraDisabled(in ComponentName who, boolean disabled);
boolean getCameraDisabled(in ComponentName who, int userHandle);
diff --git a/core/res/AndroidManifest.xml b/core/res/AndroidManifest.xml
index b02de0e..ea3c60c 100644
--- a/core/res/AndroidManifest.xml
+++ b/core/res/AndroidManifest.xml
@@ -94,6 +94,10 @@
<protected-broadcast android:name="android.app.action.EXIT_DESK_MODE" />
<protected-broadcast android:name="android.app.action.NEXT_ALARM_CLOCK_CHANGED" />
+ <protected-broadcast android:name="android.app.action.BUGREPORT_SHARING_DECLINED" />
+ <protected-broadcast android:name="android.app.action.BUGREPORT_FAILED" />
+ <protected-broadcast android:name="android.app.action.BUGREPORT_SHARE" />
+
<protected-broadcast android:name="android.appwidget.action.APPWIDGET_UPDATE_OPTIONS" />
<protected-broadcast android:name="android.appwidget.action.APPWIDGET_DELETED" />
<protected-broadcast android:name="android.appwidget.action.APPWIDGET_DISABLED" />
@@ -249,6 +253,8 @@
<protected-broadcast android:name="com.android.server.WifiManager.action.START_SCAN" />
<protected-broadcast android:name="com.android.server.WifiManager.action.START_PNO" />
<protected-broadcast android:name="com.android.server.WifiManager.action.DELAYED_DRIVER_STOP" />
+ <protected-broadcast android:name="com.android.server.action.REMOTE_BUGREPORT_SHARING_ACCEPTED" />
+ <protected-broadcast android:name="com.android.server.action.REMOTE_BUGREPORT_SHARING_DECLINED" />
<protected-broadcast android:name="android.net.wifi.WIFI_STATE_CHANGED" />
<protected-broadcast android:name="android.net.wifi.WIFI_AP_STATE_CHANGED" />
<protected-broadcast android:name="android.net.wifi.WIFI_CREDENTIAL_CHANGED" />
diff --git a/core/res/res/values/strings.xml b/core/res/res/values/strings.xml
index 997371e..96285ab 100644
--- a/core/res/res/values/strings.xml
+++ b/core/res/res/values/strings.xml
@@ -2899,6 +2899,25 @@
<!-- Message of notification shown when ADB is actively connected to the phone. -->
<string name="adb_active_notification_message">Touch to disable USB debugging.</string>
+ <!-- Title of notification shown to ask for user consent for sharing a bugreport that was requested remotely by the IT administrator. STOPSHIP: this is not final -->
+ <string name="share_remote_bugreport_notification_title">Remote bugreport request</string>
+ <!-- Ticker of notification shown to ask for user consent for sharing a bugreport that was requested remotely by the IT administrator. STOPSHIP: this is not final -->
+ <string name="share_remote_bugreport_notification_ticker">Remote bugreport request</string>
+ <!-- Message of notification shown to ask for user consent for sharing a bugreport that was requested remotely by the IT administrator. STOPSHIP: this is not final -->
+ <string name="share_remote_bugreport_notification_message">Your IT admin requested remote bugreport to carry out incident investigation</string>
+ <!-- Title of notification shown for remote bugreport progress. STOPSHIP: this is not final -->
+ <string name="remote_bugreport_progress_notification_title">Remote bugreport</string>
+ <!-- Ticker of notification shown for remote bugreport progress. STOPSHIP: this is not final -->
+ <string name="remote_bugreport_progress_notification_ticker">Remote bugreport collection in progress</string>
+ <!-- Message of notification shown for remote bugreport progress. User can cancel the bugreport STOPSHIP: this is not final -->
+ <string name="remote_bugreport_progress_notification_message_can_cancel">Remote bugreport in progress. Touch to cancel.</string>
+ <!-- Message of notification shown for remote bugreport progress. User cannot cancel the bugreport STOPSHIP: this is not final -->
+ <string name="remote_bugreport_progress_notification_message_cannot_cancel">Remote bugreport in progress.</string>
+ <!-- Acceptance label of notification shown to ask for user consent for sharing the remote bugreport. STOPSHIP: this is not final -->
+ <string name="share_remote_bugreport_notification_accept">ACCEPT</string>
+ <!-- Decline label of notification shown to ask for user consent for sharing the remote bugreport. STOPSHIP: this is not final -->
+ <string name="share_remote_bugreport_notification_decline">DECLINE</string>
+
<!-- Used to replace %s in urls retreived from the signin server with locales. For Some -->
<!-- devices we don't support all the locales we ship to and need to replace the '%s' with a -->
<!-- locale string based on mcc values. By default (0-length string) we don't replace the %s -->
diff --git a/core/res/res/values/symbols.xml b/core/res/res/values/symbols.xml
index a3021cb..55f704c 100644
--- a/core/res/res/values/symbols.xml
+++ b/core/res/res/values/symbols.xml
@@ -1763,6 +1763,15 @@
<java-symbol type="string" name="accessibility_binding_label" />
<java-symbol type="string" name="adb_active_notification_message" />
<java-symbol type="string" name="adb_active_notification_title" />
+ <java-symbol type="string" name="share_remote_bugreport_notification_title" />
+ <java-symbol type="string" name="share_remote_bugreport_notification_ticker" />
+ <java-symbol type="string" name="share_remote_bugreport_notification_message" />
+ <java-symbol type="string" name="remote_bugreport_progress_notification_title" />
+ <java-symbol type="string" name="remote_bugreport_progress_notification_ticker" />
+ <java-symbol type="string" name="remote_bugreport_progress_notification_message_can_cancel" />
+ <java-symbol type="string" name="remote_bugreport_progress_notification_message_cannot_cancel" />
+ <java-symbol type="string" name="share_remote_bugreport_notification_accept" />
+ <java-symbol type="string" name="share_remote_bugreport_notification_decline" />
<java-symbol type="string" name="aerr_application" />
<java-symbol type="string" name="aerr_process" />
<java-symbol type="string" name="aerr_process_silence" />