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