DevicePolicyManager.java revision 467d4ab03d5746c50a66d0f9662ea2366e800ab6
1/* 2 * Copyright (C) 2010 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.app.admin; 18 19import android.annotation.ColorInt; 20import android.annotation.IntDef; 21import android.annotation.NonNull; 22import android.annotation.Nullable; 23import android.annotation.SdkConstant; 24import android.annotation.SdkConstant.SdkConstantType; 25import android.annotation.SystemApi; 26import android.annotation.TestApi; 27import android.annotation.UserIdInt; 28import android.annotation.WorkerThread; 29import android.app.Activity; 30import android.app.IServiceConnection; 31import android.app.KeyguardManager; 32import android.app.admin.SecurityLog.SecurityEvent; 33import android.content.ComponentName; 34import android.content.Context; 35import android.content.Intent; 36import android.content.IntentFilter; 37import android.content.ServiceConnection; 38import android.content.pm.ApplicationInfo; 39import android.content.pm.PackageManager; 40import android.content.pm.PackageManager.NameNotFoundException; 41import android.content.pm.ParceledListSlice; 42import android.content.pm.UserInfo; 43import android.graphics.Bitmap; 44import android.net.ProxyInfo; 45import android.net.Uri; 46import android.os.Bundle; 47import android.os.Parcelable; 48import android.os.PersistableBundle; 49import android.os.Process; 50import android.os.RemoteCallback; 51import android.os.RemoteException; 52import android.os.UserHandle; 53import android.os.UserManager; 54import android.provider.ContactsContract.Directory; 55import android.provider.Settings; 56import android.security.Credentials; 57import android.service.restrictions.RestrictionsReceiver; 58import android.telephony.TelephonyManager; 59import android.util.Log; 60 61import com.android.internal.annotations.VisibleForTesting; 62import com.android.org.conscrypt.TrustedCertificateStore; 63 64import java.io.ByteArrayInputStream; 65import java.io.IOException; 66import java.lang.annotation.Retention; 67import java.lang.annotation.RetentionPolicy; 68import java.net.InetSocketAddress; 69import java.net.Proxy; 70import java.security.KeyFactory; 71import java.security.NoSuchAlgorithmException; 72import java.security.PrivateKey; 73import java.security.cert.Certificate; 74import java.security.cert.CertificateException; 75import java.security.cert.CertificateFactory; 76import java.security.cert.X509Certificate; 77import java.security.spec.InvalidKeySpecException; 78import java.security.spec.PKCS8EncodedKeySpec; 79import java.util.ArrayList; 80import java.util.Arrays; 81import java.util.Collections; 82import java.util.List; 83 84/** 85 * Public interface for managing policies enforced on a device. Most clients of this class must be 86 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device 87 * administrator</a>. Additionally, a device administrator may be registered as either a profile or 88 * device owner. A given method is accessible to all device administrators unless the documentation 89 * for that method specifies that it is restricted to either device or profile owners. Any 90 * application calling an api may only pass as an argument a device administrator component it 91 * owns. Otherwise, a {@link SecurityException} will be thrown. 92 * <div class="special reference"> 93 * <h3>Developer Guides</h3> 94 * <p> 95 * For more information about managing policies for device administration, read the <a href= 96 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer 97 * guide. </div> 98 */ 99public class DevicePolicyManager { 100 private static String TAG = "DevicePolicyManager"; 101 102 private final Context mContext; 103 private final IDevicePolicyManager mService; 104 private final boolean mParentInstance; 105 106 /** @hide */ 107 public DevicePolicyManager(Context context, IDevicePolicyManager service) { 108 this(context, service, false); 109 } 110 111 /** @hide */ 112 @VisibleForTesting 113 protected DevicePolicyManager(Context context, IDevicePolicyManager service, 114 boolean parentInstance) { 115 mContext = context; 116 mService = service; 117 mParentInstance = parentInstance; 118 } 119 120 /** @hide test will override it. */ 121 @VisibleForTesting 122 protected int myUserId() { 123 return UserHandle.myUserId(); 124 } 125 126 /** 127 * Activity action: Starts the provisioning flow which sets up a managed profile. 128 * 129 * <p>A managed profile allows data separation for example for the usage of a 130 * device as a personal and corporate device. The user which provisioning is started from and 131 * the managed profile share a launcher. 132 * 133 * <p>This intent will typically be sent by a mobile device management application (MDM). 134 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full 135 * control over the profile. 136 * 137 * <p>It is possible to check if provisioning is allowed or not by querying the method 138 * {@link #isProvisioningAllowed(String)}. 139 * 140 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the 141 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}. 142 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra 143 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only 144 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported. 145 * 146 * <p>The intent may also contain the following extras: 147 * <ul> 148 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li> 149 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from 150 * {@link android.os.Build.VERSION_CODES#N}</li> 151 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li> 152 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li> 153 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li> 154 * <li>{@link #EXTRA_PROVISIONING_SKIP_USER_CONSENT}, optional</li> 155 * <li>{@link #EXTRA_PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION}, optional</li> 156 * <li>{@link #EXTRA_PROVISIONING_DISCLAIMERS}, optional</li> 157 * </ul> 158 * 159 * <p>When managed provisioning has completed, broadcasts are sent to the application specified 160 * in the provisioning intent. The 161 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the 162 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in 163 * the primary profile. 164 * 165 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when managed provisioning has 166 * completed, along with the above broadcast, activity intent 167 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the application specified in 168 * the provisioning intent. 169 * 170 * <p>If provisioning fails, the managedProfile is removed so the device returns to its 171 * previous state. 172 * 173 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a 174 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of 175 * the provisioning flow was successful, although this doesn't guarantee the full flow will 176 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies 177 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met. 178 */ 179 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 180 public static final String ACTION_PROVISION_MANAGED_PROFILE 181 = "android.app.action.PROVISION_MANAGED_PROFILE"; 182 183 /** 184 * Activity action: Starts the provisioning flow which sets up a managed user. 185 * 186 * <p>This intent will typically be sent by a mobile device management application (MDM). 187 * Provisioning configures the user as managed user and sets the MDM as the profile 188 * owner who has full control over the user. Provisioning can only happen before user setup has 189 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is 190 * allowed. 191 * 192 * <p>The intent contains the following extras: 193 * <ul> 194 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li> 195 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li> 196 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li> 197 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li> 198 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li> 199 * </ul> 200 * 201 * <p>If provisioning fails, the device returns to its previous state. 202 * 203 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a 204 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of 205 * the provisioning flow was successful, although this doesn't guarantee the full flow will 206 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies 207 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met. 208 * 209 * @hide 210 */ 211 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 212 public static final String ACTION_PROVISION_MANAGED_USER 213 = "android.app.action.PROVISION_MANAGED_USER"; 214 215 /** 216 * Activity action: Starts the provisioning flow which sets up a managed device. 217 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}. 218 * 219 * <p> During device owner provisioning a device admin app is set as the owner of the device. 220 * A device owner has full control over the device. The device owner can not be modified by the 221 * user. 222 * 223 * <p> A typical use case would be a device that is owned by a company, but used by either an 224 * employee or client. 225 * 226 * <p> An intent with this action can be sent only on an unprovisioned device. 227 * It is possible to check if provisioning is allowed or not by querying the method 228 * {@link #isProvisioningAllowed(String)}. 229 * 230 * <p>The intent contains the following extras: 231 * <ul> 232 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li> 233 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li> 234 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li> 235 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li> 236 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li> 237 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li> 238 * <li>{@link #EXTRA_PROVISIONING_DISCLAIMERS}, optional</li> 239 * </ul> 240 * 241 * <p>When device owner provisioning has completed, an intent of the type 242 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the 243 * device owner. 244 * 245 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has 246 * completed, along with the above broadcast, activity intent 247 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner. 248 * 249 * <p>If provisioning fails, the device is factory reset. 250 * 251 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part 252 * of the provisioning flow was successful, although this doesn't guarantee the full flow will 253 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies 254 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met. 255 */ 256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 257 public static final String ACTION_PROVISION_MANAGED_DEVICE 258 = "android.app.action.PROVISION_MANAGED_DEVICE"; 259 260 /** 261 * Activity action: Starts the provisioning flow which sets up a managed device. 262 * 263 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of 264 * the device. A device owner has full control over the device. The device owner can not be 265 * modified by the user and the only way of resetting the device is via factory reset. 266 * 267 * <p>A typical use case would be a device that is owned by a company, but used by either an 268 * employee or client. 269 * 270 * <p>The provisioning message should be sent to an unprovisioned device. 271 * 272 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent 273 * by a privileged app with the permission 274 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}. 275 * 276 * <p>The provisioning intent contains the following properties: 277 * <ul> 278 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li> 279 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li> 280 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li> 281 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li> 282 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL}, optional</li> 283 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI}, optional</li> 284 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li> 285 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li> 286 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li> 287 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li> 288 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li> 289 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li> 290 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li> 291 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li> 292 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li> 293 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li> 294 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li> 295 * <li>{@link #EXTRA_PROVISIONING_SUPPORT_URL}, optional</li> 296 * <li>{@link #EXTRA_PROVISIONING_ORGANIZATION_NAME}, optional</li> 297 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul> 298 * 299 * @hide 300 */ 301 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 302 @SystemApi 303 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE = 304 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE"; 305 306 /** 307 * Activity action: Starts the provisioning flow which sets up a managed device. 308 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}. 309 * 310 * <p>NOTE: This is only supported on split system user devices, and puts the device into a 311 * management state that is distinct from that reached by 312 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system 313 * user, and only has control over device-wide policies, not individual users and their data. 314 * The primary benefit is that multiple non-system users are supported when provisioning using 315 * this form of device management. 316 * 317 * <p>During device owner provisioning a device admin app is set as the owner of the device. 318 * A device owner has full control over the device. The device owner can not be modified by the 319 * user. 320 * 321 * <p>A typical use case would be a device that is owned by a company, but used by either an 322 * employee or client. 323 * 324 * <p>An intent with this action can be sent only on an unprovisioned device. 325 * It is possible to check if provisioning is allowed or not by querying the method 326 * {@link #isProvisioningAllowed(String)}. 327 * 328 * <p>The intent contains the following extras: 329 * <ul> 330 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li> 331 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li> 332 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li> 333 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li> 334 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li> 335 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li> 336 * </ul> 337 * 338 * <p>When device owner provisioning has completed, an intent of the type 339 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the 340 * device owner. 341 * 342 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has 343 * completed, along with the above broadcast, activity intent 344 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner. 345 * 346 * <p>If provisioning fails, the device is factory reset. 347 * 348 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part 349 * of the provisioning flow was successful, although this doesn't guarantee the full flow will 350 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies 351 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met. 352 * 353 * @hide 354 */ 355 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 356 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE 357 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE"; 358 359 /** 360 * Activity action: Finalizes management provisioning, should be used after user-setup 361 * has been completed and {@link #getUserProvisioningState()} returns one of: 362 * <ul> 363 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li> 364 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li> 365 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li> 366 * </ul> 367 * 368 * @hide 369 */ 370 @SystemApi 371 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 372 public static final String ACTION_PROVISION_FINALIZATION 373 = "android.app.action.PROVISION_FINALIZATION"; 374 375 /** 376 * Action: Bugreport sharing with device owner has been accepted by the user. 377 * 378 * @hide 379 */ 380 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED = 381 "com.android.server.action.REMOTE_BUGREPORT_SHARING_ACCEPTED"; 382 383 /** 384 * Action: Bugreport sharing with device owner has been declined by the user. 385 * 386 * @hide 387 */ 388 public static final String ACTION_BUGREPORT_SHARING_DECLINED = 389 "com.android.server.action.REMOTE_BUGREPORT_SHARING_DECLINED"; 390 391 /** 392 * Action: Bugreport has been collected and is dispatched to {@code DevicePolicyManagerService}. 393 * 394 * @hide 395 */ 396 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH = 397 "android.intent.action.REMOTE_BUGREPORT_DISPATCH"; 398 399 /** 400 * Extra for shared bugreport's SHA-256 hash. 401 * 402 * @hide 403 */ 404 public static final String EXTRA_REMOTE_BUGREPORT_HASH = 405 "android.intent.extra.REMOTE_BUGREPORT_HASH"; 406 407 /** 408 * Extra for remote bugreport notification shown type. 409 * 410 * @hide 411 */ 412 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE = 413 "android.app.extra.bugreport_notification_type"; 414 415 /** 416 * Notification type for a started remote bugreport flow. 417 * 418 * @hide 419 */ 420 public static final int NOTIFICATION_BUGREPORT_STARTED = 1; 421 422 /** 423 * Notification type for a bugreport that has already been accepted to be shared, but is still 424 * being taken. 425 * 426 * @hide 427 */ 428 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2; 429 430 /** 431 * Notification type for a bugreport that has been taken and can be shared or declined. 432 * 433 * @hide 434 */ 435 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3; 436 437 /** 438 * Default and maximum timeout in milliseconds after which unlocking with weak auth times out, 439 * i.e. the user has to use a strong authentication method like password, PIN or pattern. 440 * 441 * @hide 442 */ 443 public static final long DEFAULT_STRONG_AUTH_TIMEOUT_MS = 72 * 60 * 60 * 1000; // 72h 444 445 /** 446 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that 447 * allows a mobile device management application or NFC programmer application which starts 448 * managed provisioning to pass data to the management application instance after provisioning. 449 * <p> 450 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that 451 * sends the intent to pass data to itself on the newly created profile. 452 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same 453 * instance of the app on the primary user. 454 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with 455 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC 456 * message should contain a stringified {@link java.util.Properties} instance, whose string 457 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the 458 * management application after provisioning. 459 * 460 * <p> 461 * In both cases the application receives the data in 462 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action 463 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed 464 * during the managed provisioning. 465 */ 466 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE = 467 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE"; 468 469 /** 470 * A String extra holding the package name of the mobile device management application that 471 * will be set as the profile owner or device owner. 472 * 473 * <p>If an application starts provisioning directly via an intent with action 474 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the 475 * application that started provisioning. The package will be set as profile owner in that case. 476 * 477 * <p>This package is set as device owner when device owner provisioning is started by an NFC 478 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}. 479 * 480 * <p> When this extra is set, the application must have exactly one device admin receiver. 481 * This receiver will be set as the profile or device owner and active admin. 482 * 483 * @see DeviceAdminReceiver 484 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still 485 * supported, but only if there is only one device admin receiver in the package that requires 486 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}. 487 */ 488 @Deprecated 489 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME 490 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME"; 491 492 /** 493 * A ComponentName extra indicating the device admin receiver of the mobile device management 494 * application that will be set as the profile owner or device owner and active admin. 495 * 496 * <p>If an application starts provisioning directly via an intent with action 497 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or 498 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this 499 * component has to match the package name of the application that started provisioning. 500 * 501 * <p>This component is set as device owner and active admin when device owner provisioning is 502 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC 503 * message containing an NFC record with MIME type 504 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be 505 * flattened to a string, via {@link ComponentName#flattenToShortString()}. 506 * 507 * @see DeviceAdminReceiver 508 */ 509 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME 510 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME"; 511 512 /** 513 * An {@link android.accounts.Account} extra holding the account to migrate during managed 514 * profile provisioning. If the account supplied is present in the primary user, it will be 515 * copied, along with its credentials to the managed profile and removed from the primary user. 516 * 517 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}. 518 */ 519 520 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE 521 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE"; 522 523 /** 524 * Boolean extra to indicate that the migrated account should be kept. This is used in 525 * conjunction with {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}. If it's set to {@code true}, 526 * the account will not be removed from the primary user after it is migrated to the newly 527 * created user or profile. 528 * 529 * <p> Defaults to {@code false} 530 * 531 * <p> Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} and 532 * {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} 533 */ 534 public static final String EXTRA_PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION 535 = "android.app.extra.PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION"; 536 537 /** 538 * A String extra that, holds the email address of the account which a managed profile is 539 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and 540 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. 541 * 542 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}. 543 * 544 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning 545 * contains this extra, it is forwarded in the 546 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile 547 * device management application that was set as the profile owner during provisioning. 548 * It is usually used to avoid that the user has to enter their email address twice. 549 */ 550 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS 551 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS"; 552 553 /** 554 * A integer extra indicating the predominant color to show during the provisioning. 555 * Refer to {@link android.graphics.Color} for how the color is represented. 556 * 557 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or 558 * {@link #ACTION_PROVISION_MANAGED_DEVICE}. 559 */ 560 public static final String EXTRA_PROVISIONING_MAIN_COLOR = 561 "android.app.extra.PROVISIONING_MAIN_COLOR"; 562 563 /** 564 * A Boolean extra that can be used by the mobile device management application to skip the 565 * disabling of system apps during provisioning when set to {@code true}. 566 * 567 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action 568 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning. 569 */ 570 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED = 571 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED"; 572 573 /** 574 * A String extra holding the time zone {@link android.app.AlarmManager} that the device 575 * will be set to. 576 * 577 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 578 * provisioning via an NFC bump. 579 */ 580 public static final String EXTRA_PROVISIONING_TIME_ZONE 581 = "android.app.extra.PROVISIONING_TIME_ZONE"; 582 583 /** 584 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's 585 * {@link android.app.AlarmManager}. 586 * 587 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 588 * provisioning via an NFC bump. 589 */ 590 public static final String EXTRA_PROVISIONING_LOCAL_TIME 591 = "android.app.extra.PROVISIONING_LOCAL_TIME"; 592 593 /** 594 * A String extra holding the {@link java.util.Locale} that the device will be set to. 595 * Format: xx_yy, where xx is the language code, and yy the country code. 596 * 597 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 598 * provisioning via an NFC bump. 599 */ 600 public static final String EXTRA_PROVISIONING_LOCALE 601 = "android.app.extra.PROVISIONING_LOCALE"; 602 603 /** 604 * A String extra holding the ssid of the wifi network that should be used during nfc device 605 * owner provisioning for downloading the mobile device management application. 606 * 607 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 608 * provisioning via an NFC bump. 609 */ 610 public static final String EXTRA_PROVISIONING_WIFI_SSID 611 = "android.app.extra.PROVISIONING_WIFI_SSID"; 612 613 /** 614 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID} 615 * is hidden or not. 616 * 617 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 618 * provisioning via an NFC bump. 619 */ 620 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN 621 = "android.app.extra.PROVISIONING_WIFI_HIDDEN"; 622 623 /** 624 * A String extra indicating the security type of the wifi network in 625 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or 626 * {@code WEP}. 627 * 628 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 629 * provisioning via an NFC bump. 630 */ 631 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE 632 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE"; 633 634 /** 635 * A String extra holding the password of the wifi network in 636 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 637 * 638 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 639 * provisioning via an NFC bump. 640 */ 641 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD 642 = "android.app.extra.PROVISIONING_WIFI_PASSWORD"; 643 644 /** 645 * A String extra holding the proxy host for the wifi network in 646 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 647 * 648 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 649 * provisioning via an NFC bump. 650 */ 651 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST 652 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST"; 653 654 /** 655 * An int extra holding the proxy port for the wifi network in 656 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 657 * 658 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 659 * provisioning via an NFC bump. 660 */ 661 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT 662 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT"; 663 664 /** 665 * A String extra holding the proxy bypass for the wifi network in 666 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 667 * 668 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 669 * provisioning via an NFC bump. 670 */ 671 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS 672 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS"; 673 674 /** 675 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in 676 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 677 * 678 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 679 * provisioning via an NFC bump. 680 */ 681 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL 682 = "android.app.extra.PROVISIONING_WIFI_PAC_URL"; 683 684 /** 685 * A String extra holding a url that specifies the download location of the device admin 686 * package. When not provided it is assumed that the device admin package is already installed. 687 * 688 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 689 * provisioning via an NFC bump. 690 */ 691 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION 692 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION"; 693 694 /** 695 * A String extra holding the localized name of the organization under management. 696 * 697 * The name is displayed only during provisioning. 698 * 699 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE} 700 * 701 * @hide 702 */ 703 @SystemApi 704 public static final String EXTRA_PROVISIONING_ORGANIZATION_NAME = 705 "android.app.extra.PROVISIONING_ORGANIZATION_NAME"; 706 707 /** 708 * A String extra holding a url to the website of the device's provider. The website can be 709 * opened in a browser during provisioning. 710 * 711 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE} 712 * 713 * @hide 714 */ 715 @SystemApi 716 public static final String EXTRA_PROVISIONING_SUPPORT_URL = 717 "android.app.extra.PROVISIONING_SUPPORT_URL"; 718 719 /** 720 * A String extra holding the localized name of the device admin package. It should be the same 721 * as the app label of the package. 722 * 723 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE} 724 * 725 * @hide 726 */ 727 @SystemApi 728 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL = 729 "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL"; 730 731 /** 732 * A {@link Uri} extra pointing to the app icon of device admin package. This image will be 733 * shown during the provisioning. 734 * <h5>The following URI schemes are accepted:</h5> 735 * <ul> 736 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 737 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 738 * </ul> 739 * 740 * <p> It is the responsibility of the caller to provide an image with a reasonable 741 * pixel density for the device. 742 * 743 * <p> If a content: URI is passed, the intent should have the flag 744 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the 745 * {@link android.content.ClipData} of the intent too. 746 * 747 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE} 748 * 749 * @hide 750 */ 751 @SystemApi 752 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI = 753 "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI"; 754 755 /** 756 * An int extra holding a minimum required version code for the device admin package. If the 757 * device admin is already installed on the device, it will only be re-downloaded from 758 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the 759 * installed package is less than this version code. 760 * 761 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 762 * provisioning via an NFC bump. 763 */ 764 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE 765 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE"; 766 767 /** 768 * A String extra holding a http cookie header which should be used in the http request to the 769 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. 770 * 771 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 772 * provisioning via an NFC bump. 773 */ 774 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER 775 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER"; 776 777 /** 778 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of 779 * the file at download location specified in 780 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. 781 * 782 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be 783 * present. The provided checksum must match the checksum of the file at the download 784 * location. If the checksum doesn't match an error will be shown to the user and the user will 785 * be asked to factory reset the device. 786 * 787 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 788 * provisioning via an NFC bump. 789 * 790 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP} 791 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported. 792 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in 793 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases. 794 */ 795 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM 796 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM"; 797 798 /** 799 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the 800 * android package archive at the download location specified in {@link 801 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. 802 * 803 * <p>The signatures of an android package archive can be obtained using 804 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag 805 * {@link android.content.pm.PackageManager#GET_SIGNATURES}. 806 * 807 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be 808 * present. The provided checksum must match the checksum of any signature of the file at 809 * the download location. If the checksum does not match an error will be shown to the user and 810 * the user will be asked to factory reset the device. 811 * 812 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 813 * provisioning via an NFC bump. 814 */ 815 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM 816 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM"; 817 818 /** 819 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile 820 * has completed successfully. 821 * 822 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning 823 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}. 824 * 825 * <p>This intent will contain the following extras 826 * <ul> 827 * <li>{@link Intent#EXTRA_USER}, corresponds to the {@link UserHandle} of the managed 828 * profile.</li> 829 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, corresponds to the account requested to 830 * be migrated at provisioning time, if any.</li> 831 * </ul> 832 */ 833 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 834 public static final String ACTION_MANAGED_PROFILE_PROVISIONED 835 = "android.app.action.MANAGED_PROFILE_PROVISIONED"; 836 837 /** 838 * Activity action: This activity action is sent to indicate that provisioning of a managed 839 * profile or managed device has completed successfully. It'll be sent at the same time as 840 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast but this will be 841 * delivered faster as it's an activity intent. 842 * 843 * <p>The intent is only sent to the application on the profile that requested provisioning. In 844 * the device owner case the profile is the primary user. 845 * 846 * @see #ACTION_PROVISION_MANAGED_PROFILE 847 * @see #ACTION_PROVISION_MANAGED_DEVICE 848 */ 849 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 850 public static final String ACTION_PROVISIONING_SUCCESSFUL = 851 "android.app.action.PROVISIONING_SUCCESSFUL"; 852 853 /** 854 * A boolean extra indicating whether device encryption can be skipped as part of device owner 855 * or managed profile provisioning. 856 * 857 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action 858 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning. 859 * 860 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an 861 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}. 862 */ 863 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION = 864 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION"; 865 866 /** 867 * A {@link Uri} extra pointing to a logo image. This image will be shown during the 868 * provisioning. If this extra is not passed, a default image will be shown. 869 * <h5>The following URI schemes are accepted:</h5> 870 * <ul> 871 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 872 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 873 * </ul> 874 * 875 * <p> It is the responsibility of the caller to provide an image with a reasonable 876 * pixel density for the device. 877 * 878 * <p> If a content: URI is passed, the intent should have the flag 879 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the 880 * {@link android.content.ClipData} of the intent too. 881 * 882 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or 883 * {@link #ACTION_PROVISION_MANAGED_DEVICE} 884 */ 885 public static final String EXTRA_PROVISIONING_LOGO_URI = 886 "android.app.extra.PROVISIONING_LOGO_URI"; 887 888 /** 889 * A {@link Bundle}[] extra consisting of list of disclaimer headers and disclaimer contents. 890 * Each {@link Bundle} must have both {@link #EXTRA_PROVISIONING_DISCLAIMER_HEADER} 891 * as disclaimer header, and {@link #EXTRA_PROVISIONING_DISCLAIMER_CONTENT} as disclaimer 892 * content. 893 * 894 * <p> The extra typically contains one disclaimer from the company of mobile device 895 * management application (MDM), and one disclaimer from the organization. 896 * 897 * <p> Call {@link Bundle#putParcelableArray(String, Parcelable[])} to put the {@link Bundle}[] 898 * 899 * <p> Maximum 3 key-value pairs can be specified. The rest will be ignored. 900 * 901 * <p> Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or 902 * {@link #ACTION_PROVISION_MANAGED_DEVICE} 903 */ 904 public static final String EXTRA_PROVISIONING_DISCLAIMERS = 905 "android.app.extra.PROVISIONING_DISCLAIMERS"; 906 907 /** 908 * A String extra of localized disclaimer header. 909 * 910 * <p> The extra is typically the company name of mobile device management application (MDM) 911 * or the organization name. 912 * 913 * <p> Use in Bundle {@link #EXTRA_PROVISIONING_DISCLAIMERS} 914 * 915 * <p> System app, i.e. application with {@link ApplicationInfo#FLAG_SYSTEM}, can also insert a 916 * disclaimer by declaring an application-level meta-data in {@code AndroidManifest.xml}. 917 * Must use it with {@link #EXTRA_PROVISIONING_DISCLAIMER_CONTENT}. Here is the example: 918 * 919 * <pre> 920 * <meta-data 921 * android:name="android.app.extra.PROVISIONING_DISCLAIMER_HEADER" 922 * android:resource="@string/disclaimer_header" 923 * /></pre> 924 */ 925 public static final String EXTRA_PROVISIONING_DISCLAIMER_HEADER = 926 "android.app.extra.PROVISIONING_DISCLAIMER_HEADER"; 927 928 /** 929 * A {@link Uri} extra pointing to disclaimer content. 930 * 931 * <h5>The following URI schemes are accepted:</h5> 932 * <ul> 933 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 934 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 935 * </ul> 936 * 937 * <p> Styled text is supported in the disclaimer content. The content is parsed by 938 * {@link android.text.Html#fromHtml(String)} and displayed in a 939 * {@link android.widget.TextView}. 940 * 941 * <p> If a <code>content:</code> URI is passed, URI is passed, the intent should have the flag 942 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the 943 * {@link android.content.ClipData} of the intent too. 944 * 945 * <p> Use in Bundle {@link #EXTRA_PROVISIONING_DISCLAIMERS} 946 * 947 * <p> System app, i.e. application with {@link ApplicationInfo#FLAG_SYSTEM}, can also insert a 948 * disclaimer by declaring an application-level meta-data in {@code AndroidManifest.xml}. 949 * Must use it with {@link #EXTRA_PROVISIONING_DISCLAIMER_HEADER}. Here is the example: 950 * 951 * <pre> 952 * <meta-data 953 * android:name="android.app.extra.PROVISIONING_DISCLAIMER_CONTENT" 954 * android:resource="@string/disclaimer_content" 955 * /></pre> 956 */ 957 public static final String EXTRA_PROVISIONING_DISCLAIMER_CONTENT = 958 "android.app.extra.PROVISIONING_DISCLAIMER_CONTENT"; 959 960 /** 961 * A boolean extra indicating if user setup should be skipped, for when provisioning is started 962 * during setup-wizard. 963 * 964 * <p>If unspecified, defaults to {@code true} to match the behavior in 965 * {@link android.os.Build.VERSION_CODES#M} and earlier. 966 * 967 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or 968 * {@link #ACTION_PROVISION_MANAGED_USER}. 969 * 970 * @hide 971 */ 972 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP = 973 "android.app.extra.PROVISIONING_SKIP_USER_SETUP"; 974 975 /** 976 * A boolean extra indicating if the user consent steps from the provisioning flow should be 977 * skipped. If unspecified, defaults to {@code false}. 978 * 979 * It can only be used by an existing device owner trying to create a managed profile via 980 * {@link #ACTION_PROVISION_MANAGED_PROFILE}. Otherwise it is ignored. 981 */ 982 public static final String EXTRA_PROVISIONING_SKIP_USER_CONSENT = 983 "android.app.extra.PROVISIONING_SKIP_USER_CONSENT"; 984 985 /** 986 * This MIME type is used for starting the device owner provisioning. 987 * 988 * <p>During device owner provisioning a device admin app is set as the owner of the device. 989 * A device owner has full control over the device. The device owner can not be modified by the 990 * user and the only way of resetting the device is if the device owner app calls a factory 991 * reset. 992 * 993 * <p> A typical use case would be a device that is owned by a company, but used by either an 994 * employee or client. 995 * 996 * <p> The NFC message must be sent to an unprovisioned device. 997 * 998 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which 999 * contains the following properties: 1000 * <ul> 1001 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li> 1002 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li> 1003 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li> 1004 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li> 1005 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li> 1006 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li> 1007 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li> 1008 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li> 1009 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li> 1010 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li> 1011 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li> 1012 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li> 1013 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li> 1014 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li> 1015 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li> 1016 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from 1017 * {@link android.os.Build.VERSION_CODES#M} </li></ul> 1018 * 1019 * <p> 1020 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain 1021 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of 1022 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only 1023 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported). 1024 */ 1025 public static final String MIME_TYPE_PROVISIONING_NFC 1026 = "application/com.android.managedprovisioning"; 1027 1028 /** 1029 * Activity action: ask the user to add a new device administrator to the system. 1030 * The desired policy is the ComponentName of the policy in the 1031 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to 1032 * bring the user through adding the device administrator to the system (or 1033 * allowing them to reject it). 1034 * 1035 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION} 1036 * field to provide the user with additional explanation (in addition 1037 * to your component's description) about what is being added. 1038 * 1039 * <p>If your administrator is already active, this will ordinarily return immediately (without 1040 * user intervention). However, if your administrator has been updated and is requesting 1041 * additional uses-policy flags, the user will be presented with the new list. New policies 1042 * will not be available to the updated administrator until the user has accepted the new list. 1043 */ 1044 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 1045 public static final String ACTION_ADD_DEVICE_ADMIN 1046 = "android.app.action.ADD_DEVICE_ADMIN"; 1047 1048 /** 1049 * @hide 1050 * Activity action: ask the user to add a new device administrator as the profile owner 1051 * for this user. Only system apps can launch this intent. 1052 * 1053 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN} 1054 * extra field. This will invoke a UI to bring the user through adding the profile owner admin 1055 * to remotely control restrictions on the user. 1056 * 1057 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the 1058 * result of whether or not the user approved the action. If approved, the result will 1059 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well 1060 * as a profile owner. 1061 * 1062 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION} 1063 * field to provide the user with additional explanation (in addition 1064 * to your component's description) about what is being added. 1065 * 1066 * <p>If there is already a profile owner active or the caller is not a system app, the 1067 * operation will return a failure result. 1068 */ 1069 @SystemApi 1070 public static final String ACTION_SET_PROFILE_OWNER 1071 = "android.app.action.SET_PROFILE_OWNER"; 1072 1073 /** 1074 * @hide 1075 * Name of the profile owner admin that controls the user. 1076 */ 1077 @SystemApi 1078 public static final String EXTRA_PROFILE_OWNER_NAME 1079 = "android.app.extra.PROFILE_OWNER_NAME"; 1080 1081 /** 1082 * Broadcast action: send when any policy admin changes a policy. 1083 * This is generally used to find out when a new policy is in effect. 1084 * 1085 * @hide 1086 */ 1087 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED 1088 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED"; 1089 1090 /** 1091 * Broadcast action: sent when the device owner is set, changed or cleared. 1092 * 1093 * This broadcast is sent only to the primary user. 1094 * @see #ACTION_PROVISION_MANAGED_DEVICE 1095 */ 1096 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 1097 public static final String ACTION_DEVICE_OWNER_CHANGED 1098 = "android.app.action.DEVICE_OWNER_CHANGED"; 1099 1100 /** 1101 * The ComponentName of the administrator component. 1102 * 1103 * @see #ACTION_ADD_DEVICE_ADMIN 1104 */ 1105 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN"; 1106 1107 /** 1108 * An optional CharSequence providing additional explanation for why the 1109 * admin is being added. 1110 * 1111 * @see #ACTION_ADD_DEVICE_ADMIN 1112 */ 1113 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION"; 1114 1115 /** 1116 * Constant to indicate the feature of disabling the camera. Used as argument to 1117 * {@link #createAdminSupportIntent(String)}. 1118 * @see #setCameraDisabled(ComponentName, boolean) 1119 */ 1120 public static final String POLICY_DISABLE_CAMERA = "policy_disable_camera"; 1121 1122 /** 1123 * Constant to indicate the feature of disabling screen captures. Used as argument to 1124 * {@link #createAdminSupportIntent(String)}. 1125 * @see #setScreenCaptureDisabled(ComponentName, boolean) 1126 */ 1127 public static final String POLICY_DISABLE_SCREEN_CAPTURE = "policy_disable_screen_capture"; 1128 1129 /** 1130 * A String indicating a specific restricted feature. Can be a user restriction from the 1131 * {@link UserManager}, e.g. {@link UserManager#DISALLOW_ADJUST_VOLUME}, or one of the values 1132 * {@link #POLICY_DISABLE_CAMERA} or {@link #POLICY_DISABLE_SCREEN_CAPTURE}. 1133 * @see #createAdminSupportIntent(String) 1134 * @hide 1135 */ 1136 @TestApi 1137 public static final String EXTRA_RESTRICTION = "android.app.extra.RESTRICTION"; 1138 1139 /** 1140 * Activity action: have the user enter a new password. This activity should 1141 * be launched after using {@link #setPasswordQuality(ComponentName, int)}, 1142 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user 1143 * enter a new password that meets the current requirements. You can use 1144 * {@link #isActivePasswordSufficient()} to determine whether you need to 1145 * have the user select a new password in order to meet the current 1146 * constraints. Upon being resumed from this activity, you can check the new 1147 * password characteristics to see if they are sufficient. 1148 * 1149 * If the intent is launched from within a managed profile with a profile 1150 * owner built against {@link android.os.Build.VERSION_CODES#M} or before, 1151 * this will trigger entering a new password for the parent of the profile. 1152 * For all other cases it will trigger entering a new password for the user 1153 * or profile it is launched from. 1154 * 1155 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD 1156 */ 1157 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 1158 public static final String ACTION_SET_NEW_PASSWORD 1159 = "android.app.action.SET_NEW_PASSWORD"; 1160 1161 /** 1162 * Activity action: have the user enter a new password for the parent profile. 1163 * If the intent is launched from within a managed profile, this will trigger 1164 * entering a new password for the parent of the profile. In all other cases 1165 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}. 1166 */ 1167 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 1168 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD 1169 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD"; 1170 1171 /** 1172 * Broadcast action: Tell the status bar to open the device monitoring dialog, e.g. when 1173 * Network logging was enabled and the user tapped the notification. 1174 * <p class="note">This is a protected intent that can only be sent by the system.</p> 1175 * @hide 1176 */ 1177 public static final String ACTION_SHOW_DEVICE_MONITORING_DIALOG 1178 = "android.app.action.SHOW_DEVICE_MONITORING_DIALOG"; 1179 1180 /** 1181 * Broadcast Action: Sent after application delegation scopes are changed. The new delegation 1182 * scopes will be sent in an {@code ArrayList<String>} extra identified by the 1183 * {@link #EXTRA_DELEGATION_SCOPES} key. 1184 * 1185 * <p class=”note”> Note: This is a protected intent that can only be sent by the system.</p> 1186 */ 1187 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 1188 public static final String ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED = 1189 "android.app.action.APPLICATION_DELEGATION_SCOPES_CHANGED"; 1190 1191 /** 1192 * An {@code ArrayList<String>} corresponding to the delegation scopes given to an app in the 1193 * {@link #ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED} broadcast. 1194 */ 1195 public static final String EXTRA_DELEGATION_SCOPES = "android.app.extra.DELEGATION_SCOPES"; 1196 1197 /** 1198 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in 1199 * the parent profile to access intents sent from the managed profile. 1200 * That is, when an app in the managed profile calls 1201 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a 1202 * matching activity in the parent profile. 1203 */ 1204 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001; 1205 1206 /** 1207 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in 1208 * the managed profile to access intents sent from the parent profile. 1209 * That is, when an app in the parent profile calls 1210 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a 1211 * matching activity in the managed profile. 1212 */ 1213 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002; 1214 1215 /** 1216 * Broadcast action: notify that a new local system update policy has been set by the device 1217 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}. 1218 */ 1219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 1220 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED 1221 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED"; 1222 1223 /** 1224 * Permission policy to prompt user for new permission requests for runtime permissions. 1225 * Already granted or denied permissions are not affected by this. 1226 */ 1227 public static final int PERMISSION_POLICY_PROMPT = 0; 1228 1229 /** 1230 * Permission policy to always grant new permission requests for runtime permissions. 1231 * Already granted or denied permissions are not affected by this. 1232 */ 1233 public static final int PERMISSION_POLICY_AUTO_GRANT = 1; 1234 1235 /** 1236 * Permission policy to always deny new permission requests for runtime permissions. 1237 * Already granted or denied permissions are not affected by this. 1238 */ 1239 public static final int PERMISSION_POLICY_AUTO_DENY = 2; 1240 1241 /** 1242 * Runtime permission state: The user can manage the permission 1243 * through the UI. 1244 */ 1245 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0; 1246 1247 /** 1248 * Runtime permission state: The permission is granted to the app 1249 * and the user cannot manage the permission through the UI. 1250 */ 1251 public static final int PERMISSION_GRANT_STATE_GRANTED = 1; 1252 1253 /** 1254 * Runtime permission state: The permission is denied to the app 1255 * and the user cannot manage the permission through the UI. 1256 */ 1257 public static final int PERMISSION_GRANT_STATE_DENIED = 2; 1258 1259 /** 1260 * Delegation of certificate installation and management. This scope grants access to the 1261 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert}, 1262 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair} APIs. 1263 */ 1264 public static final String DELEGATION_CERT_INSTALL = "delegation-cert-install"; 1265 1266 /** 1267 * Delegation of application restrictions management. This scope grants access to the 1268 * {@link #setApplicationRestrictions} and {@link #getApplicationRestrictions} APIs. 1269 */ 1270 public static final String DELEGATION_APP_RESTRICTIONS = "delegation-app-restrictions"; 1271 1272 /** 1273 * Delegation of application uninstall block. This scope grants access to the 1274 * {@link #setUninstallBlocked} API. 1275 */ 1276 public static final String DELEGATION_BLOCK_UNINSTALL = "delegation-block-uninstall"; 1277 1278 /** 1279 * Delegation of permission policy and permission grant state. This scope grants access to the 1280 * {@link #setPermissionPolicy}, {@link #getPermissionGrantState}, 1281 * and {@link #setPermissionGrantState} APIs. 1282 */ 1283 public static final String DELEGATION_PERMISSION_GRANT = "delegation-permission-grant"; 1284 1285 /** 1286 * Delegation of package access state. This scope grants access to the 1287 * {@link #isApplicationHidden}, {@link #setApplicationHidden}, {@link #isPackageSuspended}, and 1288 * {@link #setPackagesSuspended} APIs. 1289 */ 1290 public static final String DELEGATION_PACKAGE_ACCESS = "delegation-package-access"; 1291 1292 /** 1293 * Delegation for enabling system apps. This scope grants access to the {@link #enableSystemApp} 1294 * API. 1295 */ 1296 public static final String DELEGATION_ENABLE_SYSTEM_APP = "delegation-enable-system-app"; 1297 1298 /** 1299 * Delegation of management of uninstalled packages. This scope grants access to the 1300 * {@code #setKeepUninstalledPackages} and {@code #getKeepUninstalledPackages} APIs. 1301 * @hide 1302 */ 1303 public static final String DELEGATION_KEEP_UNINSTALLED_PACKAGES = 1304 "delegation-keep-uninstalled-packages"; 1305 1306 /** 1307 * No management for current user in-effect. This is the default. 1308 * @hide 1309 */ 1310 @SystemApi 1311 public static final int STATE_USER_UNMANAGED = 0; 1312 1313 /** 1314 * Management partially setup, user setup needs to be completed. 1315 * @hide 1316 */ 1317 @SystemApi 1318 public static final int STATE_USER_SETUP_INCOMPLETE = 1; 1319 1320 /** 1321 * Management partially setup, user setup completed. 1322 * @hide 1323 */ 1324 @SystemApi 1325 public static final int STATE_USER_SETUP_COMPLETE = 2; 1326 1327 /** 1328 * Management setup and active on current user. 1329 * @hide 1330 */ 1331 @SystemApi 1332 public static final int STATE_USER_SETUP_FINALIZED = 3; 1333 1334 /** 1335 * Management partially setup on a managed profile. 1336 * @hide 1337 */ 1338 @SystemApi 1339 public static final int STATE_USER_PROFILE_COMPLETE = 4; 1340 1341 /** 1342 * @hide 1343 */ 1344 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE, 1345 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE}) 1346 @Retention(RetentionPolicy.SOURCE) 1347 public @interface UserProvisioningState {} 1348 1349 /** 1350 * Result code for {@link #checkProvisioningPreCondition}. 1351 * 1352 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE}, 1353 * {@link #ACTION_PROVISION_MANAGED_PROFILE}, {@link #ACTION_PROVISION_MANAGED_USER} and 1354 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when provisioning is allowed. 1355 * 1356 * @hide 1357 */ 1358 public static final int CODE_OK = 0; 1359 1360 /** 1361 * Result code for {@link #checkProvisioningPreCondition}. 1362 * 1363 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and 1364 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the device already has a device 1365 * owner. 1366 * 1367 * @hide 1368 */ 1369 public static final int CODE_HAS_DEVICE_OWNER = 1; 1370 1371 /** 1372 * Result code for {@link #checkProvisioningPreCondition}. 1373 * 1374 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE}, 1375 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the user has a profile owner and for 1376 * {@link #ACTION_PROVISION_MANAGED_PROFILE} when the profile owner is already set. 1377 * 1378 * @hide 1379 */ 1380 public static final int CODE_USER_HAS_PROFILE_OWNER = 2; 1381 1382 /** 1383 * Result code for {@link #checkProvisioningPreCondition}. 1384 * 1385 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and 1386 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the user isn't running. 1387 * 1388 * @hide 1389 */ 1390 public static final int CODE_USER_NOT_RUNNING = 3; 1391 1392 /** 1393 * Result code for {@link #checkProvisioningPreCondition}. 1394 * 1395 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE}, 1396 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} if the device has already been setup and 1397 * for {@link #ACTION_PROVISION_MANAGED_USER} if the user has already been setup. 1398 * 1399 * @hide 1400 */ 1401 public static final int CODE_USER_SETUP_COMPLETED = 4; 1402 1403 /** 1404 * Code used to indicate that the device also has a user other than the system user. 1405 * 1406 * @hide 1407 */ 1408 public static final int CODE_NONSYSTEM_USER_EXISTS = 5; 1409 1410 /** 1411 * Code used to indicate that device has an account that prevents provisioning. 1412 * 1413 * @hide 1414 */ 1415 public static final int CODE_ACCOUNTS_NOT_EMPTY = 6; 1416 1417 /** 1418 * Result code for {@link #checkProvisioningPreCondition}. 1419 * 1420 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and 1421 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} if the user is not a system user. 1422 * 1423 * @hide 1424 */ 1425 public static final int CODE_NOT_SYSTEM_USER = 7; 1426 1427 /** 1428 * Result code for {@link #checkProvisioningPreCondition}. 1429 * 1430 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE}, 1431 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} and {@link #ACTION_PROVISION_MANAGED_USER} 1432 * when the device is a watch and is already paired. 1433 * 1434 * @hide 1435 */ 1436 public static final int CODE_HAS_PAIRED = 8; 1437 1438 /** 1439 * Result code for {@link #checkProvisioningPreCondition}. 1440 * 1441 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} and 1442 * {@link #ACTION_PROVISION_MANAGED_USER} on devices which do not support managed users. 1443 * 1444 * @see {@link PackageManager#FEATURE_MANAGED_USERS} 1445 * @hide 1446 */ 1447 public static final int CODE_MANAGED_USERS_NOT_SUPPORTED = 9; 1448 1449 /** 1450 * Result code for {@link #checkProvisioningPreCondition}. 1451 * 1452 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_USER} if the user is a system user. 1453 * 1454 * @hide 1455 */ 1456 public static final int CODE_SYSTEM_USER = 10; 1457 1458 /** 1459 * Result code for {@link #checkProvisioningPreCondition}. 1460 * 1461 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when the user cannot have more 1462 * managed profiles. 1463 * 1464 * @hide 1465 */ 1466 public static final int CODE_CANNOT_ADD_MANAGED_PROFILE = 11; 1467 1468 /** 1469 * Result code for {@link #checkProvisioningPreCondition}. 1470 * 1471 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_USER} and 1472 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} on devices not running with split system 1473 * user. 1474 * 1475 * @hide 1476 */ 1477 public static final int CODE_NOT_SYSTEM_USER_SPLIT = 12; 1478 1479 /** 1480 * Result code for {@link #checkProvisioningPreCondition}. 1481 * 1482 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE}, 1483 * {@link #ACTION_PROVISION_MANAGED_PROFILE}, {@link #ACTION_PROVISION_MANAGED_USER} and 1484 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} on devices which do no support device 1485 * admins. 1486 * 1487 * @hide 1488 */ 1489 public static final int CODE_DEVICE_ADMIN_NOT_SUPPORTED = 13; 1490 1491 /** 1492 * Result code for {@link #checkProvisioningPreCondition}. 1493 * 1494 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when the device the user is a 1495 * system user on a split system user device. 1496 * 1497 * @hide 1498 */ 1499 public static final int CODE_SPLIT_SYSTEM_USER_DEVICE_SYSTEM_USER = 14; 1500 1501 /** 1502 * Result code for {@link #checkProvisioningPreCondition}. 1503 * 1504 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when adding a managed profile is 1505 * disallowed by {@link UserManager#DISALLOW_ADD_MANAGED_PROFILE}. 1506 * 1507 * @hide 1508 */ 1509 public static final int CODE_ADD_MANAGED_PROFILE_DISALLOWED = 15; 1510 1511 /** 1512 * Result codes for {@link #checkProvisioningPreCondition} indicating all the provisioning pre 1513 * conditions. 1514 * 1515 * @hide 1516 */ 1517 @Retention(RetentionPolicy.SOURCE) 1518 @IntDef({CODE_OK, CODE_HAS_DEVICE_OWNER, CODE_USER_HAS_PROFILE_OWNER, CODE_USER_NOT_RUNNING, 1519 CODE_USER_SETUP_COMPLETED, CODE_NOT_SYSTEM_USER, CODE_HAS_PAIRED, 1520 CODE_MANAGED_USERS_NOT_SUPPORTED, CODE_SYSTEM_USER, CODE_CANNOT_ADD_MANAGED_PROFILE, 1521 CODE_NOT_SYSTEM_USER_SPLIT, CODE_DEVICE_ADMIN_NOT_SUPPORTED, 1522 CODE_SPLIT_SYSTEM_USER_DEVICE_SYSTEM_USER, CODE_ADD_MANAGED_PROFILE_DISALLOWED}) 1523 public @interface ProvisioningPreCondition {} 1524 1525 /** 1526 * Return true if the given administrator component is currently active (enabled) in the system. 1527 * 1528 * @param admin The administrator component to check for. 1529 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false} 1530 * otherwise 1531 */ 1532 public boolean isAdminActive(@NonNull ComponentName admin) { 1533 throwIfParentInstance("isAdminActive"); 1534 return isAdminActiveAsUser(admin, myUserId()); 1535 } 1536 1537 /** 1538 * @see #isAdminActive(ComponentName) 1539 * @hide 1540 */ 1541 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) { 1542 if (mService != null) { 1543 try { 1544 return mService.isAdminActive(admin, userId); 1545 } catch (RemoteException e) { 1546 throw e.rethrowFromSystemServer(); 1547 } 1548 } 1549 return false; 1550 } 1551 1552 /** 1553 * Return true if the given administrator component is currently being removed 1554 * for the user. 1555 * @hide 1556 */ 1557 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) { 1558 if (mService != null) { 1559 try { 1560 return mService.isRemovingAdmin(admin, userId); 1561 } catch (RemoteException e) { 1562 throw e.rethrowFromSystemServer(); 1563 } 1564 } 1565 return false; 1566 } 1567 1568 /** 1569 * Return a list of all currently active device administrators' component 1570 * names. If there are no administrators {@code null} may be 1571 * returned. 1572 */ 1573 public @Nullable List<ComponentName> getActiveAdmins() { 1574 throwIfParentInstance("getActiveAdmins"); 1575 return getActiveAdminsAsUser(myUserId()); 1576 } 1577 1578 /** 1579 * @see #getActiveAdmins() 1580 * @hide 1581 */ 1582 public @Nullable List<ComponentName> getActiveAdminsAsUser(int userId) { 1583 if (mService != null) { 1584 try { 1585 return mService.getActiveAdmins(userId); 1586 } catch (RemoteException e) { 1587 throw e.rethrowFromSystemServer(); 1588 } 1589 } 1590 return null; 1591 } 1592 1593 /** 1594 * Used by package administration code to determine if a package can be stopped 1595 * or uninstalled. 1596 * @hide 1597 */ 1598 @SystemApi 1599 public boolean packageHasActiveAdmins(String packageName) { 1600 return packageHasActiveAdmins(packageName, myUserId()); 1601 } 1602 1603 /** 1604 * Used by package administration code to determine if a package can be stopped 1605 * or uninstalled. 1606 * @hide 1607 */ 1608 public boolean packageHasActiveAdmins(String packageName, int userId) { 1609 if (mService != null) { 1610 try { 1611 return mService.packageHasActiveAdmins(packageName, userId); 1612 } catch (RemoteException e) { 1613 throw e.rethrowFromSystemServer(); 1614 } 1615 } 1616 return false; 1617 } 1618 1619 /** 1620 * Remove a current administration component. This can only be called 1621 * by the application that owns the administration component; if you 1622 * try to remove someone else's component, a security exception will be 1623 * thrown. 1624 * 1625 * <p>Note that the operation is not synchronous and the admin might still be active (as 1626 * indicated by {@link #getActiveAdmins()}) by the time this method returns. 1627 * 1628 * @param admin The administration compononent to remove. 1629 * @throws SecurityException if the caller is not in the owner application of {@code admin}. 1630 */ 1631 public void removeActiveAdmin(@NonNull ComponentName admin) { 1632 throwIfParentInstance("removeActiveAdmin"); 1633 if (mService != null) { 1634 try { 1635 mService.removeActiveAdmin(admin, myUserId()); 1636 } catch (RemoteException e) { 1637 throw e.rethrowFromSystemServer(); 1638 } 1639 } 1640 } 1641 1642 /** 1643 * Returns true if an administrator has been granted a particular device policy. This can be 1644 * used to check whether the administrator was activated under an earlier set of policies, but 1645 * requires additional policies after an upgrade. 1646 * 1647 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an 1648 * active administrator, or an exception will be thrown. 1649 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}. 1650 * @throws SecurityException if {@code admin} is not an active administrator. 1651 */ 1652 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) { 1653 throwIfParentInstance("hasGrantedPolicy"); 1654 if (mService != null) { 1655 try { 1656 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId()); 1657 } catch (RemoteException e) { 1658 throw e.rethrowFromSystemServer(); 1659 } 1660 } 1661 return false; 1662 } 1663 1664 /** 1665 * Returns true if the Profile Challenge is available to use for the given profile user. 1666 * 1667 * @hide 1668 */ 1669 public boolean isSeparateProfileChallengeAllowed(int userHandle) { 1670 if (mService != null) { 1671 try { 1672 return mService.isSeparateProfileChallengeAllowed(userHandle); 1673 } catch (RemoteException e) { 1674 throw e.rethrowFromSystemServer(); 1675 } 1676 } 1677 return false; 1678 } 1679 1680 /** 1681 * Constant for {@link #setPasswordQuality}: the policy has no requirements 1682 * for the password. Note that quality constants are ordered so that higher 1683 * values are more restrictive. 1684 */ 1685 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0; 1686 1687 /** 1688 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric 1689 * recognition technology. This implies technologies that can recognize the identity of 1690 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000). 1691 * Note that quality constants are ordered so that higher values are more restrictive. 1692 */ 1693 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000; 1694 1695 /** 1696 * Constant for {@link #setPasswordQuality}: the policy requires some kind 1697 * of password or pattern, but doesn't care what it is. Note that quality constants 1698 * are ordered so that higher values are more restrictive. 1699 */ 1700 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000; 1701 1702 /** 1703 * Constant for {@link #setPasswordQuality}: the user must have entered a 1704 * password containing at least numeric characters. Note that quality 1705 * constants are ordered so that higher values are more restrictive. 1706 */ 1707 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000; 1708 1709 /** 1710 * Constant for {@link #setPasswordQuality}: the user must have entered a 1711 * password containing at least numeric characters with no repeating (4444) 1712 * or ordered (1234, 4321, 2468) sequences. Note that quality 1713 * constants are ordered so that higher values are more restrictive. 1714 */ 1715 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000; 1716 1717 /** 1718 * Constant for {@link #setPasswordQuality}: the user must have entered a 1719 * password containing at least alphabetic (or other symbol) characters. 1720 * Note that quality constants are ordered so that higher values are more 1721 * restrictive. 1722 */ 1723 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000; 1724 1725 /** 1726 * Constant for {@link #setPasswordQuality}: the user must have entered a 1727 * password containing at least <em>both></em> numeric <em>and</em> 1728 * alphabetic (or other symbol) characters. Note that quality constants are 1729 * ordered so that higher values are more restrictive. 1730 */ 1731 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000; 1732 1733 /** 1734 * Constant for {@link #setPasswordQuality}: the user must have entered a 1735 * password containing at least a letter, a numerical digit and a special 1736 * symbol, by default. With this password quality, passwords can be 1737 * restricted to contain various sets of characters, like at least an 1738 * uppercase letter, etc. These are specified using various methods, 1739 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note 1740 * that quality constants are ordered so that higher values are more 1741 * restrictive. 1742 */ 1743 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000; 1744 1745 /** 1746 * Constant for {@link #setPasswordQuality}: the user is not allowed to 1747 * modify password. In case this password quality is set, the password is 1748 * managed by a profile owner. The profile owner can set any password, 1749 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note 1750 * that quality constants are ordered so that higher values are more 1751 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is 1752 * the highest. 1753 * @hide 1754 */ 1755 public static final int PASSWORD_QUALITY_MANAGED = 0x80000; 1756 1757 /** 1758 * @hide 1759 * 1760 * adb shell dpm set-{device,profile}-owner will normally not allow installing an owner to 1761 * a user with accounts. {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} 1762 * and {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} are the account features 1763 * used by authenticator to exempt their accounts from this: 1764 * 1765 * <ul> 1766 * <li>Non-test-only DO/PO still can't be installed when there are accounts. 1767 * <p>In order to make an apk test-only, add android:testOnly="true" to the 1768 * <application> tag in the manifest. 1769 * 1770 * <li>Test-only DO/PO can be installed even when there are accounts, as long as all the 1771 * accounts have the {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} feature. 1772 * Some authenticators claim to have any features, so to detect it, we also check 1773 * {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} and disallow installing 1774 * if any of the accounts have it. 1775 * </ul> 1776 */ 1777 @SystemApi 1778 @TestApi 1779 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED = 1780 "android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED"; 1781 1782 /** @hide See {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} */ 1783 @SystemApi 1784 @TestApi 1785 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED = 1786 "android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED"; 1787 1788 /** 1789 * Called by an application that is administering the device to set the password restrictions it 1790 * is imposing. After setting this, the user will not be able to enter a new password that is 1791 * not at least as restrictive as what has been set. Note that the current password will remain 1792 * until the user has set a new one, so the change does not take place immediately. To prompt 1793 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or 1794 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method. 1795 * <p> 1796 * Quality constants are ordered so that higher values are more restrictive; thus the highest 1797 * requested quality constant (between the policy set here, the user's preference, and any other 1798 * considerations) is the one that is in effect. 1799 * <p> 1800 * The calling device admin must have requested 1801 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 1802 * not, a security exception will be thrown. 1803 * <p> 1804 * This method can be called on the {@link DevicePolicyManager} instance returned by 1805 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 1806 * profile. 1807 * 1808 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1809 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED}, 1810 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC}, 1811 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC}, 1812 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}. 1813 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin} 1814 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 1815 */ 1816 public void setPasswordQuality(@NonNull ComponentName admin, int quality) { 1817 if (mService != null) { 1818 try { 1819 mService.setPasswordQuality(admin, quality, mParentInstance); 1820 } catch (RemoteException e) { 1821 throw e.rethrowFromSystemServer(); 1822 } 1823 } 1824 } 1825 1826 /** 1827 * Retrieve the current minimum password quality for a particular admin or all admins that set 1828 * restrictions on this user and its participating profiles. Restrictions on profiles that have 1829 * a separate challenge are not taken into account. 1830 * 1831 * <p>This method can be called on the {@link DevicePolicyManager} instance 1832 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 1833 * restrictions on the parent profile. 1834 * 1835 * @param admin The name of the admin component to check, or {@code null} to aggregate 1836 * all admins. 1837 */ 1838 public int getPasswordQuality(@Nullable ComponentName admin) { 1839 return getPasswordQuality(admin, myUserId()); 1840 } 1841 1842 /** @hide per-user version */ 1843 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) { 1844 if (mService != null) { 1845 try { 1846 return mService.getPasswordQuality(admin, userHandle, mParentInstance); 1847 } catch (RemoteException e) { 1848 throw e.rethrowFromSystemServer(); 1849 } 1850 } 1851 return PASSWORD_QUALITY_UNSPECIFIED; 1852 } 1853 1854 /** 1855 * Called by an application that is administering the device to set the minimum allowed password 1856 * length. After setting this, the user will not be able to enter a new password that is not at 1857 * least as restrictive as what has been set. Note that the current password will remain until 1858 * the user has set a new one, so the change does not take place immediately. To prompt the user 1859 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or 1860 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is 1861 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC} 1862 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC}, 1863 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with 1864 * {@link #setPasswordQuality}. 1865 * <p> 1866 * The calling device admin must have requested 1867 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 1868 * not, a security exception will be thrown. 1869 * <p> 1870 * This method can be called on the {@link DevicePolicyManager} instance returned by 1871 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 1872 * profile. 1873 * 1874 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1875 * @param length The new desired minimum password length. A value of 0 means there is no 1876 * restriction. 1877 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin} 1878 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 1879 */ 1880 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) { 1881 if (mService != null) { 1882 try { 1883 mService.setPasswordMinimumLength(admin, length, mParentInstance); 1884 } catch (RemoteException e) { 1885 throw e.rethrowFromSystemServer(); 1886 } 1887 } 1888 } 1889 1890 /** 1891 * Retrieve the current minimum password length for a particular admin or all admins that set 1892 * restrictions on this user and its participating profiles. Restrictions on profiles that have 1893 * a separate challenge are not taken into account. 1894 * 1895 * <p>This method can be called on the {@link DevicePolicyManager} instance 1896 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 1897 * restrictions on the parent profile. 1898 * 1899 * user and its profiles or a particular one. 1900 * @param admin The name of the admin component to check, or {@code null} to aggregate 1901 * all admins. 1902 */ 1903 public int getPasswordMinimumLength(@Nullable ComponentName admin) { 1904 return getPasswordMinimumLength(admin, myUserId()); 1905 } 1906 1907 /** @hide per-user version */ 1908 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) { 1909 if (mService != null) { 1910 try { 1911 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance); 1912 } catch (RemoteException e) { 1913 throw e.rethrowFromSystemServer(); 1914 } 1915 } 1916 return 0; 1917 } 1918 1919 /** 1920 * Called by an application that is administering the device to set the minimum number of upper 1921 * case letters required in the password. After setting this, the user will not be able to enter 1922 * a new password that is not at least as restrictive as what has been set. Note that the 1923 * current password will remain until the user has set a new one, so the change does not take 1924 * place immediately. To prompt the user for a new password, use 1925 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after 1926 * setting this value. This constraint is only imposed if the administrator has also requested 1927 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0. 1928 * <p> 1929 * The calling device admin must have requested 1930 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 1931 * not, a security exception will be thrown. 1932 * <p> 1933 * This method can be called on the {@link DevicePolicyManager} instance returned by 1934 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 1935 * profile. 1936 * 1937 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1938 * @param length The new desired minimum number of upper case letters required in the password. 1939 * A value of 0 means there is no restriction. 1940 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin} 1941 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 1942 */ 1943 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) { 1944 if (mService != null) { 1945 try { 1946 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance); 1947 } catch (RemoteException e) { 1948 throw e.rethrowFromSystemServer(); 1949 } 1950 } 1951 } 1952 1953 /** 1954 * Retrieve the current number of upper case letters required in the password 1955 * for a particular admin or all admins that set restrictions on this user and 1956 * its participating profiles. Restrictions on profiles that have a separate challenge 1957 * are not taken into account. 1958 * This is the same value as set by 1959 * {@link #setPasswordMinimumUpperCase(ComponentName, int)} 1960 * and only applies when the password quality is 1961 * {@link #PASSWORD_QUALITY_COMPLEX}. 1962 * 1963 * <p>This method can be called on the {@link DevicePolicyManager} instance 1964 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 1965 * restrictions on the parent profile. 1966 * 1967 * @param admin The name of the admin component to check, or {@code null} to 1968 * aggregate all admins. 1969 * @return The minimum number of upper case letters required in the 1970 * password. 1971 */ 1972 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) { 1973 return getPasswordMinimumUpperCase(admin, myUserId()); 1974 } 1975 1976 /** @hide per-user version */ 1977 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) { 1978 if (mService != null) { 1979 try { 1980 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance); 1981 } catch (RemoteException e) { 1982 throw e.rethrowFromSystemServer(); 1983 } 1984 } 1985 return 0; 1986 } 1987 1988 /** 1989 * Called by an application that is administering the device to set the minimum number of lower 1990 * case letters required in the password. After setting this, the user will not be able to enter 1991 * a new password that is not at least as restrictive as what has been set. Note that the 1992 * current password will remain until the user has set a new one, so the change does not take 1993 * place immediately. To prompt the user for a new password, use 1994 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after 1995 * setting this value. This constraint is only imposed if the administrator has also requested 1996 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0. 1997 * <p> 1998 * The calling device admin must have requested 1999 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 2000 * not, a security exception will be thrown. 2001 * <p> 2002 * This method can be called on the {@link DevicePolicyManager} instance returned by 2003 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 2004 * profile. 2005 * 2006 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2007 * @param length The new desired minimum number of lower case letters required in the password. 2008 * A value of 0 means there is no restriction. 2009 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin} 2010 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 2011 */ 2012 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) { 2013 if (mService != null) { 2014 try { 2015 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance); 2016 } catch (RemoteException e) { 2017 throw e.rethrowFromSystemServer(); 2018 } 2019 } 2020 } 2021 2022 /** 2023 * Retrieve the current number of lower case letters required in the password 2024 * for a particular admin or all admins that set restrictions on this user 2025 * and its participating profiles. Restrictions on profiles that have 2026 * a separate challenge are not taken into account. 2027 * This is the same value as set by 2028 * {@link #setPasswordMinimumLowerCase(ComponentName, int)} 2029 * and only applies when the password quality is 2030 * {@link #PASSWORD_QUALITY_COMPLEX}. 2031 * 2032 * <p>This method can be called on the {@link DevicePolicyManager} instance 2033 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2034 * restrictions on the parent profile. 2035 * 2036 * @param admin The name of the admin component to check, or {@code null} to 2037 * aggregate all admins. 2038 * @return The minimum number of lower case letters required in the 2039 * password. 2040 */ 2041 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) { 2042 return getPasswordMinimumLowerCase(admin, myUserId()); 2043 } 2044 2045 /** @hide per-user version */ 2046 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) { 2047 if (mService != null) { 2048 try { 2049 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance); 2050 } catch (RemoteException e) { 2051 throw e.rethrowFromSystemServer(); 2052 } 2053 } 2054 return 0; 2055 } 2056 2057 /** 2058 * Called by an application that is administering the device to set the minimum number of 2059 * letters required in the password. After setting this, the user will not be able to enter a 2060 * new password that is not at least as restrictive as what has been set. Note that the current 2061 * password will remain until the user has set a new one, so the change does not take place 2062 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or 2063 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is 2064 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with 2065 * {@link #setPasswordQuality}. The default value is 1. 2066 * <p> 2067 * The calling device admin must have requested 2068 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 2069 * not, a security exception will be thrown. 2070 * <p> 2071 * This method can be called on the {@link DevicePolicyManager} instance returned by 2072 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 2073 * profile. 2074 * 2075 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2076 * @param length The new desired minimum number of letters required in the password. A value of 2077 * 0 means there is no restriction. 2078 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin} 2079 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 2080 */ 2081 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) { 2082 if (mService != null) { 2083 try { 2084 mService.setPasswordMinimumLetters(admin, length, mParentInstance); 2085 } catch (RemoteException e) { 2086 throw e.rethrowFromSystemServer(); 2087 } 2088 } 2089 } 2090 2091 /** 2092 * Retrieve the current number of letters required in the password 2093 * for a particular admin or all admins that set restrictions on this user 2094 * and its participating profiles. Restrictions on profiles that have 2095 * a separate challenge are not taken into account. 2096 * This is the same value as set by 2097 * {@link #setPasswordMinimumLetters(ComponentName, int)} 2098 * and only applies when the password quality is 2099 * {@link #PASSWORD_QUALITY_COMPLEX}. 2100 * 2101 * <p>This method can be called on the {@link DevicePolicyManager} instance 2102 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2103 * restrictions on the parent profile. 2104 * 2105 * @param admin The name of the admin component to check, or {@code null} to 2106 * aggregate all admins. 2107 * @return The minimum number of letters required in the password. 2108 */ 2109 public int getPasswordMinimumLetters(@Nullable ComponentName admin) { 2110 return getPasswordMinimumLetters(admin, myUserId()); 2111 } 2112 2113 /** @hide per-user version */ 2114 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) { 2115 if (mService != null) { 2116 try { 2117 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance); 2118 } catch (RemoteException e) { 2119 throw e.rethrowFromSystemServer(); 2120 } 2121 } 2122 return 0; 2123 } 2124 2125 /** 2126 * Called by an application that is administering the device to set the minimum number of 2127 * numerical digits required in the password. After setting this, the user will not be able to 2128 * enter a new password that is not at least as restrictive as what has been set. Note that the 2129 * current password will remain until the user has set a new one, so the change does not take 2130 * place immediately. To prompt the user for a new password, use 2131 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after 2132 * setting this value. This constraint is only imposed if the administrator has also requested 2133 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1. 2134 * <p> 2135 * The calling device admin must have requested 2136 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 2137 * not, a security exception will be thrown. 2138 * <p> 2139 * This method can be called on the {@link DevicePolicyManager} instance returned by 2140 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 2141 * profile. 2142 * 2143 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2144 * @param length The new desired minimum number of numerical digits required in the password. A 2145 * value of 0 means there is no restriction. 2146 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin} 2147 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 2148 */ 2149 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) { 2150 if (mService != null) { 2151 try { 2152 mService.setPasswordMinimumNumeric(admin, length, mParentInstance); 2153 } catch (RemoteException e) { 2154 throw e.rethrowFromSystemServer(); 2155 } 2156 } 2157 } 2158 2159 /** 2160 * Retrieve the current number of numerical digits required in the password 2161 * for a particular admin or all admins that set restrictions on this user 2162 * and its participating profiles. Restrictions on profiles that have 2163 * a separate challenge are not taken into account. 2164 * This is the same value as set by 2165 * {@link #setPasswordMinimumNumeric(ComponentName, int)} 2166 * and only applies when the password quality is 2167 * {@link #PASSWORD_QUALITY_COMPLEX}. 2168 * 2169 * <p>This method can be called on the {@link DevicePolicyManager} instance 2170 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2171 * restrictions on the parent profile. 2172 * 2173 * @param admin The name of the admin component to check, or {@code null} to 2174 * aggregate all admins. 2175 * @return The minimum number of numerical digits required in the password. 2176 */ 2177 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) { 2178 return getPasswordMinimumNumeric(admin, myUserId()); 2179 } 2180 2181 /** @hide per-user version */ 2182 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) { 2183 if (mService != null) { 2184 try { 2185 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance); 2186 } catch (RemoteException e) { 2187 throw e.rethrowFromSystemServer(); 2188 } 2189 } 2190 return 0; 2191 } 2192 2193 /** 2194 * Called by an application that is administering the device to set the minimum number of 2195 * symbols required in the password. After setting this, the user will not be able to enter a 2196 * new password that is not at least as restrictive as what has been set. Note that the current 2197 * password will remain until the user has set a new one, so the change does not take place 2198 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or 2199 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is 2200 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with 2201 * {@link #setPasswordQuality}. The default value is 1. 2202 * <p> 2203 * The calling device admin must have requested 2204 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 2205 * not, a security exception will be thrown. 2206 * <p> 2207 * This method can be called on the {@link DevicePolicyManager} instance returned by 2208 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 2209 * profile. 2210 * 2211 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2212 * @param length The new desired minimum number of symbols required in the password. A value of 2213 * 0 means there is no restriction. 2214 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin} 2215 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 2216 */ 2217 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) { 2218 if (mService != null) { 2219 try { 2220 mService.setPasswordMinimumSymbols(admin, length, mParentInstance); 2221 } catch (RemoteException e) { 2222 throw e.rethrowFromSystemServer(); 2223 } 2224 } 2225 } 2226 2227 /** 2228 * Retrieve the current number of symbols required in the password 2229 * for a particular admin or all admins that set restrictions on this user 2230 * and its participating profiles. Restrictions on profiles that have 2231 * a separate challenge are not taken into account. This is the same value as 2232 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)} 2233 * and only applies when the password quality is 2234 * {@link #PASSWORD_QUALITY_COMPLEX}. 2235 * 2236 * <p>This method can be called on the {@link DevicePolicyManager} instance 2237 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2238 * restrictions on the parent profile. 2239 * 2240 * @param admin The name of the admin component to check, or {@code null} to 2241 * aggregate all admins. 2242 * @return The minimum number of symbols required in the password. 2243 */ 2244 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) { 2245 return getPasswordMinimumSymbols(admin, myUserId()); 2246 } 2247 2248 /** @hide per-user version */ 2249 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) { 2250 if (mService != null) { 2251 try { 2252 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance); 2253 } catch (RemoteException e) { 2254 throw e.rethrowFromSystemServer(); 2255 } 2256 } 2257 return 0; 2258 } 2259 2260 /** 2261 * Called by an application that is administering the device to set the minimum number of 2262 * non-letter characters (numerical digits or symbols) required in the password. After setting 2263 * this, the user will not be able to enter a new password that is not at least as restrictive 2264 * as what has been set. Note that the current password will remain until the user has set a new 2265 * one, so the change does not take place immediately. To prompt the user for a new password, 2266 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after 2267 * setting this value. This constraint is only imposed if the administrator has also requested 2268 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0. 2269 * <p> 2270 * The calling device admin must have requested 2271 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 2272 * not, a security exception will be thrown. 2273 * <p> 2274 * This method can be called on the {@link DevicePolicyManager} instance returned by 2275 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 2276 * profile. 2277 * 2278 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2279 * @param length The new desired minimum number of letters required in the password. A value of 2280 * 0 means there is no restriction. 2281 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin} 2282 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 2283 */ 2284 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) { 2285 if (mService != null) { 2286 try { 2287 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance); 2288 } catch (RemoteException e) { 2289 throw e.rethrowFromSystemServer(); 2290 } 2291 } 2292 } 2293 2294 /** 2295 * Retrieve the current number of non-letter characters required in the password 2296 * for a particular admin or all admins that set restrictions on this user 2297 * and its participating profiles. Restrictions on profiles that have 2298 * a separate challenge are not taken into account. 2299 * This is the same value as set by 2300 * {@link #setPasswordMinimumNonLetter(ComponentName, int)} 2301 * and only applies when the password quality is 2302 * {@link #PASSWORD_QUALITY_COMPLEX}. 2303 * 2304 * <p>This method can be called on the {@link DevicePolicyManager} instance 2305 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2306 * restrictions on the parent profile. 2307 * 2308 * @param admin The name of the admin component to check, or {@code null} to 2309 * aggregate all admins. 2310 * @return The minimum number of letters required in the password. 2311 */ 2312 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) { 2313 return getPasswordMinimumNonLetter(admin, myUserId()); 2314 } 2315 2316 /** @hide per-user version */ 2317 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) { 2318 if (mService != null) { 2319 try { 2320 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance); 2321 } catch (RemoteException e) { 2322 throw e.rethrowFromSystemServer(); 2323 } 2324 } 2325 return 0; 2326 } 2327 2328 /** 2329 * Called by an application that is administering the device to set the length of the password 2330 * history. After setting this, the user will not be able to enter a new password that is the 2331 * same as any password in the history. Note that the current password will remain until the 2332 * user has set a new one, so the change does not take place immediately. To prompt the user for 2333 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or 2334 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is 2335 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC} 2336 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or 2337 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}. 2338 * <p> 2339 * The calling device admin must have requested 2340 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 2341 * not, a security exception will be thrown. 2342 * <p> 2343 * This method can be called on the {@link DevicePolicyManager} instance returned by 2344 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 2345 * profile. 2346 * 2347 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2348 * @param length The new desired length of password history. A value of 0 means there is no 2349 * restriction. 2350 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin} 2351 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 2352 */ 2353 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) { 2354 if (mService != null) { 2355 try { 2356 mService.setPasswordHistoryLength(admin, length, mParentInstance); 2357 } catch (RemoteException e) { 2358 throw e.rethrowFromSystemServer(); 2359 } 2360 } 2361 } 2362 2363 /** 2364 * Called by a device admin to set the password expiration timeout. Calling this method will 2365 * restart the countdown for password expiration for the given admin, as will changing the 2366 * device password (for all admins). 2367 * <p> 2368 * The provided timeout is the time delta in ms and will be added to the current time. For 2369 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 = 2370 * 432000000 ms for timeout. 2371 * <p> 2372 * To disable password expiration, a value of 0 may be used for timeout. 2373 * <p> 2374 * The calling device admin must have requested 2375 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has 2376 * not, a security exception will be thrown. 2377 * <p> 2378 * Note that setting the password will automatically reset the expiration time for all active 2379 * admins. Active admins do not need to explicitly call this method in that case. 2380 * <p> 2381 * This method can be called on the {@link DevicePolicyManager} instance returned by 2382 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 2383 * profile. 2384 * 2385 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2386 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means 2387 * there is no restriction (unlimited). 2388 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin} 2389 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} 2390 */ 2391 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) { 2392 if (mService != null) { 2393 try { 2394 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance); 2395 } catch (RemoteException e) { 2396 throw e.rethrowFromSystemServer(); 2397 } 2398 } 2399 } 2400 2401 /** 2402 * Get the password expiration timeout for the given admin. The expiration timeout is the 2403 * recurring expiration timeout provided in the call to 2404 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the 2405 * aggregate of all participating policy administrators if {@code admin} is null. Admins that 2406 * have set restrictions on profiles that have a separate challenge are not taken into account. 2407 * 2408 * <p>This method can be called on the {@link DevicePolicyManager} instance 2409 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2410 * restrictions on the parent profile. 2411 * 2412 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins. 2413 * @return The timeout for the given admin or the minimum of all timeouts 2414 */ 2415 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) { 2416 if (mService != null) { 2417 try { 2418 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance); 2419 } catch (RemoteException e) { 2420 throw e.rethrowFromSystemServer(); 2421 } 2422 } 2423 return 0; 2424 } 2425 2426 /** 2427 * Get the current password expiration time for a particular admin or all admins that set 2428 * restrictions on this user and its participating profiles. Restrictions on profiles that have 2429 * a separate challenge are not taken into account. If admin is {@code null}, then a composite 2430 * of all expiration times is returned - which will be the minimum of all of them. 2431 * 2432 * <p>This method can be called on the {@link DevicePolicyManager} instance 2433 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2434 * the password expiration for the parent profile. 2435 * 2436 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins. 2437 * @return The password expiration time, in milliseconds since epoch. 2438 */ 2439 public long getPasswordExpiration(@Nullable ComponentName admin) { 2440 if (mService != null) { 2441 try { 2442 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance); 2443 } catch (RemoteException e) { 2444 throw e.rethrowFromSystemServer(); 2445 } 2446 } 2447 return 0; 2448 } 2449 2450 /** 2451 * Retrieve the current password history length for a particular admin or all admins that 2452 * set restrictions on this user and its participating profiles. Restrictions on profiles that 2453 * have a separate challenge are not taken into account. 2454 * 2455 * <p>This method can be called on the {@link DevicePolicyManager} instance 2456 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2457 * restrictions on the parent profile. 2458 * 2459 * @param admin The name of the admin component to check, or {@code null} to aggregate 2460 * all admins. 2461 * @return The length of the password history 2462 */ 2463 public int getPasswordHistoryLength(@Nullable ComponentName admin) { 2464 return getPasswordHistoryLength(admin, myUserId()); 2465 } 2466 2467 /** @hide per-user version */ 2468 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) { 2469 if (mService != null) { 2470 try { 2471 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance); 2472 } catch (RemoteException e) { 2473 throw e.rethrowFromSystemServer(); 2474 } 2475 } 2476 return 0; 2477 } 2478 2479 /** 2480 * Return the maximum password length that the device supports for a 2481 * particular password quality. 2482 * @param quality The quality being interrogated. 2483 * @return Returns the maximum length that the user can enter. 2484 */ 2485 public int getPasswordMaximumLength(int quality) { 2486 // Kind-of arbitrary. 2487 return 16; 2488 } 2489 2490 /** 2491 * Determine whether the current password the user has set is sufficient to meet the policy 2492 * requirements (e.g. quality, minimum length) that have been requested by the admins of this 2493 * user and its participating profiles. Restrictions on profiles that have a separate challenge 2494 * are not taken into account. The user must be unlocked in order to perform the check. 2495 * <p> 2496 * The calling device admin must have requested 2497 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has 2498 * not, a security exception will be thrown. 2499 * <p> 2500 * This method can be called on the {@link DevicePolicyManager} instance returned by 2501 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on 2502 * the parent profile is sufficient. 2503 * 2504 * @return Returns true if the password meets the current requirements, else false. 2505 * @throws SecurityException if the calling application does not own an active administrator 2506 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} 2507 * @throws InvalidStateException if the user is not unlocked. 2508 */ 2509 public boolean isActivePasswordSufficient() { 2510 if (mService != null) { 2511 try { 2512 return mService.isActivePasswordSufficient(myUserId(), mParentInstance); 2513 } catch (RemoteException e) { 2514 throw e.rethrowFromSystemServer(); 2515 } 2516 } 2517 return false; 2518 } 2519 2520 /** 2521 * Determine whether the current profile password the user has set is sufficient 2522 * to meet the policy requirements (e.g. quality, minimum length) that have been 2523 * requested by the admins of the parent user and its profiles. 2524 * 2525 * @param userHandle the userId of the profile to check the password for. 2526 * @return Returns true if the password would meet the current requirements, else false. 2527 * @throws SecurityException if {@code userHandle} is not a managed profile. 2528 * @hide 2529 */ 2530 public boolean isProfileActivePasswordSufficientForParent(int userHandle) { 2531 if (mService != null) { 2532 try { 2533 return mService.isProfileActivePasswordSufficientForParent(userHandle); 2534 } catch (RemoteException e) { 2535 throw e.rethrowFromSystemServer(); 2536 } 2537 } 2538 return false; 2539 } 2540 2541 /** 2542 * Retrieve the number of times the user has failed at entering a password since that last 2543 * successful password entry. 2544 * <p> 2545 * This method can be called on the {@link DevicePolicyManager} instance returned by 2546 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed 2547 * password attemts for the parent user. 2548 * <p> 2549 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} 2550 * to be able to call this method; if it has not, a security exception will be thrown. 2551 * 2552 * @return The number of times user has entered an incorrect password since the last correct 2553 * password entry. 2554 * @throws SecurityException if the calling application does not own an active administrator 2555 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} 2556 */ 2557 public int getCurrentFailedPasswordAttempts() { 2558 return getCurrentFailedPasswordAttempts(myUserId()); 2559 } 2560 2561 /** 2562 * Retrieve the number of times the given user has failed at entering a 2563 * password since that last successful password entry. 2564 * 2565 * <p>The calling device admin must have requested 2566 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has 2567 * not and it is not the system uid, a security exception will be thrown. 2568 * 2569 * @hide 2570 */ 2571 public int getCurrentFailedPasswordAttempts(int userHandle) { 2572 if (mService != null) { 2573 try { 2574 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance); 2575 } catch (RemoteException e) { 2576 throw e.rethrowFromSystemServer(); 2577 } 2578 } 2579 return -1; 2580 } 2581 2582 /** 2583 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set. 2584 * 2585 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set. 2586 * @hide 2587 */ 2588 public boolean getDoNotAskCredentialsOnBoot() { 2589 if (mService != null) { 2590 try { 2591 return mService.getDoNotAskCredentialsOnBoot(); 2592 } catch (RemoteException e) { 2593 throw e.rethrowFromSystemServer(); 2594 } 2595 } 2596 return false; 2597 } 2598 2599 /** 2600 * Setting this to a value greater than zero enables a built-in policy that will perform a 2601 * device or profile wipe after too many incorrect device-unlock passwords have been entered. 2602 * This built-in policy combines watching for failed passwords and wiping the device, and 2603 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and 2604 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}. 2605 * <p> 2606 * To implement any other policy (e.g. wiping data for a particular application only, erasing or 2607 * revoking credentials, or reporting the failure to a server), you should implement 2608 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not 2609 * use this API, because if the maximum count is reached, the device or profile will be wiped 2610 * immediately, and your callback will not be invoked. 2611 * <p> 2612 * This method can be called on the {@link DevicePolicyManager} instance returned by 2613 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent 2614 * profile. 2615 * 2616 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2617 * @param num The number of failed password attempts at which point the device or profile will 2618 * be wiped. 2619 * @throws SecurityException if {@code admin} is not an active administrator or does not use 2620 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and 2621 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}. 2622 */ 2623 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) { 2624 if (mService != null) { 2625 try { 2626 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance); 2627 } catch (RemoteException e) { 2628 throw e.rethrowFromSystemServer(); 2629 } 2630 } 2631 } 2632 2633 /** 2634 * Retrieve the current maximum number of login attempts that are allowed before the device 2635 * or profile is wiped, for a particular admin or all admins that set restrictions on this user 2636 * and its participating profiles. Restrictions on profiles that have a separate challenge are 2637 * not taken into account. 2638 * 2639 * <p>This method can be called on the {@link DevicePolicyManager} instance 2640 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2641 * the value for the parent profile. 2642 * 2643 * @param admin The name of the admin component to check, or {@code null} to aggregate 2644 * all admins. 2645 */ 2646 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) { 2647 return getMaximumFailedPasswordsForWipe(admin, myUserId()); 2648 } 2649 2650 /** @hide per-user version */ 2651 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) { 2652 if (mService != null) { 2653 try { 2654 return mService.getMaximumFailedPasswordsForWipe( 2655 admin, userHandle, mParentInstance); 2656 } catch (RemoteException e) { 2657 throw e.rethrowFromSystemServer(); 2658 } 2659 } 2660 return 0; 2661 } 2662 2663 /** 2664 * Returns the profile with the smallest maximum failed passwords for wipe, 2665 * for the given user. So for primary user, it might return the primary or 2666 * a managed profile. For a secondary user, it would be the same as the 2667 * user passed in. 2668 * @hide Used only by Keyguard 2669 */ 2670 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) { 2671 if (mService != null) { 2672 try { 2673 return mService.getProfileWithMinimumFailedPasswordsForWipe( 2674 userHandle, mParentInstance); 2675 } catch (RemoteException e) { 2676 throw e.rethrowFromSystemServer(); 2677 } 2678 } 2679 return UserHandle.USER_NULL; 2680 } 2681 2682 /** 2683 * Flag for {@link #resetPassword}: don't allow other admins to change 2684 * the password again until the user has entered it. 2685 */ 2686 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001; 2687 2688 /** 2689 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot. 2690 * If the flag is set, the device can be booted without asking for user password. 2691 * The absence of this flag does not change the current boot requirements. This flag 2692 * can be set by the device owner only. If the app is not the device owner, the flag 2693 * is ignored. Once the flag is set, it cannot be reverted back without resetting the 2694 * device to factory defaults. 2695 */ 2696 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002; 2697 2698 /** 2699 * Force a new device unlock password (the password needed to access the entire device, not for 2700 * individual accounts) on the user. This takes effect immediately. 2701 * <p> 2702 * <em>For device owner and profile owners targeting SDK level 2703 * {@link android.os.Build.VERSION_CODES#O} or above, this API is no longer available and will 2704 * throw {@link SecurityException}. Please use the new API {@link #resetPasswordWithToken} 2705 * instead. </em> 2706 * <p> 2707 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for 2708 * device admins that are not device owner and not profile owner. 2709 * The password can now only be changed if there is currently no password set. Device owner 2710 * and profile owner can still do this when user is unlocked and does not have a managed 2711 * profile.</em> 2712 * <p> 2713 * The given password must be sufficient for the current password quality and length constraints 2714 * as returned by {@link #getPasswordQuality(ComponentName)} and 2715 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then 2716 * it will be rejected and false returned. Note that the password may be a stronger quality 2717 * (containing alphanumeric characters when the requested quality is only numeric), in which 2718 * case the currently active quality will be increased to match. 2719 * <p> 2720 * Calling with a null or empty password will clear any existing PIN, pattern or password if the 2721 * current password constraints allow it. <em>Note: This will not work in 2722 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins 2723 * that are not device owner or profile owner. Once set, the password cannot be changed to null 2724 * or empty except by these admins.</em> 2725 * <p> 2726 * The calling device admin must have requested 2727 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has 2728 * not, a security exception will be thrown. 2729 * 2730 * @param password The new password for the user. Null or empty clears the password. 2731 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and 2732 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}. 2733 * @return Returns true if the password was applied, or false if it is not acceptable for the 2734 * current constraints or if the user has not been decrypted yet. 2735 * @throws SecurityException if the calling application does not own an active administrator 2736 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} 2737 * @throws IllegalStateException if the calling user is locked or has a managed profile. 2738 * @throws IllegalArgumentException if the password does not meet system requirements. 2739 */ 2740 public boolean resetPassword(String password, int flags) { 2741 throwIfParentInstance("resetPassword"); 2742 if (mService != null) { 2743 try { 2744 return mService.resetPassword(password, flags); 2745 } catch (RemoteException e) { 2746 throw e.rethrowFromSystemServer(); 2747 } 2748 } 2749 return false; 2750 } 2751 2752 /** 2753 * Called by a profile or device owner to provision a token which can later be used to reset the 2754 * device lockscreen password (if called by device owner), or work challenge (if called by 2755 * profile owner), via {@link #resetPasswordWithToken}. 2756 * <p> 2757 * If the user currently has a lockscreen password, the provisioned token will not be 2758 * immediately usable; it only becomes active after the user performs a confirm credential 2759 * operation, which can be triggered by {@link KeyguardManager#createConfirmDeviceCredentialIntent}. 2760 * If the user has no lockscreen password, the token is activated immediately. In all cases, 2761 * the active state of the current token can be checked by {@link #isResetPasswordTokenActive}. 2762 * For security reasons, un-activated tokens are only stored in memory and will be lost once 2763 * the device reboots. In this case a new token needs to be provisioned again. 2764 * <p> 2765 * Once provisioned and activated, the token will remain effective even if the user changes 2766 * or clears the lockscreen password. 2767 * <p> 2768 * <em>This token is highly sensitive and should be treated at the same level as user 2769 * credentials. In particular, NEVER store this token on device in plaintext, especially in 2770 * Device-Encrypted storage if the token will be used to reset password on FBE devices before 2771 * user unlocks. 2772 * </em> 2773 * 2774 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2775 * @param token a secure token a least 32-byte long, which must be generated by a 2776 * cryptographically strong random number generator. 2777 * @return true if the operation is successful, false otherwise. 2778 * @throws IllegalArgumentException if the supplied token is invalid. 2779 * @throws SecurityException 2780 */ 2781 public boolean setResetPasswordToken(ComponentName admin, byte[] token) { 2782 throwIfParentInstance("setResetPasswordToken"); 2783 if (mService != null) { 2784 try { 2785 return mService.setResetPasswordToken(admin, token); 2786 } catch (RemoteException e) { 2787 throw e.rethrowFromSystemServer(); 2788 } 2789 } 2790 return false; 2791 } 2792 2793 /** 2794 * Called by a profile or device owner to revoke the current password reset token. 2795 * 2796 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2797 * @return true if the operation is successful, false otherwise. 2798 */ 2799 public boolean clearResetPasswordToken(ComponentName admin) { 2800 throwIfParentInstance("clearResetPasswordToken"); 2801 if (mService != null) { 2802 try { 2803 return mService.clearResetPasswordToken(admin); 2804 } catch (RemoteException e) { 2805 throw e.rethrowFromSystemServer(); 2806 } 2807 } 2808 return false; 2809 } 2810 2811 /** 2812 * Called by a profile or device owner to check if the current reset password token is active. 2813 * 2814 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2815 * @return true if the token is active, false otherwise. 2816 * @throws IllegalStateException if no token has been set. 2817 */ 2818 public boolean isResetPasswordTokenActive(ComponentName admin) { 2819 throwIfParentInstance("isResetPasswordTokenActive"); 2820 if (mService != null) { 2821 try { 2822 return mService.isResetPasswordTokenActive(admin); 2823 } catch (RemoteException e) { 2824 throw e.rethrowFromSystemServer(); 2825 } 2826 } 2827 return false; 2828 } 2829 2830 /** 2831 * Called by device or profile owner to force set a new device unlock password or a work profile 2832 * challenge on current user. This takes effect immediately. 2833 * <p> 2834 * Unlike {@link #resetPassword}, this API can change the password even before the user or 2835 * device is unlocked or decrypted. The supplied token must have been previously provisioned via 2836 * {@link #setResetPasswordToken}, and in active state {@link #isResetPasswordTokenActive}. 2837 * <p> 2838 * The given password must be sufficient for the current password quality and length constraints 2839 * as returned by {@link #getPasswordQuality(ComponentName)} and 2840 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then 2841 * it will be rejected and false returned. Note that the password may be a stronger quality 2842 * (containing alphanumeric characters when the requested quality is only numeric), in which 2843 * case the currently active quality will be increased to match. 2844 * <p> 2845 * Calling with a null or empty password will clear any existing PIN, pattern or password if the 2846 * current password constraints allow it. 2847 * 2848 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2849 * @param password The new password for the user. Null or empty clears the password. 2850 * @param token the password reset token previously provisioned by #setResetPasswordToken. 2851 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and 2852 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}. 2853 * @return Returns true if the password was applied, or false if it is not acceptable for the 2854 * current constraints. 2855 * @throws SecurityException if the calling application does not own an active administrator 2856 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} 2857 * @throws IllegalStateException if the provided token is not valid. 2858 * @throws IllegalArgumentException if the password does not meet system requirements. 2859 */ 2860 public boolean resetPasswordWithToken(@NonNull ComponentName admin, String password, 2861 byte[] token, int flags) { 2862 throwIfParentInstance("resetPassword"); 2863 if (mService != null) { 2864 try { 2865 return mService.resetPasswordWithToken(admin, password, token, flags); 2866 } catch (RemoteException e) { 2867 throw e.rethrowFromSystemServer(); 2868 } 2869 } 2870 return false; 2871 } 2872 2873 /** 2874 * Called by an application that is administering the device to set the maximum time for user 2875 * activity until the device will lock. This limits the length that the user can set. It takes 2876 * effect immediately. 2877 * <p> 2878 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} 2879 * to be able to call this method; if it has not, a security exception will be thrown. 2880 * <p> 2881 * This method can be called on the {@link DevicePolicyManager} instance returned by 2882 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 2883 * profile. 2884 * 2885 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2886 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there 2887 * is no restriction. 2888 * @throws SecurityException if {@code admin} is not an active administrator or it does not use 2889 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} 2890 */ 2891 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) { 2892 if (mService != null) { 2893 try { 2894 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance); 2895 } catch (RemoteException e) { 2896 throw e.rethrowFromSystemServer(); 2897 } 2898 } 2899 } 2900 2901 /** 2902 * Retrieve the current maximum time to unlock for a particular admin or all admins that set 2903 * restrictions on this user and its participating profiles. Restrictions on profiles that have 2904 * a separate challenge are not taken into account. 2905 * 2906 * <p>This method can be called on the {@link DevicePolicyManager} instance 2907 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2908 * restrictions on the parent profile. 2909 * 2910 * @param admin The name of the admin component to check, or {@code null} to aggregate 2911 * all admins. 2912 * @return time in milliseconds for the given admin or the minimum value (strictest) of 2913 * all admins if admin is null. Returns 0 if there are no restrictions. 2914 */ 2915 public long getMaximumTimeToLock(@Nullable ComponentName admin) { 2916 return getMaximumTimeToLock(admin, myUserId()); 2917 } 2918 2919 /** @hide per-user version */ 2920 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) { 2921 if (mService != null) { 2922 try { 2923 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance); 2924 } catch (RemoteException e) { 2925 throw e.rethrowFromSystemServer(); 2926 } 2927 } 2928 return 0; 2929 } 2930 2931 /** 2932 * Returns maximum time to lock that applied by all profiles in this user. We do this because we 2933 * do not have a separate timeout to lock for work challenge only. 2934 * 2935 * @hide 2936 */ 2937 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) { 2938 if (mService != null) { 2939 try { 2940 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle); 2941 } catch (RemoteException e) { 2942 throw e.rethrowFromSystemServer(); 2943 } 2944 } 2945 return 0; 2946 } 2947 2948 /** 2949 * Called by a device/profile owner to set the timeout after which unlocking with secondary, non 2950 * strong auth (e.g. fingerprint, trust agents) times out, i.e. the user has to use a strong 2951 * authentication method like password, pin or pattern. 2952 * 2953 * <p>This timeout is used internally to reset the timer to require strong auth again after 2954 * specified timeout each time it has been successfully used. 2955 * 2956 * <p>Fingerprint can also be disabled altogether using {@link #KEYGUARD_DISABLE_FINGERPRINT}. 2957 * 2958 * <p>Trust agents can also be disabled altogether using {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. 2959 * 2960 * <p>The calling device admin must be a device or profile owner. If it is not, 2961 * a {@link SecurityException} will be thrown. 2962 * 2963 * <p>The calling device admin can verify the value it has set by calling 2964 * {@link #getRequiredStrongAuthTimeout(ComponentName)} and passing in its instance. 2965 * 2966 * <p>This method can be called on the {@link DevicePolicyManager} instance returned by 2967 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 2968 * profile. 2969 * 2970 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2971 * @param timeoutMs The new timeout, after which the user will have to unlock with strong 2972 * authentication method. A value of 0 means the admin is not participating in 2973 * controlling the timeout. 2974 * The minimum and maximum timeouts are platform-defined and are typically 1 hour and 2975 * 72 hours, respectively. Though discouraged, the admin may choose to require strong 2976 * auth at all times using {@link #KEYGUARD_DISABLE_FINGERPRINT} and/or 2977 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. 2978 * 2979 * @throws SecurityException if {@code admin} is not a device or profile owner. 2980 */ 2981 public void setRequiredStrongAuthTimeout(@NonNull ComponentName admin, 2982 long timeoutMs) { 2983 if (mService != null) { 2984 try { 2985 mService.setRequiredStrongAuthTimeout(admin, timeoutMs, mParentInstance); 2986 } catch (RemoteException e) { 2987 throw e.rethrowFromSystemServer(); 2988 } 2989 } 2990 } 2991 2992 /** 2993 * Determine for how long the user will be able to use secondary, non strong auth for 2994 * authentication, since last strong method authentication (password, pin or pattern) was used. 2995 * After the returned timeout the user is required to use strong authentication method. 2996 * 2997 * <p>This method can be called on the {@link DevicePolicyManager} instance 2998 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 2999 * restrictions on the parent profile. 3000 * 3001 * @param admin The name of the admin component to check, or {@code null} to aggregate 3002 * accross all participating admins. 3003 * @return The timeout or 0 if not configured for the provided admin. 3004 */ 3005 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin) { 3006 return getRequiredStrongAuthTimeout(admin, myUserId()); 3007 } 3008 3009 /** @hide per-user version */ 3010 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin, @UserIdInt int userId) { 3011 if (mService != null) { 3012 try { 3013 return mService.getRequiredStrongAuthTimeout(admin, userId, mParentInstance); 3014 } catch (RemoteException e) { 3015 throw e.rethrowFromSystemServer(); 3016 } 3017 } 3018 return DEFAULT_STRONG_AUTH_TIMEOUT_MS; 3019 } 3020 3021 /** 3022 * Flag for {@link #lockNow(int)}: also evict the user's credential encryption key from the 3023 * keyring. The user's credential will need to be entered again in order to derive the 3024 * credential encryption key that will be stored back in the keyring for future use. 3025 * <p> 3026 * This flag can only be used by a profile owner when locking a managed profile on an FBE 3027 * device. 3028 * <p> 3029 * In order to secure user data, the user will be stopped and restarted so apps should wait 3030 * until they are next run to perform further actions. 3031 */ 3032 public static final int FLAG_EVICT_CE_KEY = 1; 3033 3034 /** @hide */ 3035 @Retention(RetentionPolicy.SOURCE) 3036 @IntDef(flag=true, value={FLAG_EVICT_CE_KEY}) 3037 public @interface LockNowFlag {} 3038 3039 /** 3040 * Make the device lock immediately, as if the lock screen timeout has expired at the point of 3041 * this call. 3042 * <p> 3043 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} 3044 * to be able to call this method; if it has not, a security exception will be thrown. 3045 * <p> 3046 * This method can be called on the {@link DevicePolicyManager} instance returned by 3047 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile. 3048 * <p> 3049 * Equivalent to calling {@link #lockNow(int)} with no flags. 3050 * 3051 * @throws SecurityException if the calling application does not own an active administrator 3052 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} 3053 */ 3054 public void lockNow() { 3055 lockNow(0); 3056 } 3057 3058 /** 3059 * Make the device lock immediately, as if the lock screen timeout has expired at the point of 3060 * this call. 3061 * <p> 3062 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} 3063 * to be able to call this method; if it has not, a security exception will be thrown. 3064 * <p> 3065 * This method can be called on the {@link DevicePolicyManager} instance returned by 3066 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile. 3067 * 3068 * @param flags May be 0 or {@link #FLAG_EVICT_CE_KEY}. 3069 * @throws SecurityException if the calling application does not own an active administrator 3070 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} or the 3071 * {@link #FLAG_EVICT_CE_KEY} flag is passed by an application that is not a profile 3072 * owner of a managed profile. 3073 * @throws IllegalArgumentException if the {@link #FLAG_EVICT_CE_KEY} flag is passed when 3074 * locking the parent profile. 3075 * @throws UnsupportedOperationException if the {@link #FLAG_EVICT_CE_KEY} flag is passed on a 3076 * non-FBE device. 3077 */ 3078 public void lockNow(@LockNowFlag int flags) { 3079 if (mService != null) { 3080 try { 3081 mService.lockNow(flags, mParentInstance); 3082 } catch (RemoteException e) { 3083 throw e.rethrowFromSystemServer(); 3084 } 3085 } 3086 } 3087 3088 /** 3089 * Flag for {@link #wipeData(int)}: also erase the device's external 3090 * storage (such as SD cards). 3091 */ 3092 public static final int WIPE_EXTERNAL_STORAGE = 0x0001; 3093 3094 /** 3095 * Flag for {@link #wipeData(int)}: also erase the factory reset protection 3096 * data. 3097 * 3098 * <p>This flag may only be set by device owner admins; if it is set by 3099 * other admins a {@link SecurityException} will be thrown. 3100 */ 3101 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002; 3102 3103 /** 3104 * Ask that all user data be wiped. If called as a secondary user, the user will be removed and 3105 * other users will remain unaffected. Calling from the primary user will cause the device to 3106 * reboot, erasing all device data - including all the secondary users and their data - while 3107 * booting up. 3108 * <p> 3109 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to 3110 * be able to call this method; if it has not, a security exception will be thrown. 3111 * 3112 * @param flags Bit mask of additional options: currently supported flags are 3113 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}. 3114 * @throws SecurityException if the calling application does not own an active administrator 3115 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} 3116 */ 3117 public void wipeData(int flags) { 3118 throwIfParentInstance("wipeData"); 3119 if (mService != null) { 3120 try { 3121 mService.wipeData(flags); 3122 } catch (RemoteException e) { 3123 throw e.rethrowFromSystemServer(); 3124 } 3125 } 3126 } 3127 3128 /** 3129 * Called by an application that is administering the device to set the 3130 * global proxy and exclusion list. 3131 * <p> 3132 * The calling device admin must have requested 3133 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call 3134 * this method; if it has not, a security exception will be thrown. 3135 * Only the first device admin can set the proxy. If a second admin attempts 3136 * to set the proxy, the {@link ComponentName} of the admin originally setting the 3137 * proxy will be returned. If successful in setting the proxy, {@code null} will 3138 * be returned. 3139 * The method can be called repeatedly by the device admin alrady setting the 3140 * proxy to update the proxy and exclusion list. 3141 * 3142 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3143 * @param proxySpec the global proxy desired. Must be an HTTP Proxy. 3144 * Pass Proxy.NO_PROXY to reset the proxy. 3145 * @param exclusionList a list of domains to be excluded from the global proxy. 3146 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName} 3147 * of the device admin that sets the proxy. 3148 * @hide 3149 */ 3150 public @Nullable ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec, 3151 List<String> exclusionList ) { 3152 throwIfParentInstance("setGlobalProxy"); 3153 if (proxySpec == null) { 3154 throw new NullPointerException(); 3155 } 3156 if (mService != null) { 3157 try { 3158 String hostSpec; 3159 String exclSpec; 3160 if (proxySpec.equals(Proxy.NO_PROXY)) { 3161 hostSpec = null; 3162 exclSpec = null; 3163 } else { 3164 if (!proxySpec.type().equals(Proxy.Type.HTTP)) { 3165 throw new IllegalArgumentException(); 3166 } 3167 InetSocketAddress sa = (InetSocketAddress)proxySpec.address(); 3168 String hostName = sa.getHostName(); 3169 int port = sa.getPort(); 3170 StringBuilder hostBuilder = new StringBuilder(); 3171 hostSpec = hostBuilder.append(hostName) 3172 .append(":").append(Integer.toString(port)).toString(); 3173 if (exclusionList == null) { 3174 exclSpec = ""; 3175 } else { 3176 StringBuilder listBuilder = new StringBuilder(); 3177 boolean firstDomain = true; 3178 for (String exclDomain : exclusionList) { 3179 if (!firstDomain) { 3180 listBuilder = listBuilder.append(","); 3181 } else { 3182 firstDomain = false; 3183 } 3184 listBuilder = listBuilder.append(exclDomain.trim()); 3185 } 3186 exclSpec = listBuilder.toString(); 3187 } 3188 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec) 3189 != android.net.Proxy.PROXY_VALID) 3190 throw new IllegalArgumentException(); 3191 } 3192 return mService.setGlobalProxy(admin, hostSpec, exclSpec); 3193 } catch (RemoteException e) { 3194 throw e.rethrowFromSystemServer(); 3195 } 3196 } 3197 return null; 3198 } 3199 3200 /** 3201 * Set a network-independent global HTTP proxy. This is not normally what you want for typical 3202 * HTTP proxies - they are generally network dependent. However if you're doing something 3203 * unusual like general internal filtering this may be useful. On a private network where the 3204 * proxy is not accessible, you may break HTTP using this. 3205 * <p> 3206 * This method requires the caller to be the device owner. 3207 * <p> 3208 * This proxy is only a recommendation and it is possible that some apps will ignore it. 3209 * 3210 * @see ProxyInfo 3211 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3212 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A 3213 * {@code null} value will clear the global HTTP proxy. 3214 * @throws SecurityException if {@code admin} is not the device owner. 3215 */ 3216 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo 3217 proxyInfo) { 3218 throwIfParentInstance("setRecommendedGlobalProxy"); 3219 if (mService != null) { 3220 try { 3221 mService.setRecommendedGlobalProxy(admin, proxyInfo); 3222 } catch (RemoteException e) { 3223 throw e.rethrowFromSystemServer(); 3224 } 3225 } 3226 } 3227 3228 /** 3229 * Returns the component name setting the global proxy. 3230 * @return ComponentName object of the device admin that set the global proxy, or {@code null} 3231 * if no admin has set the proxy. 3232 * @hide 3233 */ 3234 public @Nullable ComponentName getGlobalProxyAdmin() { 3235 if (mService != null) { 3236 try { 3237 return mService.getGlobalProxyAdmin(myUserId()); 3238 } catch (RemoteException e) { 3239 throw e.rethrowFromSystemServer(); 3240 } 3241 } 3242 return null; 3243 } 3244 3245 /** 3246 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 3247 * indicating that encryption is not supported. 3248 */ 3249 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0; 3250 3251 /** 3252 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 3253 * indicating that encryption is supported, but is not currently active. 3254 */ 3255 public static final int ENCRYPTION_STATUS_INACTIVE = 1; 3256 3257 /** 3258 * Result code for {@link #getStorageEncryptionStatus}: 3259 * indicating that encryption is not currently active, but is currently 3260 * being activated. This is only reported by devices that support 3261 * encryption of data and only when the storage is currently 3262 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data 3263 * to become encrypted will never return this value. 3264 */ 3265 public static final int ENCRYPTION_STATUS_ACTIVATING = 2; 3266 3267 /** 3268 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 3269 * indicating that encryption is active. 3270 * <p> 3271 * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}. 3272 */ 3273 public static final int ENCRYPTION_STATUS_ACTIVE = 3; 3274 3275 /** 3276 * Result code for {@link #getStorageEncryptionStatus}: 3277 * indicating that encryption is active, but an encryption key has not 3278 * been set by the user. 3279 */ 3280 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4; 3281 3282 /** 3283 * Result code for {@link #getStorageEncryptionStatus}: 3284 * indicating that encryption is active and the encryption key is tied to the user or profile. 3285 * <p> 3286 * This value is only returned to apps targeting API level 24 and above. For apps targeting 3287 * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the 3288 * encryption key is specific to the user or profile. 3289 */ 3290 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5; 3291 3292 /** 3293 * Activity action: begin the process of encrypting data on the device. This activity should 3294 * be launched after using {@link #setStorageEncryption} to request encryption be activated. 3295 * After resuming from this activity, use {@link #getStorageEncryption} 3296 * to check encryption status. However, on some devices this activity may never return, as 3297 * it may trigger a reboot and in some cases a complete data wipe of the device. 3298 */ 3299 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 3300 public static final String ACTION_START_ENCRYPTION 3301 = "android.app.action.START_ENCRYPTION"; 3302 /** 3303 * Widgets are enabled in keyguard 3304 */ 3305 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0; 3306 3307 /** 3308 * Disable all keyguard widgets. Has no effect. 3309 */ 3310 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0; 3311 3312 /** 3313 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password) 3314 */ 3315 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1; 3316 3317 /** 3318 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password) 3319 */ 3320 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2; 3321 3322 /** 3323 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password) 3324 */ 3325 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3; 3326 3327 /** 3328 * Ignore trust agent state on secure keyguard screens 3329 * (e.g. PIN/Pattern/Password). 3330 */ 3331 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4; 3332 3333 /** 3334 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password). 3335 */ 3336 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5; 3337 3338 /** 3339 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password). 3340 */ 3341 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6; 3342 3343 /** 3344 * Disable all current and future keyguard customizations. 3345 */ 3346 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff; 3347 3348 /** 3349 * Called by an application that is administering the device to request that the storage system 3350 * be encrypted. 3351 * <p> 3352 * When multiple device administrators attempt to control device encryption, the most secure, 3353 * supported setting will always be used. If any device administrator requests device 3354 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable 3355 * device encryption while another device administrator has enabled it, the call to disable will 3356 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}). 3357 * <p> 3358 * This policy controls encryption of the secure (application data) storage area. Data written 3359 * to other storage areas may or may not be encrypted, and this policy does not require or 3360 * control the encryption of any other storage areas. There is one exception: If 3361 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the 3362 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be 3363 * written to disk within the encrypted storage area. 3364 * <p> 3365 * Important Note: On some devices, it is possible to encrypt storage without requiring the user 3366 * to create a device PIN or Password. In this case, the storage is encrypted, but the 3367 * encryption key may not be fully secured. For maximum security, the administrator should also 3368 * require (and check for) a pattern, PIN, or password. 3369 * 3370 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3371 * @param encrypt true to request encryption, false to release any previous request 3372 * @return the new request status (for all active admins) - will be one of 3373 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or 3374 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use 3375 * {@link #getStorageEncryptionStatus()} to query the actual device state. 3376 * @throws SecurityException if {@code admin} is not an active administrator or does not use 3377 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE} 3378 */ 3379 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) { 3380 throwIfParentInstance("setStorageEncryption"); 3381 if (mService != null) { 3382 try { 3383 return mService.setStorageEncryption(admin, encrypt); 3384 } catch (RemoteException e) { 3385 throw e.rethrowFromSystemServer(); 3386 } 3387 } 3388 return ENCRYPTION_STATUS_UNSUPPORTED; 3389 } 3390 3391 /** 3392 * Called by an application that is administering the device to 3393 * determine the requested setting for secure storage. 3394 * 3395 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null, 3396 * this will return the requested encryption setting as an aggregate of all active 3397 * administrators. 3398 * @return true if the admin(s) are requesting encryption, false if not. 3399 */ 3400 public boolean getStorageEncryption(@Nullable ComponentName admin) { 3401 throwIfParentInstance("getStorageEncryption"); 3402 if (mService != null) { 3403 try { 3404 return mService.getStorageEncryption(admin, myUserId()); 3405 } catch (RemoteException e) { 3406 throw e.rethrowFromSystemServer(); 3407 } 3408 } 3409 return false; 3410 } 3411 3412 /** 3413 * Called by an application that is administering the device to 3414 * determine the current encryption status of the device. 3415 * <p> 3416 * Depending on the returned status code, the caller may proceed in different 3417 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the 3418 * storage system does not support encryption. If the 3419 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link 3420 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the 3421 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the 3422 * storage system has enabled encryption but no password is set so further action 3423 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING}, 3424 * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}, 3425 * no further action is required. 3426 * 3427 * @return current status of encryption. The value will be one of 3428 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, 3429 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, 3430 * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}. 3431 */ 3432 public int getStorageEncryptionStatus() { 3433 throwIfParentInstance("getStorageEncryptionStatus"); 3434 return getStorageEncryptionStatus(myUserId()); 3435 } 3436 3437 /** @hide per-user version */ 3438 public int getStorageEncryptionStatus(int userHandle) { 3439 if (mService != null) { 3440 try { 3441 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle); 3442 } catch (RemoteException e) { 3443 throw e.rethrowFromSystemServer(); 3444 } 3445 } 3446 return ENCRYPTION_STATUS_UNSUPPORTED; 3447 } 3448 3449 /** 3450 * Mark a CA certificate as approved by the device user. This means that they have been notified 3451 * of the installation, were made aware of the risks, viewed the certificate and still wanted to 3452 * keep the certificate on the device. 3453 * 3454 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to 3455 * this certificate. 3456 * 3457 * @hide 3458 */ 3459 public boolean approveCaCert(String alias, int userHandle, boolean approval) { 3460 if (mService != null) { 3461 try { 3462 return mService.approveCaCert(alias, userHandle, approval); 3463 } catch (RemoteException e) { 3464 throw e.rethrowFromSystemServer(); 3465 } 3466 } 3467 return false; 3468 } 3469 3470 /** 3471 * Check whether a CA certificate has been approved by the device user. 3472 * 3473 * @hide 3474 */ 3475 public boolean isCaCertApproved(String alias, int userHandle) { 3476 if (mService != null) { 3477 try { 3478 return mService.isCaCertApproved(alias, userHandle); 3479 } catch (RemoteException e) { 3480 throw e.rethrowFromSystemServer(); 3481 } 3482 } 3483 return false; 3484 } 3485 3486 /** 3487 * Installs the given certificate as a user CA. 3488 * 3489 * The caller must be a profile or device owner on that user, or a delegate package given the 3490 * {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a 3491 * security exception will be thrown. 3492 * 3493 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3494 * {@code null} if calling from a delegated certificate installer. 3495 * @param certBuffer encoded form of the certificate to install. 3496 * 3497 * @return false if the certBuffer cannot be parsed or installation is 3498 * interrupted, true otherwise. 3499 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile 3500 * owner. 3501 * @see #setDelegatedScopes 3502 * @see #DELEGATION_CERT_INSTALL 3503 */ 3504 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) { 3505 throwIfParentInstance("installCaCert"); 3506 if (mService != null) { 3507 try { 3508 return mService.installCaCert(admin, mContext.getPackageName(), certBuffer); 3509 } catch (RemoteException e) { 3510 throw e.rethrowFromSystemServer(); 3511 } 3512 } 3513 return false; 3514 } 3515 3516 /** 3517 * Uninstalls the given certificate from trusted user CAs, if present. 3518 * 3519 * The caller must be a profile or device owner on that user, or a delegate package given the 3520 * {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a 3521 * security exception will be thrown. 3522 * 3523 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3524 * {@code null} if calling from a delegated certificate installer. 3525 * @param certBuffer encoded form of the certificate to remove. 3526 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile 3527 * owner. 3528 * @see #setDelegatedScopes 3529 * @see #DELEGATION_CERT_INSTALL 3530 */ 3531 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) { 3532 throwIfParentInstance("uninstallCaCert"); 3533 if (mService != null) { 3534 try { 3535 final String alias = getCaCertAlias(certBuffer); 3536 mService.uninstallCaCerts(admin, mContext.getPackageName(), new String[] {alias}); 3537 } catch (CertificateException e) { 3538 Log.w(TAG, "Unable to parse certificate", e); 3539 } catch (RemoteException e) { 3540 throw e.rethrowFromSystemServer(); 3541 } 3542 } 3543 } 3544 3545 /** 3546 * Returns all CA certificates that are currently trusted, excluding system CA certificates. 3547 * If a user has installed any certificates by other means than device policy these will be 3548 * included too. 3549 * 3550 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3551 * {@code null} if calling from a delegated certificate installer. 3552 * @return a List of byte[] arrays, each encoding one user CA certificate. 3553 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile 3554 * owner. 3555 */ 3556 public @NonNull List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) { 3557 final List<byte[]> certs = new ArrayList<byte[]>(); 3558 throwIfParentInstance("getInstalledCaCerts"); 3559 if (mService != null) { 3560 try { 3561 mService.enforceCanManageCaCerts(admin, mContext.getPackageName()); 3562 final TrustedCertificateStore certStore = new TrustedCertificateStore(); 3563 for (String alias : certStore.userAliases()) { 3564 try { 3565 certs.add(certStore.getCertificate(alias).getEncoded()); 3566 } catch (CertificateException ce) { 3567 Log.w(TAG, "Could not encode certificate: " + alias, ce); 3568 } 3569 } 3570 } catch (RemoteException re) { 3571 throw re.rethrowFromSystemServer(); 3572 } 3573 } 3574 return certs; 3575 } 3576 3577 /** 3578 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by 3579 * means other than device policy will also be removed, except for system CA certificates. 3580 * 3581 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3582 * {@code null} if calling from a delegated certificate installer. 3583 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile 3584 * owner. 3585 */ 3586 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) { 3587 throwIfParentInstance("uninstallAllUserCaCerts"); 3588 if (mService != null) { 3589 try { 3590 mService.uninstallCaCerts(admin, mContext.getPackageName(), 3591 new TrustedCertificateStore().userAliases() .toArray(new String[0])); 3592 } catch (RemoteException re) { 3593 throw re.rethrowFromSystemServer(); 3594 } 3595 } 3596 } 3597 3598 /** 3599 * Returns whether this certificate is installed as a trusted CA. 3600 * 3601 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3602 * {@code null} if calling from a delegated certificate installer. 3603 * @param certBuffer encoded form of the certificate to look up. 3604 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile 3605 * owner. 3606 */ 3607 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) { 3608 throwIfParentInstance("hasCaCertInstalled"); 3609 if (mService != null) { 3610 try { 3611 mService.enforceCanManageCaCerts(admin, mContext.getPackageName()); 3612 return getCaCertAlias(certBuffer) != null; 3613 } catch (RemoteException re) { 3614 throw re.rethrowFromSystemServer(); 3615 } catch (CertificateException ce) { 3616 Log.w(TAG, "Could not parse certificate", ce); 3617 } 3618 } 3619 return false; 3620 } 3621 3622 /** 3623 * Called by a device or profile owner, or delegated certificate installer, to install a 3624 * certificate and corresponding private key. All apps within the profile will be able to access 3625 * the certificate and use the private key, given direct user approval. 3626 * 3627 * <p>Access to the installed credentials will not be granted to the caller of this API without 3628 * direct user approval. This is for security - should a certificate installer become 3629 * compromised, certificates it had already installed will be protected. 3630 * 3631 * <p>If the installer must have access to the credentials, call 3632 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead. 3633 * 3634 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3635 * {@code null} if calling from a delegated certificate installer. 3636 * @param privKey The private key to install. 3637 * @param cert The certificate to install. 3638 * @param alias The private key alias under which to install the certificate. If a certificate 3639 * with that alias already exists, it will be overwritten. 3640 * @return {@code true} if the keys were installed, {@code false} otherwise. 3641 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile 3642 * owner. 3643 * @see #setDelegatedScopes 3644 * @see #DELEGATION_CERT_INSTALL 3645 */ 3646 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey, 3647 @NonNull Certificate cert, @NonNull String alias) { 3648 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false); 3649 } 3650 3651 /** 3652 * Called by a device or profile owner, or delegated certificate installer, to install a 3653 * certificate chain and corresponding private key for the leaf certificate. All apps within the 3654 * profile will be able to access the certificate chain and use the private key, given direct 3655 * user approval. 3656 * 3657 * <p>The caller of this API may grant itself access to the certificate and private key 3658 * immediately, without user approval. It is a best practice not to request this unless strictly 3659 * necessary since it opens up additional security vulnerabilities. 3660 * 3661 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3662 * {@code null} if calling from a delegated certificate installer. 3663 * @param privKey The private key to install. 3664 * @param certs The certificate chain to install. The chain should start with the leaf 3665 * certificate and include the chain of trust in order. This will be returned by 3666 * {@link android.security.KeyChain#getCertificateChain}. 3667 * @param alias The private key alias under which to install the certificate. If a certificate 3668 * with that alias already exists, it will be overwritten. 3669 * @param requestAccess {@code true} to request that the calling app be granted access to the 3670 * credentials immediately. Otherwise, access to the credentials will be gated by user 3671 * approval. 3672 * @return {@code true} if the keys were installed, {@code false} otherwise. 3673 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile 3674 * owner. 3675 * @see android.security.KeyChain#getCertificateChain 3676 * @see #setDelegatedScopes 3677 * @see #DELEGATION_CERT_INSTALL 3678 */ 3679 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey, 3680 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) { 3681 throwIfParentInstance("installKeyPair"); 3682 try { 3683 final byte[] pemCert = Credentials.convertToPem(certs[0]); 3684 byte[] pemChain = null; 3685 if (certs.length > 1) { 3686 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length)); 3687 } 3688 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm()) 3689 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded(); 3690 return mService.installKeyPair(admin, mContext.getPackageName(), pkcs8Key, pemCert, 3691 pemChain, alias, requestAccess); 3692 } catch (RemoteException e) { 3693 throw e.rethrowFromSystemServer(); 3694 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) { 3695 Log.w(TAG, "Failed to obtain private key material", e); 3696 } catch (CertificateException | IOException e) { 3697 Log.w(TAG, "Could not pem-encode certificate", e); 3698 } 3699 return false; 3700 } 3701 3702 /** 3703 * Called by a device or profile owner, or delegated certificate installer, to remove a 3704 * certificate and private key pair installed under a given alias. 3705 * 3706 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3707 * {@code null} if calling from a delegated certificate installer. 3708 * @param alias The private key alias under which the certificate is installed. 3709 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise. 3710 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile 3711 * owner. 3712 * @see #setDelegatedScopes 3713 * @see #DELEGATION_CERT_INSTALL 3714 */ 3715 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) { 3716 throwIfParentInstance("removeKeyPair"); 3717 try { 3718 return mService.removeKeyPair(admin, mContext.getPackageName(), alias); 3719 } catch (RemoteException e) { 3720 throw e.rethrowFromSystemServer(); 3721 } 3722 } 3723 3724 /** 3725 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it 3726 * doesn't exist. 3727 */ 3728 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException { 3729 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509"); 3730 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate( 3731 new ByteArrayInputStream(certBuffer)); 3732 return new TrustedCertificateStore().getCertificateAlias(cert); 3733 } 3734 3735 /** 3736 * Called by a profile owner or device owner to grant access to privileged certificate 3737 * manipulation APIs to a third-party certificate installer app. Granted APIs include 3738 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert}, 3739 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}. 3740 * <p> 3741 * Delegated certificate installer is a per-user state. The delegated access is persistent until 3742 * it is later cleared by calling this method with a null value or uninstallling the certificate 3743 * installer. 3744 * <p> 3745 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller 3746 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the 3747 * supplied certificate installer package must be installed when calling this API, otherwise an 3748 * {@link IllegalArgumentException} will be thrown. 3749 * 3750 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3751 * @param installerPackage The package name of the certificate installer which will be given 3752 * access. If {@code null} is given the current package will be cleared. 3753 * @throws SecurityException if {@code admin} is not a device or a profile owner. 3754 * 3755 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes} 3756 * with the {@link #DELEGATION_CERT_INSTALL} scope instead. 3757 */ 3758 @Deprecated 3759 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String 3760 installerPackage) throws SecurityException { 3761 throwIfParentInstance("setCertInstallerPackage"); 3762 if (mService != null) { 3763 try { 3764 mService.setCertInstallerPackage(admin, installerPackage); 3765 } catch (RemoteException e) { 3766 throw e.rethrowFromSystemServer(); 3767 } 3768 } 3769 } 3770 3771 /** 3772 * Called by a profile owner or device owner to retrieve the certificate installer for the user, 3773 * or {@code null} if none is set. If there are multiple delegates this function will return one 3774 * of them. 3775 * 3776 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3777 * @return The package name of the current delegated certificate installer, or {@code null} if 3778 * none is set. 3779 * @throws SecurityException if {@code admin} is not a device or a profile owner. 3780 * 3781 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages} 3782 * with the {@link #DELEGATION_CERT_INSTALL} scope instead. 3783 */ 3784 @Deprecated 3785 public @Nullable String getCertInstallerPackage(@NonNull ComponentName admin) 3786 throws SecurityException { 3787 throwIfParentInstance("getCertInstallerPackage"); 3788 if (mService != null) { 3789 try { 3790 return mService.getCertInstallerPackage(admin); 3791 } catch (RemoteException e) { 3792 throw e.rethrowFromSystemServer(); 3793 } 3794 } 3795 return null; 3796 } 3797 3798 /** 3799 * Called by a profile owner or device owner to grant access to privileged APIs to another app. 3800 * Granted APIs are determined by {@code scopes}, which is a list of the {@code DELEGATION_*} 3801 * constants. 3802 * <p> 3803 * A broadcast with the {@link #ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED} action will be 3804 * sent to the {@code delegatePackage} with its new scopes in an {@code ArrayList<String>} extra 3805 * under the {@link #EXTRA_DELEGATION_SCOPES} key. The broadcast is sent with the 3806 * {@link Intent#FLAG_RECEIVER_REGISTERED_ONLY} flag. 3807 * <p> 3808 * Delegated scopes are a per-user state. The delegated access is persistent until it is later 3809 * cleared by calling this method with an empty {@code scopes} list or uninstalling the 3810 * {@code delegatePackage}. 3811 * 3812 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3813 * @param delegatePackage The package name of the app which will be given access. 3814 * @param scopes The groups of privileged APIs whose access should be granted to 3815 * {@code delegatedPackage}. 3816 * @throws SecurityException if {@code admin} is not a device or a profile owner. 3817 */ 3818 public void setDelegatedScopes(@NonNull ComponentName admin, @NonNull String delegatePackage, 3819 @NonNull List<String> scopes) { 3820 throwIfParentInstance("setDelegatedScopes"); 3821 if (mService != null) { 3822 try { 3823 mService.setDelegatedScopes(admin, delegatePackage, scopes); 3824 } catch (RemoteException e) { 3825 throw e.rethrowFromSystemServer(); 3826 } 3827 } 3828 } 3829 3830 /** 3831 * Called by a profile owner or device owner to retrieve a list of the scopes given to a 3832 * delegate package. Other apps can use this method to retrieve their own delegated scopes by 3833 * passing {@code null} for {@code admin} and their own package name as 3834 * {@code delegatedPackage}. 3835 * 3836 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3837 * {@code null} if the caller is {@code delegatedPackage}. 3838 * @param delegatedPackage The package name of the app whose scopes should be retrieved. 3839 * @return A list containing the scopes given to {@code delegatedPackage}. 3840 * @throws SecurityException if {@code admin} is not a device or a profile owner. 3841 */ 3842 @NonNull 3843 public List<String> getDelegatedScopes(@Nullable ComponentName admin, 3844 @NonNull String delegatedPackage) { 3845 throwIfParentInstance("getDelegatedScopes"); 3846 if (mService != null) { 3847 try { 3848 return mService.getDelegatedScopes(admin, delegatedPackage); 3849 } catch (RemoteException e) { 3850 throw e.rethrowFromSystemServer(); 3851 } 3852 } 3853 return null; 3854 } 3855 3856 /** 3857 * Called by a profile owner or device owner to retrieve a list of delegate packages that were 3858 * granted a delegation scope. 3859 * 3860 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3861 * @param delegationScope The scope whose delegates should be retrieved. 3862 * @return A list of package names of the current delegated packages for 3863 {@code delegationScope}. 3864 * @throws SecurityException if {@code admin} is not a device or a profile owner. 3865 */ 3866 @Nullable 3867 public List<String> getDelegatePackages(@NonNull ComponentName admin, 3868 @NonNull String delegationScope) { 3869 throwIfParentInstance("getDelegatePackages"); 3870 if (mService != null) { 3871 try { 3872 return mService.getDelegatePackages(admin, delegationScope); 3873 } catch (RemoteException e) { 3874 throw e.rethrowFromSystemServer(); 3875 } 3876 } 3877 return null; 3878 } 3879 3880 /** 3881 * Called by a device or profile owner to configure an always-on VPN connection through a 3882 * specific application for the current user. 3883 * 3884 * @deprecated this version only exists for compability with previous developer preview builds. 3885 * TODO: delete once there are no longer any live references. 3886 * @hide 3887 */ 3888 @Deprecated 3889 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage) 3890 throws NameNotFoundException, UnsupportedOperationException { 3891 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true); 3892 } 3893 3894 /** 3895 * Called by a device or profile owner to configure an always-on VPN connection through a 3896 * specific application for the current user. This connection is automatically granted and 3897 * persisted after a reboot. 3898 * <p> 3899 * The designated package should declare a {@link android.net.VpnService} in its manifest 3900 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will 3901 * fail. 3902 * 3903 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to 3904 * remove an existing always-on VPN configuration. 3905 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or 3906 * {@code false} otherwise. This carries the risk that any failure of the VPN provider 3907 * could break networking for all apps. This has no effect when clearing. 3908 * @throws SecurityException if {@code admin} is not a device or a profile owner. 3909 * @throws NameNotFoundException if {@code vpnPackage} is not installed. 3910 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being 3911 * set as always-on, or if always-on VPN is not available. 3912 */ 3913 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage, 3914 boolean lockdownEnabled) 3915 throws NameNotFoundException, UnsupportedOperationException { 3916 throwIfParentInstance("setAlwaysOnVpnPackage"); 3917 if (mService != null) { 3918 try { 3919 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) { 3920 throw new NameNotFoundException(vpnPackage); 3921 } 3922 } catch (RemoteException e) { 3923 throw e.rethrowFromSystemServer(); 3924 } 3925 } 3926 } 3927 3928 /** 3929 * Called by a device or profile owner to read the name of the package administering an 3930 * always-on VPN connection for the current user. If there is no such package, or the always-on 3931 * VPN is provided by the system instead of by an application, {@code null} will be returned. 3932 * 3933 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none 3934 * is set. 3935 * @throws SecurityException if {@code admin} is not a device or a profile owner. 3936 */ 3937 public @Nullable String getAlwaysOnVpnPackage(@NonNull ComponentName admin) { 3938 throwIfParentInstance("getAlwaysOnVpnPackage"); 3939 if (mService != null) { 3940 try { 3941 return mService.getAlwaysOnVpnPackage(admin); 3942 } catch (RemoteException e) { 3943 throw e.rethrowFromSystemServer(); 3944 } 3945 } 3946 return null; 3947 } 3948 3949 /** 3950 * Called by an application that is administering the device to disable all cameras on the 3951 * device, for this user. After setting this, no applications running as this user will be able 3952 * to access any cameras on the device. 3953 * <p> 3954 * If the caller is device owner, then the restriction will be applied to all users. 3955 * <p> 3956 * The calling device admin must have requested 3957 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has 3958 * not, a security exception will be thrown. 3959 * 3960 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3961 * @param disabled Whether or not the camera should be disabled. 3962 * @throws SecurityException if {@code admin} is not an active administrator or does not use 3963 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}. 3964 */ 3965 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) { 3966 throwIfParentInstance("setCameraDisabled"); 3967 if (mService != null) { 3968 try { 3969 mService.setCameraDisabled(admin, disabled); 3970 } catch (RemoteException e) { 3971 throw e.rethrowFromSystemServer(); 3972 } 3973 } 3974 } 3975 3976 /** 3977 * Determine whether or not the device's cameras have been disabled for this user, 3978 * either by the calling admin, if specified, or all admins. 3979 * @param admin The name of the admin component to check, or {@code null} to check whether any admins 3980 * have disabled the camera 3981 */ 3982 public boolean getCameraDisabled(@Nullable ComponentName admin) { 3983 throwIfParentInstance("getCameraDisabled"); 3984 return getCameraDisabled(admin, myUserId()); 3985 } 3986 3987 /** @hide per-user version */ 3988 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) { 3989 if (mService != null) { 3990 try { 3991 return mService.getCameraDisabled(admin, userHandle); 3992 } catch (RemoteException e) { 3993 throw e.rethrowFromSystemServer(); 3994 } 3995 } 3996 return false; 3997 } 3998 3999 /** 4000 * Called by a device owner to request a bugreport. 4001 * <p> 4002 * If the device contains secondary users or profiles, they must be affiliated with the device 4003 * owner user. Otherwise a {@link SecurityException} will be thrown. See 4004 * {@link #setAffiliationIds}. 4005 * 4006 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4007 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it 4008 * wasn't triggered because a previous bugreport operation is still active (either the 4009 * bugreport is still running or waiting for the user to share or decline) 4010 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one 4011 * profile or secondary user that is not affiliated with the device owner user. 4012 */ 4013 public boolean requestBugreport(@NonNull ComponentName admin) { 4014 throwIfParentInstance("requestBugreport"); 4015 if (mService != null) { 4016 try { 4017 return mService.requestBugreport(admin); 4018 } catch (RemoteException e) { 4019 throw e.rethrowFromSystemServer(); 4020 } 4021 } 4022 return false; 4023 } 4024 4025 /** 4026 * Determine whether or not creating a guest user has been disabled for the device 4027 * 4028 * @hide 4029 */ 4030 public boolean getGuestUserDisabled(@Nullable ComponentName admin) { 4031 // Currently guest users can always be created if multi-user is enabled 4032 // TODO introduce a policy for guest user creation 4033 return false; 4034 } 4035 4036 /** 4037 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling 4038 * screen capture also prevents the content from being shown on display devices that do not have 4039 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about 4040 * secure surfaces and secure displays. 4041 * <p> 4042 * The calling device admin must be a device or profile owner. If it is not, a security 4043 * exception will be thrown. 4044 * <p> 4045 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks 4046 * assist requests for all activities of the relevant user. 4047 * 4048 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4049 * @param disabled Whether screen capture is disabled or not. 4050 * @throws SecurityException if {@code admin} is not a device or profile owner. 4051 */ 4052 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) { 4053 throwIfParentInstance("setScreenCaptureDisabled"); 4054 if (mService != null) { 4055 try { 4056 mService.setScreenCaptureDisabled(admin, disabled); 4057 } catch (RemoteException e) { 4058 throw e.rethrowFromSystemServer(); 4059 } 4060 } 4061 } 4062 4063 /** 4064 * Determine whether or not screen capture has been disabled by the calling 4065 * admin, if specified, or all admins. 4066 * @param admin The name of the admin component to check, or {@code null} to check whether any admins 4067 * have disabled screen capture. 4068 */ 4069 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) { 4070 throwIfParentInstance("getScreenCaptureDisabled"); 4071 return getScreenCaptureDisabled(admin, myUserId()); 4072 } 4073 4074 /** @hide per-user version */ 4075 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) { 4076 if (mService != null) { 4077 try { 4078 return mService.getScreenCaptureDisabled(admin, userHandle); 4079 } catch (RemoteException e) { 4080 throw e.rethrowFromSystemServer(); 4081 } 4082 } 4083 return false; 4084 } 4085 4086 /** 4087 * Called by a device or profile owner to set whether auto time is required. If auto time is 4088 * required, no user will be able set the date and time and network date and time will be used. 4089 * <p> 4090 * Note: if auto time is required the user can still manually set the time zone. 4091 * <p> 4092 * The calling device admin must be a device or profile owner. If it is not, a security 4093 * exception will be thrown. 4094 * 4095 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4096 * @param required Whether auto time is set required or not. 4097 * @throws SecurityException if {@code admin} is not a device owner. 4098 */ 4099 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) { 4100 throwIfParentInstance("setAutoTimeRequired"); 4101 if (mService != null) { 4102 try { 4103 mService.setAutoTimeRequired(admin, required); 4104 } catch (RemoteException e) { 4105 throw e.rethrowFromSystemServer(); 4106 } 4107 } 4108 } 4109 4110 /** 4111 * @return true if auto time is required. 4112 */ 4113 public boolean getAutoTimeRequired() { 4114 throwIfParentInstance("getAutoTimeRequired"); 4115 if (mService != null) { 4116 try { 4117 return mService.getAutoTimeRequired(); 4118 } catch (RemoteException e) { 4119 throw e.rethrowFromSystemServer(); 4120 } 4121 } 4122 return false; 4123 } 4124 4125 /** 4126 * Called by a device owner to set whether all users created on the device should be ephemeral. 4127 * <p> 4128 * The system user is exempt from this policy - it is never ephemeral. 4129 * <p> 4130 * The calling device admin must be the device owner. If it is not, a security exception will be 4131 * thrown. 4132 * 4133 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4134 * @param forceEphemeralUsers If true, all the existing users will be deleted and all 4135 * subsequently created users will be ephemeral. 4136 * @throws SecurityException if {@code admin} is not a device owner. 4137 * @hide 4138 */ 4139 public void setForceEphemeralUsers( 4140 @NonNull ComponentName admin, boolean forceEphemeralUsers) { 4141 throwIfParentInstance("setForceEphemeralUsers"); 4142 if (mService != null) { 4143 try { 4144 mService.setForceEphemeralUsers(admin, forceEphemeralUsers); 4145 } catch (RemoteException e) { 4146 throw e.rethrowFromSystemServer(); 4147 } 4148 } 4149 } 4150 4151 /** 4152 * @return true if all users are created ephemeral. 4153 * @throws SecurityException if {@code admin} is not a device owner. 4154 * @hide 4155 */ 4156 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) { 4157 throwIfParentInstance("getForceEphemeralUsers"); 4158 if (mService != null) { 4159 try { 4160 return mService.getForceEphemeralUsers(admin); 4161 } catch (RemoteException e) { 4162 throw e.rethrowFromSystemServer(); 4163 } 4164 } 4165 return false; 4166 } 4167 4168 /** 4169 * Called by an application that is administering the device to disable keyguard customizations, 4170 * such as widgets. After setting this, keyguard features will be disabled according to the 4171 * provided feature list. 4172 * <p> 4173 * The calling device admin must have requested 4174 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method; 4175 * if it has not, a security exception will be thrown. 4176 * <p> 4177 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M} 4178 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the 4179 * profile owner of a managed profile can set: 4180 * <ul> 4181 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there 4182 * is no separate challenge set on the managed profile. 4183 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if 4184 * there is one, or the parent user otherwise. 4185 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated 4186 * by applications in the managed profile. 4187 * </ul> 4188 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be 4189 * set on the {@link DevicePolicyManager} instance returned by 4190 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent 4191 * profile. 4192 * <p> 4193 * Requests to disable other features on a managed profile will be ignored. 4194 * <p> 4195 * The admin can check which features have been disabled by calling 4196 * {@link #getKeyguardDisabledFeatures(ComponentName)} 4197 * 4198 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4199 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default), 4200 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA}, 4201 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS}, 4202 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, 4203 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS}, 4204 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL} 4205 * @throws SecurityException if {@code admin} is not an active administrator or does not user 4206 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} 4207 */ 4208 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) { 4209 if (mService != null) { 4210 try { 4211 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance); 4212 } catch (RemoteException e) { 4213 throw e.rethrowFromSystemServer(); 4214 } 4215 } 4216 } 4217 4218 /** 4219 * Determine whether or not features have been disabled in keyguard either by the calling 4220 * admin, if specified, or all admins that set restrictions on this user and its participating 4221 * profiles. Restrictions on profiles that have a separate challenge are not taken into account. 4222 * 4223 * <p>This method can be called on the {@link DevicePolicyManager} instance 4224 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve 4225 * restrictions on the parent profile. 4226 * 4227 * @param admin The name of the admin component to check, or {@code null} to check whether any 4228 * admins have disabled features in keyguard. 4229 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)} 4230 * for a list. 4231 */ 4232 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) { 4233 return getKeyguardDisabledFeatures(admin, myUserId()); 4234 } 4235 4236 /** @hide per-user version */ 4237 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) { 4238 if (mService != null) { 4239 try { 4240 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance); 4241 } catch (RemoteException e) { 4242 throw e.rethrowFromSystemServer(); 4243 } 4244 } 4245 return KEYGUARD_DISABLE_FEATURES_NONE; 4246 } 4247 4248 /** 4249 * @hide 4250 */ 4251 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing, 4252 int userHandle) { 4253 if (mService != null) { 4254 try { 4255 mService.setActiveAdmin(policyReceiver, refreshing, userHandle); 4256 } catch (RemoteException e) { 4257 throw e.rethrowFromSystemServer(); 4258 } 4259 } 4260 } 4261 4262 /** 4263 * @hide 4264 */ 4265 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) { 4266 setActiveAdmin(policyReceiver, refreshing, myUserId()); 4267 } 4268 4269 /** 4270 * @hide 4271 */ 4272 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) { 4273 if (mService != null) { 4274 try { 4275 mService.getRemoveWarning(admin, result, myUserId()); 4276 } catch (RemoteException e) { 4277 throw e.rethrowFromSystemServer(); 4278 } 4279 } 4280 } 4281 4282 /** 4283 * @hide 4284 */ 4285 public void setActivePasswordState(PasswordMetrics metrics, int userHandle) { 4286 if (mService != null) { 4287 try { 4288 mService.setActivePasswordState(metrics, userHandle); 4289 } catch (RemoteException e) { 4290 throw e.rethrowFromSystemServer(); 4291 } 4292 } 4293 } 4294 4295 /** 4296 * @hide 4297 */ 4298 public void reportPasswordChanged(@UserIdInt int userId) { 4299 if (mService != null) { 4300 try { 4301 mService.reportPasswordChanged(userId); 4302 } catch (RemoteException e) { 4303 throw e.rethrowFromSystemServer(); 4304 } 4305 } 4306 } 4307 4308 /** 4309 * @hide 4310 */ 4311 public void reportFailedPasswordAttempt(int userHandle) { 4312 if (mService != null) { 4313 try { 4314 mService.reportFailedPasswordAttempt(userHandle); 4315 } catch (RemoteException e) { 4316 throw e.rethrowFromSystemServer(); 4317 } 4318 } 4319 } 4320 4321 /** 4322 * @hide 4323 */ 4324 public void reportSuccessfulPasswordAttempt(int userHandle) { 4325 if (mService != null) { 4326 try { 4327 mService.reportSuccessfulPasswordAttempt(userHandle); 4328 } catch (RemoteException e) { 4329 throw e.rethrowFromSystemServer(); 4330 } 4331 } 4332 } 4333 4334 /** 4335 * @hide 4336 */ 4337 public void reportFailedFingerprintAttempt(int userHandle) { 4338 if (mService != null) { 4339 try { 4340 mService.reportFailedFingerprintAttempt(userHandle); 4341 } catch (RemoteException e) { 4342 throw e.rethrowFromSystemServer(); 4343 } 4344 } 4345 } 4346 4347 /** 4348 * @hide 4349 */ 4350 public void reportSuccessfulFingerprintAttempt(int userHandle) { 4351 if (mService != null) { 4352 try { 4353 mService.reportSuccessfulFingerprintAttempt(userHandle); 4354 } catch (RemoteException e) { 4355 throw e.rethrowFromSystemServer(); 4356 } 4357 } 4358 } 4359 4360 /** 4361 * Should be called when keyguard has been dismissed. 4362 * @hide 4363 */ 4364 public void reportKeyguardDismissed(int userHandle) { 4365 if (mService != null) { 4366 try { 4367 mService.reportKeyguardDismissed(userHandle); 4368 } catch (RemoteException e) { 4369 throw e.rethrowFromSystemServer(); 4370 } 4371 } 4372 } 4373 4374 /** 4375 * Should be called when keyguard view has been shown to the user. 4376 * @hide 4377 */ 4378 public void reportKeyguardSecured(int userHandle) { 4379 if (mService != null) { 4380 try { 4381 mService.reportKeyguardSecured(userHandle); 4382 } catch (RemoteException e) { 4383 throw e.rethrowFromSystemServer(); 4384 } 4385 } 4386 } 4387 4388 /** 4389 * @hide 4390 * Sets the given package as the device owner. 4391 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name. 4392 * @param who the component name to be registered as device owner. 4393 * @return whether the package was successfully registered as the device owner. 4394 * @throws IllegalArgumentException if the package name is null or invalid 4395 * @throws IllegalStateException If the preconditions mentioned are not met. 4396 */ 4397 public boolean setDeviceOwner(ComponentName who) { 4398 return setDeviceOwner(who, null); 4399 } 4400 4401 /** 4402 * @hide 4403 */ 4404 public boolean setDeviceOwner(ComponentName who, int userId) { 4405 return setDeviceOwner(who, null, userId); 4406 } 4407 4408 /** 4409 * @hide 4410 */ 4411 public boolean setDeviceOwner(ComponentName who, String ownerName) { 4412 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM); 4413 } 4414 4415 /** 4416 * @hide 4417 * Sets the given package as the device owner. The package must already be installed. There 4418 * must not already be a device owner. 4419 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call 4420 * this method. 4421 * Calling this after the setup phase of the primary user has completed is allowed only if 4422 * the caller is the shell uid, and there are no additional users and no accounts. 4423 * @param who the component name to be registered as device owner. 4424 * @param ownerName the human readable name of the institution that owns this device. 4425 * @param userId ID of the user on which the device owner runs. 4426 * @return whether the package was successfully registered as the device owner. 4427 * @throws IllegalArgumentException if the package name is null or invalid 4428 * @throws IllegalStateException If the preconditions mentioned are not met. 4429 */ 4430 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId) 4431 throws IllegalArgumentException, IllegalStateException { 4432 if (mService != null) { 4433 try { 4434 return mService.setDeviceOwner(who, ownerName, userId); 4435 } catch (RemoteException re) { 4436 throw re.rethrowFromSystemServer(); 4437 } 4438 } 4439 return false; 4440 } 4441 4442 /** 4443 * Used to determine if a particular package has been registered as a Device Owner app. 4444 * A device owner app is a special device admin that cannot be deactivated by the user, once 4445 * activated as a device admin. It also cannot be uninstalled. To check whether a particular 4446 * package is currently registered as the device owner app, pass in the package name from 4447 * {@link Context#getPackageName()} to this method.<p/>This is useful for device 4448 * admin apps that want to check whether they are also registered as the device owner app. The 4449 * exact mechanism by which a device admin app is registered as a device owner app is defined by 4450 * the setup process. 4451 * @param packageName the package name of the app, to compare with the registered device owner 4452 * app, if any. 4453 * @return whether or not the package is registered as the device owner app. 4454 */ 4455 public boolean isDeviceOwnerApp(String packageName) { 4456 throwIfParentInstance("isDeviceOwnerApp"); 4457 return isDeviceOwnerAppOnCallingUser(packageName); 4458 } 4459 4460 /** 4461 * @return true if a package is registered as device owner, only when it's running on the 4462 * calling user. 4463 * 4464 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity. 4465 * @hide 4466 */ 4467 public boolean isDeviceOwnerAppOnCallingUser(String packageName) { 4468 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true); 4469 } 4470 4471 /** 4472 * @return true if a package is registered as device owner, even if it's running on a different 4473 * user. 4474 * 4475 * <p>Requires the MANAGE_USERS permission. 4476 * 4477 * @hide 4478 */ 4479 public boolean isDeviceOwnerAppOnAnyUser(String packageName) { 4480 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false); 4481 } 4482 4483 /** 4484 * @return device owner component name, only when it's running on the calling user. 4485 * 4486 * @hide 4487 */ 4488 public ComponentName getDeviceOwnerComponentOnCallingUser() { 4489 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true); 4490 } 4491 4492 /** 4493 * @return device owner component name, even if it's running on a different user. 4494 * 4495 * <p>Requires the MANAGE_USERS permission. 4496 * 4497 * @hide 4498 */ 4499 @SystemApi 4500 public ComponentName getDeviceOwnerComponentOnAnyUser() { 4501 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false); 4502 } 4503 4504 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) { 4505 if (packageName == null) { 4506 return false; 4507 } 4508 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly); 4509 if (deviceOwner == null) { 4510 return false; 4511 } 4512 return packageName.equals(deviceOwner.getPackageName()); 4513 } 4514 4515 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) { 4516 if (mService != null) { 4517 try { 4518 return mService.getDeviceOwnerComponent(callingUserOnly); 4519 } catch (RemoteException re) { 4520 throw re.rethrowFromSystemServer(); 4521 } 4522 } 4523 return null; 4524 } 4525 4526 /** 4527 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's 4528 * no device owner. 4529 * 4530 * <p>Requires the MANAGE_USERS permission. 4531 * 4532 * @hide 4533 */ 4534 public int getDeviceOwnerUserId() { 4535 if (mService != null) { 4536 try { 4537 return mService.getDeviceOwnerUserId(); 4538 } catch (RemoteException re) { 4539 throw re.rethrowFromSystemServer(); 4540 } 4541 } 4542 return UserHandle.USER_NULL; 4543 } 4544 4545 /** 4546 * Clears the current device owner. The caller must be the device owner. This function should be 4547 * used cautiously as once it is called it cannot be undone. The device owner can only be set as 4548 * a part of device setup before setup completes. 4549 * 4550 * @param packageName The package name of the device owner. 4551 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName} 4552 * does not own the current device owner component. 4553 */ 4554 public void clearDeviceOwnerApp(String packageName) { 4555 throwIfParentInstance("clearDeviceOwnerApp"); 4556 if (mService != null) { 4557 try { 4558 mService.clearDeviceOwner(packageName); 4559 } catch (RemoteException re) { 4560 throw re.rethrowFromSystemServer(); 4561 } 4562 } 4563 } 4564 4565 /** 4566 * Returns the device owner package name, only if it's running on the calling user. 4567 * 4568 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity. 4569 * 4570 * @hide 4571 */ 4572 @SystemApi 4573 public @Nullable String getDeviceOwner() { 4574 throwIfParentInstance("getDeviceOwner"); 4575 final ComponentName name = getDeviceOwnerComponentOnCallingUser(); 4576 return name != null ? name.getPackageName() : null; 4577 } 4578 4579 /** 4580 * Called by the system to find out whether the device is managed by a Device Owner. 4581 * 4582 * @return whether the device is managed by a Device Owner. 4583 * @throws SecurityException if the caller is not the device owner, does not hold the 4584 * MANAGE_USERS permission and is not the system. 4585 * 4586 * @hide 4587 */ 4588 @SystemApi 4589 @TestApi 4590 public boolean isDeviceManaged() { 4591 try { 4592 return mService.hasDeviceOwner(); 4593 } catch (RemoteException re) { 4594 throw re.rethrowFromSystemServer(); 4595 } 4596 } 4597 4598 /** 4599 * Returns the device owner name. Note this method *will* return the device owner 4600 * name when it's running on a different user. 4601 * 4602 * <p>Requires the MANAGE_USERS permission. 4603 * 4604 * @hide 4605 */ 4606 @SystemApi 4607 public String getDeviceOwnerNameOnAnyUser() { 4608 throwIfParentInstance("getDeviceOwnerNameOnAnyUser"); 4609 if (mService != null) { 4610 try { 4611 return mService.getDeviceOwnerName(); 4612 } catch (RemoteException re) { 4613 throw re.rethrowFromSystemServer(); 4614 } 4615 } 4616 return null; 4617 } 4618 4619 /** 4620 * @hide 4621 * @deprecated Do not use 4622 * @removed 4623 */ 4624 @Deprecated 4625 @SystemApi 4626 public @Nullable String getDeviceInitializerApp() { 4627 return null; 4628 } 4629 4630 /** 4631 * @hide 4632 * @deprecated Do not use 4633 * @removed 4634 */ 4635 @Deprecated 4636 @SystemApi 4637 public @Nullable ComponentName getDeviceInitializerComponent() { 4638 return null; 4639 } 4640 4641 /** 4642 * @hide 4643 * @deprecated Use #ACTION_SET_PROFILE_OWNER 4644 * Sets the given component as an active admin and registers the package as the profile 4645 * owner for this user. The package must already be installed and there shouldn't be 4646 * an existing profile owner registered for this user. Also, this method must be called 4647 * before the user setup has been completed. 4648 * <p> 4649 * This method can only be called by system apps that hold MANAGE_USERS permission and 4650 * MANAGE_DEVICE_ADMINS permission. 4651 * @param admin The component to register as an active admin and profile owner. 4652 * @param ownerName The user-visible name of the entity that is managing this user. 4653 * @return whether the admin was successfully registered as the profile owner. 4654 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or 4655 * the user has already been set up. 4656 */ 4657 @Deprecated 4658 @SystemApi 4659 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName) 4660 throws IllegalArgumentException { 4661 throwIfParentInstance("setActiveProfileOwner"); 4662 if (mService != null) { 4663 try { 4664 final int myUserId = myUserId(); 4665 mService.setActiveAdmin(admin, false, myUserId); 4666 return mService.setProfileOwner(admin, ownerName, myUserId); 4667 } catch (RemoteException re) { 4668 throw re.rethrowFromSystemServer(); 4669 } 4670 } 4671 return false; 4672 } 4673 4674 /** 4675 * Clears the active profile owner and removes all user restrictions. The caller must be from 4676 * the same package as the active profile owner for this user, otherwise a SecurityException 4677 * will be thrown. 4678 * <p> 4679 * This doesn't work for managed profile owners. 4680 * 4681 * @param admin The component to remove as the profile owner. 4682 * @throws SecurityException if {@code admin} is not an active profile owner. 4683 */ 4684 public void clearProfileOwner(@NonNull ComponentName admin) { 4685 throwIfParentInstance("clearProfileOwner"); 4686 if (mService != null) { 4687 try { 4688 mService.clearProfileOwner(admin); 4689 } catch (RemoteException re) { 4690 throw re.rethrowFromSystemServer(); 4691 } 4692 } 4693 } 4694 4695 /** 4696 * @hide 4697 * Checks whether the user was already setup. 4698 */ 4699 public boolean hasUserSetupCompleted() { 4700 if (mService != null) { 4701 try { 4702 return mService.hasUserSetupCompleted(); 4703 } catch (RemoteException re) { 4704 throw re.rethrowFromSystemServer(); 4705 } 4706 } 4707 return true; 4708 } 4709 4710 /** 4711 * @hide 4712 * Sets the given component as the profile owner of the given user profile. The package must 4713 * already be installed. There must not already be a profile owner for this user. 4714 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call 4715 * this method. 4716 * Calling this after the setup phase of the specified user has completed is allowed only if: 4717 * - the caller is SYSTEM_UID. 4718 * - or the caller is the shell uid, and there are no accounts on the specified user. 4719 * @param admin the component name to be registered as profile owner. 4720 * @param ownerName the human readable name of the organisation associated with this DPM. 4721 * @param userHandle the userId to set the profile owner for. 4722 * @return whether the component was successfully registered as the profile owner. 4723 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the 4724 * preconditions mentioned are not met. 4725 */ 4726 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName, 4727 int userHandle) throws IllegalArgumentException { 4728 if (mService != null) { 4729 try { 4730 if (ownerName == null) { 4731 ownerName = ""; 4732 } 4733 return mService.setProfileOwner(admin, ownerName, userHandle); 4734 } catch (RemoteException re) { 4735 throw re.rethrowFromSystemServer(); 4736 } 4737 } 4738 return false; 4739 } 4740 4741 /** 4742 * Sets the device owner information to be shown on the lock screen. 4743 * <p> 4744 * If the device owner information is {@code null} or empty then the device owner info is 4745 * cleared and the user owner info is shown on the lock screen if it is set. 4746 * <p> 4747 * If the device owner information contains only whitespaces then the message on the lock screen 4748 * will be blank and the user will not be allowed to change it. 4749 * <p> 4750 * If the device owner information needs to be localized, it is the responsibility of the 4751 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast 4752 * and set a new version of this string accordingly. 4753 * 4754 * @param admin The name of the admin component to check. 4755 * @param info Device owner information which will be displayed instead of the user owner info. 4756 * @throws SecurityException if {@code admin} is not a device owner. 4757 */ 4758 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) { 4759 throwIfParentInstance("setDeviceOwnerLockScreenInfo"); 4760 if (mService != null) { 4761 try { 4762 mService.setDeviceOwnerLockScreenInfo(admin, info); 4763 } catch (RemoteException re) { 4764 throw re.rethrowFromSystemServer(); 4765 } 4766 } 4767 } 4768 4769 /** 4770 * @return The device owner information. If it is not set returns {@code null}. 4771 */ 4772 public CharSequence getDeviceOwnerLockScreenInfo() { 4773 throwIfParentInstance("getDeviceOwnerLockScreenInfo"); 4774 if (mService != null) { 4775 try { 4776 return mService.getDeviceOwnerLockScreenInfo(); 4777 } catch (RemoteException re) { 4778 throw re.rethrowFromSystemServer(); 4779 } 4780 } 4781 return null; 4782 } 4783 4784 /** 4785 * Called by device or profile owners to suspend packages for this user. This function can be 4786 * called by a device owner, profile owner, or by a delegate given the 4787 * {@link #DELEGATION_PACKAGE_ACCESS} scope via {@link #setDelegatedScopes}. 4788 * <p> 4789 * A suspended package will not be able to start activities. Its notifications will be hidden, 4790 * it will not show up in recents, will not be able to show toasts or dialogs or ring the 4791 * device. 4792 * <p> 4793 * The package must already be installed. If the package is uninstalled while suspended the 4794 * package will no longer be suspended. The admin can block this by using 4795 * {@link #setUninstallBlocked}. 4796 * 4797 * @param admin The name of the admin component to check, or {@code null} if the caller is a 4798 * package access delegate. 4799 * @param packageNames The package names to suspend or unsuspend. 4800 * @param suspended If set to {@code true} than the packages will be suspended, if set to 4801 * {@code false} the packages will be unsuspended. 4802 * @return an array of package names for which the suspended status is not set as requested in 4803 * this method. 4804 * @throws SecurityException if {@code admin} is not a device or profile owner. 4805 * @see #setDelegatedScopes 4806 * @see #DELEGATION_PACKAGE_ACCESS 4807 */ 4808 public @NonNull String[] setPackagesSuspended(@NonNull ComponentName admin, 4809 @NonNull String[] packageNames, boolean suspended) { 4810 throwIfParentInstance("setPackagesSuspended"); 4811 if (mService != null) { 4812 try { 4813 return mService.setPackagesSuspended(admin, mContext.getPackageName(), packageNames, 4814 suspended); 4815 } catch (RemoteException re) { 4816 throw re.rethrowFromSystemServer(); 4817 } 4818 } 4819 return packageNames; 4820 } 4821 4822 /** 4823 * Determine if a package is suspended. This function can be called by a device owner, profile 4824 * owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via 4825 * {@link #setDelegatedScopes}. 4826 * 4827 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 4828 * {@code null} if the caller is a package access delegate. 4829 * @param packageName The name of the package to retrieve the suspended status of. 4830 * @return {@code true} if the package is suspended or {@code false} if the package is not 4831 * suspended, could not be found or an error occurred. 4832 * @throws SecurityException if {@code admin} is not a device or profile owner. 4833 * @throws NameNotFoundException if the package could not be found. 4834 * @see #setDelegatedScopes 4835 * @see #DELEGATION_PACKAGE_ACCESS 4836 */ 4837 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName) 4838 throws NameNotFoundException { 4839 throwIfParentInstance("isPackageSuspended"); 4840 if (mService != null) { 4841 try { 4842 return mService.isPackageSuspended(admin, mContext.getPackageName(), packageName); 4843 } catch (RemoteException e) { 4844 throw e.rethrowFromSystemServer(); 4845 } catch (IllegalArgumentException ex) { 4846 throw new NameNotFoundException(packageName); 4847 } 4848 } 4849 return false; 4850 } 4851 4852 /** 4853 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to 4854 * be used. Only the profile owner can call this. 4855 * 4856 * @see #isProfileOwnerApp 4857 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4858 * @throws SecurityException if {@code admin} is not a profile owner. 4859 */ 4860 public void setProfileEnabled(@NonNull ComponentName admin) { 4861 throwIfParentInstance("setProfileEnabled"); 4862 if (mService != null) { 4863 try { 4864 mService.setProfileEnabled(admin); 4865 } catch (RemoteException e) { 4866 throw e.rethrowFromSystemServer(); 4867 } 4868 } 4869 } 4870 4871 /** 4872 * Sets the name of the profile. In the device owner case it sets the name of the user which it 4873 * is called from. Only a profile owner or device owner can call this. If this is never called 4874 * by the profile or device owner, the name will be set to default values. 4875 * 4876 * @see #isProfileOwnerApp 4877 * @see #isDeviceOwnerApp 4878 * @param admin Which {@link DeviceAdminReceiver} this request is associate with. 4879 * @param profileName The name of the profile. 4880 * @throws SecurityException if {@code admin} is not a device or profile owner. 4881 */ 4882 public void setProfileName(@NonNull ComponentName admin, String profileName) { 4883 throwIfParentInstance("setProfileName"); 4884 if (mService != null) { 4885 try { 4886 mService.setProfileName(admin, profileName); 4887 } catch (RemoteException e) { 4888 throw e.rethrowFromSystemServer(); 4889 } 4890 } 4891 } 4892 4893 /** 4894 * Used to determine if a particular package is registered as the profile owner for the 4895 * user. A profile owner is a special device admin that has additional privileges 4896 * within the profile. 4897 * 4898 * @param packageName The package name of the app to compare with the registered profile owner. 4899 * @return Whether or not the package is registered as the profile owner. 4900 */ 4901 public boolean isProfileOwnerApp(String packageName) { 4902 throwIfParentInstance("isProfileOwnerApp"); 4903 if (mService != null) { 4904 try { 4905 ComponentName profileOwner = mService.getProfileOwner(myUserId()); 4906 return profileOwner != null 4907 && profileOwner.getPackageName().equals(packageName); 4908 } catch (RemoteException re) { 4909 throw re.rethrowFromSystemServer(); 4910 } 4911 } 4912 return false; 4913 } 4914 4915 /** 4916 * @hide 4917 * @return the packageName of the owner of the given user profile or {@code null} if no profile 4918 * owner has been set for that user. 4919 * @throws IllegalArgumentException if the userId is invalid. 4920 */ 4921 @SystemApi 4922 public @Nullable ComponentName getProfileOwner() throws IllegalArgumentException { 4923 throwIfParentInstance("getProfileOwner"); 4924 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier()); 4925 } 4926 4927 /** 4928 * @see #getProfileOwner() 4929 * @hide 4930 */ 4931 public @Nullable ComponentName getProfileOwnerAsUser(final int userId) 4932 throws IllegalArgumentException { 4933 if (mService != null) { 4934 try { 4935 return mService.getProfileOwner(userId); 4936 } catch (RemoteException re) { 4937 throw re.rethrowFromSystemServer(); 4938 } 4939 } 4940 return null; 4941 } 4942 4943 /** 4944 * @hide 4945 * @return the human readable name of the organisation associated with this DPM or {@code null} 4946 * if one is not set. 4947 * @throws IllegalArgumentException if the userId is invalid. 4948 */ 4949 public @Nullable String getProfileOwnerName() throws IllegalArgumentException { 4950 if (mService != null) { 4951 try { 4952 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier()); 4953 } catch (RemoteException re) { 4954 throw re.rethrowFromSystemServer(); 4955 } 4956 } 4957 return null; 4958 } 4959 4960 /** 4961 * @hide 4962 * @param userId The user for whom to fetch the profile owner name, if any. 4963 * @return the human readable name of the organisation associated with this profile owner or 4964 * null if one is not set. 4965 * @throws IllegalArgumentException if the userId is invalid. 4966 */ 4967 @SystemApi 4968 public @Nullable String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException { 4969 throwIfParentInstance("getProfileOwnerNameAsUser"); 4970 if (mService != null) { 4971 try { 4972 return mService.getProfileOwnerName(userId); 4973 } catch (RemoteException re) { 4974 throw re.rethrowFromSystemServer(); 4975 } 4976 } 4977 return null; 4978 } 4979 4980 /** 4981 * Called by a profile owner or device owner to add a default intent handler activity for 4982 * intents that match a certain intent filter. This activity will remain the default intent 4983 * handler even if the set of potential event handlers for the intent filter changes and if the 4984 * intent preferences are reset. 4985 * <p> 4986 * The default disambiguation mechanism takes over if the activity is not installed (anymore). 4987 * When the activity is (re)installed, it is automatically reset as default intent handler for 4988 * the filter. 4989 * <p> 4990 * The calling device admin must be a profile owner or device owner. If it is not, a security 4991 * exception will be thrown. 4992 * 4993 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4994 * @param filter The IntentFilter for which a default handler is added. 4995 * @param activity The Activity that is added as default intent handler. 4996 * @throws SecurityException if {@code admin} is not a device or profile owner. 4997 */ 4998 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter, 4999 @NonNull ComponentName activity) { 5000 throwIfParentInstance("addPersistentPreferredActivity"); 5001 if (mService != null) { 5002 try { 5003 mService.addPersistentPreferredActivity(admin, filter, activity); 5004 } catch (RemoteException e) { 5005 throw e.rethrowFromSystemServer(); 5006 } 5007 } 5008 } 5009 5010 /** 5011 * Called by a profile owner or device owner to remove all persistent intent handler preferences 5012 * associated with the given package that were set by {@link #addPersistentPreferredActivity}. 5013 * <p> 5014 * The calling device admin must be a profile owner. If it is not, a security exception will be 5015 * thrown. 5016 * 5017 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5018 * @param packageName The name of the package for which preferences are removed. 5019 * @throws SecurityException if {@code admin} is not a device or profile owner. 5020 */ 5021 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin, 5022 String packageName) { 5023 throwIfParentInstance("clearPackagePersistentPreferredActivities"); 5024 if (mService != null) { 5025 try { 5026 mService.clearPackagePersistentPreferredActivities(admin, packageName); 5027 } catch (RemoteException e) { 5028 throw e.rethrowFromSystemServer(); 5029 } 5030 } 5031 } 5032 5033 /** 5034 * Called by a profile owner or device owner to grant permission to a package to manage 5035 * application restrictions for the calling user via {@link #setApplicationRestrictions} and 5036 * {@link #getApplicationRestrictions}. 5037 * <p> 5038 * This permission is persistent until it is later cleared by calling this method with a 5039 * {@code null} value or uninstalling the managing package. 5040 * <p> 5041 * The supplied application restriction managing package must be installed when calling this 5042 * API, otherwise an {@link NameNotFoundException} will be thrown. 5043 * 5044 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5045 * @param packageName The package name which will be given access to application restrictions 5046 * APIs. If {@code null} is given the current package will be cleared. 5047 * @throws SecurityException if {@code admin} is not a device or profile owner. 5048 * @throws NameNotFoundException if {@code packageName} is not found 5049 * 5050 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes} 5051 * with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead. 5052 */ 5053 @Deprecated 5054 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin, 5055 @Nullable String packageName) throws NameNotFoundException { 5056 throwIfParentInstance("setApplicationRestrictionsManagingPackage"); 5057 if (mService != null) { 5058 try { 5059 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) { 5060 throw new NameNotFoundException(packageName); 5061 } 5062 } catch (RemoteException e) { 5063 throw e.rethrowFromSystemServer(); 5064 } 5065 } 5066 } 5067 5068 /** 5069 * Called by a profile owner or device owner to retrieve the application restrictions managing 5070 * package for the current user, or {@code null} if none is set. If there are multiple 5071 * delegates this function will return one of them. 5072 * 5073 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5074 * @return The package name allowed to manage application restrictions on the current user, or 5075 * {@code null} if none is set. 5076 * @throws SecurityException if {@code admin} is not a device or profile owner. 5077 * 5078 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages} 5079 * with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead. 5080 */ 5081 @Deprecated 5082 @Nullable 5083 public String getApplicationRestrictionsManagingPackage( 5084 @NonNull ComponentName admin) { 5085 throwIfParentInstance("getApplicationRestrictionsManagingPackage"); 5086 if (mService != null) { 5087 try { 5088 return mService.getApplicationRestrictionsManagingPackage(admin); 5089 } catch (RemoteException e) { 5090 throw e.rethrowFromSystemServer(); 5091 } 5092 } 5093 return null; 5094 } 5095 5096 /** 5097 * Called by any application to find out whether it has been granted permission via 5098 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions 5099 * for the calling user. 5100 * 5101 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by 5102 * that method. 5103 * 5104 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatedScopes} 5105 * instead. 5106 */ 5107 @Deprecated 5108 public boolean isCallerApplicationRestrictionsManagingPackage() { 5109 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage"); 5110 if (mService != null) { 5111 try { 5112 return mService.isCallerApplicationRestrictionsManagingPackage( 5113 mContext.getPackageName()); 5114 } catch (RemoteException e) { 5115 throw e.rethrowFromSystemServer(); 5116 } 5117 } 5118 return false; 5119 } 5120 5121 /** 5122 * Sets the application restrictions for a given target application running in the calling user. 5123 * <p> 5124 * The caller must be a profile or device owner on that user, or the package allowed to manage 5125 * application restrictions via {@link #setDelegatedScopes} with the 5126 * {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown. 5127 * <p> 5128 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be: 5129 * <ul> 5130 * <li>{@code boolean} 5131 * <li>{@code int} 5132 * <li>{@code String} or {@code String[]} 5133 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]} 5134 * </ul> 5135 * <p> 5136 * If the restrictions are not available yet, but may be applied in the near future, the caller 5137 * can notify the target application of that by adding 5138 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter. 5139 * <p> 5140 * The application restrictions are only made visible to the target application via 5141 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device 5142 * owner, and the application restrictions managing package via 5143 * {@link #getApplicationRestrictions}. 5144 * 5145 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread 5146 * 5147 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 5148 * {@code null} if called by the application restrictions managing package. 5149 * @param packageName The name of the package to update restricted settings for. 5150 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new 5151 * set of active restrictions. 5152 * @throws SecurityException if {@code admin} is not a device or profile owner. 5153 * @see #setDelegatedScopes 5154 * @see #DELEGATION_APP_RESTRICTIONS 5155 * @see UserManager#KEY_RESTRICTIONS_PENDING 5156 */ 5157 @WorkerThread 5158 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName, 5159 Bundle settings) { 5160 throwIfParentInstance("setApplicationRestrictions"); 5161 if (mService != null) { 5162 try { 5163 mService.setApplicationRestrictions(admin, mContext.getPackageName(), packageName, 5164 settings); 5165 } catch (RemoteException e) { 5166 throw e.rethrowFromSystemServer(); 5167 } 5168 } 5169 } 5170 5171 /** 5172 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to 5173 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust 5174 * agents but those enabled by this function call. If flag 5175 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect. 5176 * <p> 5177 * The calling device admin must have requested 5178 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method; 5179 * if not, a security exception will be thrown. 5180 * <p> 5181 * This method can be called on the {@link DevicePolicyManager} instance returned by 5182 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for 5183 * the parent profile. 5184 * 5185 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5186 * @param target Component name of the agent to be enabled. 5187 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be 5188 * strictly disabled according to the state of the 5189 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag. 5190 * <p> 5191 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all 5192 * admins, then it's up to the TrustAgent itself to aggregate the values from all 5193 * device admins. 5194 * <p> 5195 * Consult documentation for the specific TrustAgent to determine legal options 5196 * parameters. 5197 * @throws SecurityException if {@code admin} is not an active administrator or does not use 5198 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} 5199 */ 5200 public void setTrustAgentConfiguration(@NonNull ComponentName admin, 5201 @NonNull ComponentName target, PersistableBundle configuration) { 5202 if (mService != null) { 5203 try { 5204 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance); 5205 } catch (RemoteException e) { 5206 throw e.rethrowFromSystemServer(); 5207 } 5208 } 5209 } 5210 5211 /** 5212 * Gets configuration for the given trust agent based on aggregating all calls to 5213 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for 5214 * all device admins. 5215 * <p> 5216 * This method can be called on the {@link DevicePolicyManager} instance returned by 5217 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set 5218 * on the parent profile. 5219 * 5220 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null, 5221 * this function returns a list of configurations for all admins that declare 5222 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares 5223 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call 5224 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} 5225 * for this {@param agent} or calls it with a null configuration, null is returned. 5226 * @param agent Which component to get enabled features for. 5227 * @return configuration for the given trust agent. 5228 */ 5229 public @Nullable List<PersistableBundle> getTrustAgentConfiguration( 5230 @Nullable ComponentName admin, @NonNull ComponentName agent) { 5231 return getTrustAgentConfiguration(admin, agent, myUserId()); 5232 } 5233 5234 /** @hide per-user version */ 5235 public @Nullable List<PersistableBundle> getTrustAgentConfiguration( 5236 @Nullable ComponentName admin, @NonNull ComponentName agent, int userHandle) { 5237 if (mService != null) { 5238 try { 5239 return mService.getTrustAgentConfiguration(admin, agent, userHandle, 5240 mParentInstance); 5241 } catch (RemoteException e) { 5242 throw e.rethrowFromSystemServer(); 5243 } 5244 } 5245 return new ArrayList<PersistableBundle>(); // empty list 5246 } 5247 5248 /** 5249 * Called by a profile owner of a managed profile to set whether caller-Id information from the 5250 * managed profile will be shown in the parent profile, for incoming calls. 5251 * <p> 5252 * The calling device admin must be a profile owner. If it is not, a security exception will be 5253 * thrown. 5254 * 5255 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5256 * @param disabled If true caller-Id information in the managed profile is not displayed. 5257 * @throws SecurityException if {@code admin} is not a device or profile owner. 5258 */ 5259 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) { 5260 throwIfParentInstance("setCrossProfileCallerIdDisabled"); 5261 if (mService != null) { 5262 try { 5263 mService.setCrossProfileCallerIdDisabled(admin, disabled); 5264 } catch (RemoteException e) { 5265 throw e.rethrowFromSystemServer(); 5266 } 5267 } 5268 } 5269 5270 /** 5271 * Called by a profile owner of a managed profile to determine whether or not caller-Id 5272 * information has been disabled. 5273 * <p> 5274 * The calling device admin must be a profile owner. If it is not, a security exception will be 5275 * thrown. 5276 * 5277 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5278 * @throws SecurityException if {@code admin} is not a device or profile owner. 5279 */ 5280 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) { 5281 throwIfParentInstance("getCrossProfileCallerIdDisabled"); 5282 if (mService != null) { 5283 try { 5284 return mService.getCrossProfileCallerIdDisabled(admin); 5285 } catch (RemoteException e) { 5286 throw e.rethrowFromSystemServer(); 5287 } 5288 } 5289 return false; 5290 } 5291 5292 /** 5293 * Determine whether or not caller-Id information has been disabled. 5294 * 5295 * @param userHandle The user for whom to check the caller-id permission 5296 * @hide 5297 */ 5298 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) { 5299 if (mService != null) { 5300 try { 5301 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier()); 5302 } catch (RemoteException e) { 5303 throw e.rethrowFromSystemServer(); 5304 } 5305 } 5306 return false; 5307 } 5308 5309 /** 5310 * Called by a profile owner of a managed profile to set whether contacts search from the 5311 * managed profile will be shown in the parent profile, for incoming calls. 5312 * <p> 5313 * The calling device admin must be a profile owner. If it is not, a security exception will be 5314 * thrown. 5315 * 5316 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5317 * @param disabled If true contacts search in the managed profile is not displayed. 5318 * @throws SecurityException if {@code admin} is not a device or profile owner. 5319 */ 5320 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin, 5321 boolean disabled) { 5322 throwIfParentInstance("setCrossProfileContactsSearchDisabled"); 5323 if (mService != null) { 5324 try { 5325 mService.setCrossProfileContactsSearchDisabled(admin, disabled); 5326 } catch (RemoteException e) { 5327 throw e.rethrowFromSystemServer(); 5328 } 5329 } 5330 } 5331 5332 /** 5333 * Called by a profile owner of a managed profile to determine whether or not contacts search 5334 * has been disabled. 5335 * <p> 5336 * The calling device admin must be a profile owner. If it is not, a security exception will be 5337 * thrown. 5338 * 5339 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5340 * @throws SecurityException if {@code admin} is not a device or profile owner. 5341 */ 5342 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) { 5343 throwIfParentInstance("getCrossProfileContactsSearchDisabled"); 5344 if (mService != null) { 5345 try { 5346 return mService.getCrossProfileContactsSearchDisabled(admin); 5347 } catch (RemoteException e) { 5348 throw e.rethrowFromSystemServer(); 5349 } 5350 } 5351 return false; 5352 } 5353 5354 5355 /** 5356 * Determine whether or not contacts search has been disabled. 5357 * 5358 * @param userHandle The user for whom to check the contacts search permission 5359 * @hide 5360 */ 5361 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) { 5362 if (mService != null) { 5363 try { 5364 return mService 5365 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier()); 5366 } catch (RemoteException e) { 5367 throw e.rethrowFromSystemServer(); 5368 } 5369 } 5370 return false; 5371 } 5372 5373 /** 5374 * Start Quick Contact on the managed profile for the user, if the policy allows. 5375 * 5376 * @hide 5377 */ 5378 public void startManagedQuickContact(String actualLookupKey, long actualContactId, 5379 boolean isContactIdIgnored, long directoryId, Intent originalIntent) { 5380 if (mService != null) { 5381 try { 5382 mService.startManagedQuickContact(actualLookupKey, actualContactId, 5383 isContactIdIgnored, directoryId, originalIntent); 5384 } catch (RemoteException e) { 5385 throw e.rethrowFromSystemServer(); 5386 } 5387 } 5388 } 5389 5390 /** 5391 * Start Quick Contact on the managed profile for the user, if the policy allows. 5392 * @hide 5393 */ 5394 public void startManagedQuickContact(String actualLookupKey, long actualContactId, 5395 Intent originalIntent) { 5396 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT, 5397 originalIntent); 5398 } 5399 5400 /** 5401 * Called by a profile owner of a managed profile to set whether bluetooth devices can access 5402 * enterprise contacts. 5403 * <p> 5404 * The calling device admin must be a profile owner. If it is not, a security exception will be 5405 * thrown. 5406 * <p> 5407 * This API works on managed profile only. 5408 * 5409 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5410 * @param disabled If true, bluetooth devices cannot access enterprise contacts. 5411 * @throws SecurityException if {@code admin} is not a device or profile owner. 5412 */ 5413 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) { 5414 throwIfParentInstance("setBluetoothContactSharingDisabled"); 5415 if (mService != null) { 5416 try { 5417 mService.setBluetoothContactSharingDisabled(admin, disabled); 5418 } catch (RemoteException e) { 5419 throw e.rethrowFromSystemServer(); 5420 } 5421 } 5422 } 5423 5424 /** 5425 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices 5426 * cannot access enterprise contacts. 5427 * <p> 5428 * The calling device admin must be a profile owner. If it is not, a security exception will be 5429 * thrown. 5430 * <p> 5431 * This API works on managed profile only. 5432 * 5433 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5434 * @throws SecurityException if {@code admin} is not a device or profile owner. 5435 */ 5436 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) { 5437 throwIfParentInstance("getBluetoothContactSharingDisabled"); 5438 if (mService != null) { 5439 try { 5440 return mService.getBluetoothContactSharingDisabled(admin); 5441 } catch (RemoteException e) { 5442 throw e.rethrowFromSystemServer(); 5443 } 5444 } 5445 return true; 5446 } 5447 5448 /** 5449 * Determine whether or not Bluetooth devices cannot access contacts. 5450 * <p> 5451 * This API works on managed profile UserHandle only. 5452 * 5453 * @param userHandle The user for whom to check the caller-id permission 5454 * @hide 5455 */ 5456 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) { 5457 if (mService != null) { 5458 try { 5459 return mService.getBluetoothContactSharingDisabledForUser(userHandle 5460 .getIdentifier()); 5461 } catch (RemoteException e) { 5462 throw e.rethrowFromSystemServer(); 5463 } 5464 } 5465 return true; 5466 } 5467 5468 /** 5469 * Called by the profile owner of a managed profile so that some intents sent in the managed 5470 * profile can also be resolved in the parent, or vice versa. Only activity intents are 5471 * supported. 5472 * 5473 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5474 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the 5475 * other profile 5476 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and 5477 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported. 5478 * @throws SecurityException if {@code admin} is not a device or profile owner. 5479 */ 5480 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) { 5481 throwIfParentInstance("addCrossProfileIntentFilter"); 5482 if (mService != null) { 5483 try { 5484 mService.addCrossProfileIntentFilter(admin, filter, flags); 5485 } catch (RemoteException e) { 5486 throw e.rethrowFromSystemServer(); 5487 } 5488 } 5489 } 5490 5491 /** 5492 * Called by a profile owner of a managed profile to remove the cross-profile intent filters 5493 * that go from the managed profile to the parent, or from the parent to the managed profile. 5494 * Only removes those that have been set by the profile owner. 5495 * 5496 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5497 * @throws SecurityException if {@code admin} is not a device or profile owner. 5498 */ 5499 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) { 5500 throwIfParentInstance("clearCrossProfileIntentFilters"); 5501 if (mService != null) { 5502 try { 5503 mService.clearCrossProfileIntentFilters(admin); 5504 } catch (RemoteException e) { 5505 throw e.rethrowFromSystemServer(); 5506 } 5507 } 5508 } 5509 5510 /** 5511 * Called by a profile or device owner to set the permitted accessibility services. When set by 5512 * a device owner or profile owner the restriction applies to all profiles of the user the 5513 * device owner or profile owner is an admin for. By default the user can use any accessiblity 5514 * service. When zero or more packages have been added, accessiblity services that are not in 5515 * the list and not part of the system can not be enabled by the user. 5516 * <p> 5517 * Calling with a null value for the list disables the restriction so that all services can be 5518 * used, calling with an empty list only allows the builtin system's services. 5519 * <p> 5520 * System accesibility services are always available to the user the list can't modify this. 5521 * 5522 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5523 * @param packageNames List of accessibility service package names. 5524 * @return true if setting the restriction succeeded. It fail if there is one or more non-system 5525 * accessibility services enabled, that are not in the list. 5526 * @throws SecurityException if {@code admin} is not a device or profile owner. 5527 */ 5528 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin, 5529 List<String> packageNames) { 5530 throwIfParentInstance("setPermittedAccessibilityServices"); 5531 if (mService != null) { 5532 try { 5533 return mService.setPermittedAccessibilityServices(admin, packageNames); 5534 } catch (RemoteException e) { 5535 throw e.rethrowFromSystemServer(); 5536 } 5537 } 5538 return false; 5539 } 5540 5541 /** 5542 * Returns the list of permitted accessibility services set by this device or profile owner. 5543 * <p> 5544 * An empty list means no accessibility services except system services are allowed. Null means 5545 * all accessibility services are allowed. 5546 * 5547 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5548 * @return List of accessiblity service package names. 5549 * @throws SecurityException if {@code admin} is not a device or profile owner. 5550 */ 5551 public @Nullable List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) { 5552 throwIfParentInstance("getPermittedAccessibilityServices"); 5553 if (mService != null) { 5554 try { 5555 return mService.getPermittedAccessibilityServices(admin); 5556 } catch (RemoteException e) { 5557 throw e.rethrowFromSystemServer(); 5558 } 5559 } 5560 return null; 5561 } 5562 5563 /** 5564 * Called by the system to check if a specific accessibility service is disabled by admin. 5565 * 5566 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5567 * @param packageName Accessibility service package name that needs to be checked. 5568 * @param userHandle user id the admin is running as. 5569 * @return true if the accessibility service is permitted, otherwise false. 5570 * 5571 * @hide 5572 */ 5573 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin, 5574 @NonNull String packageName, int userHandle) { 5575 if (mService != null) { 5576 try { 5577 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName, 5578 userHandle); 5579 } catch (RemoteException e) { 5580 throw e.rethrowFromSystemServer(); 5581 } 5582 } 5583 return false; 5584 } 5585 5586 /** 5587 * Returns the list of accessibility services permitted by the device or profiles 5588 * owners of this user. 5589 * 5590 * <p>Null means all accessibility services are allowed, if a non-null list is returned 5591 * it will contain the intersection of the permitted lists for any device or profile 5592 * owners that apply to this user. It will also include any system accessibility services. 5593 * 5594 * @param userId which user to check for. 5595 * @return List of accessiblity service package names. 5596 * @hide 5597 */ 5598 @SystemApi 5599 public @Nullable List<String> getPermittedAccessibilityServices(int userId) { 5600 throwIfParentInstance("getPermittedAccessibilityServices"); 5601 if (mService != null) { 5602 try { 5603 return mService.getPermittedAccessibilityServicesForUser(userId); 5604 } catch (RemoteException e) { 5605 throw e.rethrowFromSystemServer(); 5606 } 5607 } 5608 return null; 5609 } 5610 5611 /** 5612 * Called by a profile or device owner to set the permitted input methods services. When set by 5613 * a device owner or profile owner the restriction applies to all profiles of the user the 5614 * device owner or profile owner is an admin for. By default the user can use any input method. 5615 * When zero or more packages have been added, input method that are not in the list and not 5616 * part of the system can not be enabled by the user. This method will fail if it is called for 5617 * a admin that is not for the foreground user or a profile of the foreground user. 5618 * <p> 5619 * Calling with a null value for the list disables the restriction so that all input methods can 5620 * be used, calling with an empty list disables all but the system's own input methods. 5621 * <p> 5622 * System input methods are always available to the user this method can't modify this. 5623 * 5624 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5625 * @param packageNames List of input method package names. 5626 * @return true if setting the restriction succeeded. It will fail if there are one or more 5627 * non-system input methods currently enabled that are not in the packageNames list. 5628 * @throws SecurityException if {@code admin} is not a device or profile owner. 5629 */ 5630 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) { 5631 throwIfParentInstance("setPermittedInputMethods"); 5632 if (mService != null) { 5633 try { 5634 return mService.setPermittedInputMethods(admin, packageNames); 5635 } catch (RemoteException e) { 5636 throw e.rethrowFromSystemServer(); 5637 } 5638 } 5639 return false; 5640 } 5641 5642 5643 /** 5644 * Returns the list of permitted input methods set by this device or profile owner. 5645 * <p> 5646 * An empty list means no input methods except system input methods are allowed. Null means all 5647 * input methods are allowed. 5648 * 5649 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5650 * @return List of input method package names. 5651 * @throws SecurityException if {@code admin} is not a device or profile owner. 5652 */ 5653 public @Nullable List<String> getPermittedInputMethods(@NonNull ComponentName admin) { 5654 throwIfParentInstance("getPermittedInputMethods"); 5655 if (mService != null) { 5656 try { 5657 return mService.getPermittedInputMethods(admin); 5658 } catch (RemoteException e) { 5659 throw e.rethrowFromSystemServer(); 5660 } 5661 } 5662 return null; 5663 } 5664 5665 /** 5666 * Called by the system to check if a specific input method is disabled by admin. 5667 * 5668 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5669 * @param packageName Input method package name that needs to be checked. 5670 * @param userHandle user id the admin is running as. 5671 * @return true if the input method is permitted, otherwise false. 5672 * 5673 * @hide 5674 */ 5675 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin, 5676 @NonNull String packageName, int userHandle) { 5677 if (mService != null) { 5678 try { 5679 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle); 5680 } catch (RemoteException e) { 5681 throw e.rethrowFromSystemServer(); 5682 } 5683 } 5684 return false; 5685 } 5686 5687 /** 5688 * Returns the list of input methods permitted by the device or profiles 5689 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.) 5690 * 5691 * <p>Null means all input methods are allowed, if a non-null list is returned 5692 * it will contain the intersection of the permitted lists for any device or profile 5693 * owners that apply to this user. It will also include any system input methods. 5694 * 5695 * @return List of input method package names. 5696 * @hide 5697 */ 5698 @SystemApi 5699 public @Nullable List<String> getPermittedInputMethodsForCurrentUser() { 5700 throwIfParentInstance("getPermittedInputMethodsForCurrentUser"); 5701 if (mService != null) { 5702 try { 5703 return mService.getPermittedInputMethodsForCurrentUser(); 5704 } catch (RemoteException e) { 5705 throw e.rethrowFromSystemServer(); 5706 } 5707 } 5708 return null; 5709 } 5710 5711 /** 5712 * Get the list of apps to keep around as APKs even if no user has currently installed it. This 5713 * function can be called by a device owner or by a delegate given the 5714 * {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}. 5715 * <p> 5716 * Please note that packages returned in this method are not automatically pre-cached. 5717 * 5718 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 5719 * {@code null} if the caller is a keep uninstalled packages delegate. 5720 * @return List of package names to keep cached. 5721 * @see #setDelegatedScopes 5722 * @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES 5723 * @hide 5724 */ 5725 public @Nullable List<String> getKeepUninstalledPackages(@Nullable ComponentName admin) { 5726 throwIfParentInstance("getKeepUninstalledPackages"); 5727 if (mService != null) { 5728 try { 5729 return mService.getKeepUninstalledPackages(admin, mContext.getPackageName()); 5730 } catch (RemoteException e) { 5731 throw e.rethrowFromSystemServer(); 5732 } 5733 } 5734 return null; 5735 } 5736 5737 /** 5738 * Set a list of apps to keep around as APKs even if no user has currently installed it. This 5739 * function can be called by a device owner or by a delegate given the 5740 * {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}. 5741 * 5742 * <p>Please note that setting this policy does not imply that specified apps will be 5743 * automatically pre-cached.</p> 5744 * 5745 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 5746 * {@code null} if the caller is a keep uninstalled packages delegate. 5747 * @param packageNames List of package names to keep cached. 5748 * @throws SecurityException if {@code admin} is not a device owner. 5749 * @see #setDelegatedScopes 5750 * @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES 5751 * @hide 5752 */ 5753 public void setKeepUninstalledPackages(@Nullable ComponentName admin, 5754 @NonNull List<String> packageNames) { 5755 throwIfParentInstance("setKeepUninstalledPackages"); 5756 if (mService != null) { 5757 try { 5758 mService.setKeepUninstalledPackages(admin, mContext.getPackageName(), packageNames); 5759 } catch (RemoteException e) { 5760 throw e.rethrowFromSystemServer(); 5761 } 5762 } 5763 } 5764 5765 /** 5766 * Called by a device owner to create a user with the specified name. The UserHandle returned 5767 * by this method should not be persisted as user handles are recycled as users are removed and 5768 * created. If you need to persist an identifier for this user, use 5769 * {@link UserManager#getSerialNumberForUser}. 5770 * 5771 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5772 * @param name the user's name 5773 * @see UserHandle 5774 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the 5775 * user could not be created. 5776 * 5777 * @deprecated From {@link android.os.Build.VERSION_CODES#M} 5778 * @removed From {@link android.os.Build.VERSION_CODES#N} 5779 */ 5780 @Deprecated 5781 public @Nullable UserHandle createUser(@NonNull ComponentName admin, String name) { 5782 return null; 5783 } 5784 5785 /** 5786 * Called by a device owner to create a user with the specified name. The UserHandle returned 5787 * by this method should not be persisted as user handles are recycled as users are removed and 5788 * created. If you need to persist an identifier for this user, use 5789 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background 5790 * immediately. 5791 * 5792 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well 5793 * as registered as an active admin on the new user. The profile owner package will be 5794 * installed on the new user if it already is installed on the device. 5795 * 5796 * <p>If the optionalInitializeData is not null, then the extras will be passed to the 5797 * profileOwnerComponent when onEnable is called. 5798 * 5799 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5800 * @param name the user's name 5801 * @param ownerName the human readable name of the organisation associated with this DPM. 5802 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on 5803 * the user. 5804 * @param adminExtras Extras that will be passed to onEnable of the admin receiver 5805 * on the new user. 5806 * @see UserHandle 5807 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the 5808 * user could not be created. 5809 * 5810 * @deprecated From {@link android.os.Build.VERSION_CODES#M} 5811 * @removed From {@link android.os.Build.VERSION_CODES#N} 5812 */ 5813 @Deprecated 5814 public @Nullable UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name, 5815 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) { 5816 return null; 5817 } 5818 5819 /** 5820 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user. 5821 */ 5822 public static final int SKIP_SETUP_WIZARD = 0x0001; 5823 5824 /** 5825 * Flag used by {@link #createAndManageUser} to specify that the user should be created 5826 * ephemeral. 5827 * @hide 5828 */ 5829 public static final int MAKE_USER_EPHEMERAL = 0x0002; 5830 5831 /** 5832 * Called by a device owner to create a user with the specified name and a given component of 5833 * the calling package as profile owner. The UserHandle returned by this method should not be 5834 * persisted as user handles are recycled as users are removed and created. If you need to 5835 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new 5836 * user will not be started in the background. 5837 * <p> 5838 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a 5839 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will 5840 * be registered as an active admin on the new user. The profile owner package will be installed 5841 * on the new user. 5842 * <p> 5843 * If the adminExtras are not null, they will be stored on the device until the user is started 5844 * for the first time. Then the extras will be passed to the admin when onEnable is called. 5845 * 5846 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5847 * @param name The user's name. 5848 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the 5849 * same package as admin, otherwise no user is created and an 5850 * IllegalArgumentException is thrown. 5851 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new 5852 * user. 5853 * @param flags {@link #SKIP_SETUP_WIZARD} is supported. 5854 * @see UserHandle 5855 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the 5856 * user could not be created. 5857 * @throws SecurityException if {@code admin} is not a device owner. 5858 */ 5859 public @Nullable UserHandle createAndManageUser(@NonNull ComponentName admin, 5860 @NonNull String name, 5861 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras, 5862 int flags) { 5863 throwIfParentInstance("createAndManageUser"); 5864 try { 5865 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags); 5866 } catch (RemoteException re) { 5867 throw re.rethrowFromSystemServer(); 5868 } 5869 } 5870 5871 /** 5872 * Called by a device owner to remove a user and all associated data. The primary user can not 5873 * be removed. 5874 * 5875 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5876 * @param userHandle the user to remove. 5877 * @return {@code true} if the user was removed, {@code false} otherwise. 5878 * @throws SecurityException if {@code admin} is not a device owner. 5879 */ 5880 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) { 5881 throwIfParentInstance("removeUser"); 5882 try { 5883 return mService.removeUser(admin, userHandle); 5884 } catch (RemoteException re) { 5885 throw re.rethrowFromSystemServer(); 5886 } 5887 } 5888 5889 /** 5890 * Called by a device owner to switch the specified user to the foreground. 5891 * 5892 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5893 * @param userHandle the user to switch to; null will switch to primary. 5894 * @return {@code true} if the switch was successful, {@code false} otherwise. 5895 * @throws SecurityException if {@code admin} is not a device owner. 5896 * @see Intent#ACTION_USER_FOREGROUND 5897 */ 5898 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) { 5899 throwIfParentInstance("switchUser"); 5900 try { 5901 return mService.switchUser(admin, userHandle); 5902 } catch (RemoteException re) { 5903 throw re.rethrowFromSystemServer(); 5904 } 5905 } 5906 5907 /** 5908 * Retrieves the application restrictions for a given target application running in the calling 5909 * user. 5910 * <p> 5911 * The caller must be a profile or device owner on that user, or the package allowed to manage 5912 * application restrictions via {@link #setDelegatedScopes} with the 5913 * {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown. 5914 * 5915 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread 5916 * 5917 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 5918 * {@code null} if called by the application restrictions managing package. 5919 * @param packageName The name of the package to fetch restricted settings of. 5920 * @return {@link Bundle} of settings corresponding to what was set last time 5921 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty 5922 * {@link Bundle} if no restrictions have been set. 5923 * @throws SecurityException if {@code admin} is not a device or profile owner. 5924 * @see #setDelegatedScopes 5925 * @see #DELEGATION_APP_RESTRICTIONS 5926 */ 5927 @WorkerThread 5928 public @NonNull Bundle getApplicationRestrictions( 5929 @Nullable ComponentName admin, String packageName) { 5930 throwIfParentInstance("getApplicationRestrictions"); 5931 if (mService != null) { 5932 try { 5933 return mService.getApplicationRestrictions(admin, mContext.getPackageName(), 5934 packageName); 5935 } catch (RemoteException e) { 5936 throw e.rethrowFromSystemServer(); 5937 } 5938 } 5939 return null; 5940 } 5941 5942 /** 5943 * Called by a profile or device owner to set a user restriction specified by the key. 5944 * <p> 5945 * The calling device admin must be a profile or device owner; if it is not, a security 5946 * exception will be thrown. 5947 * 5948 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5949 * @param key The key of the restriction. See the constants in {@link android.os.UserManager} 5950 * for the list of keys. 5951 * @throws SecurityException if {@code admin} is not a device or profile owner. 5952 */ 5953 public void addUserRestriction(@NonNull ComponentName admin, String key) { 5954 throwIfParentInstance("addUserRestriction"); 5955 if (mService != null) { 5956 try { 5957 mService.setUserRestriction(admin, key, true); 5958 } catch (RemoteException e) { 5959 throw e.rethrowFromSystemServer(); 5960 } 5961 } 5962 } 5963 5964 /** 5965 * Called by a profile or device owner to clear a user restriction specified by the key. 5966 * <p> 5967 * The calling device admin must be a profile or device owner; if it is not, a security 5968 * exception will be thrown. 5969 * 5970 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5971 * @param key The key of the restriction. See the constants in {@link android.os.UserManager} 5972 * for the list of keys. 5973 * @throws SecurityException if {@code admin} is not a device or profile owner. 5974 */ 5975 public void clearUserRestriction(@NonNull ComponentName admin, String key) { 5976 throwIfParentInstance("clearUserRestriction"); 5977 if (mService != null) { 5978 try { 5979 mService.setUserRestriction(admin, key, false); 5980 } catch (RemoteException e) { 5981 throw e.rethrowFromSystemServer(); 5982 } 5983 } 5984 } 5985 5986 /** 5987 * Called by a profile or device owner to get user restrictions set with 5988 * {@link #addUserRestriction(ComponentName, String)}. 5989 * <p> 5990 * The target user may have more restrictions set by the system or other device owner / profile 5991 * owner. To get all the user restrictions currently set, use 5992 * {@link UserManager#getUserRestrictions()}. 5993 * 5994 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5995 * @throws SecurityException if {@code admin} is not a device or profile owner. 5996 */ 5997 public @NonNull Bundle getUserRestrictions(@NonNull ComponentName admin) { 5998 throwIfParentInstance("getUserRestrictions"); 5999 Bundle ret = null; 6000 if (mService != null) { 6001 try { 6002 ret = mService.getUserRestrictions(admin); 6003 } catch (RemoteException e) { 6004 throw e.rethrowFromSystemServer(); 6005 } 6006 } 6007 return ret == null ? new Bundle() : ret; 6008 } 6009 6010 /** 6011 * Called by any app to display a support dialog when a feature was disabled by an admin. 6012 * This returns an intent that can be used with {@link Context#startActivity(Intent)} to 6013 * display the dialog. It will tell the user that the feature indicated by {@code restriction} 6014 * was disabled by an admin, and include a link for more information. The default content of 6015 * the dialog can be changed by the restricting admin via 6016 * {@link #setShortSupportMessage(ComponentName, CharSequence)}. If the restriction is not 6017 * set (i.e. the feature is available), then the return value will be {@code null}. 6018 * @param restriction Indicates for which feature the dialog should be displayed. Can be a 6019 * user restriction from {@link UserManager}, e.g. 6020 * {@link UserManager#DISALLOW_ADJUST_VOLUME}, or one of the constants 6021 * {@link #POLICY_DISABLE_CAMERA} or {@link #POLICY_DISABLE_SCREEN_CAPTURE}. 6022 * @return Intent An intent to be used to start the dialog-activity if the restriction is 6023 * set by an admin, or null if the restriction does not exist or no admin set it. 6024 */ 6025 public Intent createAdminSupportIntent(@NonNull String restriction) { 6026 throwIfParentInstance("createAdminSupportIntent"); 6027 if (mService != null) { 6028 try { 6029 return mService.createAdminSupportIntent(restriction); 6030 } catch (RemoteException e) { 6031 throw e.rethrowFromSystemServer(); 6032 } 6033 } 6034 return null; 6035 } 6036 6037 /** 6038 * Hide or unhide packages. When a package is hidden it is unavailable for use, but the data and 6039 * actual package file remain. This function can be called by a device owner, profile owner, or 6040 * by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via 6041 * {@link #setDelegatedScopes}. 6042 * 6043 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 6044 * {@code null} if the caller is a package access delegate. 6045 * @param packageName The name of the package to hide or unhide. 6046 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be 6047 * unhidden. 6048 * @return boolean Whether the hidden setting of the package was successfully updated. 6049 * @throws SecurityException if {@code admin} is not a device or profile owner. 6050 * @see #setDelegatedScopes 6051 * @see #DELEGATION_PACKAGE_ACCESS 6052 */ 6053 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName, 6054 boolean hidden) { 6055 throwIfParentInstance("setApplicationHidden"); 6056 if (mService != null) { 6057 try { 6058 return mService.setApplicationHidden(admin, mContext.getPackageName(), packageName, 6059 hidden); 6060 } catch (RemoteException e) { 6061 throw e.rethrowFromSystemServer(); 6062 } 6063 } 6064 return false; 6065 } 6066 6067 /** 6068 * Determine if a package is hidden. This function can be called by a device owner, profile 6069 * owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via 6070 * {@link #setDelegatedScopes}. 6071 * 6072 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 6073 * {@code null} if the caller is a package access delegate. 6074 * @param packageName The name of the package to retrieve the hidden status of. 6075 * @return boolean {@code true} if the package is hidden, {@code false} otherwise. 6076 * @throws SecurityException if {@code admin} is not a device or profile owner. 6077 * @see #setDelegatedScopes 6078 * @see #DELEGATION_PACKAGE_ACCESS 6079 */ 6080 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) { 6081 throwIfParentInstance("isApplicationHidden"); 6082 if (mService != null) { 6083 try { 6084 return mService.isApplicationHidden(admin, mContext.getPackageName(), packageName); 6085 } catch (RemoteException e) { 6086 throw e.rethrowFromSystemServer(); 6087 } 6088 } 6089 return false; 6090 } 6091 6092 /** 6093 * Re-enable a system app that was disabled by default when the user was initialized. This 6094 * function can be called by a device owner, profile owner, or by a delegate given the 6095 * {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}. 6096 * 6097 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 6098 * {@code null} if the caller is an enable system app delegate. 6099 * @param packageName The package to be re-enabled in the calling profile. 6100 * @throws SecurityException if {@code admin} is not a device or profile owner. 6101 * @see #setDelegatedScopes 6102 * @see #DELEGATION_PACKAGE_ACCESS 6103 */ 6104 public void enableSystemApp(@NonNull ComponentName admin, String packageName) { 6105 throwIfParentInstance("enableSystemApp"); 6106 if (mService != null) { 6107 try { 6108 mService.enableSystemApp(admin, mContext.getPackageName(), packageName); 6109 } catch (RemoteException e) { 6110 throw e.rethrowFromSystemServer(); 6111 } 6112 } 6113 } 6114 6115 /** 6116 * Re-enable system apps by intent that were disabled by default when the user was initialized. 6117 * This function can be called by a device owner, profile owner, or by a delegate given the 6118 * {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}. 6119 * 6120 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 6121 * {@code null} if the caller is an enable system app delegate. 6122 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this 6123 * intent will be re-enabled in the calling profile. 6124 * @return int The number of activities that matched the intent and were installed. 6125 * @throws SecurityException if {@code admin} is not a device or profile owner. 6126 * @see #setDelegatedScopes 6127 * @see #DELEGATION_PACKAGE_ACCESS 6128 */ 6129 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) { 6130 throwIfParentInstance("enableSystemApp"); 6131 if (mService != null) { 6132 try { 6133 return mService.enableSystemAppWithIntent(admin, mContext.getPackageName(), intent); 6134 } catch (RemoteException e) { 6135 throw e.rethrowFromSystemServer(); 6136 } 6137 } 6138 return 0; 6139 } 6140 6141 /** 6142 * Called by a device owner or profile owner to disable account management for a specific type 6143 * of account. 6144 * <p> 6145 * The calling device admin must be a device owner or profile owner. If it is not, a security 6146 * exception will be thrown. 6147 * <p> 6148 * When account management is disabled for an account type, adding or removing an account of 6149 * that type will not be possible. 6150 * <p> 6151 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use 6152 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account 6153 * management for a specific type is disabled. 6154 * 6155 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6156 * @param accountType For which account management is disabled or enabled. 6157 * @param disabled The boolean indicating that account management will be disabled (true) or 6158 * enabled (false). 6159 * @throws SecurityException if {@code admin} is not a device or profile owner. 6160 */ 6161 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType, 6162 boolean disabled) { 6163 throwIfParentInstance("setAccountManagementDisabled"); 6164 if (mService != null) { 6165 try { 6166 mService.setAccountManagementDisabled(admin, accountType, disabled); 6167 } catch (RemoteException e) { 6168 throw e.rethrowFromSystemServer(); 6169 } 6170 } 6171 } 6172 6173 /** 6174 * Gets the array of accounts for which account management is disabled by the profile owner. 6175 * 6176 * <p> Account management can be disabled/enabled by calling 6177 * {@link #setAccountManagementDisabled}. 6178 * 6179 * @return a list of account types for which account management has been disabled. 6180 * 6181 * @see #setAccountManagementDisabled 6182 */ 6183 public @Nullable String[] getAccountTypesWithManagementDisabled() { 6184 throwIfParentInstance("getAccountTypesWithManagementDisabled"); 6185 return getAccountTypesWithManagementDisabledAsUser(myUserId()); 6186 } 6187 6188 /** 6189 * @see #getAccountTypesWithManagementDisabled() 6190 * @hide 6191 */ 6192 public @Nullable String[] getAccountTypesWithManagementDisabledAsUser(int userId) { 6193 if (mService != null) { 6194 try { 6195 return mService.getAccountTypesWithManagementDisabledAsUser(userId); 6196 } catch (RemoteException e) { 6197 throw e.rethrowFromSystemServer(); 6198 } 6199 } 6200 6201 return null; 6202 } 6203 6204 /** 6205 * Sets which packages may enter lock task mode. 6206 * <p> 6207 * Any packages that share uid with an allowed package will also be allowed to activate lock 6208 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task 6209 * package list results in locked tasks belonging to those packages to be finished. 6210 * <p> 6211 * This function can only be called by the device owner or by a profile owner of a user/profile 6212 * that is affiliated with the device owner user. See {@link #setAffiliationIds}. Any packages 6213 * set via this method will be cleared if the user becomes unaffiliated. 6214 * 6215 * @param packages The list of packages allowed to enter lock task mode 6216 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6217 * @throws SecurityException if {@code admin} is not the device owner, or the profile owner of 6218 * an affiliated user or profile. 6219 * @see Activity#startLockTask() 6220 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String) 6221 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent) 6222 * @see UserManager#DISALLOW_CREATE_WINDOWS 6223 */ 6224 public void setLockTaskPackages(@NonNull ComponentName admin, @NonNull String[] packages) 6225 throws SecurityException { 6226 throwIfParentInstance("setLockTaskPackages"); 6227 if (mService != null) { 6228 try { 6229 mService.setLockTaskPackages(admin, packages); 6230 } catch (RemoteException e) { 6231 throw e.rethrowFromSystemServer(); 6232 } 6233 } 6234 } 6235 6236 /** 6237 * Returns the list of packages allowed to start the lock task mode. 6238 * 6239 * @throws SecurityException if {@code admin} is not the device owner, or the profile owner of 6240 * an affiliated user or profile. 6241 * @see #setLockTaskPackages 6242 */ 6243 public @NonNull String[] getLockTaskPackages(@NonNull ComponentName admin) { 6244 throwIfParentInstance("getLockTaskPackages"); 6245 if (mService != null) { 6246 try { 6247 return mService.getLockTaskPackages(admin); 6248 } catch (RemoteException e) { 6249 throw e.rethrowFromSystemServer(); 6250 } 6251 } 6252 return new String[0]; 6253 } 6254 6255 /** 6256 * This function lets the caller know whether the given component is allowed to start the 6257 * lock task mode. 6258 * @param pkg The package to check 6259 */ 6260 public boolean isLockTaskPermitted(String pkg) { 6261 throwIfParentInstance("isLockTaskPermitted"); 6262 if (mService != null) { 6263 try { 6264 return mService.isLockTaskPermitted(pkg); 6265 } catch (RemoteException e) { 6266 throw e.rethrowFromSystemServer(); 6267 } 6268 } 6269 return false; 6270 } 6271 6272 /** 6273 * Called by device owners to update {@link Settings.Global} settings. Validation that the value 6274 * of the setting is in the correct form for the setting type should be performed by the caller. 6275 * <p> 6276 * The settings that can be updated with this method are: 6277 * <ul> 6278 * <li>{@link Settings.Global#ADB_ENABLED}</li> 6279 * <li>{@link Settings.Global#AUTO_TIME}</li> 6280 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li> 6281 * <li>{@link Settings.Global#DATA_ROAMING}</li> 6282 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li> 6283 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li> 6284 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from 6285 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if 6286 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li> 6287 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only 6288 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li> 6289 * </ul> 6290 * <p> 6291 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}: 6292 * <ul> 6293 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use 6294 * {@link android.bluetooth.BluetoothAdapter#enable()} and 6295 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li> 6296 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li> 6297 * <li>{@link Settings.Global#MODE_RINGER}. Use 6298 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li> 6299 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li> 6300 * <li>{@link Settings.Global#WIFI_ON}. Use 6301 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li> 6302 * </ul> 6303 * 6304 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6305 * @param setting The name of the setting to update. 6306 * @param value The value to update the setting to. 6307 * @throws SecurityException if {@code admin} is not a device owner. 6308 */ 6309 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) { 6310 throwIfParentInstance("setGlobalSetting"); 6311 if (mService != null) { 6312 try { 6313 mService.setGlobalSetting(admin, setting, value); 6314 } catch (RemoteException e) { 6315 throw e.rethrowFromSystemServer(); 6316 } 6317 } 6318 } 6319 6320 /** 6321 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation 6322 * that the value of the setting is in the correct form for the setting type should be performed 6323 * by the caller. 6324 * <p> 6325 * The settings that can be updated by a profile or device owner with this method are: 6326 * <ul> 6327 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li> 6328 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li> 6329 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li> 6330 * </ul> 6331 * <p> 6332 * A device owner can additionally update the following settings: 6333 * <ul> 6334 * <li>{@link Settings.Secure#LOCATION_MODE}</li> 6335 * </ul> 6336 * 6337 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6338 * @param setting The name of the setting to update. 6339 * @param value The value to update the setting to. 6340 * @throws SecurityException if {@code admin} is not a device or profile owner. 6341 */ 6342 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) { 6343 throwIfParentInstance("setSecureSetting"); 6344 if (mService != null) { 6345 try { 6346 mService.setSecureSetting(admin, setting, value); 6347 } catch (RemoteException e) { 6348 throw e.rethrowFromSystemServer(); 6349 } 6350 } 6351 } 6352 6353 /** 6354 * Designates a specific service component as the provider for making permission requests of a 6355 * local or remote administrator of the user. 6356 * <p/> 6357 * Only a profile owner can designate the restrictions provider. 6358 * 6359 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6360 * @param provider The component name of the service that implements 6361 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions 6362 * provider previously assigned. 6363 * @throws SecurityException if {@code admin} is not a device or profile owner. 6364 */ 6365 public void setRestrictionsProvider(@NonNull ComponentName admin, 6366 @Nullable ComponentName provider) { 6367 throwIfParentInstance("setRestrictionsProvider"); 6368 if (mService != null) { 6369 try { 6370 mService.setRestrictionsProvider(admin, provider); 6371 } catch (RemoteException re) { 6372 throw re.rethrowFromSystemServer(); 6373 } 6374 } 6375 } 6376 6377 /** 6378 * Called by profile or device owners to set the master volume mute on or off. 6379 * This has no effect when set on a managed profile. 6380 * 6381 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6382 * @param on {@code true} to mute master volume, {@code false} to turn mute off. 6383 * @throws SecurityException if {@code admin} is not a device or profile owner. 6384 */ 6385 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) { 6386 throwIfParentInstance("setMasterVolumeMuted"); 6387 if (mService != null) { 6388 try { 6389 mService.setMasterVolumeMuted(admin, on); 6390 } catch (RemoteException re) { 6391 throw re.rethrowFromSystemServer(); 6392 } 6393 } 6394 } 6395 6396 /** 6397 * Called by profile or device owners to check whether the master volume mute is on or off. 6398 * 6399 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6400 * @return {@code true} if master volume is muted, {@code false} if it's not. 6401 * @throws SecurityException if {@code admin} is not a device or profile owner. 6402 */ 6403 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) { 6404 throwIfParentInstance("isMasterVolumeMuted"); 6405 if (mService != null) { 6406 try { 6407 return mService.isMasterVolumeMuted(admin); 6408 } catch (RemoteException re) { 6409 throw re.rethrowFromSystemServer(); 6410 } 6411 } 6412 return false; 6413 } 6414 6415 /** 6416 * Change whether a user can uninstall a package. This function can be called by a device owner, 6417 * profile owner, or by a delegate given the {@link #DELEGATION_BLOCK_UNINSTALL} scope via 6418 * {@link #setDelegatedScopes}. 6419 * 6420 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 6421 * {@code null} if the caller is a block uninstall delegate. 6422 * @param packageName package to change. 6423 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package. 6424 * @throws SecurityException if {@code admin} is not a device or profile owner. 6425 * @see #setDelegatedScopes 6426 * @see #DELEGATION_BLOCK_UNINSTALL 6427 */ 6428 public void setUninstallBlocked(@Nullable ComponentName admin, String packageName, 6429 boolean uninstallBlocked) { 6430 throwIfParentInstance("setUninstallBlocked"); 6431 if (mService != null) { 6432 try { 6433 mService.setUninstallBlocked(admin, mContext.getPackageName(), packageName, 6434 uninstallBlocked); 6435 } catch (RemoteException re) { 6436 throw re.rethrowFromSystemServer(); 6437 } 6438 } 6439 } 6440 6441 /** 6442 * Check whether the user has been blocked by device policy from uninstalling a package. 6443 * Requires the caller to be the profile owner if checking a specific admin's policy. 6444 * <p> 6445 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the 6446 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter 6447 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null} 6448 * will cause a NullPointerException to be raised. 6449 * 6450 * @param admin The name of the admin component whose blocking policy will be checked, or 6451 * {@code null} to check whether any admin has blocked the uninstallation. 6452 * @param packageName package to check. 6453 * @return true if uninstallation is blocked. 6454 * @throws SecurityException if {@code admin} is not a device or profile owner. 6455 */ 6456 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) { 6457 throwIfParentInstance("isUninstallBlocked"); 6458 if (mService != null) { 6459 try { 6460 return mService.isUninstallBlocked(admin, packageName); 6461 } catch (RemoteException re) { 6462 throw re.rethrowFromSystemServer(); 6463 } 6464 } 6465 return false; 6466 } 6467 6468 /** 6469 * Called by the profile owner of a managed profile to enable widget providers from a given 6470 * package to be available in the parent profile. As a result the user will be able to add 6471 * widgets from the white-listed package running under the profile to a widget host which runs 6472 * under the parent profile, for example the home screen. Note that a package may have zero or 6473 * more provider components, where each component provides a different widget type. 6474 * <p> 6475 * <strong>Note:</strong> By default no widget provider package is white-listed. 6476 * 6477 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6478 * @param packageName The package from which widget providers are white-listed. 6479 * @return Whether the package was added. 6480 * @throws SecurityException if {@code admin} is not a profile owner. 6481 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String) 6482 * @see #getCrossProfileWidgetProviders(android.content.ComponentName) 6483 */ 6484 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) { 6485 throwIfParentInstance("addCrossProfileWidgetProvider"); 6486 if (mService != null) { 6487 try { 6488 return mService.addCrossProfileWidgetProvider(admin, packageName); 6489 } catch (RemoteException re) { 6490 throw re.rethrowFromSystemServer(); 6491 } 6492 } 6493 return false; 6494 } 6495 6496 /** 6497 * Called by the profile owner of a managed profile to disable widget providers from a given 6498 * package to be available in the parent profile. For this method to take effect the package 6499 * should have been added via 6500 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}. 6501 * <p> 6502 * <strong>Note:</strong> By default no widget provider package is white-listed. 6503 * 6504 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6505 * @param packageName The package from which widget providers are no longer white-listed. 6506 * @return Whether the package was removed. 6507 * @throws SecurityException if {@code admin} is not a profile owner. 6508 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String) 6509 * @see #getCrossProfileWidgetProviders(android.content.ComponentName) 6510 */ 6511 public boolean removeCrossProfileWidgetProvider( 6512 @NonNull ComponentName admin, String packageName) { 6513 throwIfParentInstance("removeCrossProfileWidgetProvider"); 6514 if (mService != null) { 6515 try { 6516 return mService.removeCrossProfileWidgetProvider(admin, packageName); 6517 } catch (RemoteException re) { 6518 throw re.rethrowFromSystemServer(); 6519 } 6520 } 6521 return false; 6522 } 6523 6524 /** 6525 * Called by the profile owner of a managed profile to query providers from which packages are 6526 * available in the parent profile. 6527 * 6528 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6529 * @return The white-listed package list. 6530 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String) 6531 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String) 6532 * @throws SecurityException if {@code admin} is not a profile owner. 6533 */ 6534 public @NonNull List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) { 6535 throwIfParentInstance("getCrossProfileWidgetProviders"); 6536 if (mService != null) { 6537 try { 6538 List<String> providers = mService.getCrossProfileWidgetProviders(admin); 6539 if (providers != null) { 6540 return providers; 6541 } 6542 } catch (RemoteException re) { 6543 throw re.rethrowFromSystemServer(); 6544 } 6545 } 6546 return Collections.emptyList(); 6547 } 6548 6549 /** 6550 * Called by profile or device owners to set the user's photo. 6551 * 6552 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6553 * @param icon the bitmap to set as the photo. 6554 * @throws SecurityException if {@code admin} is not a device or profile owner. 6555 */ 6556 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) { 6557 throwIfParentInstance("setUserIcon"); 6558 try { 6559 mService.setUserIcon(admin, icon); 6560 } catch (RemoteException re) { 6561 throw re.rethrowFromSystemServer(); 6562 } 6563 } 6564 6565 /** 6566 * Called by device owners to set a local system update policy. When a new policy is set, 6567 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted. 6568 * 6569 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All 6570 * components in the device owner package can set system update policies and the most 6571 * recent policy takes effect. 6572 * @param policy the new policy, or {@code null} to clear the current policy. 6573 * @throws SecurityException if {@code admin} is not a device owner. 6574 * @see SystemUpdatePolicy 6575 */ 6576 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) { 6577 throwIfParentInstance("setSystemUpdatePolicy"); 6578 if (mService != null) { 6579 try { 6580 mService.setSystemUpdatePolicy(admin, policy); 6581 } catch (RemoteException re) { 6582 throw re.rethrowFromSystemServer(); 6583 } 6584 } 6585 } 6586 6587 /** 6588 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}. 6589 * 6590 * @return The current policy object, or {@code null} if no policy is set. 6591 */ 6592 public @Nullable SystemUpdatePolicy getSystemUpdatePolicy() { 6593 throwIfParentInstance("getSystemUpdatePolicy"); 6594 if (mService != null) { 6595 try { 6596 return mService.getSystemUpdatePolicy(); 6597 } catch (RemoteException re) { 6598 throw re.rethrowFromSystemServer(); 6599 } 6600 } 6601 return null; 6602 } 6603 6604 /** 6605 * Called by a device owner to disable the keyguard altogether. 6606 * <p> 6607 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock 6608 * type. However, this call has no effect if a password, pin or pattern is currently set. If a 6609 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being 6610 * disabled. 6611 * 6612 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6613 * @param disabled {@code true} disables the keyguard, {@code false} reenables it. 6614 * @return {@code false} if attempting to disable the keyguard while a lock password was in 6615 * place. {@code true} otherwise. 6616 * @throws SecurityException if {@code admin} is not a device owner. 6617 */ 6618 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) { 6619 throwIfParentInstance("setKeyguardDisabled"); 6620 try { 6621 return mService.setKeyguardDisabled(admin, disabled); 6622 } catch (RemoteException re) { 6623 throw re.rethrowFromSystemServer(); 6624 } 6625 } 6626 6627 /** 6628 * Called by device owner to disable the status bar. Disabling the status bar blocks 6629 * notifications, quick settings and other screen overlays that allow escaping from a single use 6630 * device. 6631 * 6632 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6633 * @param disabled {@code true} disables the status bar, {@code false} reenables it. 6634 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise. 6635 * @throws SecurityException if {@code admin} is not a device owner. 6636 */ 6637 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) { 6638 throwIfParentInstance("setStatusBarDisabled"); 6639 try { 6640 return mService.setStatusBarDisabled(admin, disabled); 6641 } catch (RemoteException re) { 6642 throw re.rethrowFromSystemServer(); 6643 } 6644 } 6645 6646 /** 6647 * Called by the system update service to notify device and profile owners of pending system 6648 * updates. 6649 * 6650 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE} 6651 * permission. This method should only be used when it is unknown whether the pending system 6652 * update is a security patch. Otherwise, use 6653 * {@link #notifyPendingSystemUpdate(long, boolean)}. 6654 * 6655 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} 6656 * indicating when the current pending update was first available. {@code -1} if no 6657 * update is available. 6658 * @see #notifyPendingSystemUpdate(long, boolean) 6659 * @hide 6660 */ 6661 @SystemApi 6662 public void notifyPendingSystemUpdate(long updateReceivedTime) { 6663 throwIfParentInstance("notifyPendingSystemUpdate"); 6664 if (mService != null) { 6665 try { 6666 mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime)); 6667 } catch (RemoteException re) { 6668 throw re.rethrowFromSystemServer(); 6669 } 6670 } 6671 } 6672 6673 /** 6674 * Called by the system update service to notify device and profile owners of pending system 6675 * updates. 6676 * 6677 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE} 6678 * permission. This method should be used instead of {@link #notifyPendingSystemUpdate(long)} 6679 * when it is known whether the pending system update is a security patch. 6680 * 6681 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} 6682 * indicating when the current pending update was first available. {@code -1} if no 6683 * update is available. 6684 * @param isSecurityPatch {@code true} if this system update is purely a security patch; 6685 * {@code false} if not. 6686 * @see #notifyPendingSystemUpdate(long) 6687 * @hide 6688 */ 6689 @SystemApi 6690 public void notifyPendingSystemUpdate(long updateReceivedTime, boolean isSecurityPatch) { 6691 throwIfParentInstance("notifyPendingSystemUpdate"); 6692 if (mService != null) { 6693 try { 6694 mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime, 6695 isSecurityPatch)); 6696 } catch (RemoteException re) { 6697 throw re.rethrowFromSystemServer(); 6698 } 6699 } 6700 } 6701 6702 /** 6703 * Called by device or profile owners to get information about a pending system update. 6704 * 6705 * @param admin Which profile or device owner this request is associated with. 6706 * @return Information about a pending system update or {@code null} if no update pending. 6707 * @throws SecurityException if {@code admin} is not a device or profile owner. 6708 * @see DeviceAdminReceiver#onSystemUpdatePending(Context, Intent, long) 6709 */ 6710 public @Nullable SystemUpdateInfo getPendingSystemUpdate(@NonNull ComponentName admin) { 6711 throwIfParentInstance("getPendingSystemUpdate"); 6712 try { 6713 return mService.getPendingSystemUpdate(admin); 6714 } catch (RemoteException re) { 6715 throw re.rethrowFromSystemServer(); 6716 } 6717 } 6718 6719 /** 6720 * Set the default response for future runtime permission requests by applications. This 6721 * function can be called by a device owner, profile owner, or by a delegate given the 6722 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}. 6723 * The policy can allow for normal operation which prompts the user to grant a permission, or 6724 * can allow automatic granting or denying of runtime permission requests by an application. 6725 * This also applies to new permissions declared by app updates. When a permission is denied or 6726 * granted this way, the effect is equivalent to setting the permission * grant state via 6727 * {@link #setPermissionGrantState}. 6728 * <p/> 6729 * As this policy only acts on runtime permission requests, it only applies to applications 6730 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later. 6731 * 6732 * @param admin Which profile or device owner this request is associated with. 6733 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT}, 6734 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}. 6735 * @throws SecurityException if {@code admin} is not a device or profile owner. 6736 * @see #setPermissionGrantState 6737 * @see #setDelegatedScopes 6738 * @see #DELEGATION_PERMISSION_GRANT 6739 */ 6740 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) { 6741 throwIfParentInstance("setPermissionPolicy"); 6742 try { 6743 mService.setPermissionPolicy(admin, mContext.getPackageName(), policy); 6744 } catch (RemoteException re) { 6745 throw re.rethrowFromSystemServer(); 6746 } 6747 } 6748 6749 /** 6750 * Returns the current runtime permission policy set by the device or profile owner. The 6751 * default is {@link #PERMISSION_POLICY_PROMPT}. 6752 * 6753 * @param admin Which profile or device owner this request is associated with. 6754 * @return the current policy for future permission requests. 6755 */ 6756 public int getPermissionPolicy(ComponentName admin) { 6757 throwIfParentInstance("getPermissionPolicy"); 6758 try { 6759 return mService.getPermissionPolicy(admin); 6760 } catch (RemoteException re) { 6761 throw re.rethrowFromSystemServer(); 6762 } 6763 } 6764 6765 /** 6766 * Sets the grant state of a runtime permission for a specific application. The state can be 6767 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI, 6768 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user 6769 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which 6770 * the permission is granted and the user cannot manage it through the UI. This might affect all 6771 * permissions in a group that the runtime permission belongs to. This method can only be called 6772 * by a profile owner, device owner, or a delegate given the 6773 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}. 6774 * <p/> 6775 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke 6776 * the permission. It retains the previous grant, if any. 6777 * <p/> 6778 * Permissions can be granted or revoked only for applications built with a 6779 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later. 6780 * 6781 * @param admin Which profile or device owner this request is associated with. 6782 * @param packageName The application to grant or revoke a permission to. 6783 * @param permission The permission to grant or revoke. 6784 * @param grantState The permission grant state which is one of 6785 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT}, 6786 * {@link #PERMISSION_GRANT_STATE_GRANTED}, 6787 * @return whether the permission was successfully granted or revoked. 6788 * @throws SecurityException if {@code admin} is not a device or profile owner. 6789 * @see #PERMISSION_GRANT_STATE_DENIED 6790 * @see #PERMISSION_GRANT_STATE_DEFAULT 6791 * @see #PERMISSION_GRANT_STATE_GRANTED 6792 * @see #setDelegatedScopes 6793 * @see #DELEGATION_PERMISSION_GRANT 6794 */ 6795 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName, 6796 String permission, int grantState) { 6797 throwIfParentInstance("setPermissionGrantState"); 6798 try { 6799 return mService.setPermissionGrantState(admin, mContext.getPackageName(), packageName, 6800 permission, grantState); 6801 } catch (RemoteException re) { 6802 throw re.rethrowFromSystemServer(); 6803 } 6804 } 6805 6806 /** 6807 * Returns the current grant state of a runtime permission for a specific application. This 6808 * function can be called by a device owner, profile owner, or by a delegate given the 6809 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}. 6810 * 6811 * @param admin Which profile or device owner this request is associated with, or {@code null} 6812 * if the caller is a permission grant delegate. 6813 * @param packageName The application to check the grant state for. 6814 * @param permission The permission to check for. 6815 * @return the current grant state specified by device policy. If the profile or device owner 6816 * has not set a grant state, the return value is 6817 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the 6818 * permission is currently granted for the package. 6819 * <p/> 6820 * If a grant state was set by the profile or device owner, then the return value will 6821 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or 6822 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is 6823 * currently denied or granted. 6824 * @throws SecurityException if {@code admin} is not a device or profile owner. 6825 * @see #setPermissionGrantState(ComponentName, String, String, int) 6826 * @see PackageManager#checkPermission(String, String) 6827 * @see #setDelegatedScopes 6828 * @see #DELEGATION_PERMISSION_GRANT 6829 */ 6830 public int getPermissionGrantState(@Nullable ComponentName admin, String packageName, 6831 String permission) { 6832 throwIfParentInstance("getPermissionGrantState"); 6833 try { 6834 return mService.getPermissionGrantState(admin, mContext.getPackageName(), packageName, 6835 permission); 6836 } catch (RemoteException re) { 6837 throw re.rethrowFromSystemServer(); 6838 } 6839 } 6840 6841 /** 6842 * Returns whether it is possible for the caller to initiate provisioning of a managed profile 6843 * or device, setting itself as the device or profile owner. 6844 * 6845 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE}, 6846 * {@link #ACTION_PROVISION_MANAGED_PROFILE}. 6847 * @return whether provisioning a managed profile or device is possible. 6848 * @throws IllegalArgumentException if the supplied action is not valid. 6849 */ 6850 public boolean isProvisioningAllowed(@NonNull String action) { 6851 throwIfParentInstance("isProvisioningAllowed"); 6852 try { 6853 return mService.isProvisioningAllowed(action, mContext.getPackageName()); 6854 } catch (RemoteException re) { 6855 throw re.rethrowFromSystemServer(); 6856 } 6857 } 6858 6859 /** 6860 * Checks whether it is possible to initiate provisioning a managed device, 6861 * profile or user, setting the given package as owner. 6862 * 6863 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE}, 6864 * {@link #ACTION_PROVISION_MANAGED_PROFILE}, 6865 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}, 6866 * {@link #ACTION_PROVISION_MANAGED_USER} 6867 * @param packageName The package of the component that would be set as device, user, or profile 6868 * owner. 6869 * @return A {@link ProvisioningPreCondition} value indicating whether provisioning is allowed. 6870 * @hide 6871 */ 6872 public @ProvisioningPreCondition int checkProvisioningPreCondition( 6873 String action, @NonNull String packageName) { 6874 try { 6875 return mService.checkProvisioningPreCondition(action, packageName); 6876 } catch (RemoteException re) { 6877 throw re.rethrowFromSystemServer(); 6878 } 6879 } 6880 6881 /** 6882 * Return if this user is a managed profile of another user. An admin can become the profile 6883 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed 6884 * user with {@link #createAndManageUser} 6885 * @param admin Which profile owner this request is associated with. 6886 * @return if this user is a managed profile of another user. 6887 */ 6888 public boolean isManagedProfile(@NonNull ComponentName admin) { 6889 throwIfParentInstance("isManagedProfile"); 6890 try { 6891 return mService.isManagedProfile(admin); 6892 } catch (RemoteException re) { 6893 throw re.rethrowFromSystemServer(); 6894 } 6895 } 6896 6897 /** 6898 * @hide 6899 * Return if this user is a system-only user. An admin can manage a device from a system only 6900 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}. 6901 * @param admin Which device owner this request is associated with. 6902 * @return if this user is a system-only user. 6903 */ 6904 public boolean isSystemOnlyUser(@NonNull ComponentName admin) { 6905 try { 6906 return mService.isSystemOnlyUser(admin); 6907 } catch (RemoteException re) { 6908 throw re.rethrowFromSystemServer(); 6909 } 6910 } 6911 6912 /** 6913 * Called by device owner to get the MAC address of the Wi-Fi device. 6914 * 6915 * @param admin Which device owner this request is associated with. 6916 * @return the MAC address of the Wi-Fi device, or null when the information is not available. 6917 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.) 6918 * <p> 6919 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format. 6920 * @throws SecurityException if {@code admin} is not a device owner. 6921 */ 6922 public @Nullable String getWifiMacAddress(@NonNull ComponentName admin) { 6923 throwIfParentInstance("getWifiMacAddress"); 6924 try { 6925 return mService.getWifiMacAddress(admin); 6926 } catch (RemoteException re) { 6927 throw re.rethrowFromSystemServer(); 6928 } 6929 } 6930 6931 /** 6932 * Called by device owner to reboot the device. If there is an ongoing call on the device, 6933 * throws an {@link IllegalStateException}. 6934 * @param admin Which device owner the request is associated with. 6935 * @throws IllegalStateException if device has an ongoing call. 6936 * @throws SecurityException if {@code admin} is not a device owner. 6937 * @see TelephonyManager#CALL_STATE_IDLE 6938 */ 6939 public void reboot(@NonNull ComponentName admin) { 6940 throwIfParentInstance("reboot"); 6941 try { 6942 mService.reboot(admin); 6943 } catch (RemoteException re) { 6944 throw re.rethrowFromSystemServer(); 6945 } 6946 } 6947 6948 /** 6949 * Called by a device admin to set the short support message. This will be displayed to the user 6950 * in settings screens where funtionality has been disabled by the admin. The message should be 6951 * limited to a short statement such as "This setting is disabled by your administrator. Contact 6952 * someone@example.com for support." If the message is longer than 200 characters it may be 6953 * truncated. 6954 * <p> 6955 * If the short support message needs to be localized, it is the responsibility of the 6956 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast 6957 * and set a new version of this string accordingly. 6958 * 6959 * @see #setLongSupportMessage 6960 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6961 * @param message Short message to be displayed to the user in settings or null to clear the 6962 * existing message. 6963 * @throws SecurityException if {@code admin} is not an active administrator. 6964 */ 6965 public void setShortSupportMessage(@NonNull ComponentName admin, 6966 @Nullable CharSequence message) { 6967 throwIfParentInstance("setShortSupportMessage"); 6968 if (mService != null) { 6969 try { 6970 mService.setShortSupportMessage(admin, message); 6971 } catch (RemoteException e) { 6972 throw e.rethrowFromSystemServer(); 6973 } 6974 } 6975 } 6976 6977 /** 6978 * Called by a device admin to get the short support message. 6979 * 6980 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 6981 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or 6982 * null if no message has been set. 6983 * @throws SecurityException if {@code admin} is not an active administrator. 6984 */ 6985 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) { 6986 throwIfParentInstance("getShortSupportMessage"); 6987 if (mService != null) { 6988 try { 6989 return mService.getShortSupportMessage(admin); 6990 } catch (RemoteException e) { 6991 throw e.rethrowFromSystemServer(); 6992 } 6993 } 6994 return null; 6995 } 6996 6997 /** 6998 * Called by a device admin to set the long support message. This will be displayed to the user 6999 * in the device administators settings screen. 7000 * <p> 7001 * If the long support message needs to be localized, it is the responsibility of the 7002 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast 7003 * and set a new version of this string accordingly. 7004 * 7005 * @see #setShortSupportMessage 7006 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7007 * @param message Long message to be displayed to the user in settings or null to clear the 7008 * existing message. 7009 * @throws SecurityException if {@code admin} is not an active administrator. 7010 */ 7011 public void setLongSupportMessage(@NonNull ComponentName admin, 7012 @Nullable CharSequence message) { 7013 throwIfParentInstance("setLongSupportMessage"); 7014 if (mService != null) { 7015 try { 7016 mService.setLongSupportMessage(admin, message); 7017 } catch (RemoteException e) { 7018 throw e.rethrowFromSystemServer(); 7019 } 7020 } 7021 } 7022 7023 /** 7024 * Called by a device admin to get the long support message. 7025 * 7026 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7027 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or 7028 * null if no message has been set. 7029 * @throws SecurityException if {@code admin} is not an active administrator. 7030 */ 7031 public @Nullable CharSequence getLongSupportMessage(@NonNull ComponentName admin) { 7032 throwIfParentInstance("getLongSupportMessage"); 7033 if (mService != null) { 7034 try { 7035 return mService.getLongSupportMessage(admin); 7036 } catch (RemoteException e) { 7037 throw e.rethrowFromSystemServer(); 7038 } 7039 } 7040 return null; 7041 } 7042 7043 /** 7044 * Called by the system to get the short support message. 7045 * 7046 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7047 * @param userHandle user id the admin is running as. 7048 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} 7049 * 7050 * @hide 7051 */ 7052 public @Nullable CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin, 7053 int userHandle) { 7054 if (mService != null) { 7055 try { 7056 return mService.getShortSupportMessageForUser(admin, userHandle); 7057 } catch (RemoteException e) { 7058 throw e.rethrowFromSystemServer(); 7059 } 7060 } 7061 return null; 7062 } 7063 7064 7065 /** 7066 * Called by the system to get the long support message. 7067 * 7068 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7069 * @param userHandle user id the admin is running as. 7070 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} 7071 * 7072 * @hide 7073 */ 7074 public @Nullable CharSequence getLongSupportMessageForUser( 7075 @NonNull ComponentName admin, int userHandle) { 7076 if (mService != null) { 7077 try { 7078 return mService.getLongSupportMessageForUser(admin, userHandle); 7079 } catch (RemoteException e) { 7080 throw e.rethrowFromSystemServer(); 7081 } 7082 } 7083 return null; 7084 } 7085 7086 /** 7087 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager} 7088 * whose calls act on the parent profile. 7089 * 7090 * <p>The following methods are supported for the parent instance, all other methods will 7091 * throw a SecurityException when called on the parent instance: 7092 * <ul> 7093 * <li>{@link #getPasswordQuality}</li> 7094 * <li>{@link #setPasswordQuality}</li> 7095 * <li>{@link #getPasswordMinimumLength}</li> 7096 * <li>{@link #setPasswordMinimumLength}</li> 7097 * <li>{@link #getPasswordMinimumUpperCase}</li> 7098 * <li>{@link #setPasswordMinimumUpperCase}</li> 7099 * <li>{@link #getPasswordMinimumLowerCase}</li> 7100 * <li>{@link #setPasswordMinimumLowerCase}</li> 7101 * <li>{@link #getPasswordMinimumLetters}</li> 7102 * <li>{@link #setPasswordMinimumLetters}</li> 7103 * <li>{@link #getPasswordMinimumNumeric}</li> 7104 * <li>{@link #setPasswordMinimumNumeric}</li> 7105 * <li>{@link #getPasswordMinimumSymbols}</li> 7106 * <li>{@link #setPasswordMinimumSymbols}</li> 7107 * <li>{@link #getPasswordMinimumNonLetter}</li> 7108 * <li>{@link #setPasswordMinimumNonLetter}</li> 7109 * <li>{@link #getPasswordHistoryLength}</li> 7110 * <li>{@link #setPasswordHistoryLength}</li> 7111 * <li>{@link #getPasswordExpirationTimeout}</li> 7112 * <li>{@link #setPasswordExpirationTimeout}</li> 7113 * <li>{@link #getPasswordExpiration}</li> 7114 * <li>{@link #getPasswordMaximumLength}</li> 7115 * <li>{@link #isActivePasswordSufficient}</li> 7116 * <li>{@link #getCurrentFailedPasswordAttempts}</li> 7117 * <li>{@link #getMaximumFailedPasswordsForWipe}</li> 7118 * <li>{@link #setMaximumFailedPasswordsForWipe}</li> 7119 * <li>{@link #getMaximumTimeToLock}</li> 7120 * <li>{@link #setMaximumTimeToLock}</li> 7121 * <li>{@link #lockNow}</li> 7122 * <li>{@link #getKeyguardDisabledFeatures}</li> 7123 * <li>{@link #setKeyguardDisabledFeatures}</li> 7124 * <li>{@link #getTrustAgentConfiguration}</li> 7125 * <li>{@link #setTrustAgentConfiguration}</li> 7126 * <li>{@link #getRequiredStrongAuthTimeout}</li> 7127 * <li>{@link #setRequiredStrongAuthTimeout}</li> 7128 * </ul> 7129 * 7130 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile. 7131 * @throws SecurityException if {@code admin} is not a profile owner. 7132 */ 7133 public @NonNull DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) { 7134 throwIfParentInstance("getParentProfileInstance"); 7135 try { 7136 if (!mService.isManagedProfile(admin)) { 7137 throw new SecurityException("The current user does not have a parent profile."); 7138 } 7139 return new DevicePolicyManager(mContext, mService, true); 7140 } catch (RemoteException e) { 7141 throw e.rethrowFromSystemServer(); 7142 } 7143 } 7144 7145 /** 7146 * Called by device owner to control the security logging feature. 7147 * 7148 * <p> Security logs contain various information intended for security auditing purposes. 7149 * See {@link SecurityEvent} for details. 7150 * 7151 * <p><strong>Note:</strong> The device owner won't be able to retrieve security logs if there 7152 * are unaffiliated secondary users or profiles on the device, regardless of whether the 7153 * feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for 7154 * all users to become affiliated. Therefore it's recommended that affiliation ids are set for 7155 * new users as soon as possible after provisioning via {@link #setAffiliationIds}. 7156 * 7157 * @param admin Which device owner this request is associated with. 7158 * @param enabled whether security logging should be enabled or not. 7159 * @throws SecurityException if {@code admin} is not a device owner. 7160 * @see #retrieveSecurityLogs 7161 */ 7162 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) { 7163 throwIfParentInstance("setSecurityLoggingEnabled"); 7164 try { 7165 mService.setSecurityLoggingEnabled(admin, enabled); 7166 } catch (RemoteException re) { 7167 throw re.rethrowFromSystemServer(); 7168 } 7169 } 7170 7171 /** 7172 * Return whether security logging is enabled or not by the device owner. 7173 * 7174 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be 7175 * thrown. 7176 * 7177 * @param admin Which device owner this request is associated with. 7178 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise. 7179 * @throws SecurityException if {@code admin} is not a device owner. 7180 */ 7181 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) { 7182 throwIfParentInstance("isSecurityLoggingEnabled"); 7183 try { 7184 return mService.isSecurityLoggingEnabled(admin); 7185 } catch (RemoteException re) { 7186 throw re.rethrowFromSystemServer(); 7187 } 7188 } 7189 7190 /** 7191 * Called by device owner to retrieve all new security logging entries since the last call to 7192 * this API after device boots. 7193 * 7194 * <p> Access to the logs is rate limited and it will only return new logs after the device 7195 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}. 7196 * 7197 * <p>If there is any other user or profile on the device, it must be affiliated with the 7198 * device owner. Otherwise a {@link SecurityException} will be thrown. See 7199 * {@link #setAffiliationIds} 7200 * 7201 * @param admin Which device owner this request is associated with. 7202 * @return the new batch of security logs which is a list of {@link SecurityEvent}, 7203 * or {@code null} if rate limitation is exceeded or if logging is currently disabled. 7204 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one 7205 * profile or secondary user that is not affiliated with the device owner user. 7206 * @see DeviceAdminReceiver#onSecurityLogsAvailable 7207 */ 7208 public @Nullable List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) { 7209 throwIfParentInstance("retrieveSecurityLogs"); 7210 try { 7211 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin); 7212 if (list != null) { 7213 return list.getList(); 7214 } else { 7215 // Rate limit exceeded. 7216 return null; 7217 } 7218 } catch (RemoteException re) { 7219 throw re.rethrowFromSystemServer(); 7220 } 7221 } 7222 7223 /** 7224 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent 7225 * profile. 7226 * 7227 * @hide 7228 */ 7229 public @NonNull DevicePolicyManager getParentProfileInstance(UserInfo uInfo) { 7230 mContext.checkSelfPermission( 7231 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS); 7232 if (!uInfo.isManagedProfile()) { 7233 throw new SecurityException("The user " + uInfo.id 7234 + " does not have a parent profile."); 7235 } 7236 return new DevicePolicyManager(mContext, mService, true); 7237 } 7238 7239 /** 7240 * Called by device owners to retrieve device logs from before the device's last reboot. 7241 * <p> 7242 * <strong> This API is not supported on all devices. Calling this API on unsupported devices 7243 * will result in {@code null} being returned. The device logs are retrieved from a RAM region 7244 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious 7245 * about data corruption when parsing. </strong> 7246 * 7247 * <p>If there is any other user or profile on the device, it must be affiliated with the 7248 * device owner. Otherwise a {@link SecurityException} will be thrown. See 7249 * {@link #setAffiliationIds} 7250 * 7251 * @param admin Which device owner this request is associated with. 7252 * @return Device logs from before the latest reboot of the system, or {@code null} if this API 7253 * is not supported on the device. 7254 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one 7255 * profile or secondary user that is not affiliated with the device owner user. 7256 * @see #retrieveSecurityLogs 7257 */ 7258 public @Nullable List<SecurityEvent> retrievePreRebootSecurityLogs( 7259 @NonNull ComponentName admin) { 7260 throwIfParentInstance("retrievePreRebootSecurityLogs"); 7261 try { 7262 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin); 7263 if (list != null) { 7264 return list.getList(); 7265 } else { 7266 return null; 7267 } 7268 } catch (RemoteException re) { 7269 throw re.rethrowFromSystemServer(); 7270 } 7271 } 7272 7273 /** 7274 * Called by a profile owner of a managed profile to set the color used for customization. This 7275 * color is used as background color of the confirm credentials screen for that user. The 7276 * default color is teal (#00796B). 7277 * <p> 7278 * The confirm credentials screen can be created using 7279 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}. 7280 * 7281 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7282 * @param color The 24bit (0xRRGGBB) representation of the color to be used. 7283 * @throws SecurityException if {@code admin} is not a profile owner. 7284 */ 7285 public void setOrganizationColor(@NonNull ComponentName admin, int color) { 7286 throwIfParentInstance("setOrganizationColor"); 7287 try { 7288 // always enforce alpha channel to have 100% opacity 7289 color |= 0xFF000000; 7290 mService.setOrganizationColor(admin, color); 7291 } catch (RemoteException re) { 7292 throw re.rethrowFromSystemServer(); 7293 } 7294 } 7295 7296 /** 7297 * @hide 7298 * 7299 * Sets the color used for customization. 7300 * 7301 * @param color The 24bit (0xRRGGBB) representation of the color to be used. 7302 * @param userId which user to set the color to. 7303 * @RequiresPermission(allOf = { 7304 * Manifest.permission.MANAGE_USERS, 7305 * Manifest.permission.INTERACT_ACROSS_USERS_FULL}) 7306 */ 7307 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) { 7308 try { 7309 // always enforce alpha channel to have 100% opacity 7310 color |= 0xFF000000; 7311 mService.setOrganizationColorForUser(color, userId); 7312 } catch (RemoteException re) { 7313 throw re.rethrowFromSystemServer(); 7314 } 7315 } 7316 7317 /** 7318 * Called by a profile owner of a managed profile to retrieve the color used for customization. 7319 * This color is used as background color of the confirm credentials screen for that user. 7320 * 7321 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7322 * @return The 24bit (0xRRGGBB) representation of the color to be used. 7323 * @throws SecurityException if {@code admin} is not a profile owner. 7324 */ 7325 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) { 7326 throwIfParentInstance("getOrganizationColor"); 7327 try { 7328 return mService.getOrganizationColor(admin); 7329 } catch (RemoteException re) { 7330 throw re.rethrowFromSystemServer(); 7331 } 7332 } 7333 7334 /** 7335 * @hide 7336 * Retrieve the customization color for a given user. 7337 * 7338 * @param userHandle The user id of the user we're interested in. 7339 * @return The 24bit (0xRRGGBB) representation of the color to be used. 7340 */ 7341 public @ColorInt int getOrganizationColorForUser(int userHandle) { 7342 try { 7343 return mService.getOrganizationColorForUser(userHandle); 7344 } catch (RemoteException re) { 7345 throw re.rethrowFromSystemServer(); 7346 } 7347 } 7348 7349 /** 7350 * Called by the device owner or profile owner to set the name of the organization under 7351 * management. 7352 * <p> 7353 * If the organization name needs to be localized, it is the responsibility of the 7354 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast 7355 * and set a new version of this string accordingly. 7356 * 7357 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7358 * @param title The organization name or {@code null} to clear a previously set name. 7359 * @throws SecurityException if {@code admin} is not a device or profile owner. 7360 */ 7361 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) { 7362 throwIfParentInstance("setOrganizationName"); 7363 try { 7364 mService.setOrganizationName(admin, title); 7365 } catch (RemoteException re) { 7366 throw re.rethrowFromSystemServer(); 7367 } 7368 } 7369 7370 /** 7371 * Called by a profile owner of a managed profile to retrieve the name of the organization under 7372 * management. 7373 * 7374 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7375 * @return The organization name or {@code null} if none is set. 7376 * @throws SecurityException if {@code admin} is not a profile owner. 7377 */ 7378 public @Nullable CharSequence getOrganizationName(@NonNull ComponentName admin) { 7379 throwIfParentInstance("getOrganizationName"); 7380 try { 7381 return mService.getOrganizationName(admin); 7382 } catch (RemoteException re) { 7383 throw re.rethrowFromSystemServer(); 7384 } 7385 } 7386 7387 /** 7388 * Called by the system to retrieve the name of the organization managing the device. 7389 * 7390 * @return The organization name or {@code null} if none is set. 7391 * @throws SecurityException if the caller is not the device owner, does not hold the 7392 * MANAGE_USERS permission and is not the system. 7393 * 7394 * @hide 7395 */ 7396 @SystemApi 7397 @TestApi 7398 public @Nullable CharSequence getDeviceOwnerOrganizationName() { 7399 try { 7400 return mService.getDeviceOwnerOrganizationName(); 7401 } catch (RemoteException re) { 7402 throw re.rethrowFromSystemServer(); 7403 } 7404 } 7405 7406 /** 7407 * Retrieve the default title message used in the confirm credentials screen for a given user. 7408 * 7409 * @param userHandle The user id of the user we're interested in. 7410 * @return The organization name or {@code null} if none is set. 7411 * 7412 * @hide 7413 */ 7414 public @Nullable CharSequence getOrganizationNameForUser(int userHandle) { 7415 try { 7416 return mService.getOrganizationNameForUser(userHandle); 7417 } catch (RemoteException re) { 7418 throw re.rethrowFromSystemServer(); 7419 } 7420 } 7421 7422 /** 7423 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will 7424 * return {@link #STATE_USER_UNMANAGED} 7425 * @hide 7426 */ 7427 @SystemApi 7428 @UserProvisioningState 7429 public int getUserProvisioningState() { 7430 throwIfParentInstance("getUserProvisioningState"); 7431 if (mService != null) { 7432 try { 7433 return mService.getUserProvisioningState(); 7434 } catch (RemoteException e) { 7435 throw e.rethrowFromSystemServer(); 7436 } 7437 } 7438 return STATE_USER_UNMANAGED; 7439 } 7440 7441 /** 7442 * Set the {@link UserProvisioningState} for the supplied user, if they are managed. 7443 * 7444 * @param state to store 7445 * @param userHandle for user 7446 * @hide 7447 */ 7448 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) { 7449 if (mService != null) { 7450 try { 7451 mService.setUserProvisioningState(state, userHandle); 7452 } catch (RemoteException e) { 7453 throw e.rethrowFromSystemServer(); 7454 } 7455 } 7456 } 7457 7458 /** 7459 * Indicates the entity that controls the device or profile owner. Two users/profiles are 7460 * affiliated if the set of ids set by their device or profile owners intersect. 7461 * 7462 * <p><strong>Note:</strong> Features that depend on user affiliation (such as security logging 7463 * or {@link #bindDeviceAdminServiceAsUser}) won't be available when a secondary user or profile 7464 * is created, until it becomes affiliated. Therefore it is recommended that the appropriate 7465 * affiliation ids are set by its profile owner as soon as possible after the user/profile is 7466 * created. 7467 * 7468 * @param admin Which profile or device owner this request is associated with. 7469 * @param ids A list of opaque non-empty affiliation ids. Duplicate elements will be ignored. 7470 * 7471 * @throws NullPointerException if {@code ids} is null or contains null elements. 7472 * @throws IllegalArgumentException if {@code ids} contains an empty string. 7473 */ 7474 public void setAffiliationIds(@NonNull ComponentName admin, @NonNull List<String> ids) { 7475 throwIfParentInstance("setAffiliationIds"); 7476 try { 7477 mService.setAffiliationIds(admin, ids); 7478 } catch (RemoteException e) { 7479 throw e.rethrowFromSystemServer(); 7480 } 7481 } 7482 7483 /** 7484 * Returns the list of affiliation ids previously set via {@link #setAffiliationIds}, or an 7485 * empty list if none have been set. 7486 */ 7487 public @NonNull List<String> getAffiliationIds(@NonNull ComponentName admin) { 7488 throwIfParentInstance("getAffiliationIds"); 7489 try { 7490 return mService.getAffiliationIds(admin); 7491 } catch (RemoteException e) { 7492 throw e.rethrowFromSystemServer(); 7493 } 7494 } 7495 7496 /** 7497 * @hide 7498 * Returns whether this user/profile is affiliated with the device. 7499 * <p> 7500 * By definition, the user that the device owner runs on is always affiliated with the device. 7501 * Any other user/profile is considered affiliated with the device if the set specified by its 7502 * profile owner via {@link #setAffiliationIds} intersects with the device owner's. 7503 * 7504 */ 7505 public boolean isAffiliatedUser() { 7506 throwIfParentInstance("isAffiliatedUser"); 7507 try { 7508 return mService.isAffiliatedUser(); 7509 } catch (RemoteException e) { 7510 throw e.rethrowFromSystemServer(); 7511 } 7512 } 7513 7514 /** 7515 * @hide 7516 * Returns whether the uninstall for {@code packageName} for the current user is in queue 7517 * to be started 7518 * @param packageName the package to check for 7519 * @return whether the uninstall intent for {@code packageName} is pending 7520 */ 7521 public boolean isUninstallInQueue(String packageName) { 7522 try { 7523 return mService.isUninstallInQueue(packageName); 7524 } catch (RemoteException re) { 7525 throw re.rethrowFromSystemServer(); 7526 } 7527 } 7528 7529 /** 7530 * @hide 7531 * @param packageName the package containing active DAs to be uninstalled 7532 */ 7533 public void uninstallPackageWithActiveAdmins(String packageName) { 7534 try { 7535 mService.uninstallPackageWithActiveAdmins(packageName); 7536 } catch (RemoteException re) { 7537 throw re.rethrowFromSystemServer(); 7538 } 7539 } 7540 7541 /** 7542 * @hide 7543 * Remove a test admin synchronously without sending it a broadcast about being removed. 7544 * If the admin is a profile owner or device owner it will still be removed. 7545 * 7546 * @param userHandle user id to remove the admin for. 7547 * @param admin The administration compononent to remove. 7548 * @throws SecurityException if the caller is not shell / root or the admin package 7549 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}. 7550 */ 7551 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) { 7552 try { 7553 mService.forceRemoveActiveAdmin(adminReceiver, userHandle); 7554 } catch (RemoteException re) { 7555 throw re.rethrowFromSystemServer(); 7556 } 7557 } 7558 7559 /** 7560 * Returns whether the device has been provisioned. 7561 * 7562 * <p>Not for use by third-party applications. 7563 * 7564 * @hide 7565 */ 7566 @SystemApi 7567 public boolean isDeviceProvisioned() { 7568 try { 7569 return mService.isDeviceProvisioned(); 7570 } catch (RemoteException re) { 7571 throw re.rethrowFromSystemServer(); 7572 } 7573 } 7574 7575 /** 7576 * Writes that the provisioning configuration has been applied. 7577 * 7578 * <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS} 7579 * permission. 7580 * 7581 * <p>Not for use by third-party applications. 7582 * 7583 * @hide 7584 */ 7585 @SystemApi 7586 public void setDeviceProvisioningConfigApplied() { 7587 try { 7588 mService.setDeviceProvisioningConfigApplied(); 7589 } catch (RemoteException re) { 7590 throw re.rethrowFromSystemServer(); 7591 } 7592 } 7593 7594 /** 7595 * Returns whether the provisioning configuration has been applied. 7596 * 7597 * <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS} permission. 7598 * 7599 * <p>Not for use by third-party applications. 7600 * 7601 * @return whether the provisioning configuration has been applied. 7602 * 7603 * @hide 7604 */ 7605 @SystemApi 7606 public boolean isDeviceProvisioningConfigApplied() { 7607 try { 7608 return mService.isDeviceProvisioningConfigApplied(); 7609 } catch (RemoteException re) { 7610 throw re.rethrowFromSystemServer(); 7611 } 7612 } 7613 7614 /** 7615 * @hide 7616 * Force update user setup completed status. This API has no effect on user build. 7617 * @throws {@link SecurityException} if the caller has no 7618 * {@code android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS} or the caller is 7619 * not {@link UserHandle#SYSTEM_USER} 7620 */ 7621 public void forceUpdateUserSetupComplete() { 7622 try { 7623 mService.forceUpdateUserSetupComplete(); 7624 } catch (RemoteException re) { 7625 throw re.rethrowFromSystemServer(); 7626 } 7627 } 7628 7629 private void throwIfParentInstance(String functionName) { 7630 if (mParentInstance) { 7631 throw new SecurityException(functionName + " cannot be called on the parent instance"); 7632 } 7633 } 7634 7635 /** 7636 * Allows the device owner to enable or disable the backup service. 7637 * 7638 * <p> Backup service manages all backup and restore mechanisms on the device. Setting this to 7639 * false will prevent data from being backed up or restored. 7640 * 7641 * <p> Backup service is off by default when device owner is present. 7642 * 7643 * @throws SecurityException if {@code admin} is not a device owner. 7644 */ 7645 public void setBackupServiceEnabled(@NonNull ComponentName admin, boolean enabled) { 7646 try { 7647 mService.setBackupServiceEnabled(admin, enabled); 7648 } catch (RemoteException re) { 7649 throw re.rethrowFromSystemServer(); 7650 } 7651 } 7652 7653 /** 7654 * Return whether the backup service is enabled by the device owner. 7655 * 7656 * <p> Backup service manages all backup and restore mechanisms on the device. 7657 * 7658 * @return {@code true} if backup service is enabled, {@code false} otherwise. 7659 * @see #setBackupServiceEnabled 7660 */ 7661 public boolean isBackupServiceEnabled(@NonNull ComponentName admin) { 7662 try { 7663 return mService.isBackupServiceEnabled(admin); 7664 } catch (RemoteException re) { 7665 throw re.rethrowFromSystemServer(); 7666 } 7667 } 7668 7669 /** 7670 * Called by a device owner to control the network logging feature. 7671 * 7672 * <p> Network logs contain DNS lookup and connect() library call events. 7673 * 7674 * <p><strong>Note:</strong> The device owner won't be able to retrieve network logs if there 7675 * are unaffiliated secondary users or profiles on the device, regardless of whether the 7676 * feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for 7677 * all users to become affiliated. Therefore it's recommended that affiliation ids are set for 7678 * new users as soon as possible after provisioning via {@link #setAffiliationIds}. 7679 * 7680 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7681 * @param enabled whether network logging should be enabled or not. 7682 * @throws SecurityException if {@code admin} is not a device owner. 7683 * @see #retrieveNetworkLogs 7684 */ 7685 public void setNetworkLoggingEnabled(@NonNull ComponentName admin, boolean enabled) { 7686 throwIfParentInstance("setNetworkLoggingEnabled"); 7687 try { 7688 mService.setNetworkLoggingEnabled(admin, enabled); 7689 } catch (RemoteException re) { 7690 throw re.rethrowFromSystemServer(); 7691 } 7692 } 7693 7694 /** 7695 * Return whether network logging is enabled by a device owner. 7696 * 7697 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Can only 7698 * be {@code null} if the caller has MANAGE_USERS permission. 7699 * @return {@code true} if network logging is enabled by device owner, {@code false} otherwise. 7700 * @throws SecurityException if {@code admin} is not a device owner and caller has 7701 * no MANAGE_USERS permission 7702 */ 7703 public boolean isNetworkLoggingEnabled(@Nullable ComponentName admin) { 7704 throwIfParentInstance("isNetworkLoggingEnabled"); 7705 try { 7706 return mService.isNetworkLoggingEnabled(admin); 7707 } catch (RemoteException re) { 7708 throw re.rethrowFromSystemServer(); 7709 } 7710 } 7711 7712 /** 7713 * Called by device owner to retrieve the most recent batch of network logging events. 7714 * A device owner has to provide a batchToken provided as part of 7715 * {@link DeviceAdminReceiver#onNetworkLogsAvailable} callback. If the token doesn't match the 7716 * token of the most recent available batch of logs, {@code null} will be returned. 7717 * 7718 * <p> {@link NetworkEvent} can be one of {@link DnsEvent} or {@link ConnectEvent}. 7719 * 7720 * <p> The list of network events is sorted chronologically, and contains at most 1200 events. 7721 * 7722 * <p> Access to the logs is rate limited and this method will only return a new batch of logs 7723 * after the device device owner has been notified via 7724 * {@link DeviceAdminReceiver#onNetworkLogsAvailable}. 7725 * 7726 * <p>If a secondary user or profile is created, calling this method will throw a 7727 * {@link SecurityException} until all users become affiliated again. It will also no longer be 7728 * possible to retrieve the network logs batch with the most recent batchToken provided 7729 * by {@link DeviceAdminReceiver#onNetworkLogsAvailable}. See 7730 * {@link DevicePolicyManager#setAffiliationIds}. 7731 * 7732 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7733 * @param batchToken A token of the batch to retrieve 7734 * @return A new batch of network logs which is a list of {@link NetworkEvent}. Returns 7735 * {@code null} if the batch represented by batchToken is no longer available or if 7736 * logging is disabled. 7737 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one 7738 * profile or secondary user that is not affiliated with the device owner user. 7739 * @see DeviceAdminReceiver#onNetworkLogsAvailable 7740 */ 7741 public @Nullable List<NetworkEvent> retrieveNetworkLogs(@NonNull ComponentName admin, 7742 long batchToken) { 7743 throwIfParentInstance("retrieveNetworkLogs"); 7744 try { 7745 return mService.retrieveNetworkLogs(admin, batchToken); 7746 } catch (RemoteException re) { 7747 throw re.rethrowFromSystemServer(); 7748 } 7749 } 7750 7751 /** 7752 * Called by a device owner to bind to a service from a profile owner or vice versa. 7753 * See {@link #getBindDeviceAdminTargetUsers} for a definition of which 7754 * device/profile owners are allowed to bind to services of another profile/device owner. 7755 * <p> 7756 * The service must be unexported. Note that the {@link Context} used to obtain this 7757 * {@link DevicePolicyManager} instance via {@link Context#getSystemService(Class)} will be used 7758 * to bind to the {@link android.app.Service}. 7759 * 7760 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 7761 * @param serviceIntent Identifies the service to connect to. The Intent must specify either an 7762 * explicit component name or a package name to match an 7763 * {@link IntentFilter} published by a service. 7764 * @param conn Receives information as the service is started and stopped in main thread. This 7765 * must be a valid {@link ServiceConnection} object; it must not be {@code null}. 7766 * @param flags Operation options for the binding operation. See 7767 * {@link Context#bindService(Intent, ServiceConnection, int)}. 7768 * @param targetUser Which user to bind to. Must be one of the users returned by 7769 * {@link #getBindDeviceAdminTargetUsers}, otherwise a {@link SecurityException} will 7770 * be thrown. 7771 * @return If you have successfully bound to the service, {@code true} is returned; 7772 * {@code false} is returned if the connection is not made and you will not 7773 * receive the service object. 7774 * 7775 * @see Context#bindService(Intent, ServiceConnection, int) 7776 * @see #getBindDeviceAdminTargetUsers(ComponentName) 7777 */ 7778 public boolean bindDeviceAdminServiceAsUser( 7779 @NonNull ComponentName admin, Intent serviceIntent, @NonNull ServiceConnection conn, 7780 @Context.BindServiceFlags int flags, @NonNull UserHandle targetUser) { 7781 throwIfParentInstance("bindDeviceAdminServiceAsUser"); 7782 // Keep this in sync with ContextImpl.bindServiceCommon. 7783 try { 7784 final IServiceConnection sd = mContext.getServiceDispatcher( 7785 conn, mContext.getMainThreadHandler(), flags); 7786 serviceIntent.prepareToLeaveProcess(mContext); 7787 return mService.bindDeviceAdminServiceAsUser(admin, 7788 mContext.getIApplicationThread(), mContext.getActivityToken(), serviceIntent, 7789 sd, flags, targetUser.getIdentifier()); 7790 } catch (RemoteException re) { 7791 throw re.rethrowFromSystemServer(); 7792 } 7793 } 7794 7795 /** 7796 * Returns the list of target users that the calling device or profile owner can use when 7797 * calling {@link #bindDeviceAdminServiceAsUser}. 7798 * <p> 7799 * A device owner can bind to a service from a profile owner and vice versa, provided that: 7800 * <ul> 7801 * <li>Both belong to the same package name. 7802 * <li>Both users are affiliated. See {@link #setAffiliationIds}. 7803 * </ul> 7804 */ 7805 public @NonNull List<UserHandle> getBindDeviceAdminTargetUsers(@NonNull ComponentName admin) { 7806 throwIfParentInstance("getBindDeviceAdminTargetUsers"); 7807 try { 7808 return mService.getBindDeviceAdminTargetUsers(admin); 7809 } catch (RemoteException re) { 7810 throw re.rethrowFromSystemServer(); 7811 } 7812 } 7813 7814 /** 7815 * Called by the system to get the time at which the device owner last retrieved security 7816 * logging entries. 7817 * 7818 * @return the time at which the device owner most recently retrieved security logging entries, 7819 * in milliseconds since epoch; -1 if security logging entries were never retrieved. 7820 * @throws SecurityException if the caller is not the device owner, does not hold the 7821 * MANAGE_USERS permission and is not the system. 7822 * 7823 * @hide 7824 */ 7825 @TestApi 7826 public long getLastSecurityLogRetrievalTime() { 7827 try { 7828 return mService.getLastSecurityLogRetrievalTime(); 7829 } catch (RemoteException re) { 7830 throw re.rethrowFromSystemServer(); 7831 } 7832 } 7833 7834 /** 7835 * Called by the system to get the time at which the device owner last requested a bug report. 7836 * 7837 * @return the time at which the device owner most recently requested a bug report, in 7838 * milliseconds since epoch; -1 if a bug report was never requested. 7839 * @throws SecurityException if the caller is not the device owner, does not hold the 7840 * MANAGE_USERS permission and is not the system. 7841 * 7842 * @hide 7843 */ 7844 @TestApi 7845 public long getLastBugReportRequestTime() { 7846 try { 7847 return mService.getLastBugReportRequestTime(); 7848 } catch (RemoteException re) { 7849 throw re.rethrowFromSystemServer(); 7850 } 7851 } 7852 7853 /** 7854 * Called by the system to get the time at which the device owner last retrieved network logging 7855 * events. 7856 * 7857 * @return the time at which the device owner most recently retrieved network logging events, in 7858 * milliseconds since epoch; -1 if network logging events were never retrieved. 7859 * @throws SecurityException if the caller is not the device owner, does not hold the 7860 * MANAGE_USERS permission and is not the system. 7861 * 7862 * @hide 7863 */ 7864 @TestApi 7865 public long getLastNetworkLogRetrievalTime() { 7866 try { 7867 return mService.getLastNetworkLogRetrievalTime(); 7868 } catch (RemoteException re) { 7869 throw re.rethrowFromSystemServer(); 7870 } 7871 } 7872} 7873