1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
|
/*
* Copyright (C) 2016 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.os;
import android.annotation.CallbackExecutor;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.RequiresPermission;
import android.annotation.SystemApi;
import android.annotation.SystemService;
import android.annotation.TestApi;
import android.content.Context;
import android.net.Uri;
import android.util.Slog;
import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Executor;
/**
* Class to take an incident report.
*
* @hide
*/
@SystemApi
@TestApi
@SystemService(Context.INCIDENT_SERVICE)
public class IncidentManager {
private static final String TAG = "IncidentManager";
/**
* Authority for pending report id urls.
*
* @hide
*/
public static final String URI_SCHEME = "content";
/**
* Authority for pending report id urls.
*
* @hide
*/
public static final String URI_AUTHORITY = "android.os.IncidentManager";
/**
* Authority for pending report id urls.
*
* @hide
*/
public static final String URI_PATH = "/pending";
/**
* Query parameter for the uris for the pending report id.
*
* @hide
*/
public static final String URI_PARAM_ID = "id";
/**
* Query parameter for the uris for the incident report id.
*
* @hide
*/
public static final String URI_PARAM_REPORT_ID = "r";
/**
* Query parameter for the uris for the pending report id.
*
* @hide
*/
public static final String URI_PARAM_CALLING_PACKAGE = "pkg";
/**
* Query parameter for the uris for the pending report id, in wall clock
* ({@link System.currentTimeMillis()}) timebase.
*
* @hide
*/
public static final String URI_PARAM_TIMESTAMP = "t";
/**
* Query parameter for the uris for the pending report id.
*
* @hide
*/
public static final String URI_PARAM_FLAGS = "flags";
/**
* Query parameter for the uris for the pending report id.
*
* @hide
*/
public static final String URI_PARAM_RECEIVER_CLASS = "receiver";
/**
* Do the confirmation with a dialog instead of the default, which is a notification.
* It is possible for the dialog to be downgraded to a notification in some cases.
*/
public static final int FLAG_CONFIRMATION_DIALOG = 0x1;
/**
* Flag marking fields and incident reports than can be taken
* off the device only via adb.
*/
public static final int PRIVACY_POLICY_LOCAL = 0;
/**
* Flag marking fields and incident reports than can be taken
* off the device with contemporary consent.
*/
public static final int PRIVACY_POLICY_EXPLICIT = 100;
/**
* Flag marking fields and incident reports than can be taken
* off the device with prior consent.
*/
public static final int PRIVACY_POLICY_AUTO = 200;
/** @hide */
@IntDef(flag = false, prefix = { "PRIVACY_POLICY_" }, value = {
PRIVACY_POLICY_AUTO,
PRIVACY_POLICY_EXPLICIT,
PRIVACY_POLICY_LOCAL,
})
@Retention(RetentionPolicy.SOURCE)
public @interface PrivacyPolicy {}
private final Context mContext;
private Object mLock = new Object();
private IIncidentManager mIncidentService;
private IIncidentCompanion mCompanionService;
/**
* Record for a report that has been taken and is pending user authorization
* to share it.
* @hide
*/
@SystemApi
@TestApi
public static class PendingReport {
/**
* Encoded data.
*/
private final Uri mUri;
/**
* URI_PARAM_FLAGS from the uri
*/
private final int mFlags;
/**
* URI_PARAM_CALLING_PACKAGE from the uri
*/
private final String mRequestingPackage;
/**
* URI_PARAM_TIMESTAMP from the uri
*/
private final long mTimestamp;
/**
* Constructor.
*/
public PendingReport(@NonNull Uri uri) {
int flags = 0;
try {
flags = Integer.parseInt(uri.getQueryParameter(URI_PARAM_FLAGS));
} catch (NumberFormatException ex) {
throw new RuntimeException("Invalid URI: No " + URI_PARAM_FLAGS
+ " parameter. " + uri);
}
mFlags = flags;
String requestingPackage = uri.getQueryParameter(URI_PARAM_CALLING_PACKAGE);
if (requestingPackage == null) {
throw new RuntimeException("Invalid URI: No " + URI_PARAM_CALLING_PACKAGE
+ " parameter. " + uri);
}
mRequestingPackage = requestingPackage;
long timestamp = -1;
try {
timestamp = Long.parseLong(uri.getQueryParameter(URI_PARAM_TIMESTAMP));
} catch (NumberFormatException ex) {
throw new RuntimeException("Invalid URI: No " + URI_PARAM_TIMESTAMP
+ " parameter. " + uri);
}
mTimestamp = timestamp;
mUri = uri;
}
/**
* Get the package with which this report will be shared.
*/
public @NonNull String getRequestingPackage() {
return mRequestingPackage;
}
/**
* Get the flags requested for this pending report.
*
* @see #FLAG_CONFIRMATION_DIALOG
*/
public int getFlags() {
return mFlags;
}
/**
* Get the time this pending report was posted.
*/
public long getTimestamp() {
return mTimestamp;
}
/**
* Get the URI associated with this PendingReport. It can be used to
* re-retrieve it from {@link IncidentManager} or set as the data field of
* an Intent.
*/
public @NonNull Uri getUri() {
return mUri;
}
/**
* String representation of this PendingReport.
*/
@Override
public @NonNull String toString() {
return "PendingReport(" + getUri().toString() + ")";
}
/**
* @inheritDoc
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof PendingReport)) {
return false;
}
final PendingReport that = (PendingReport) obj;
return this.mUri.equals(that.mUri)
&& this.mFlags == that.mFlags
&& this.mRequestingPackage.equals(that.mRequestingPackage)
&& this.mTimestamp == that.mTimestamp;
}
}
/**
* Record of an incident report that has previously been taken.
* @hide
*/
@SystemApi
@TestApi
public static class IncidentReport implements Parcelable, Closeable {
private final long mTimestampNs;
private final int mPrivacyPolicy;
private ParcelFileDescriptor mFileDescriptor;
public IncidentReport(Parcel in) {
mTimestampNs = in.readLong();
mPrivacyPolicy = in.readInt();
if (in.readInt() != 0) {
mFileDescriptor = ParcelFileDescriptor.CREATOR.createFromParcel(in);
} else {
mFileDescriptor = null;
}
}
/**
* Close the input stream associated with this entry.
*/
public void close() {
try {
if (mFileDescriptor != null) {
mFileDescriptor.close();
mFileDescriptor = null;
}
} catch (IOException e) {
}
}
/**
* Get the time at which this incident report was taken, in wall clock time
* ({@link System#currenttimeMillis System.currenttimeMillis()} time base).
*/
public long getTimestamp() {
return mTimestampNs / 1000000;
}
/**
* Get the privacy level to which this report has been filtered.
*
* @see #PRIVACY_POLICY_AUTO
* @see #PRIVACY_POLICY_EXPLICIT
* @see #PRIVACY_POLICY_LOCAL
*/
public long getPrivacyPolicy() {
return mPrivacyPolicy;
}
/**
* Get the contents of this incident report.
*/
public InputStream getInputStream() throws IOException {
if (mFileDescriptor == null) {
return null;
}
return new ParcelFileDescriptor.AutoCloseInputStream(mFileDescriptor);
}
/**
* @inheritDoc
*/
public int describeContents() {
return mFileDescriptor != null ? Parcelable.CONTENTS_FILE_DESCRIPTOR : 0;
}
/**
* @inheritDoc
*/
public void writeToParcel(Parcel out, int flags) {
out.writeLong(mTimestampNs);
out.writeInt(mPrivacyPolicy);
if (mFileDescriptor != null) {
out.writeInt(1);
mFileDescriptor.writeToParcel(out, flags);
} else {
out.writeInt(0);
}
}
/**
* {@link Parcelable.Creator Creator} for {@link IncidentReport}.
*/
public static final @android.annotation.NonNull Parcelable.Creator<IncidentReport> CREATOR = new Parcelable.Creator() {
/**
* @inheritDoc
*/
public IncidentReport[] newArray(int size) {
return new IncidentReport[size];
}
/**
* @inheritDoc
*/
public IncidentReport createFromParcel(Parcel in) {
return new IncidentReport(in);
}
};
}
/**
* Listener for the status of an incident report being authorized or denied.
*
* @see #requestAuthorization
* @see #cancelAuthorization
*/
public static class AuthListener {
Executor mExecutor;
IIncidentAuthListener.Stub mBinder = new IIncidentAuthListener.Stub() {
@Override
public void onReportApproved() {
if (mExecutor != null) {
mExecutor.execute(() -> {
AuthListener.this.onReportApproved();
});
} else {
AuthListener.this.onReportApproved();
}
}
@Override
public void onReportDenied() {
if (mExecutor != null) {
mExecutor.execute(() -> {
AuthListener.this.onReportDenied();
});
} else {
AuthListener.this.onReportDenied();
}
}
};
/**
* Called when a report is approved.
*/
public void onReportApproved() {
}
/**
* Called when a report is denied.
*/
public void onReportDenied() {
}
}
/**
* @hide
*/
public IncidentManager(Context context) {
mContext = context;
}
/**
* Take an incident report.
*/
@RequiresPermission(allOf = {
android.Manifest.permission.DUMP,
android.Manifest.permission.PACKAGE_USAGE_STATS
})
public void reportIncident(IncidentReportArgs args) {
reportIncidentInternal(args);
}
/**
* Request authorization of an incident report.
*/
@RequiresPermission(android.Manifest.permission.REQUEST_INCIDENT_REPORT_APPROVAL)
public void requestAuthorization(int callingUid, String callingPackage, int flags,
AuthListener listener) {
requestAuthorization(callingUid, callingPackage, flags,
mContext.getMainExecutor(), listener);
}
/**
* Request authorization of an incident report.
* @hide
*/
@RequiresPermission(android.Manifest.permission.REQUEST_INCIDENT_REPORT_APPROVAL)
public void requestAuthorization(int callingUid, @NonNull String callingPackage, int flags,
@NonNull @CallbackExecutor Executor executor, @NonNull AuthListener listener) {
try {
if (listener.mExecutor != null) {
throw new RuntimeException("Do not reuse AuthListener objects when calling"
+ " requestAuthorization");
}
listener.mExecutor = executor;
getCompanionServiceLocked().authorizeReport(callingUid, callingPackage, null, null,
flags, listener.mBinder);
} catch (RemoteException ex) {
// System process going down
throw new RuntimeException(ex);
}
}
/**
* Cancel a previous request for incident report authorization.
*/
@RequiresPermission(android.Manifest.permission.REQUEST_INCIDENT_REPORT_APPROVAL)
public void cancelAuthorization(AuthListener listener) {
try {
getCompanionServiceLocked().cancelAuthorization(listener.mBinder);
} catch (RemoteException ex) {
// System process going down
throw new RuntimeException(ex);
}
}
/**
* Get incident (and bug) reports that are pending approval to share.
*/
@RequiresPermission(android.Manifest.permission.APPROVE_INCIDENT_REPORTS)
public List<PendingReport> getPendingReports() {
List<String> strings;
try {
strings = getCompanionServiceLocked().getPendingReports();
} catch (RemoteException ex) {
throw new RuntimeException(ex);
}
final int size = strings.size();
ArrayList<PendingReport> result = new ArrayList(size);
for (int i = 0; i < size; i++) {
result.add(new PendingReport(Uri.parse(strings.get(i))));
}
return result;
}
/**
* Allow this report to be shared with the given app.
*/
@RequiresPermission(android.Manifest.permission.APPROVE_INCIDENT_REPORTS)
public void approveReport(Uri uri) {
try {
getCompanionServiceLocked().approveReport(uri.toString());
} catch (RemoteException ex) {
// System process going down
throw new RuntimeException(ex);
}
}
/**
* Do not allow this report to be shared with the given app.
*/
@RequiresPermission(android.Manifest.permission.APPROVE_INCIDENT_REPORTS)
public void denyReport(Uri uri) {
try {
getCompanionServiceLocked().denyReport(uri.toString());
} catch (RemoteException ex) {
// System process going down
throw new RuntimeException(ex);
}
}
/**
* Get the incident reports that are available for upload for the supplied
* broadcast recevier.
*
* @param receiverClass Class name of broadcast receiver in this package that
* was registered to retrieve reports.
*
* @return A list of {@link Uri Uris} that are awaiting upload.
*/
@RequiresPermission(allOf = {
android.Manifest.permission.DUMP,
android.Manifest.permission.PACKAGE_USAGE_STATS
})
public @NonNull List<Uri> getIncidentReportList(String receiverClass) {
List<String> strings;
try {
strings = getCompanionServiceLocked().getIncidentReportList(
mContext.getPackageName(), receiverClass);
} catch (RemoteException ex) {
throw new RuntimeException("System server or incidentd going down", ex);
}
final int size = strings.size();
ArrayList<Uri> result = new ArrayList(size);
for (int i = 0; i < size; i++) {
result.add(Uri.parse(strings.get(i)));
}
return result;
}
/**
* Get the incident report with the given URI id.
*
* @param uri Identifier of the incident report.
*
* @return an IncidentReport object, or null if the incident report has been
* expired from disk.
*/
@RequiresPermission(allOf = {
android.Manifest.permission.DUMP,
android.Manifest.permission.PACKAGE_USAGE_STATS
})
public @Nullable IncidentReport getIncidentReport(Uri uri) {
final String id = uri.getQueryParameter(URI_PARAM_REPORT_ID);
if (id == null) {
// If there's no report id, it's a bug report, so we can't return the incident
// report.
return null;
}
final String pkg = uri.getQueryParameter(URI_PARAM_CALLING_PACKAGE);
if (pkg == null) {
throw new RuntimeException("Invalid URI: No "
+ URI_PARAM_CALLING_PACKAGE + " parameter. " + uri);
}
final String cls = uri.getQueryParameter(URI_PARAM_RECEIVER_CLASS);
if (cls == null) {
throw new RuntimeException("Invalid URI: No "
+ URI_PARAM_RECEIVER_CLASS + " parameter. " + uri);
}
try {
return getCompanionServiceLocked().getIncidentReport(pkg, cls, id);
} catch (RemoteException ex) {
throw new RuntimeException("System server or incidentd going down", ex);
}
}
/**
* Delete the incident report with the given URI id.
*
* @param uri Identifier of the incident report. Pass null to delete all
* incident reports owned by this application.
*/
@RequiresPermission(allOf = {
android.Manifest.permission.DUMP,
android.Manifest.permission.PACKAGE_USAGE_STATS
})
public void deleteIncidentReports(Uri uri) {
if (uri == null) {
try {
getCompanionServiceLocked().deleteAllIncidentReports(mContext.getPackageName());
} catch (RemoteException ex) {
throw new RuntimeException("System server or incidentd going down", ex);
}
} else {
final String pkg = uri.getQueryParameter(URI_PARAM_CALLING_PACKAGE);
if (pkg == null) {
throw new RuntimeException("Invalid URI: No "
+ URI_PARAM_CALLING_PACKAGE + " parameter. " + uri);
}
final String cls = uri.getQueryParameter(URI_PARAM_RECEIVER_CLASS);
if (cls == null) {
throw new RuntimeException("Invalid URI: No "
+ URI_PARAM_RECEIVER_CLASS + " parameter. " + uri);
}
final String id = uri.getQueryParameter(URI_PARAM_REPORT_ID);
if (id == null) {
throw new RuntimeException("Invalid URI: No "
+ URI_PARAM_REPORT_ID + " parameter. " + uri);
}
try {
getCompanionServiceLocked().deleteIncidentReports(pkg, cls, id);
} catch (RemoteException ex) {
throw new RuntimeException("System server or incidentd going down", ex);
}
}
}
private void reportIncidentInternal(IncidentReportArgs args) {
try {
final IIncidentManager service = getIIncidentManagerLocked();
if (service == null) {
Slog.e(TAG, "reportIncident can't find incident binder service");
return;
}
service.reportIncident(args);
} catch (RemoteException ex) {
Slog.e(TAG, "reportIncident failed", ex);
}
}
private IIncidentManager getIIncidentManagerLocked() throws RemoteException {
if (mIncidentService != null) {
return mIncidentService;
}
synchronized (mLock) {
if (mIncidentService != null) {
return mIncidentService;
}
mIncidentService = IIncidentManager.Stub.asInterface(
ServiceManager.getService(Context.INCIDENT_SERVICE));
if (mIncidentService != null) {
mIncidentService.asBinder().linkToDeath(() -> {
synchronized (mLock) {
mIncidentService = null;
}
}, 0);
}
return mIncidentService;
}
}
private IIncidentCompanion getCompanionServiceLocked() throws RemoteException {
if (mCompanionService != null) {
return mCompanionService;
}
synchronized (this) {
if (mCompanionService != null) {
return mCompanionService;
}
mCompanionService = IIncidentCompanion.Stub.asInterface(
ServiceManager.getService(Context.INCIDENT_COMPANION_SERVICE));
if (mCompanionService != null) {
mCompanionService.asBinder().linkToDeath(() -> {
synchronized (mLock) {
mCompanionService = null;
}
}, 0);
}
return mCompanionService;
}
}
}
|