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