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