DevicePolicyManager.java revision 44a18081546345a0655748717862a89ae6dd7948
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.IntDef; 20import android.annotation.NonNull; 21import android.annotation.Nullable; 22import android.annotation.SdkConstant; 23import android.annotation.SdkConstant.SdkConstantType; 24import android.annotation.SystemApi; 25import android.app.Activity; 26import android.content.ComponentName; 27import android.content.Context; 28import android.content.Intent; 29import android.content.IntentFilter; 30import android.content.pm.ActivityInfo; 31import android.content.pm.PackageManager; 32import android.content.pm.ResolveInfo; 33import android.graphics.Bitmap; 34import android.net.ProxyInfo; 35import android.net.Uri; 36import android.os.Bundle; 37import android.os.PersistableBundle; 38import android.os.Process; 39import android.os.RemoteCallback; 40import android.os.RemoteException; 41import android.os.ServiceManager; 42import android.os.UserHandle; 43import android.os.UserManager; 44import android.provider.ContactsContract.Directory; 45import android.provider.Settings; 46import android.security.Credentials; 47import android.service.restrictions.RestrictionsReceiver; 48import android.util.Log; 49 50import com.android.internal.annotations.VisibleForTesting; 51import com.android.org.conscrypt.TrustedCertificateStore; 52 53import org.xmlpull.v1.XmlPullParserException; 54 55import java.io.ByteArrayInputStream; 56import java.io.IOException; 57import java.lang.annotation.Retention; 58import java.lang.annotation.RetentionPolicy; 59import java.net.InetSocketAddress; 60import java.net.Proxy; 61import java.security.KeyFactory; 62import java.security.NoSuchAlgorithmException; 63import java.security.PrivateKey; 64import java.security.cert.Certificate; 65import java.security.cert.CertificateException; 66import java.security.cert.CertificateFactory; 67import java.security.cert.X509Certificate; 68import java.security.spec.InvalidKeySpecException; 69import java.security.spec.PKCS8EncodedKeySpec; 70import java.util.ArrayList; 71import java.util.Collections; 72import java.util.List; 73import java.util.Set; 74 75/** 76 * Public interface for managing policies enforced on a device. Most clients of this class must be 77 * registered with the system as a 78 * <a href="{@docRoot}guide/topics/admin/device-admin.html">device administrator</a>. Additionally, 79 * a device administrator may be registered as either a profile or device owner. A given method is 80 * accessible to all device administrators unless the documentation for that method specifies that 81 * it is restricted to either device or profile owners. 82 * 83 * <div class="special reference"> 84 * <h3>Developer Guides</h3> 85 * <p>For more information about managing policies for device administration, read the 86 * <a href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> 87 * developer guide. 88 * </div> 89 */ 90public class DevicePolicyManager { 91 private static String TAG = "DevicePolicyManager"; 92 93 private final Context mContext; 94 private final IDevicePolicyManager mService; 95 private final boolean mParentInstance; 96 97 private static final String REMOTE_EXCEPTION_MESSAGE = 98 "Failed to talk with device policy manager service"; 99 100 private DevicePolicyManager(Context context, boolean parentInstance) { 101 this(context, 102 IDevicePolicyManager.Stub.asInterface( 103 ServiceManager.getService(Context.DEVICE_POLICY_SERVICE)), 104 parentInstance); 105 } 106 107 /** @hide */ 108 @VisibleForTesting 109 protected DevicePolicyManager( 110 Context context, IDevicePolicyManager service, boolean parentInstance) { 111 mContext = context; 112 mService = service; 113 mParentInstance = parentInstance; 114 } 115 116 /** @hide */ 117 public static DevicePolicyManager create(Context context) { 118 DevicePolicyManager me = new DevicePolicyManager(context, false); 119 return me.mService != null ? me : null; 120 } 121 122 /** @hide test will override it. */ 123 @VisibleForTesting 124 protected int myUserId() { 125 return UserHandle.myUserId(); 126 } 127 128 /** 129 * Activity action: Starts the provisioning flow which sets up a managed profile. 130 * 131 * <p>A managed profile allows data separation for example for the usage of a 132 * device as a personal and corporate device. The user which provisioning is started from and 133 * the managed profile share a launcher. 134 * 135 * <p>This intent will typically be sent by a mobile device management application (MDM). 136 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full 137 * control over the profile. 138 * 139 * <p>It is possible to check if provisioning is allowed or not by querying the method 140 * {@link #isProvisioningAllowed(String)}. 141 * 142 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the 143 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}. 144 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra 145 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only 146 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported. 147 * 148 * <p> The intent may also contain the following extras: 149 * <ul> 150 * <li> {@link #EXTRA_PROVISIONING_LOGO_URI}, optional </li> 151 * <li> {@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional </li> 152 * </ul> 153 * 154 * <p> When managed provisioning has completed, broadcasts are sent to the application specified 155 * in the provisioning intent. The 156 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the 157 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in 158 * the primary profile. 159 * 160 * <p> If provisioning fails, the managedProfile is removed so the device returns to its 161 * previous state. 162 * 163 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a 164 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of 165 * the provisioning flow was successful, although this doesn't guarantee the full flow will 166 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies 167 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met. 168 */ 169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 170 public static final String ACTION_PROVISION_MANAGED_PROFILE 171 = "android.app.action.PROVISION_MANAGED_PROFILE"; 172 173 /** 174 * @hide 175 * Activity action: Starts the provisioning flow which sets up a managed user. 176 * 177 * <p>This intent will typically be sent by a mobile device management application (MDM). 178 * Provisioning configures the user as managed user and sets the MDM as the profile 179 * owner who has full control over the user. Provisioning can only happen before user setup has 180 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is 181 * allowed. 182 * 183 * <p>This intent should contain the extra 184 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. 185 * 186 * <p> If provisioning fails, the device returns to its previous state. 187 * 188 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a 189 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of 190 * the provisioning flow was successful, although this doesn't guarantee the full flow will 191 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies 192 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met. 193 */ 194 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 195 public static final String ACTION_PROVISION_MANAGED_USER 196 = "android.app.action.PROVISION_MANAGED_USER"; 197 198 /** 199 * Activity action: Starts the provisioning flow which sets up a managed device. 200 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}. 201 * 202 * <p> During device owner provisioning a device admin app is set as the owner of the device. 203 * A device owner has full control over the device. The device owner can not be modified by the 204 * user. 205 * 206 * <p> A typical use case would be a device that is owned by a company, but used by either an 207 * employee or client. 208 * 209 * <p> An intent with this action can be sent only on an unprovisioned device. 210 * It is possible to check if provisioning is allowed or not by querying the method 211 * {@link #isProvisioningAllowed(String)}. 212 * 213 * <p>The intent contains the following extras: 214 * <ul> 215 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li> 216 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li> 217 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li> 218 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li> 219 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li> 220 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li> 221 * </ul> 222 * 223 * <p> When device owner provisioning has completed, an intent of the type 224 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the 225 * device owner. 226 * 227 * <p> If provisioning fails, the device is factory reset. 228 * 229 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part 230 * of the provisioning flow was successful, although this doesn't guarantee the full flow will 231 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies 232 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met. 233 */ 234 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 235 public static final String ACTION_PROVISION_MANAGED_DEVICE 236 = "android.app.action.PROVISION_MANAGED_DEVICE"; 237 238 /** 239 * Activity action: Starts the provisioning flow which sets up a managed device. 240 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}. 241 * 242 * <p>NOTE: This is only supported on split system user devices, and puts the device into a 243 * management state that is distinct from that reached by 244 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system 245 * user, and only has control over device-wide policies, not individual users and their data. 246 * The primary benefit is that multiple non-system users are supported when provisioning using 247 * this form of device management. 248 * 249 * <p> During device owner provisioning a device admin app is set as the owner of the device. 250 * A device owner has full control over the device. The device owner can not be modified by the 251 * user. 252 * 253 * <p> A typical use case would be a device that is owned by a company, but used by either an 254 * employee or client. 255 * 256 * <p> An intent with this action can be sent only on an unprovisioned device. 257 * It is possible to check if provisioning is allowed or not by querying the method 258 * {@link #isProvisioningAllowed(String)}. 259 * 260 * <p>The intent contains the following extras: 261 * <ul> 262 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li> 263 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li> 264 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li> 265 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li> 266 * </ul> 267 * 268 * <p> When device owner provisioning has completed, an intent of the type 269 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the 270 * device owner. 271 * 272 * <p> If provisioning fails, the device is factory reset. 273 * 274 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part 275 * of the provisioning flow was successful, although this doesn't guarantee the full flow will 276 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies 277 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met. 278 * 279 * @hide 280 */ 281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 282 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE 283 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE"; 284 285 /** 286 * Activity action: Finalizes management provisioning, should be used after user-setup 287 * has been completed and {@link #getUserProvisioningState()} returns one of: 288 * <ul> 289 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li> 290 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li> 291 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li> 292 * </ul> 293 * 294 * @hide 295 */ 296 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 297 public static final String ACTION_PROVISION_FINALIZATION 298 = "android.app.action.PROVISION_FINALIZATION"; 299 300 /** 301 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that 302 * allows a mobile device management application or NFC programmer application which starts 303 * managed provisioning to pass data to the management application instance after provisioning. 304 * <p> 305 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that 306 * sends the intent to pass data to itself on the newly created profile. 307 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same 308 * instance of the app on the primary user. 309 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with 310 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC 311 * message should contain a stringified {@link java.util.Properties} instance, whose string 312 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the 313 * management application after provisioning. 314 * 315 * <p> 316 * In both cases the application receives the data in 317 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action 318 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed 319 * during the managed provisioning. 320 */ 321 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE = 322 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE"; 323 324 /** 325 * A String extra holding the package name of the mobile device management application that 326 * will be set as the profile owner or device owner. 327 * 328 * <p>If an application starts provisioning directly via an intent with action 329 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the 330 * application that started provisioning. The package will be set as profile owner in that case. 331 * 332 * <p>This package is set as device owner when device owner provisioning is started by an NFC 333 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}. 334 * 335 * <p> When this extra is set, the application must have exactly one device admin receiver. 336 * This receiver will be set as the profile or device owner and active admin. 337 338 * @see DeviceAdminReceiver 339 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still 340 * supported, but only if there is only one device admin receiver in the package that requires 341 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}. 342 */ 343 @Deprecated 344 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME 345 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME"; 346 347 /** 348 * A ComponentName extra indicating the device admin receiver of the mobile device management 349 * application that will be set as the profile owner or device owner and active admin. 350 * 351 * <p>If an application starts provisioning directly via an intent with action 352 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or 353 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this 354 * component has to match the package name of the application that started provisioning. 355 * 356 * <p>This component is set as device owner and active admin when device owner provisioning is 357 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC 358 * message containing an NFC record with MIME type 359 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name should be 360 * flattened to a string, via {@link ComponentName#flattenToShortString()}. 361 * 362 * @see DeviceAdminReceiver 363 */ 364 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME 365 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME"; 366 367 /** 368 * An {@link android.accounts.Account} extra holding the account to migrate during managed 369 * profile provisioning. If the account supplied is present in the primary user, it will be 370 * copied, along with its credentials to the managed profile and removed from the primary user. 371 * 372 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}. 373 */ 374 375 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE 376 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE"; 377 378 /** 379 * A String extra that, holds the email address of the account which a managed profile is 380 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and 381 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. 382 * 383 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}. 384 * 385 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning 386 * contains this extra, it is forwarded in the 387 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile 388 * device management application that was set as the profile owner during provisioning. 389 * It is usually used to avoid that the user has to enter their email address twice. 390 */ 391 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS 392 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS"; 393 394 /** 395 * A integer extra indicating the predominant color to show during the provisioning. 396 * Refer to {@link android.graphics.Color} for how the color is represented. 397 * 398 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or 399 * {@link #ACTION_PROVISION_MANAGED_DEVICE}. 400 */ 401 public static final String EXTRA_PROVISIONING_MAIN_COLOR = 402 "android.app.extra.PROVISIONING_MAIN_COLOR"; 403 404 /** 405 * A Boolean extra that can be used by the mobile device management application to skip the 406 * disabling of system apps during provisioning when set to {@code true}. 407 * 408 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action 409 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning. 410 */ 411 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED = 412 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED"; 413 414 /** 415 * A String extra holding the time zone {@link android.app.AlarmManager} that the device 416 * will be set to. 417 * 418 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 419 * provisioning via an NFC bump. 420 */ 421 public static final String EXTRA_PROVISIONING_TIME_ZONE 422 = "android.app.extra.PROVISIONING_TIME_ZONE"; 423 424 /** 425 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's 426 * {@link android.app.AlarmManager}. 427 * 428 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 429 * provisioning via an NFC bump. 430 */ 431 public static final String EXTRA_PROVISIONING_LOCAL_TIME 432 = "android.app.extra.PROVISIONING_LOCAL_TIME"; 433 434 /** 435 * A String extra holding the {@link java.util.Locale} that the device will be set to. 436 * Format: xx_yy, where xx is the language code, and yy the country code. 437 * 438 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 439 * provisioning via an NFC bump. 440 */ 441 public static final String EXTRA_PROVISIONING_LOCALE 442 = "android.app.extra.PROVISIONING_LOCALE"; 443 444 /** 445 * A String extra holding the ssid of the wifi network that should be used during nfc device 446 * owner provisioning for downloading the mobile device management application. 447 * 448 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 449 * provisioning via an NFC bump. 450 */ 451 public static final String EXTRA_PROVISIONING_WIFI_SSID 452 = "android.app.extra.PROVISIONING_WIFI_SSID"; 453 454 /** 455 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID} 456 * is hidden or not. 457 * 458 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 459 * provisioning via an NFC bump. 460 */ 461 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN 462 = "android.app.extra.PROVISIONING_WIFI_HIDDEN"; 463 464 /** 465 * A String extra indicating the security type of the wifi network in 466 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or 467 * {@code WEP}. 468 * 469 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 470 * provisioning via an NFC bump. 471 */ 472 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE 473 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE"; 474 475 /** 476 * A String extra holding the password of the wifi network in 477 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 478 * 479 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 480 * provisioning via an NFC bump. 481 */ 482 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD 483 = "android.app.extra.PROVISIONING_WIFI_PASSWORD"; 484 485 /** 486 * A String extra holding the proxy host for the wifi network in 487 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 488 * 489 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 490 * provisioning via an NFC bump. 491 */ 492 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST 493 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST"; 494 495 /** 496 * An int extra holding the proxy port for the wifi network in 497 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 498 * 499 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 500 * provisioning via an NFC bump. 501 */ 502 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT 503 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT"; 504 505 /** 506 * A String extra holding the proxy bypass for the wifi network in 507 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 508 * 509 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 510 * provisioning via an NFC bump. 511 */ 512 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS 513 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS"; 514 515 /** 516 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in 517 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 518 * 519 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 520 * provisioning via an NFC bump. 521 */ 522 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL 523 = "android.app.extra.PROVISIONING_WIFI_PAC_URL"; 524 525 /** 526 * A String extra holding a url that specifies the download location of the device admin 527 * package. When not provided it is assumed that the device admin package is already installed. 528 * 529 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 530 * provisioning via an NFC bump. 531 */ 532 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION 533 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION"; 534 535 /** 536 * An int extra holding a minimum required version code for the device admin package. If the 537 * device admin is already installed on the device, it will only be re-downloaded from 538 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the 539 * installed package is less than this version code. 540 * 541 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 542 * provisioning via an NFC bump. 543 */ 544 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE 545 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE"; 546 547 /** 548 * A String extra holding a http cookie header which should be used in the http request to the 549 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. 550 * 551 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 552 * provisioning via an NFC bump. 553 */ 554 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER 555 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER"; 556 557 /** 558 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of 559 * the file at download location specified in 560 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. 561 * 562 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} should be 563 * present. The provided checksum should match the checksum of the file at the download 564 * location. If the checksum doesn't match an error will be shown to the user and the user will 565 * be asked to factory reset the device. 566 * 567 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 568 * provisioning via an NFC bump. 569 * 570 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP} 571 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported. 572 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in 573 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases. 574 */ 575 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM 576 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM"; 577 578 /** 579 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the 580 * android package archive at the download location specified in {@link 581 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. 582 * 583 * <p>The signatures of an android package archive can be obtained using 584 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag 585 * {@link android.content.pm.PackageManager#GET_SIGNATURES}. 586 * 587 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} should be 588 * present. The provided checksum should match the checksum of any signature of the file at 589 * the download location. If the checksum does not match an error will be shown to the user and 590 * the user will be asked to factory reset the device. 591 * 592 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 593 * provisioning via an NFC bump. 594 */ 595 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM 596 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM"; 597 598 /** 599 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile 600 * has completed successfully. 601 * 602 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning 603 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}. 604 * 605 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which 606 * corresponds to the account requested to be migrated at provisioning time, if any. 607 */ 608 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 609 public static final String ACTION_MANAGED_PROFILE_PROVISIONED 610 = "android.app.action.MANAGED_PROFILE_PROVISIONED"; 611 612 /** 613 * A boolean extra indicating whether device encryption can be skipped as part of Device Owner 614 * provisioning. 615 * 616 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action 617 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning. 618 */ 619 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION = 620 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION"; 621 622 /** 623 * A {@link Uri} extra pointing to a logo image. This image will be shown during the 624 * provisioning. If this extra is not passed, a default image will be shown. 625 * <h5>The following URI schemes are accepted:</h5> 626 * <ul> 627 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 628 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 629 * </ul> 630 * 631 * <p> It is the responsability of the caller to provide an image with a reasonable 632 * pixed density for the device. 633 * 634 * <p> If a content: URI is passed, the intent should have the flag 635 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the 636 * {@link android.content.ClipData} of the intent too. 637 * 638 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or 639 * {@link #ACTION_PROVISION_MANAGED_DEVICE} 640 */ 641 public static final String EXTRA_PROVISIONING_LOGO_URI = 642 "android.app.extra.PROVISIONING_LOGO_URI"; 643 644 /** 645 * A boolean extra indicating if user setup should be skipped, for when provisioning is started 646 * during setup-wizard. 647 * 648 * <p>If unspecified, defaults to {@code true} to match the behavior in 649 * {@link android.os.Build.VERSION_CODES#M} and earlier. 650 * 651 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or 652 * {@link #ACTION_PROVISION_MANAGED_USER}. 653 * 654 * @hide 655 */ 656 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP = 657 "android.app.extra.PROVISIONING_SKIP_USER_SETUP"; 658 659 /** 660 * This MIME type is used for starting the Device Owner provisioning. 661 * 662 * <p>During device owner provisioning a device admin app is set as the owner of the device. 663 * A device owner has full control over the device. The device owner can not be modified by the 664 * user and the only way of resetting the device is if the device owner app calls a factory 665 * reset. 666 * 667 * <p> A typical use case would be a device that is owned by a company, but used by either an 668 * employee or client. 669 * 670 * <p> The NFC message should be send to an unprovisioned device. 671 * 672 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which 673 * contains the following properties: 674 * <ul> 675 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li> 676 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li> 677 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li> 678 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li> 679 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li> 680 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li> 681 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li> 682 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li> 683 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li> 684 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li> 685 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li> 686 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li> 687 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li> 688 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li> 689 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li> 690 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from 691 * {@link android.os.Build.VERSION_CODES#M} </li></ul> 692 * 693 * <p> 694 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain 695 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of 696 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only 697 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported). 698 */ 699 public static final String MIME_TYPE_PROVISIONING_NFC 700 = "application/com.android.managedprovisioning"; 701 702 /** 703 * Activity action: ask the user to add a new device administrator to the system. 704 * The desired policy is the ComponentName of the policy in the 705 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to 706 * bring the user through adding the device administrator to the system (or 707 * allowing them to reject it). 708 * 709 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION} 710 * field to provide the user with additional explanation (in addition 711 * to your component's description) about what is being added. 712 * 713 * <p>If your administrator is already active, this will ordinarily return immediately (without 714 * user intervention). However, if your administrator has been updated and is requesting 715 * additional uses-policy flags, the user will be presented with the new list. New policies 716 * will not be available to the updated administrator until the user has accepted the new list. 717 */ 718 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 719 public static final String ACTION_ADD_DEVICE_ADMIN 720 = "android.app.action.ADD_DEVICE_ADMIN"; 721 722 /** 723 * @hide 724 * Activity action: ask the user to add a new device administrator as the profile owner 725 * for this user. Only system apps can launch this intent. 726 * 727 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN} 728 * extra field. This will invoke a UI to bring the user through adding the profile owner admin 729 * to remotely control restrictions on the user. 730 * 731 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the 732 * result of whether or not the user approved the action. If approved, the result will 733 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well 734 * as a profile owner. 735 * 736 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION} 737 * field to provide the user with additional explanation (in addition 738 * to your component's description) about what is being added. 739 * 740 * <p>If there is already a profile owner active or the caller is not a system app, the 741 * operation will return a failure result. 742 */ 743 @SystemApi 744 public static final String ACTION_SET_PROFILE_OWNER 745 = "android.app.action.SET_PROFILE_OWNER"; 746 747 /** 748 * @hide 749 * Name of the profile owner admin that controls the user. 750 */ 751 @SystemApi 752 public static final String EXTRA_PROFILE_OWNER_NAME 753 = "android.app.extra.PROFILE_OWNER_NAME"; 754 755 /** 756 * Broadcast action: send when any policy admin changes a policy. 757 * This is generally used to find out when a new policy is in effect. 758 * 759 * @hide 760 */ 761 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED 762 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED"; 763 764 /** 765 * Broadcast action: sent when the device owner is set or changed. 766 * 767 * This broadcast is sent only to the primary user. 768 * @see #ACTION_PROVISION_MANAGED_DEVICE 769 */ 770 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 771 public static final String ACTION_DEVICE_OWNER_CHANGED 772 = "android.app.action.DEVICE_OWNER_CHANGED"; 773 774 /** 775 * The ComponentName of the administrator component. 776 * 777 * @see #ACTION_ADD_DEVICE_ADMIN 778 */ 779 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN"; 780 781 /** 782 * An optional CharSequence providing additional explanation for why the 783 * admin is being added. 784 * 785 * @see #ACTION_ADD_DEVICE_ADMIN 786 */ 787 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION"; 788 789 /** 790 * Activity action: have the user enter a new password. This activity should 791 * be launched after using {@link #setPasswordQuality(ComponentName, int)}, 792 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user 793 * enter a new password that meets the current requirements. You can use 794 * {@link #isActivePasswordSufficient()} to determine whether you need to 795 * have the user select a new password in order to meet the current 796 * constraints. Upon being resumed from this activity, you can check the new 797 * password characteristics to see if they are sufficient. 798 * 799 * If the intent is launched from within a managed profile with a profile 800 * owner built against {@link android.os.Build.VERSION_CODES#M} or before, 801 * this will trigger entering a new password for the parent of the profile. 802 * For all other cases it will trigger entering a new password for the user 803 * or profile it is launched from. 804 */ 805 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 806 public static final String ACTION_SET_NEW_PASSWORD 807 = "android.app.action.SET_NEW_PASSWORD"; 808 809 /** 810 * Activity action: have the user enter a new password for the parent profile. 811 * If the intent is launched from within a managed profile, this will trigger 812 * entering a new password for the parent of the profile. In all other cases 813 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}. 814 */ 815 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 816 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD 817 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD"; 818 819 /** 820 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in 821 * the parent profile to access intents sent from the managed profile. 822 * That is, when an app in the managed profile calls 823 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a 824 * matching activity in the parent profile. 825 */ 826 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001; 827 828 /** 829 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in 830 * the managed profile to access intents sent from the parent profile. 831 * That is, when an app in the parent profile calls 832 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a 833 * matching activity in the managed profile. 834 */ 835 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002; 836 837 /** 838 * Broadcast action: notify that a new local system update policy has been set by the device 839 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}. 840 */ 841 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 842 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED 843 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED"; 844 845 /** 846 * Permission policy to prompt user for new permission requests for runtime permissions. 847 * Already granted or denied permissions are not affected by this. 848 */ 849 public static final int PERMISSION_POLICY_PROMPT = 0; 850 851 /** 852 * Permission policy to always grant new permission requests for runtime permissions. 853 * Already granted or denied permissions are not affected by this. 854 */ 855 public static final int PERMISSION_POLICY_AUTO_GRANT = 1; 856 857 /** 858 * Permission policy to always deny new permission requests for runtime permissions. 859 * Already granted or denied permissions are not affected by this. 860 */ 861 public static final int PERMISSION_POLICY_AUTO_DENY = 2; 862 863 /** 864 * Runtime permission state: The user can manage the permission 865 * through the UI. 866 */ 867 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0; 868 869 /** 870 * Runtime permission state: The permission is granted to the app 871 * and the user cannot manage the permission through the UI. 872 */ 873 public static final int PERMISSION_GRANT_STATE_GRANTED = 1; 874 875 /** 876 * Runtime permission state: The permission is denied to the app 877 * and the user cannot manage the permission through the UI. 878 */ 879 public static final int PERMISSION_GRANT_STATE_DENIED = 2; 880 881 /** 882 * No management for current user in-effect. This is the default. 883 * @hide 884 */ 885 public static final int STATE_USER_UNMANAGED = 0; 886 887 /** 888 * Management partially setup, user setup needs to be completed. 889 * @hide 890 */ 891 public static final int STATE_USER_SETUP_INCOMPLETE = 1; 892 893 /** 894 * Management partially setup, user setup completed. 895 * @hide 896 */ 897 public static final int STATE_USER_SETUP_COMPLETE = 2; 898 899 /** 900 * Management setup and active on current user. 901 * @hide 902 */ 903 public static final int STATE_USER_SETUP_FINALIZED = 3; 904 905 /** 906 * Management partially setup on a managed profile. 907 * @hide 908 */ 909 public static final int STATE_USER_PROFILE_COMPLETE = 4; 910 911 /** 912 * @hide 913 */ 914 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE, 915 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE}) 916 @Retention(RetentionPolicy.SOURCE) 917 public @interface UserProvisioningState {} 918 919 /** 920 * Return true if the given administrator component is currently 921 * active (enabled) in the system. 922 */ 923 public boolean isAdminActive(@NonNull ComponentName admin) { 924 return isAdminActiveAsUser(admin, myUserId()); 925 } 926 927 /** 928 * @see #isAdminActive(ComponentName) 929 * @hide 930 */ 931 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) { 932 if (mService != null) { 933 try { 934 return mService.isAdminActive(admin, userId); 935 } catch (RemoteException e) { 936 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 937 } 938 } 939 return false; 940 } 941 /** 942 * Return true if the given administrator component is currently being removed 943 * for the user. 944 * @hide 945 */ 946 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) { 947 if (mService != null) { 948 try { 949 return mService.isRemovingAdmin(admin, userId); 950 } catch (RemoteException e) { 951 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 952 } 953 } 954 return false; 955 } 956 957 958 /** 959 * Return a list of all currently active device administrators' component 960 * names. If there are no administrators {@code null} may be 961 * returned. 962 */ 963 public List<ComponentName> getActiveAdmins() { 964 return getActiveAdminsAsUser(myUserId()); 965 } 966 967 /** 968 * @see #getActiveAdmins() 969 * @hide 970 */ 971 public List<ComponentName> getActiveAdminsAsUser(int userId) { 972 if (mService != null) { 973 try { 974 return mService.getActiveAdmins(userId); 975 } catch (RemoteException e) { 976 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 977 } 978 } 979 return null; 980 } 981 982 /** 983 * Used by package administration code to determine if a package can be stopped 984 * or uninstalled. 985 * @hide 986 */ 987 public boolean packageHasActiveAdmins(String packageName) { 988 if (mService != null) { 989 try { 990 return mService.packageHasActiveAdmins(packageName, myUserId()); 991 } catch (RemoteException e) { 992 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 993 } 994 } 995 return false; 996 } 997 998 /** 999 * Remove a current administration component. This can only be called 1000 * by the application that owns the administration component; if you 1001 * try to remove someone else's component, a security exception will be 1002 * thrown. 1003 */ 1004 public void removeActiveAdmin(@NonNull ComponentName admin) { 1005 if (mService != null) { 1006 try { 1007 mService.removeActiveAdmin(admin, myUserId()); 1008 } catch (RemoteException e) { 1009 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1010 } 1011 } 1012 } 1013 1014 /** 1015 * Returns true if an administrator has been granted a particular device policy. This can 1016 * be used to check whether the administrator was activated under an earlier set of policies, 1017 * but requires additional policies after an upgrade. 1018 * 1019 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be 1020 * an active administrator, or an exception will be thrown. 1021 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}. 1022 */ 1023 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) { 1024 if (mService != null) { 1025 try { 1026 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId()); 1027 } catch (RemoteException e) { 1028 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1029 } 1030 } 1031 return false; 1032 } 1033 1034 /** 1035 * Returns true if the Profile Challenge is available to use for the given profile user. 1036 * 1037 * @hide 1038 */ 1039 public boolean isSeparateProfileChallengeAllowed(int userHandle) { 1040 if (mService != null) { 1041 try { 1042 return mService.isSeparateProfileChallengeAllowed(userHandle); 1043 } catch (RemoteException e) { 1044 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1045 } 1046 } 1047 return false; 1048 } 1049 1050 /** 1051 * Constant for {@link #setPasswordQuality}: the policy has no requirements 1052 * for the password. Note that quality constants are ordered so that higher 1053 * values are more restrictive. 1054 */ 1055 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0; 1056 1057 /** 1058 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric 1059 * recognition technology. This implies technologies that can recognize the identity of 1060 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000). 1061 * Note that quality constants are ordered so that higher values are more restrictive. 1062 */ 1063 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000; 1064 1065 /** 1066 * Constant for {@link #setPasswordQuality}: the policy requires some kind 1067 * of password or pattern, but doesn't care what it is. Note that quality constants 1068 * are ordered so that higher values are more restrictive. 1069 */ 1070 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000; 1071 1072 /** 1073 * Constant for {@link #setPasswordQuality}: the user must have entered a 1074 * password containing at least numeric characters. Note that quality 1075 * constants are ordered so that higher values are more restrictive. 1076 */ 1077 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000; 1078 1079 /** 1080 * Constant for {@link #setPasswordQuality}: the user must have entered a 1081 * password containing at least numeric characters with no repeating (4444) 1082 * or ordered (1234, 4321, 2468) sequences. Note that quality 1083 * constants are ordered so that higher values are more restrictive. 1084 */ 1085 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000; 1086 1087 /** 1088 * Constant for {@link #setPasswordQuality}: the user must have entered a 1089 * password containing at least alphabetic (or other symbol) characters. 1090 * Note that quality constants are ordered so that higher values are more 1091 * restrictive. 1092 */ 1093 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000; 1094 1095 /** 1096 * Constant for {@link #setPasswordQuality}: the user must have entered a 1097 * password containing at least <em>both></em> numeric <em>and</em> 1098 * alphabetic (or other symbol) characters. Note that quality constants are 1099 * ordered so that higher values are more restrictive. 1100 */ 1101 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000; 1102 1103 /** 1104 * Constant for {@link #setPasswordQuality}: the user must have entered a 1105 * password containing at least a letter, a numerical digit and a special 1106 * symbol, by default. With this password quality, passwords can be 1107 * restricted to contain various sets of characters, like at least an 1108 * uppercase letter, etc. These are specified using various methods, 1109 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note 1110 * that quality constants are ordered so that higher values are more 1111 * restrictive. 1112 */ 1113 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000; 1114 1115 /** 1116 * Constant for {@link #setPasswordQuality}: the user is not allowed to 1117 * modify password. In case this password quality is set, the password is 1118 * managed by a profile owner. The profile owner can set any password, 1119 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note 1120 * that quality constants are ordered so that higher values are more 1121 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is 1122 * the highest. 1123 * @hide 1124 */ 1125 public static final int PASSWORD_QUALITY_MANAGED = 0x80000; 1126 1127 /** 1128 * Called by an application that is administering the device to set the 1129 * password restrictions it is imposing. After setting this, the user 1130 * will not be able to enter a new password that is not at least as 1131 * restrictive as what has been set. Note that the current password 1132 * will remain until the user has set a new one, so the change does not 1133 * take place immediately. To prompt the user for a new password, use 1134 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. 1135 * 1136 * <p>Quality constants are ordered so that higher values are more restrictive; 1137 * thus the highest requested quality constant (between the policy set here, 1138 * the user's preference, and any other considerations) is the one that 1139 * is in effect. 1140 * 1141 * <p>The calling device admin must have requested 1142 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1143 * this method; if it has not, a security exception will be thrown. 1144 * 1145 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1146 * @param quality The new desired quality. One of 1147 * {@link #PASSWORD_QUALITY_UNSPECIFIED}, {@link #PASSWORD_QUALITY_SOMETHING}, 1148 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, 1149 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC} 1150 * or {@link #PASSWORD_QUALITY_COMPLEX}. 1151 */ 1152 public void setPasswordQuality(@NonNull ComponentName admin, int quality) { 1153 if (mService != null) { 1154 try { 1155 mService.setPasswordQuality(admin, quality, mParentInstance); 1156 } catch (RemoteException e) { 1157 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1158 } 1159 } 1160 } 1161 1162 /** 1163 * Retrieve the current minimum password quality for all admins of this user 1164 * and its profiles or a particular one. 1165 * @param admin The name of the admin component to check, or {@code null} to aggregate 1166 * all admins. 1167 */ 1168 public int getPasswordQuality(@Nullable ComponentName admin) { 1169 return getPasswordQuality(admin, myUserId()); 1170 } 1171 1172 /** @hide per-user version */ 1173 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) { 1174 if (mService != null) { 1175 try { 1176 return mService.getPasswordQuality(admin, userHandle, mParentInstance); 1177 } catch (RemoteException e) { 1178 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1179 } 1180 } 1181 return PASSWORD_QUALITY_UNSPECIFIED; 1182 } 1183 1184 /** 1185 * Called by an application that is administering the device to set the 1186 * minimum allowed password length. After setting this, the user 1187 * will not be able to enter a new password that is not at least as 1188 * restrictive as what has been set. Note that the current password 1189 * will remain until the user has set a new one, so the change does not 1190 * take place immediately. To prompt the user for a new password, use 1191 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 1192 * constraint is only imposed if the administrator has also requested either 1193 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, 1194 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC}, 1195 * or {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. 1196 * 1197 * <p>The calling device admin must have requested 1198 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1199 * this method; if it has not, a security exception will be thrown. 1200 * 1201 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1202 * @param length The new desired minimum password length. A value of 0 1203 * means there is no restriction. 1204 */ 1205 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) { 1206 if (mService != null) { 1207 try { 1208 mService.setPasswordMinimumLength(admin, length, mParentInstance); 1209 } catch (RemoteException e) { 1210 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1211 } 1212 } 1213 } 1214 1215 /** 1216 * Retrieve the current minimum password length for all admins of this 1217 * user and its profiles or a particular one. 1218 * @param admin The name of the admin component to check, or {@code null} to aggregate 1219 * all admins. 1220 */ 1221 public int getPasswordMinimumLength(@Nullable ComponentName admin) { 1222 return getPasswordMinimumLength(admin, myUserId()); 1223 } 1224 1225 /** @hide per-user version */ 1226 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) { 1227 if (mService != null) { 1228 try { 1229 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance); 1230 } catch (RemoteException e) { 1231 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1232 } 1233 } 1234 return 0; 1235 } 1236 1237 /** 1238 * Called by an application that is administering the device to set the 1239 * minimum number of upper case letters required in the password. After 1240 * setting this, the user will not be able to enter a new password that is 1241 * not at least as restrictive as what has been set. Note that the current 1242 * password will remain until the user has set a new one, so the change does 1243 * not take place immediately. To prompt the user for a new password, use 1244 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 1245 * constraint is only imposed if the administrator has also requested 1246 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 1247 * default value is 0. 1248 * <p> 1249 * The calling device admin must have requested 1250 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1251 * this method; if it has not, a security exception will be thrown. 1252 * 1253 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1254 * with. 1255 * @param length The new desired minimum number of upper case letters 1256 * required in the password. A value of 0 means there is no 1257 * restriction. 1258 */ 1259 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) { 1260 if (mService != null) { 1261 try { 1262 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance); 1263 } catch (RemoteException e) { 1264 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1265 } 1266 } 1267 } 1268 1269 /** 1270 * Retrieve the current number of upper case letters required in the 1271 * password for all admins of this user and its profiles or a particular one. 1272 * This is the same value as set by 1273 * {#link {@link #setPasswordMinimumUpperCase(ComponentName, int)} 1274 * and only applies when the password quality is 1275 * {@link #PASSWORD_QUALITY_COMPLEX}. 1276 * 1277 * @param admin The name of the admin component to check, or {@code null} to 1278 * aggregate all admins. 1279 * @return The minimum number of upper case letters required in the 1280 * password. 1281 */ 1282 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) { 1283 return getPasswordMinimumUpperCase(admin, myUserId()); 1284 } 1285 1286 /** @hide per-user version */ 1287 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) { 1288 if (mService != null) { 1289 try { 1290 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance); 1291 } catch (RemoteException e) { 1292 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1293 } 1294 } 1295 return 0; 1296 } 1297 1298 /** 1299 * Called by an application that is administering the device to set the 1300 * minimum number of lower case letters required in the password. After 1301 * setting this, the user will not be able to enter a new password that is 1302 * not at least as restrictive as what has been set. Note that the current 1303 * password will remain until the user has set a new one, so the change does 1304 * not take place immediately. To prompt the user for a new password, use 1305 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 1306 * constraint is only imposed if the administrator has also requested 1307 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 1308 * default value is 0. 1309 * <p> 1310 * The calling device admin must have requested 1311 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1312 * this method; if it has not, a security exception will be thrown. 1313 * 1314 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1315 * with. 1316 * @param length The new desired minimum number of lower case letters 1317 * required in the password. A value of 0 means there is no 1318 * restriction. 1319 */ 1320 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) { 1321 if (mService != null) { 1322 try { 1323 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance); 1324 } catch (RemoteException e) { 1325 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1326 } 1327 } 1328 } 1329 1330 /** 1331 * Retrieve the current number of lower case letters required in the 1332 * password for all admins of this user and its profiles or a particular one. 1333 * This is the same value as set by 1334 * {#link {@link #setPasswordMinimumLowerCase(ComponentName, int)} 1335 * and only applies when the password quality is 1336 * {@link #PASSWORD_QUALITY_COMPLEX}. 1337 * 1338 * @param admin The name of the admin component to check, or {@code null} to 1339 * aggregate all admins. 1340 * @return The minimum number of lower case letters required in the 1341 * password. 1342 */ 1343 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) { 1344 return getPasswordMinimumLowerCase(admin, myUserId()); 1345 } 1346 1347 /** @hide per-user version */ 1348 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) { 1349 if (mService != null) { 1350 try { 1351 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance); 1352 } catch (RemoteException e) { 1353 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1354 } 1355 } 1356 return 0; 1357 } 1358 1359 /** 1360 * Called by an application that is administering the device to set the 1361 * minimum number of letters required in the password. After setting this, 1362 * the user will not be able to enter a new password that is not at least as 1363 * restrictive as what has been set. Note that the current password will 1364 * remain until the user has set a new one, so the change does not take 1365 * place immediately. To prompt the user for a new password, use 1366 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 1367 * constraint is only imposed if the administrator has also requested 1368 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 1369 * default value is 1. 1370 * <p> 1371 * The calling device admin must have requested 1372 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1373 * this method; if it has not, a security exception will be thrown. 1374 * 1375 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1376 * with. 1377 * @param length The new desired minimum number of letters required in the 1378 * password. A value of 0 means there is no restriction. 1379 */ 1380 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) { 1381 if (mService != null) { 1382 try { 1383 mService.setPasswordMinimumLetters(admin, length, mParentInstance); 1384 } catch (RemoteException e) { 1385 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1386 } 1387 } 1388 } 1389 1390 /** 1391 * Retrieve the current number of letters required in the password for all 1392 * admins or a particular one. This is the same value as 1393 * set by {#link {@link #setPasswordMinimumLetters(ComponentName, int)} 1394 * and only applies when the password quality is 1395 * {@link #PASSWORD_QUALITY_COMPLEX}. 1396 * 1397 * @param admin The name of the admin component to check, or {@code null} to 1398 * aggregate all admins. 1399 * @return The minimum number of letters required in the password. 1400 */ 1401 public int getPasswordMinimumLetters(@Nullable ComponentName admin) { 1402 return getPasswordMinimumLetters(admin, myUserId()); 1403 } 1404 1405 /** @hide per-user version */ 1406 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) { 1407 if (mService != null) { 1408 try { 1409 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance); 1410 } catch (RemoteException e) { 1411 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1412 } 1413 } 1414 return 0; 1415 } 1416 1417 /** 1418 * Called by an application that is administering the device to set the 1419 * minimum number of numerical digits required in the password. After 1420 * setting this, the user will not be able to enter a new password that is 1421 * not at least as restrictive as what has been set. Note that the current 1422 * password will remain until the user has set a new one, so the change does 1423 * not take place immediately. To prompt the user for a new password, use 1424 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 1425 * constraint is only imposed if the administrator has also requested 1426 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 1427 * default value is 1. 1428 * <p> 1429 * The calling device admin must have requested 1430 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1431 * this method; if it has not, a security exception will be thrown. 1432 * 1433 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1434 * with. 1435 * @param length The new desired minimum number of numerical digits required 1436 * in the password. A value of 0 means there is no restriction. 1437 */ 1438 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) { 1439 if (mService != null) { 1440 try { 1441 mService.setPasswordMinimumNumeric(admin, length, mParentInstance); 1442 } catch (RemoteException e) { 1443 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1444 } 1445 } 1446 } 1447 1448 /** 1449 * Retrieve the current number of numerical digits required in the password 1450 * for all admins of this user and its profiles or a particular one. 1451 * This is the same value as set by 1452 * {#link {@link #setPasswordMinimumNumeric(ComponentName, int)} 1453 * and only applies when the password quality is 1454 * {@link #PASSWORD_QUALITY_COMPLEX}. 1455 * 1456 * @param admin The name of the admin component to check, or {@code null} to 1457 * aggregate all admins. 1458 * @return The minimum number of numerical digits required in the password. 1459 */ 1460 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) { 1461 return getPasswordMinimumNumeric(admin, myUserId()); 1462 } 1463 1464 /** @hide per-user version */ 1465 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) { 1466 if (mService != null) { 1467 try { 1468 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance); 1469 } catch (RemoteException e) { 1470 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1471 } 1472 } 1473 return 0; 1474 } 1475 1476 /** 1477 * Called by an application that is administering the device to set the 1478 * minimum number of symbols required in the password. After setting this, 1479 * the user will not be able to enter a new password that is not at least as 1480 * restrictive as what has been set. Note that the current password will 1481 * remain until the user has set a new one, so the change does not take 1482 * place immediately. To prompt the user for a new password, use 1483 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 1484 * constraint is only imposed if the administrator has also requested 1485 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 1486 * default value is 1. 1487 * <p> 1488 * The calling device admin must have requested 1489 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1490 * this method; if it has not, a security exception will be thrown. 1491 * 1492 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1493 * with. 1494 * @param length The new desired minimum number of symbols required in the 1495 * password. A value of 0 means there is no restriction. 1496 */ 1497 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) { 1498 if (mService != null) { 1499 try { 1500 mService.setPasswordMinimumSymbols(admin, length, mParentInstance); 1501 } catch (RemoteException e) { 1502 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1503 } 1504 } 1505 } 1506 1507 /** 1508 * Retrieve the current number of symbols required in the password for all 1509 * admins or a particular one. This is the same value as 1510 * set by {#link {@link #setPasswordMinimumSymbols(ComponentName, int)} 1511 * and only applies when the password quality is 1512 * {@link #PASSWORD_QUALITY_COMPLEX}. 1513 * 1514 * @param admin The name of the admin component to check, or {@code null} to 1515 * aggregate all admins. 1516 * @return The minimum number of symbols required in the password. 1517 */ 1518 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) { 1519 return getPasswordMinimumSymbols(admin, myUserId()); 1520 } 1521 1522 /** @hide per-user version */ 1523 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) { 1524 if (mService != null) { 1525 try { 1526 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance); 1527 } catch (RemoteException e) { 1528 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1529 } 1530 } 1531 return 0; 1532 } 1533 1534 /** 1535 * Called by an application that is administering the device to set the 1536 * minimum number of non-letter characters (numerical digits or symbols) 1537 * required in the password. After setting this, the user will not be able 1538 * to enter a new password that is not at least as restrictive as what has 1539 * been set. Note that the current password will remain until the user has 1540 * set a new one, so the change does not take place immediately. To prompt 1541 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} after 1542 * setting this value. This constraint is only imposed if the administrator 1543 * has also requested {@link #PASSWORD_QUALITY_COMPLEX} with 1544 * {@link #setPasswordQuality}. The default value is 0. 1545 * <p> 1546 * The calling device admin must have requested 1547 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1548 * this method; if it has not, a security exception will be thrown. 1549 * 1550 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1551 * with. 1552 * @param length The new desired minimum number of letters required in the 1553 * password. A value of 0 means there is no restriction. 1554 */ 1555 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) { 1556 if (mService != null) { 1557 try { 1558 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance); 1559 } catch (RemoteException e) { 1560 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1561 } 1562 } 1563 } 1564 1565 /** 1566 * Retrieve the current number of non-letter characters required in the 1567 * password for all admins of this user and its profiles or a particular one. 1568 * This is the same value as set by 1569 * {#link {@link #setPasswordMinimumNonLetter(ComponentName, int)} 1570 * and only applies when the password quality is 1571 * {@link #PASSWORD_QUALITY_COMPLEX}. 1572 * 1573 * @param admin The name of the admin component to check, or {@code null} to 1574 * aggregate all admins. 1575 * @return The minimum number of letters required in the password. 1576 */ 1577 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) { 1578 return getPasswordMinimumNonLetter(admin, myUserId()); 1579 } 1580 1581 /** @hide per-user version */ 1582 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) { 1583 if (mService != null) { 1584 try { 1585 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance); 1586 } catch (RemoteException e) { 1587 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1588 } 1589 } 1590 return 0; 1591 } 1592 1593 /** 1594 * Called by an application that is administering the device to set the length 1595 * of the password history. After setting this, the user will not be able to 1596 * enter a new password that is the same as any password in the history. Note 1597 * that the current password will remain until the user has set a new one, so 1598 * the change does not take place immediately. To prompt the user for a new 1599 * password, use {@link #ACTION_SET_NEW_PASSWORD} after setting this value. 1600 * This constraint is only imposed if the administrator has also requested 1601 * either {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} 1602 * {@link #PASSWORD_QUALITY_ALPHABETIC}, or {@link #PASSWORD_QUALITY_ALPHANUMERIC} 1603 * with {@link #setPasswordQuality}. 1604 * 1605 * <p> 1606 * The calling device admin must have requested 1607 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this 1608 * method; if it has not, a security exception will be thrown. 1609 * 1610 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1611 * with. 1612 * @param length The new desired length of password history. A value of 0 1613 * means there is no restriction. 1614 */ 1615 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) { 1616 if (mService != null) { 1617 try { 1618 mService.setPasswordHistoryLength(admin, length, mParentInstance); 1619 } catch (RemoteException e) { 1620 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1621 } 1622 } 1623 } 1624 1625 /** 1626 * Called by a device admin to set the password expiration timeout. Calling this method 1627 * will restart the countdown for password expiration for the given admin, as will changing 1628 * the device password (for all admins). 1629 * 1630 * <p>The provided timeout is the time delta in ms and will be added to the current time. 1631 * For example, to have the password expire 5 days from now, timeout would be 1632 * 5 * 86400 * 1000 = 432000000 ms for timeout. 1633 * 1634 * <p>To disable password expiration, a value of 0 may be used for timeout. 1635 * 1636 * <p>The calling device admin must have requested 1637 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this 1638 * method; if it has not, a security exception will be thrown. 1639 * 1640 * <p> Note that setting the password will automatically reset the expiration time for all 1641 * active admins. Active admins do not need to explicitly call this method in that case. 1642 * 1643 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1644 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 1645 * means there is no restriction (unlimited). 1646 */ 1647 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) { 1648 if (mService != null) { 1649 try { 1650 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance); 1651 } catch (RemoteException e) { 1652 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1653 } 1654 } 1655 } 1656 1657 /** 1658 * Get the password expiration timeout for the given admin. The expiration timeout is the 1659 * recurring expiration timeout provided in the call to 1660 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the 1661 * aggregate of all policy administrators if {@code admin} is null. 1662 * 1663 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins. 1664 * @return The timeout for the given admin or the minimum of all timeouts 1665 */ 1666 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) { 1667 if (mService != null) { 1668 try { 1669 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance); 1670 } catch (RemoteException e) { 1671 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1672 } 1673 } 1674 return 0; 1675 } 1676 1677 /** 1678 * Get the current password expiration time for the given admin or an aggregate of 1679 * all admins of this user and its profiles if admin is null. If the password is 1680 * expired, this will return the time since the password expired as a negative number. 1681 * If admin is null, then a composite of all expiration timeouts is returned 1682 * - which will be the minimum of all timeouts. 1683 * 1684 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins. 1685 * @return The password expiration time, in ms. 1686 */ 1687 public long getPasswordExpiration(@Nullable ComponentName admin) { 1688 if (mService != null) { 1689 try { 1690 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance); 1691 } catch (RemoteException e) { 1692 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1693 } 1694 } 1695 return 0; 1696 } 1697 1698 /** 1699 * Retrieve the current password history length for all admins of this 1700 * user and its profiles or a particular one. 1701 * @param admin The name of the admin component to check, or {@code null} to aggregate 1702 * all admins. 1703 * @return The length of the password history 1704 */ 1705 public int getPasswordHistoryLength(@Nullable ComponentName admin) { 1706 return getPasswordHistoryLength(admin, myUserId()); 1707 } 1708 1709 /** @hide per-user version */ 1710 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) { 1711 if (mService != null) { 1712 try { 1713 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance); 1714 } catch (RemoteException e) { 1715 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1716 } 1717 } 1718 return 0; 1719 } 1720 1721 /** 1722 * Return the maximum password length that the device supports for a 1723 * particular password quality. 1724 * @param quality The quality being interrogated. 1725 * @return Returns the maximum length that the user can enter. 1726 */ 1727 public int getPasswordMaximumLength(int quality) { 1728 // Kind-of arbitrary. 1729 return 16; 1730 } 1731 1732 /** 1733 * Determine whether the current password the user has set is sufficient 1734 * to meet the policy requirements (quality, minimum length) that have been 1735 * requested by the admins of this user and its profiles. 1736 * 1737 * <p>The calling device admin must have requested 1738 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1739 * this method; if it has not, a security exception will be thrown. 1740 * 1741 * @return Returns true if the password meets the current requirements, else false. 1742 */ 1743 public boolean isActivePasswordSufficient() { 1744 if (mService != null) { 1745 try { 1746 return mService.isActivePasswordSufficient(myUserId(), mParentInstance); 1747 } catch (RemoteException e) { 1748 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1749 } 1750 } 1751 return false; 1752 } 1753 1754 /** 1755 * Retrieve the number of times the user has failed at entering a 1756 * password since that last successful password entry. 1757 * 1758 * <p>The calling device admin must have requested 1759 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call 1760 * this method; if it has not, a security exception will be thrown. 1761 */ 1762 public int getCurrentFailedPasswordAttempts() { 1763 if (mService != null) { 1764 try { 1765 return mService.getCurrentFailedPasswordAttempts(myUserId(), mParentInstance); 1766 } catch (RemoteException e) { 1767 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1768 } 1769 } 1770 return -1; 1771 } 1772 1773 /** 1774 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set. 1775 * 1776 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set. 1777 * @hide 1778 */ 1779 public boolean getDoNotAskCredentialsOnBoot() { 1780 if (mService != null) { 1781 try { 1782 return mService.getDoNotAskCredentialsOnBoot(); 1783 } catch (RemoteException e) { 1784 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1785 } 1786 } 1787 return false; 1788 } 1789 1790 /** 1791 * Setting this to a value greater than zero enables a built-in policy 1792 * that will perform a device wipe after too many incorrect 1793 * device-unlock passwords have been entered. This built-in policy combines 1794 * watching for failed passwords and wiping the device, and requires 1795 * that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and 1796 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}. 1797 * 1798 * <p>To implement any other policy (e.g. wiping data for a particular 1799 * application only, erasing or revoking credentials, or reporting the 1800 * failure to a server), you should implement 1801 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} 1802 * instead. Do not use this API, because if the maximum count is reached, 1803 * the device will be wiped immediately, and your callback will not be invoked. 1804 * 1805 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1806 * @param num The number of failed password attempts at which point the 1807 * device will wipe its data. 1808 */ 1809 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) { 1810 if (mService != null) { 1811 try { 1812 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance); 1813 } catch (RemoteException e) { 1814 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1815 } 1816 } 1817 } 1818 1819 /** 1820 * Retrieve the current maximum number of login attempts that are allowed 1821 * before the device wipes itself, for all admins of this user and its profiles 1822 * or a particular one. 1823 * @param admin The name of the admin component to check, or {@code null} to aggregate 1824 * all admins. 1825 */ 1826 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) { 1827 return getMaximumFailedPasswordsForWipe(admin, myUserId()); 1828 } 1829 1830 /** @hide per-user version */ 1831 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) { 1832 if (mService != null) { 1833 try { 1834 return mService.getMaximumFailedPasswordsForWipe( 1835 admin, userHandle, mParentInstance); 1836 } catch (RemoteException e) { 1837 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1838 } 1839 } 1840 return 0; 1841 } 1842 1843 /** 1844 * Returns the profile with the smallest maximum failed passwords for wipe, 1845 * for the given user. So for primary user, it might return the primary or 1846 * a managed profile. For a secondary user, it would be the same as the 1847 * user passed in. 1848 * @hide Used only by Keyguard 1849 */ 1850 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) { 1851 if (mService != null) { 1852 try { 1853 return mService.getProfileWithMinimumFailedPasswordsForWipe( 1854 userHandle, mParentInstance); 1855 } catch (RemoteException e) { 1856 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1857 } 1858 } 1859 return UserHandle.USER_NULL; 1860 } 1861 1862 /** 1863 * Flag for {@link #resetPassword}: don't allow other admins to change 1864 * the password again until the user has entered it. 1865 */ 1866 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001; 1867 1868 /** 1869 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot. 1870 * If the flag is set, the device can be booted without asking for user password. 1871 * The absence of this flag does not change the current boot requirements. This flag 1872 * can be set by the device owner only. If the app is not the device owner, the flag 1873 * is ignored. Once the flag is set, it cannot be reverted back without resetting the 1874 * device to factory defaults. 1875 */ 1876 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002; 1877 1878 /** 1879 * Force a new device unlock password (the password needed to access the 1880 * entire device, not for individual accounts) on the user. This takes 1881 * effect immediately. 1882 * 1883 * <p>Calling this from a managed profile that shares the password with the owner profile 1884 * will throw a security exception. 1885 * 1886 * <p><em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for 1887 * device admins that are not device owner and not profile owner. 1888 * The password can now only be changed if there is currently no password set. Device owner 1889 * and profile owner can still do this.</em> 1890 * 1891 * <p>The given password must be sufficient for the 1892 * current password quality and length constraints as returned by 1893 * {@link #getPasswordQuality(ComponentName)} and 1894 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet 1895 * these constraints, then it will be rejected and false returned. Note 1896 * that the password may be a stronger quality (containing alphanumeric 1897 * characters when the requested quality is only numeric), in which case 1898 * the currently active quality will be increased to match. 1899 * 1900 * <p>Calling with a null or empty password will clear any existing PIN, 1901 * pattern or password if the current password constraints allow it. <em>Note: This will not 1902 * work in {@link android.os.Build.VERSION_CODES#N} and later for device admins that are not 1903 * device owner and not profile owner. Once set, the password cannot be changed to null or 1904 * empty, except by device owner or profile owner.</em> 1905 * 1906 * <p>The calling device admin must have requested 1907 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call 1908 * this method; if it has not, a security exception will be thrown. 1909 * 1910 * @param password The new password for the user. Null or empty clears the password. 1911 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and 1912 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}. 1913 * @return Returns true if the password was applied, or false if it is 1914 * not acceptable for the current constraints or if the user has not been decrypted yet. 1915 */ 1916 public boolean resetPassword(String password, int flags) { 1917 if (mParentInstance) { 1918 throw new SecurityException("Reset password does not work across profiles."); 1919 } 1920 if (mService != null) { 1921 try { 1922 return mService.resetPassword(password, flags); 1923 } catch (RemoteException e) { 1924 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1925 } 1926 } 1927 return false; 1928 } 1929 1930 /** 1931 * Called by an application that is administering the device to set the 1932 * maximum time for user activity until the device will lock. This limits 1933 * the length that the user can set. It takes effect immediately. 1934 * 1935 * <p>The calling device admin must have requested 1936 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call 1937 * this method; if it has not, a security exception will be thrown. 1938 * 1939 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1940 * @param timeMs The new desired maximum time to lock in milliseconds. 1941 * A value of 0 means there is no restriction. 1942 */ 1943 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) { 1944 if (mService != null) { 1945 try { 1946 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance); 1947 } catch (RemoteException e) { 1948 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1949 } 1950 } 1951 } 1952 1953 /** 1954 * Retrieve the current maximum time to unlock for all admins of this user 1955 * and its profiles or a particular one. 1956 * @param admin The name of the admin component to check, or {@code null} to aggregate 1957 * all admins. 1958 * @return time in milliseconds for the given admin or the minimum value (strictest) of 1959 * all admins if admin is null. Returns 0 if there are no restrictions. 1960 */ 1961 public long getMaximumTimeToLock(@Nullable ComponentName admin) { 1962 return getMaximumTimeToLock(admin, myUserId()); 1963 } 1964 1965 /** @hide per-user version */ 1966 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) { 1967 if (mService != null) { 1968 try { 1969 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance); 1970 } catch (RemoteException e) { 1971 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1972 } 1973 } 1974 return 0; 1975 } 1976 1977 /** 1978 * Make the device lock immediately, as if the lock screen timeout has 1979 * expired at the point of this call. 1980 * 1981 * <p>The calling device admin must have requested 1982 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call 1983 * this method; if it has not, a security exception will be thrown. 1984 */ 1985 public void lockNow() { 1986 if (mService != null) { 1987 try { 1988 mService.lockNow(mParentInstance); 1989 } catch (RemoteException e) { 1990 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 1991 } 1992 } 1993 } 1994 1995 /** 1996 * Flag for {@link #wipeData(int)}: also erase the device's external 1997 * storage (such as SD cards). 1998 */ 1999 public static final int WIPE_EXTERNAL_STORAGE = 0x0001; 2000 2001 /** 2002 * Flag for {@link #wipeData(int)}: also erase the factory reset protection 2003 * data. 2004 * 2005 * <p>This flag may only be set by device owner admins; if it is set by 2006 * other admins a {@link SecurityException} will be thrown. 2007 */ 2008 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002; 2009 2010 /** 2011 * Ask the user data be wiped. Wiping the primary user will cause the 2012 * device to reboot, erasing all user data while next booting up. 2013 * 2014 * <p>The calling device admin must have requested 2015 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to be able to call 2016 * this method; if it has not, a security exception will be thrown. 2017 * 2018 * @param flags Bit mask of additional options: currently supported flags 2019 * are {@link #WIPE_EXTERNAL_STORAGE} and 2020 * {@link #WIPE_RESET_PROTECTION_DATA}. 2021 */ 2022 public void wipeData(int flags) { 2023 if (mService != null) { 2024 try { 2025 mService.wipeData(flags); 2026 } catch (RemoteException e) { 2027 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2028 } 2029 } 2030 } 2031 2032 /** 2033 * Called by an application that is administering the device to set the 2034 * global proxy and exclusion list. 2035 * <p> 2036 * The calling device admin must have requested 2037 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call 2038 * this method; if it has not, a security exception will be thrown. 2039 * Only the first device admin can set the proxy. If a second admin attempts 2040 * to set the proxy, the {@link ComponentName} of the admin originally setting the 2041 * proxy will be returned. If successful in setting the proxy, {@code null} will 2042 * be returned. 2043 * The method can be called repeatedly by the device admin alrady setting the 2044 * proxy to update the proxy and exclusion list. 2045 * 2046 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2047 * @param proxySpec the global proxy desired. Must be an HTTP Proxy. 2048 * Pass Proxy.NO_PROXY to reset the proxy. 2049 * @param exclusionList a list of domains to be excluded from the global proxy. 2050 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName} 2051 * of the device admin that sets the proxy. 2052 * @hide 2053 */ 2054 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec, 2055 List<String> exclusionList ) { 2056 if (proxySpec == null) { 2057 throw new NullPointerException(); 2058 } 2059 if (mService != null) { 2060 try { 2061 String hostSpec; 2062 String exclSpec; 2063 if (proxySpec.equals(Proxy.NO_PROXY)) { 2064 hostSpec = null; 2065 exclSpec = null; 2066 } else { 2067 if (!proxySpec.type().equals(Proxy.Type.HTTP)) { 2068 throw new IllegalArgumentException(); 2069 } 2070 InetSocketAddress sa = (InetSocketAddress)proxySpec.address(); 2071 String hostName = sa.getHostName(); 2072 int port = sa.getPort(); 2073 StringBuilder hostBuilder = new StringBuilder(); 2074 hostSpec = hostBuilder.append(hostName) 2075 .append(":").append(Integer.toString(port)).toString(); 2076 if (exclusionList == null) { 2077 exclSpec = ""; 2078 } else { 2079 StringBuilder listBuilder = new StringBuilder(); 2080 boolean firstDomain = true; 2081 for (String exclDomain : exclusionList) { 2082 if (!firstDomain) { 2083 listBuilder = listBuilder.append(","); 2084 } else { 2085 firstDomain = false; 2086 } 2087 listBuilder = listBuilder.append(exclDomain.trim()); 2088 } 2089 exclSpec = listBuilder.toString(); 2090 } 2091 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec) 2092 != android.net.Proxy.PROXY_VALID) 2093 throw new IllegalArgumentException(); 2094 } 2095 return mService.setGlobalProxy(admin, hostSpec, exclSpec); 2096 } catch (RemoteException e) { 2097 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2098 } 2099 } 2100 return null; 2101 } 2102 2103 /** 2104 * Set a network-independent global HTTP proxy. This is not normally what you want 2105 * for typical HTTP proxies - they are generally network dependent. However if you're 2106 * doing something unusual like general internal filtering this may be useful. On 2107 * a private network where the proxy is not accessible, you may break HTTP using this. 2108 * 2109 * <p>This method requires the caller to be the device owner. 2110 * 2111 * <p>This proxy is only a recommendation and it is possible that some apps will ignore it. 2112 * @see ProxyInfo 2113 * 2114 * @param admin Which {@link DeviceAdminReceiver} this request is associated 2115 * with. 2116 * @param proxyInfo The a {@link ProxyInfo} object defining the new global 2117 * HTTP proxy. A {@code null} value will clear the global HTTP proxy. 2118 */ 2119 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo 2120 proxyInfo) { 2121 if (mService != null) { 2122 try { 2123 mService.setRecommendedGlobalProxy(admin, proxyInfo); 2124 } catch (RemoteException e) { 2125 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2126 } 2127 } 2128 } 2129 2130 /** 2131 * Returns the component name setting the global proxy. 2132 * @return ComponentName object of the device admin that set the global proxy, or {@code null} 2133 * if no admin has set the proxy. 2134 * @hide 2135 */ 2136 public ComponentName getGlobalProxyAdmin() { 2137 if (mService != null) { 2138 try { 2139 return mService.getGlobalProxyAdmin(myUserId()); 2140 } catch (RemoteException e) { 2141 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2142 } 2143 } 2144 return null; 2145 } 2146 2147 /** 2148 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 2149 * indicating that encryption is not supported. 2150 */ 2151 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0; 2152 2153 /** 2154 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 2155 * indicating that encryption is supported, but is not currently active. 2156 */ 2157 public static final int ENCRYPTION_STATUS_INACTIVE = 1; 2158 2159 /** 2160 * Result code for {@link #getStorageEncryptionStatus}: 2161 * indicating that encryption is not currently active, but is currently 2162 * being activated. This is only reported by devices that support 2163 * encryption of data and only when the storage is currently 2164 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data 2165 * to become encrypted will never return this value. 2166 */ 2167 public static final int ENCRYPTION_STATUS_ACTIVATING = 2; 2168 2169 /** 2170 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 2171 * indicating that encryption is active. 2172 */ 2173 public static final int ENCRYPTION_STATUS_ACTIVE = 3; 2174 2175 /** 2176 * Result code for {@link #getStorageEncryptionStatus}: 2177 * indicating that encryption is active, but an encryption key has not 2178 * been set by the user. 2179 */ 2180 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4; 2181 2182 /** 2183 * Activity action: begin the process of encrypting data on the device. This activity should 2184 * be launched after using {@link #setStorageEncryption} to request encryption be activated. 2185 * After resuming from this activity, use {@link #getStorageEncryption} 2186 * to check encryption status. However, on some devices this activity may never return, as 2187 * it may trigger a reboot and in some cases a complete data wipe of the device. 2188 */ 2189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 2190 public static final String ACTION_START_ENCRYPTION 2191 = "android.app.action.START_ENCRYPTION"; 2192 2193 /** 2194 * Widgets are enabled in keyguard 2195 */ 2196 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0; 2197 2198 /** 2199 * Disable all keyguard widgets. Has no effect. 2200 */ 2201 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0; 2202 2203 /** 2204 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password) 2205 */ 2206 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1; 2207 2208 /** 2209 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password) 2210 */ 2211 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2; 2212 2213 /** 2214 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password) 2215 */ 2216 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3; 2217 2218 /** 2219 * Ignore trust agent state on secure keyguard screens 2220 * (e.g. PIN/Pattern/Password). 2221 */ 2222 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4; 2223 2224 /** 2225 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password). 2226 */ 2227 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5; 2228 2229 /** 2230 * Disable all current and future keyguard customizations. 2231 */ 2232 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff; 2233 2234 /** 2235 * Called by an application that is administering the device to 2236 * request that the storage system be encrypted. 2237 * 2238 * <p>When multiple device administrators attempt to control device 2239 * encryption, the most secure, supported setting will always be 2240 * used. If any device administrator requests device encryption, 2241 * it will be enabled; Conversely, if a device administrator 2242 * attempts to disable device encryption while another 2243 * device administrator has enabled it, the call to disable will 2244 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}). 2245 * 2246 * <p>This policy controls encryption of the secure (application data) storage area. Data 2247 * written to other storage areas may or may not be encrypted, and this policy does not require 2248 * or control the encryption of any other storage areas. 2249 * There is one exception: If {@link android.os.Environment#isExternalStorageEmulated()} is 2250 * {@code true}, then the directory returned by 2251 * {@link android.os.Environment#getExternalStorageDirectory()} must be written to disk 2252 * within the encrypted storage area. 2253 * 2254 * <p>Important Note: On some devices, it is possible to encrypt storage without requiring 2255 * the user to create a device PIN or Password. In this case, the storage is encrypted, but 2256 * the encryption key may not be fully secured. For maximum security, the administrator should 2257 * also require (and check for) a pattern, PIN, or password. 2258 * 2259 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2260 * @param encrypt true to request encryption, false to release any previous request 2261 * @return the new request status (for all active admins) - will be one of 2262 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or 2263 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use 2264 * {@link #getStorageEncryptionStatus()} to query the actual device state. 2265 */ 2266 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) { 2267 if (mService != null) { 2268 try { 2269 return mService.setStorageEncryption(admin, encrypt); 2270 } catch (RemoteException e) { 2271 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2272 } 2273 } 2274 return ENCRYPTION_STATUS_UNSUPPORTED; 2275 } 2276 2277 /** 2278 * Called by an application that is administering the device to 2279 * determine the requested setting for secure storage. 2280 * 2281 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null, 2282 * this will return the requested encryption setting as an aggregate of all active 2283 * administrators. 2284 * @return true if the admin(s) are requesting encryption, false if not. 2285 */ 2286 public boolean getStorageEncryption(@Nullable ComponentName admin) { 2287 if (mService != null) { 2288 try { 2289 return mService.getStorageEncryption(admin, myUserId()); 2290 } catch (RemoteException e) { 2291 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2292 } 2293 } 2294 return false; 2295 } 2296 2297 /** 2298 * Called by an application that is administering the device to 2299 * determine the current encryption status of the device. 2300 * 2301 * Depending on the returned status code, the caller may proceed in different 2302 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the 2303 * storage system does not support encryption. If the 2304 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link 2305 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the 2306 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the 2307 * storage system has enabled encryption but no password is set so further action 2308 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or 2309 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required. 2310 * 2311 * @return current status of encryption. The value will be one of 2312 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, 2313 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, 2314 * or {@link #ENCRYPTION_STATUS_ACTIVE}. 2315 */ 2316 public int getStorageEncryptionStatus() { 2317 return getStorageEncryptionStatus(myUserId()); 2318 } 2319 2320 /** @hide per-user version */ 2321 public int getStorageEncryptionStatus(int userHandle) { 2322 if (mService != null) { 2323 try { 2324 return mService.getStorageEncryptionStatus(userHandle); 2325 } catch (RemoteException e) { 2326 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2327 } 2328 } 2329 return ENCRYPTION_STATUS_UNSUPPORTED; 2330 } 2331 2332 /** 2333 * Installs the given certificate as a user CA. 2334 * 2335 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 2336 * {@code null} if calling from a delegated certificate installer. 2337 * @param certBuffer encoded form of the certificate to install. 2338 * 2339 * @return false if the certBuffer cannot be parsed or installation is 2340 * interrupted, true otherwise. 2341 */ 2342 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) { 2343 if (mService != null) { 2344 try { 2345 return mService.installCaCert(admin, certBuffer); 2346 } catch (RemoteException e) { 2347 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2348 } 2349 } 2350 return false; 2351 } 2352 2353 /** 2354 * Uninstalls the given certificate from trusted user CAs, if present. 2355 * 2356 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 2357 * {@code null} if calling from a delegated certificate installer. 2358 * @param certBuffer encoded form of the certificate to remove. 2359 */ 2360 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) { 2361 if (mService != null) { 2362 try { 2363 final String alias = getCaCertAlias(certBuffer); 2364 mService.uninstallCaCerts(admin, new String[] {alias}); 2365 } catch (CertificateException e) { 2366 Log.w(TAG, "Unable to parse certificate", e); 2367 } catch (RemoteException e) { 2368 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2369 } 2370 } 2371 } 2372 2373 /** 2374 * Returns all CA certificates that are currently trusted, excluding system CA certificates. 2375 * If a user has installed any certificates by other means than device policy these will be 2376 * included too. 2377 * 2378 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 2379 * {@code null} if calling from a delegated certificate installer. 2380 * @return a List of byte[] arrays, each encoding one user CA certificate. 2381 */ 2382 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) { 2383 List<byte[]> certs = new ArrayList<byte[]>(); 2384 if (mService != null) { 2385 try { 2386 mService.enforceCanManageCaCerts(admin); 2387 final TrustedCertificateStore certStore = new TrustedCertificateStore(); 2388 for (String alias : certStore.userAliases()) { 2389 try { 2390 certs.add(certStore.getCertificate(alias).getEncoded()); 2391 } catch (CertificateException ce) { 2392 Log.w(TAG, "Could not encode certificate: " + alias, ce); 2393 } 2394 } 2395 } catch (RemoteException re) { 2396 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 2397 } 2398 } 2399 return certs; 2400 } 2401 2402 /** 2403 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by 2404 * means other than device policy will also be removed, except for system CA certificates. 2405 * 2406 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 2407 * {@code null} if calling from a delegated certificate installer. 2408 */ 2409 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) { 2410 if (mService != null) { 2411 try { 2412 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases() 2413 .toArray(new String[0])); 2414 } catch (RemoteException re) { 2415 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 2416 } 2417 } 2418 } 2419 2420 /** 2421 * Returns whether this certificate is installed as a trusted CA. 2422 * 2423 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 2424 * {@code null} if calling from a delegated certificate installer. 2425 * @param certBuffer encoded form of the certificate to look up. 2426 */ 2427 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) { 2428 if (mService != null) { 2429 try { 2430 mService.enforceCanManageCaCerts(admin); 2431 return getCaCertAlias(certBuffer) != null; 2432 } catch (RemoteException re) { 2433 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 2434 } catch (CertificateException ce) { 2435 Log.w(TAG, "Could not parse certificate", ce); 2436 } 2437 } 2438 return false; 2439 } 2440 2441 /** 2442 * Called by a device or profile owner to install a certificate and private key pair. The 2443 * keypair will be visible to all apps within the profile. 2444 * 2445 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 2446 * {@code null} if calling from a delegated certificate installer. 2447 * @param privKey The private key to install. 2448 * @param cert The certificate to install. 2449 * @param alias The private key alias under which to install the certificate. If a certificate 2450 * with that alias already exists, it will be overwritten. 2451 * @return {@code true} if the keys were installed, {@code false} otherwise. 2452 */ 2453 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey, 2454 @NonNull Certificate cert, @NonNull String alias) { 2455 try { 2456 final byte[] pemCert = Credentials.convertToPem(cert); 2457 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm()) 2458 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded(); 2459 return mService.installKeyPair(admin, pkcs8Key, pemCert, alias); 2460 } catch (RemoteException e) { 2461 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2462 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) { 2463 Log.w(TAG, "Failed to obtain private key material", e); 2464 } catch (CertificateException | IOException e) { 2465 Log.w(TAG, "Could not pem-encode certificate", e); 2466 } 2467 return false; 2468 } 2469 2470 /** 2471 * Called by a device or profile owner to remove all user credentials installed under a given 2472 * alias. 2473 * 2474 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 2475 * {@code null} if calling from a delegated certificate installer. 2476 * @param alias The private key alias under which the certificate is installed. 2477 * @return {@code true} if the keys were both removed, {@code false} otherwise. 2478 */ 2479 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) { 2480 try { 2481 return mService.removeKeyPair(admin, alias); 2482 } catch (RemoteException e) { 2483 Log.w(TAG, "Failed talking with device policy service", e); 2484 } 2485 return false; 2486 } 2487 2488 /** 2489 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it 2490 * doesn't exist. 2491 */ 2492 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException { 2493 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509"); 2494 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate( 2495 new ByteArrayInputStream(certBuffer)); 2496 return new TrustedCertificateStore().getCertificateAlias(cert); 2497 } 2498 2499 /** 2500 * Called by a profile owner or device owner to grant access to privileged certificate 2501 * manipulation APIs to a third-party certificate installer app. Granted APIs include 2502 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert}, 2503 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}. 2504 * <p> 2505 * Delegated certificate installer is a per-user state. The delegated access is persistent until 2506 * it is later cleared by calling this method with a null value or uninstallling the certificate 2507 * installer. 2508 * 2509 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2510 * @param installerPackage The package name of the certificate installer which will be given 2511 * access. If {@code null} is given the current package will be cleared. 2512 */ 2513 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String 2514 installerPackage) throws SecurityException { 2515 if (mService != null) { 2516 try { 2517 mService.setCertInstallerPackage(admin, installerPackage); 2518 } catch (RemoteException e) { 2519 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2520 } 2521 } 2522 } 2523 2524 /** 2525 * Called by a profile owner or device owner to retrieve the certificate installer for the 2526 * user. null if none is set. 2527 * 2528 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2529 * @return The package name of the current delegated certificate installer, or {@code null} 2530 * if none is set. 2531 */ 2532 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException { 2533 if (mService != null) { 2534 try { 2535 return mService.getCertInstallerPackage(admin); 2536 } catch (RemoteException e) { 2537 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2538 } 2539 } 2540 return null; 2541 } 2542 2543 /** 2544 * Called by a device or profile owner to configure an always-on VPN connection through a 2545 * specific application for the current user. 2546 * This connection is automatically granted and persisted after a reboot. 2547 * 2548 * <p>The designated package should declare a {@link android.net.VpnService} in its 2549 * manifest guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, 2550 * otherwise the call will fail. 2551 * 2552 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} 2553 * to remove an existing always-on VPN configuration. 2554 * 2555 * @return {@code true} if the package is set as always-on VPN controller; 2556 * {@code false} otherwise. 2557 */ 2558 public boolean setAlwaysOnVpnPackage(@NonNull ComponentName admin, 2559 @Nullable String vpnPackage) { 2560 if (mService != null) { 2561 try { 2562 return mService.setAlwaysOnVpnPackage(admin, vpnPackage); 2563 } catch (RemoteException e) { 2564 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2565 } 2566 } 2567 return false; 2568 } 2569 2570 /** 2571 * Called by a device or profile owner to read the name of the package administering an 2572 * always-on VPN connection for the current user. 2573 * If there is no such package, or the always-on VPN is provided by the system instead 2574 * of by an application, {@code null} will be returned. 2575 * 2576 * @return Package name of VPN controller responsible for always-on VPN, 2577 * or {@code null} if none is set. 2578 */ 2579 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) { 2580 if (mService != null) { 2581 try { 2582 return mService.getAlwaysOnVpnPackage(admin); 2583 } catch (RemoteException e) { 2584 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2585 } 2586 } 2587 return null; 2588 } 2589 2590 /** 2591 * Called by an application that is administering the device to disable all cameras 2592 * on the device, for this user. After setting this, no applications running as this user 2593 * will be able to access any cameras on the device. 2594 * 2595 * <p>If the caller is device owner, then the restriction will be applied to all users. 2596 * 2597 * <p>The calling device admin must have requested 2598 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call 2599 * this method; if it has not, a security exception will be thrown. 2600 * 2601 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2602 * @param disabled Whether or not the camera should be disabled. 2603 */ 2604 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) { 2605 if (mService != null) { 2606 try { 2607 mService.setCameraDisabled(admin, disabled); 2608 } catch (RemoteException e) { 2609 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2610 } 2611 } 2612 } 2613 2614 /** 2615 * Determine whether or not the device's cameras have been disabled for this user, 2616 * either by the calling admin, if specified, or all admins. 2617 * @param admin The name of the admin component to check, or {@code null} to check whether any admins 2618 * have disabled the camera 2619 */ 2620 public boolean getCameraDisabled(@Nullable ComponentName admin) { 2621 return getCameraDisabled(admin, myUserId()); 2622 } 2623 2624 /** @hide per-user version */ 2625 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) { 2626 if (mService != null) { 2627 try { 2628 return mService.getCameraDisabled(admin, userHandle); 2629 } catch (RemoteException e) { 2630 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2631 } 2632 } 2633 return false; 2634 } 2635 2636 /** 2637 * Called by a device owner to request a bugreport. 2638 * 2639 * <p>There must be only one user on the device, managed by the device owner. 2640 * Otherwise a security exception will be thrown. 2641 * 2642 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2643 * @return {@code true} if the bugreport collection started successfully, or {@code false} 2644 * if it wasn't triggered because a previous bugreport operation is still active 2645 * (either the bugreport is still running or waiting for the user to share or decline) 2646 */ 2647 public boolean requestBugreport(@NonNull ComponentName admin) { 2648 if (mService != null) { 2649 try { 2650 return mService.requestBugreport(admin); 2651 } catch (RemoteException e) { 2652 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2653 } 2654 } 2655 return false; 2656 } 2657 2658 /** 2659 * Determine whether or not creating a guest user has been disabled for the device 2660 * 2661 * @hide 2662 */ 2663 public boolean getGuestUserDisabled(@Nullable ComponentName admin) { 2664 // Currently guest users can always be created if multi-user is enabled 2665 // TODO introduce a policy for guest user creation 2666 return false; 2667 } 2668 2669 /** 2670 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling 2671 * screen capture also prevents the content from being shown on display devices that do not have 2672 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about 2673 * secure surfaces and secure displays. 2674 * 2675 * <p>The calling device admin must be a device or profile owner. If it is not, a 2676 * security exception will be thrown. 2677 * 2678 * <p>From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also 2679 * blocks assist requests for all activities of the relevant user. 2680 * 2681 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2682 * @param disabled Whether screen capture is disabled or not. 2683 */ 2684 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) { 2685 if (mService != null) { 2686 try { 2687 mService.setScreenCaptureDisabled(admin, disabled); 2688 } catch (RemoteException e) { 2689 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2690 } 2691 } 2692 } 2693 2694 /** 2695 * Determine whether or not screen capture has been disabled by the calling 2696 * admin, if specified, or all admins. 2697 * @param admin The name of the admin component to check, or {@code null} to check whether any admins 2698 * have disabled screen capture. 2699 */ 2700 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) { 2701 return getScreenCaptureDisabled(admin, myUserId()); 2702 } 2703 2704 /** @hide per-user version */ 2705 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) { 2706 if (mService != null) { 2707 try { 2708 return mService.getScreenCaptureDisabled(admin, userHandle); 2709 } catch (RemoteException e) { 2710 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2711 } 2712 } 2713 return false; 2714 } 2715 2716 /** 2717 * Called by a device owner to set whether auto time is required. If auto time is 2718 * required the user cannot set the date and time, but has to use network date and time. 2719 * 2720 * <p>Note: if auto time is required the user can still manually set the time zone. 2721 * 2722 * <p>The calling device admin must be a device owner. If it is not, a security exception will 2723 * be thrown. 2724 * 2725 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2726 * @param required Whether auto time is set required or not. 2727 */ 2728 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) { 2729 if (mService != null) { 2730 try { 2731 mService.setAutoTimeRequired(admin, required); 2732 } catch (RemoteException e) { 2733 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2734 } 2735 } 2736 } 2737 2738 /** 2739 * @return true if auto time is required. 2740 */ 2741 public boolean getAutoTimeRequired() { 2742 if (mService != null) { 2743 try { 2744 return mService.getAutoTimeRequired(); 2745 } catch (RemoteException e) { 2746 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2747 } 2748 } 2749 return false; 2750 } 2751 2752 /** 2753 * Called by an application that is administering the device to disable keyguard customizations, 2754 * such as widgets. After setting this, keyguard features will be disabled according to the 2755 * provided feature list. 2756 * 2757 * <p>The calling device admin must have requested 2758 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call 2759 * this method; if it has not, a security exception will be thrown. 2760 * 2761 * <p>Calling this from a managed profile before version 2762 * {@link android.os.Build.VERSION_CODES#M} will throw a security exception. 2763 * 2764 * <p>From version {@link android.os.Build.VERSION_CODES#M} a profile owner can set: 2765 * <ul> 2766 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, {@link #KEYGUARD_DISABLE_FINGERPRINT} 2767 * these will affect the profile's parent user. 2768 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} this will affect notifications 2769 * generated by applications in the managed profile. 2770 * </ul> 2771 * <p>Requests to disable other features on a managed profile will be ignored. The admin 2772 * can check which features have been disabled by calling 2773 * {@link #getKeyguardDisabledFeatures(ComponentName)} 2774 * 2775 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2776 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default), 2777 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA}, 2778 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, 2779 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_FINGERPRINT}, 2780 * {@link #KEYGUARD_DISABLE_FEATURES_ALL} 2781 */ 2782 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) { 2783 if (mService != null) { 2784 try { 2785 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance); 2786 } catch (RemoteException e) { 2787 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2788 } 2789 } 2790 } 2791 2792 /** 2793 * Determine whether or not features have been disabled in keyguard either by the calling 2794 * admin, if specified, or all admins. 2795 * @param admin The name of the admin component to check, or {@code null} to check whether any 2796 * admins have disabled features in keyguard. 2797 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)} 2798 * for a list. 2799 */ 2800 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) { 2801 return getKeyguardDisabledFeatures(admin, myUserId()); 2802 } 2803 2804 /** @hide per-user version */ 2805 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) { 2806 if (mService != null) { 2807 try { 2808 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance); 2809 } catch (RemoteException e) { 2810 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2811 } 2812 } 2813 return KEYGUARD_DISABLE_FEATURES_NONE; 2814 } 2815 2816 /** 2817 * @hide 2818 */ 2819 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing, 2820 int userHandle) { 2821 if (mService != null) { 2822 try { 2823 mService.setActiveAdmin(policyReceiver, refreshing, userHandle); 2824 } catch (RemoteException e) { 2825 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2826 } 2827 } 2828 } 2829 2830 /** 2831 * @hide 2832 */ 2833 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) { 2834 setActiveAdmin(policyReceiver, refreshing, myUserId()); 2835 } 2836 2837 /** 2838 * Returns the DeviceAdminInfo as defined by the administrator's package info & meta-data 2839 * @hide 2840 */ 2841 public DeviceAdminInfo getAdminInfo(@NonNull ComponentName cn) { 2842 ActivityInfo ai; 2843 try { 2844 ai = mContext.getPackageManager().getReceiverInfo(cn, 2845 PackageManager.GET_META_DATA); 2846 } catch (PackageManager.NameNotFoundException e) { 2847 Log.w(TAG, "Unable to retrieve device policy " + cn, e); 2848 return null; 2849 } 2850 2851 ResolveInfo ri = new ResolveInfo(); 2852 ri.activityInfo = ai; 2853 2854 try { 2855 return new DeviceAdminInfo(mContext, ri); 2856 } catch (XmlPullParserException | IOException e) { 2857 Log.w(TAG, "Unable to parse device policy " + cn, e); 2858 return null; 2859 } 2860 } 2861 2862 /** 2863 * @hide 2864 */ 2865 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) { 2866 if (mService != null) { 2867 try { 2868 mService.getRemoveWarning(admin, result, myUserId()); 2869 } catch (RemoteException e) { 2870 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2871 } 2872 } 2873 } 2874 2875 /** 2876 * @hide 2877 */ 2878 public void setActivePasswordState(int quality, int length, int letters, int uppercase, 2879 int lowercase, int numbers, int symbols, int nonletter, int userHandle) { 2880 if (mService != null) { 2881 try { 2882 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase, 2883 numbers, symbols, nonletter, userHandle); 2884 } catch (RemoteException e) { 2885 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2886 } 2887 } 2888 } 2889 2890 /** 2891 * @hide 2892 */ 2893 public void reportFailedPasswordAttempt(int userHandle) { 2894 if (mService != null) { 2895 try { 2896 mService.reportFailedPasswordAttempt(userHandle); 2897 } catch (RemoteException e) { 2898 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2899 } 2900 } 2901 } 2902 2903 /** 2904 * @hide 2905 */ 2906 public void reportSuccessfulPasswordAttempt(int userHandle) { 2907 if (mService != null) { 2908 try { 2909 mService.reportSuccessfulPasswordAttempt(userHandle); 2910 } catch (RemoteException e) { 2911 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 2912 } 2913 } 2914 } 2915 2916 /** 2917 * @hide 2918 * Sets the given package as the device owner. 2919 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name. 2920 * @param who the component name to be registered as device owner. 2921 * @return whether the package was successfully registered as the device owner. 2922 * @throws IllegalArgumentException if the package name is null or invalid 2923 * @throws IllegalStateException If the preconditions mentioned are not met. 2924 */ 2925 public boolean setDeviceOwner(ComponentName who) { 2926 return setDeviceOwner(who, null); 2927 } 2928 2929 /** 2930 * @hide 2931 */ 2932 public boolean setDeviceOwner(ComponentName who, int userId) { 2933 return setDeviceOwner(who, null, userId); 2934 } 2935 2936 /** 2937 * @hide 2938 */ 2939 public boolean setDeviceOwner(ComponentName who, String ownerName) { 2940 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM); 2941 } 2942 2943 /** 2944 * @hide 2945 * Sets the given package as the device owner. The package must already be installed. There 2946 * must not already be a device owner. 2947 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call 2948 * this method. 2949 * Calling this after the setup phase of the primary user has completed is allowed only if 2950 * the caller is the shell uid, and there are no additional users and no accounts. 2951 * @param who the component name to be registered as device owner. 2952 * @param ownerName the human readable name of the institution that owns this device. 2953 * @param userId ID of the user on which the device owner runs. 2954 * @return whether the package was successfully registered as the device owner. 2955 * @throws IllegalArgumentException if the package name is null or invalid 2956 * @throws IllegalStateException If the preconditions mentioned are not met. 2957 */ 2958 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId) 2959 throws IllegalArgumentException, IllegalStateException { 2960 if (mService != null) { 2961 try { 2962 return mService.setDeviceOwner(who, ownerName, userId); 2963 } catch (RemoteException re) { 2964 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 2965 } 2966 } 2967 return false; 2968 } 2969 2970 /** 2971 * Used to determine if a particular package has been registered as a Device Owner app. 2972 * A device owner app is a special device admin that cannot be deactivated by the user, once 2973 * activated as a device admin. It also cannot be uninstalled. To check whether a particular 2974 * package is currently registered as the device owner app, pass in the package name from 2975 * {@link Context#getPackageName()} to this method.<p/>This is useful for device 2976 * admin apps that want to check whether they are also registered as the device owner app. The 2977 * exact mechanism by which a device admin app is registered as a device owner app is defined by 2978 * the setup process. 2979 * @param packageName the package name of the app, to compare with the registered device owner 2980 * app, if any. 2981 * @return whether or not the package is registered as the device owner app. 2982 */ 2983 public boolean isDeviceOwnerApp(String packageName) { 2984 return isDeviceOwnerAppOnCallingUser(packageName); 2985 } 2986 2987 /** 2988 * @return true if a package is registered as device owner, only when it's running on the 2989 * calling user. 2990 * 2991 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity. 2992 * @hide 2993 */ 2994 public boolean isDeviceOwnerAppOnCallingUser(String packageName) { 2995 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true); 2996 } 2997 2998 /** 2999 * @return true if a package is registered as device owner, even if it's running on a different 3000 * user. 3001 * 3002 * <p>Requires the MANAGE_USERS permission. 3003 * 3004 * @hide 3005 */ 3006 public boolean isDeviceOwnerAppOnAnyUser(String packageName) { 3007 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false); 3008 } 3009 3010 /** 3011 * @return device owner component name, only when it's running on the calling user. 3012 * 3013 * @hide 3014 */ 3015 public ComponentName getDeviceOwnerComponentOnCallingUser() { 3016 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true); 3017 } 3018 3019 /** 3020 * @return device owner component name, even if it's running on a different user. 3021 * 3022 * <p>Requires the MANAGE_USERS permission. 3023 * 3024 * @hide 3025 */ 3026 public ComponentName getDeviceOwnerComponentOnAnyUser() { 3027 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false); 3028 } 3029 3030 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) { 3031 if (packageName == null) { 3032 return false; 3033 } 3034 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly); 3035 if (deviceOwner == null) { 3036 return false; 3037 } 3038 return packageName.equals(deviceOwner.getPackageName()); 3039 } 3040 3041 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) { 3042 if (mService != null) { 3043 try { 3044 return mService.getDeviceOwnerComponent(callingUserOnly); 3045 } catch (RemoteException re) { 3046 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3047 } 3048 } 3049 return null; 3050 } 3051 3052 /** 3053 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's 3054 * no device owner. 3055 * 3056 * <p>Requires the MANAGE_USERS permission. 3057 * 3058 * @hide 3059 */ 3060 public int getDeviceOwnerUserId() { 3061 if (mService != null) { 3062 try { 3063 return mService.getDeviceOwnerUserId(); 3064 } catch (RemoteException re) { 3065 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3066 } 3067 } 3068 return UserHandle.USER_NULL; 3069 } 3070 3071 /** 3072 * Clears the current device owner. The caller must be the device owner. 3073 * 3074 * This function should be used cautiously as once it is called it cannot 3075 * be undone. The device owner can only be set as a part of device setup 3076 * before setup completes. 3077 * 3078 * @param packageName The package name of the device owner. 3079 */ 3080 public void clearDeviceOwnerApp(String packageName) { 3081 if (mService != null) { 3082 try { 3083 mService.clearDeviceOwner(packageName); 3084 } catch (RemoteException re) { 3085 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3086 } 3087 } 3088 } 3089 3090 /** 3091 * Returns the device owner package name, only if it's running on the calling user. 3092 * 3093 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity. 3094 * 3095 * @hide 3096 */ 3097 @SystemApi 3098 public String getDeviceOwner() { 3099 final ComponentName name = getDeviceOwnerComponentOnCallingUser(); 3100 return name != null ? name.getPackageName() : null; 3101 } 3102 3103 /** 3104 * @return true if the device is managed by any device owner. 3105 * 3106 * <p>Requires the MANAGE_USERS permission. 3107 * 3108 * @hide 3109 */ 3110 public boolean isDeviceManaged() { 3111 return getDeviceOwnerComponentOnAnyUser() != null; 3112 } 3113 3114 /** 3115 * Returns the device owner name. Note this method *will* return the device owner 3116 * name when it's running on a different user. 3117 * 3118 * <p>Requires the MANAGE_USERS permission. 3119 * 3120 * @hide 3121 */ 3122 @SystemApi 3123 public String getDeviceOwnerNameOnAnyUser() { 3124 if (mService != null) { 3125 try { 3126 return mService.getDeviceOwnerName(); 3127 } catch (RemoteException re) { 3128 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3129 } 3130 } 3131 return null; 3132 } 3133 3134 /** 3135 * @hide 3136 * @deprecated Do not use 3137 * @removed 3138 */ 3139 @Deprecated 3140 @SystemApi 3141 public String getDeviceInitializerApp() { 3142 return null; 3143 } 3144 3145 /** 3146 * @hide 3147 * @deprecated Do not use 3148 * @removed 3149 */ 3150 @Deprecated 3151 @SystemApi 3152 public ComponentName getDeviceInitializerComponent() { 3153 return null; 3154 } 3155 3156 /** 3157 * @hide 3158 * @deprecated Use #ACTION_SET_PROFILE_OWNER 3159 * Sets the given component as an active admin and registers the package as the profile 3160 * owner for this user. The package must already be installed and there shouldn't be 3161 * an existing profile owner registered for this user. Also, this method must be called 3162 * before the user setup has been completed. 3163 * <p> 3164 * This method can only be called by system apps that hold MANAGE_USERS permission and 3165 * MANAGE_DEVICE_ADMINS permission. 3166 * @param admin The component to register as an active admin and profile owner. 3167 * @param ownerName The user-visible name of the entity that is managing this user. 3168 * @return whether the admin was successfully registered as the profile owner. 3169 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or 3170 * the user has already been set up. 3171 */ 3172 @SystemApi 3173 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName) 3174 throws IllegalArgumentException { 3175 if (mService != null) { 3176 try { 3177 final int myUserId = myUserId(); 3178 mService.setActiveAdmin(admin, false, myUserId); 3179 return mService.setProfileOwner(admin, ownerName, myUserId); 3180 } catch (RemoteException re) { 3181 throw new IllegalArgumentException("Couldn't set profile owner.", re); 3182 } 3183 } 3184 return false; 3185 } 3186 3187 /** 3188 * @hide 3189 * Clears the active profile owner and removes all user restrictions. The caller must 3190 * be from the same package as the active profile owner for this user, otherwise a 3191 * SecurityException will be thrown. 3192 * 3193 * @param admin The component to remove as the profile owner. 3194 * @return 3195 */ 3196 @SystemApi 3197 public void clearProfileOwner(@NonNull ComponentName admin) { 3198 if (mService != null) { 3199 try { 3200 mService.clearProfileOwner(admin); 3201 } catch (RemoteException re) { 3202 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3203 } 3204 } 3205 } 3206 3207 /** 3208 * @hide 3209 * Checks whether the user was already setup. 3210 */ 3211 public boolean hasUserSetupCompleted() { 3212 if (mService != null) { 3213 try { 3214 return mService.hasUserSetupCompleted(); 3215 } catch (RemoteException re) { 3216 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3217 } 3218 } 3219 return true; 3220 } 3221 3222 /** 3223 * @hide 3224 * Sets the given component as the profile owner of the given user profile. The package must 3225 * already be installed. There must not already be a profile owner for this user. 3226 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call 3227 * this method. 3228 * Calling this after the setup phase of the specified user has completed is allowed only if: 3229 * - the caller is SYSTEM_UID. 3230 * - or the caller is the shell uid, and there are no accounts on the specified user. 3231 * @param admin the component name to be registered as profile owner. 3232 * @param ownerName the human readable name of the organisation associated with this DPM. 3233 * @param userHandle the userId to set the profile owner for. 3234 * @return whether the component was successfully registered as the profile owner. 3235 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the 3236 * preconditions mentioned are not met. 3237 */ 3238 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName, 3239 int userHandle) throws IllegalArgumentException { 3240 if (mService != null) { 3241 try { 3242 if (ownerName == null) { 3243 ownerName = ""; 3244 } 3245 return mService.setProfileOwner(admin, ownerName, userHandle); 3246 } catch (RemoteException re) { 3247 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3248 throw new IllegalArgumentException("Couldn't set profile owner.", re); 3249 } 3250 } 3251 return false; 3252 } 3253 3254 /** 3255 * Sets the device owner information to be shown on the lock screen. 3256 * 3257 * <p>If the device owner information is {@code null} or empty then the device owner info is 3258 * cleared and the user owner info is shown on the lock screen if it is set. 3259 * <p>If the device owner information contains only whitespaces then the message on the lock 3260 * screen will be blank and the user will not be allowed to change it. 3261 * 3262 * @param admin The name of the admin component to check. 3263 * @param info Device owner information which will be displayed instead of the user 3264 * owner info. 3265 * @return Whether the device owner information has been set. 3266 */ 3267 public boolean setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, String info) { 3268 if (mService != null) { 3269 try { 3270 return mService.setDeviceOwnerLockScreenInfo(admin, info); 3271 } catch (RemoteException re) { 3272 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3273 } 3274 } 3275 return false; 3276 } 3277 3278 /** 3279 * @return The device owner information. If it is not set returns {@code null}. 3280 */ 3281 public String getDeviceOwnerLockScreenInfo() { 3282 if (mService != null) { 3283 try { 3284 return mService.getDeviceOwnerLockScreenInfo(); 3285 } catch (RemoteException re) { 3286 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3287 } 3288 } 3289 return null; 3290 } 3291 3292 /** 3293 * Called by device or profile owners for setting the package suspended for this user. 3294 * A suspended package will not be started by the package manager, its notifications will 3295 * be hidden and it will not show up in recents. The package must already be installed. 3296 * 3297 * @param admin The name of the admin component to check. 3298 * @param packageName The package name of the app to suspend or unsuspend. 3299 * @param suspended If set to {@code true} than the package will be suspended, if set to 3300 * {@code false} the package will be unsuspended. 3301 * @return boolean {@code true} if the operation was successfully performed, {@code false} 3302 * otherwise. 3303 */ 3304 public boolean setPackageSuspended(@NonNull ComponentName admin, String packageName, 3305 boolean suspended) { 3306 if (mService != null) { 3307 try { 3308 return mService.setPackageSuspended(admin, packageName, suspended); 3309 } catch (RemoteException re) { 3310 Log.w(TAG, "Failed talking with device policy service", re); 3311 } 3312 } 3313 return false; 3314 } 3315 3316 /** 3317 * Called by device or profile owners to determine if a package is suspended. 3318 * 3319 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3320 * @param packageName The name of the package to retrieve the suspended status of. 3321 * @return boolean {@code true} if the package is suspended, {@code false} otherwise. 3322 */ 3323 public boolean getPackageSuspended(@NonNull ComponentName admin, String packageName) { 3324 if (mService != null) { 3325 try { 3326 return mService.getPackageSuspended(admin, packageName); 3327 } catch (RemoteException e) { 3328 Log.w(TAG, "Failed talking with device policy service", e); 3329 } 3330 } 3331 return false; 3332 } 3333 3334 /** 3335 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to 3336 * be used. Only the profile owner can call this. 3337 * 3338 * @see #isProfileOwnerApp 3339 * 3340 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3341 */ 3342 public void setProfileEnabled(@NonNull ComponentName admin) { 3343 if (mService != null) { 3344 try { 3345 mService.setProfileEnabled(admin); 3346 } catch (RemoteException e) { 3347 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3348 } 3349 } 3350 } 3351 3352 /** 3353 * Sets the name of the profile. In the device owner case it sets the name of the user 3354 * which it is called from. Only a profile owner or device owner can call this. If this is 3355 * never called by the profile or device owner, the name will be set to default values. 3356 * 3357 * @see #isProfileOwnerApp 3358 * @see #isDeviceOwnerApp 3359 * 3360 * @param admin Which {@link DeviceAdminReceiver} this request is associate with. 3361 * @param profileName The name of the profile. 3362 */ 3363 public void setProfileName(@NonNull ComponentName admin, String profileName) { 3364 if (mService != null) { 3365 try { 3366 mService.setProfileName(admin, profileName); 3367 } catch (RemoteException e) { 3368 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3369 } 3370 } 3371 } 3372 3373 /** 3374 * Used to determine if a particular package is registered as the profile owner for the 3375 * user. A profile owner is a special device admin that has additional privileges 3376 * within the profile. 3377 * 3378 * @param packageName The package name of the app to compare with the registered profile owner. 3379 * @return Whether or not the package is registered as the profile owner. 3380 */ 3381 public boolean isProfileOwnerApp(String packageName) { 3382 if (mService != null) { 3383 try { 3384 ComponentName profileOwner = mService.getProfileOwner( 3385 Process.myUserHandle().getIdentifier()); 3386 return profileOwner != null 3387 && profileOwner.getPackageName().equals(packageName); 3388 } catch (RemoteException re) { 3389 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3390 } 3391 } 3392 return false; 3393 } 3394 3395 /** 3396 * @hide 3397 * @return the packageName of the owner of the given user profile or {@code null} if no profile 3398 * owner has been set for that user. 3399 * @throws IllegalArgumentException if the userId is invalid. 3400 */ 3401 @SystemApi 3402 public ComponentName getProfileOwner() throws IllegalArgumentException { 3403 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier()); 3404 } 3405 3406 /** 3407 * @see #getProfileOwner() 3408 * @hide 3409 */ 3410 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException { 3411 if (mService != null) { 3412 try { 3413 return mService.getProfileOwner(userId); 3414 } catch (RemoteException re) { 3415 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3416 throw new IllegalArgumentException( 3417 "Requested profile owner for invalid userId", re); 3418 } 3419 } 3420 return null; 3421 } 3422 3423 /** 3424 * @hide 3425 * @return the human readable name of the organisation associated with this DPM or {@code null} 3426 * if one is not set. 3427 * @throws IllegalArgumentException if the userId is invalid. 3428 */ 3429 public String getProfileOwnerName() throws IllegalArgumentException { 3430 if (mService != null) { 3431 try { 3432 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier()); 3433 } catch (RemoteException re) { 3434 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3435 throw new IllegalArgumentException( 3436 "Requested profile owner for invalid userId", re); 3437 } 3438 } 3439 return null; 3440 } 3441 3442 /** 3443 * @hide 3444 * @param userId The user for whom to fetch the profile owner name, if any. 3445 * @return the human readable name of the organisation associated with this profile owner or 3446 * null if one is not set. 3447 * @throws IllegalArgumentException if the userId is invalid. 3448 */ 3449 @SystemApi 3450 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException { 3451 if (mService != null) { 3452 try { 3453 return mService.getProfileOwnerName(userId); 3454 } catch (RemoteException re) { 3455 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 3456 throw new IllegalArgumentException( 3457 "Requested profile owner for invalid userId", re); 3458 } 3459 } 3460 return null; 3461 } 3462 3463 /** 3464 * Called by a profile owner or device owner to add a default intent handler activity for 3465 * intents that match a certain intent filter. This activity will remain the default intent 3466 * handler even if the set of potential event handlers for the intent filter changes and if 3467 * the intent preferences are reset. 3468 * 3469 * <p>The default disambiguation mechanism takes over if the activity is not installed 3470 * (anymore). When the activity is (re)installed, it is automatically reset as default 3471 * intent handler for the filter. 3472 * 3473 * <p>The calling device admin must be a profile owner or device owner. If it is not, a 3474 * security exception will be thrown. 3475 * 3476 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3477 * @param filter The IntentFilter for which a default handler is added. 3478 * @param activity The Activity that is added as default intent handler. 3479 */ 3480 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter, 3481 @NonNull ComponentName activity) { 3482 if (mService != null) { 3483 try { 3484 mService.addPersistentPreferredActivity(admin, filter, activity); 3485 } catch (RemoteException e) { 3486 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3487 } 3488 } 3489 } 3490 3491 /** 3492 * Called by a profile owner or device owner to remove all persistent intent handler preferences 3493 * associated with the given package that were set by {@link #addPersistentPreferredActivity}. 3494 * 3495 * <p>The calling device admin must be a profile owner. If it is not, a security 3496 * exception will be thrown. 3497 * 3498 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3499 * @param packageName The name of the package for which preferences are removed. 3500 */ 3501 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin, 3502 String packageName) { 3503 if (mService != null) { 3504 try { 3505 mService.clearPackagePersistentPreferredActivities(admin, packageName); 3506 } catch (RemoteException e) { 3507 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3508 } 3509 } 3510 } 3511 3512 /** 3513 * Called by a profile owner or device owner to grant permission to a package to manage 3514 * application restrictions for the calling user via {@link #setApplicationRestrictions} and 3515 * {@link #getApplicationRestrictions}. 3516 * <p> 3517 * This permission is persistent until it is later cleared by calling this method with a 3518 * {@code null} value or uninstalling the managing package. 3519 * 3520 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3521 * @param packageName The package name which will be given access to application restrictions 3522 * APIs. If {@code null} is given the current package will be cleared. 3523 */ 3524 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin, 3525 @Nullable String packageName) { 3526 if (mService != null) { 3527 try { 3528 mService.setApplicationRestrictionsManagingPackage(admin, packageName); 3529 } catch (RemoteException e) { 3530 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3531 } 3532 } 3533 } 3534 3535 /** 3536 * Called by a profile owner or device owner to retrieve the application restrictions managing 3537 * package for the current user, or {@code null} if none is set. 3538 * 3539 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3540 * @return The package name allowed to manage application restrictions on the current user, or 3541 * {@code null} if none is set. 3542 */ 3543 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) { 3544 if (mService != null) { 3545 try { 3546 return mService.getApplicationRestrictionsManagingPackage(admin); 3547 } catch (RemoteException e) { 3548 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3549 } 3550 } 3551 return null; 3552 } 3553 3554 /** 3555 * Returns {@code true} if the calling package has been granted permission via 3556 * {@link #setApplicationRestrictionsManagingPackage} to manage application 3557 * restrictions for the calling user. 3558 */ 3559 public boolean isCallerApplicationRestrictionsManagingPackage() { 3560 if (mService != null) { 3561 try { 3562 return mService.isCallerApplicationRestrictionsManagingPackage(); 3563 } catch (RemoteException e) { 3564 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3565 } 3566 } 3567 return false; 3568 } 3569 3570 /** 3571 * Sets the application restrictions for a given target application running in the calling user. 3572 * 3573 * <p>The caller must be a profile or device owner on that user, or the package allowed to 3574 * manage application restrictions via {@link #setApplicationRestrictionsManagingPackage}; 3575 * otherwise a security exception will be thrown. 3576 * 3577 * <p>The provided {@link Bundle} consists of key-value pairs, where the types of values may be: 3578 * <ul> 3579 * <li>{@code boolean} 3580 * <li>{@code int} 3581 * <li>{@code String} or {@code String[]} 3582 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]} 3583 * </ul> 3584 * 3585 * <p>If the restrictions are not available yet, but may be applied in the near future, 3586 * the caller can notify the target application of that by adding 3587 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter. 3588 * 3589 * <p>The application restrictions are only made visible to the target application via 3590 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or 3591 * device owner, and the application restrictions managing package via 3592 * {@link #getApplicationRestrictions}. 3593 * 3594 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 3595 * {@code null} if called by the application restrictions managing package. 3596 * @param packageName The name of the package to update restricted settings for. 3597 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new 3598 * set of active restrictions. 3599 * 3600 * @see #setApplicationRestrictionsManagingPackage 3601 * @see UserManager#KEY_RESTRICTIONS_PENDING 3602 */ 3603 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName, 3604 Bundle settings) { 3605 if (mService != null) { 3606 try { 3607 mService.setApplicationRestrictions(admin, packageName, settings); 3608 } catch (RemoteException e) { 3609 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3610 } 3611 } 3612 } 3613 3614 /** 3615 * Sets a list of configuration features to enable for a TrustAgent component. This is meant 3616 * to be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all 3617 * trust agents but those enabled by this function call. If flag 3618 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect. 3619 * 3620 * <p>The calling device admin must have requested 3621 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call 3622 * this method; if not, a security exception will be thrown. 3623 * 3624 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3625 * @param target Component name of the agent to be enabled. 3626 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent 3627 * will be strictly disabled according to the state of the 3628 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag. 3629 * <p>If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all admins, 3630 * then it's up to the TrustAgent itself to aggregate the values from all device admins. 3631 * <p>Consult documentation for the specific TrustAgent to determine legal options parameters. 3632 */ 3633 public void setTrustAgentConfiguration(@NonNull ComponentName admin, 3634 @NonNull ComponentName target, PersistableBundle configuration) { 3635 if (mService != null) { 3636 try { 3637 mService.setTrustAgentConfiguration(admin, target, configuration); 3638 } catch (RemoteException e) { 3639 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3640 } 3641 } 3642 } 3643 3644 /** 3645 * Gets configuration for the given trust agent based on aggregating all calls to 3646 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for 3647 * all device admins. 3648 * 3649 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null, 3650 * this function returns a list of configurations for all admins that declare 3651 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares 3652 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call 3653 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} 3654 * for this {@param agent} or calls it with a null configuration, null is returned. 3655 * @param agent Which component to get enabled features for. 3656 * @return configuration for the given trust agent. 3657 */ 3658 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin, 3659 @NonNull ComponentName agent) { 3660 return getTrustAgentConfiguration(admin, agent, myUserId()); 3661 } 3662 3663 /** @hide per-user version */ 3664 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin, 3665 @NonNull ComponentName agent, int userHandle) { 3666 if (mService != null) { 3667 try { 3668 return mService.getTrustAgentConfiguration(admin, agent, userHandle); 3669 } catch (RemoteException e) { 3670 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3671 } 3672 } 3673 return new ArrayList<PersistableBundle>(); // empty list 3674 } 3675 3676 /** 3677 * Called by a profile owner of a managed profile to set whether caller-Id information from 3678 * the managed profile will be shown in the parent profile, for incoming calls. 3679 * 3680 * <p>The calling device admin must be a profile owner. If it is not, a 3681 * security exception will be thrown. 3682 * 3683 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3684 * @param disabled If true caller-Id information in the managed profile is not displayed. 3685 */ 3686 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) { 3687 if (mService != null) { 3688 try { 3689 mService.setCrossProfileCallerIdDisabled(admin, disabled); 3690 } catch (RemoteException e) { 3691 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3692 } 3693 } 3694 } 3695 3696 /** 3697 * Called by a profile owner of a managed profile to determine whether or not caller-Id 3698 * information has been disabled. 3699 * 3700 * <p>The calling device admin must be a profile owner. If it is not, a 3701 * security exception will be thrown. 3702 * 3703 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3704 */ 3705 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) { 3706 if (mService != null) { 3707 try { 3708 return mService.getCrossProfileCallerIdDisabled(admin); 3709 } catch (RemoteException e) { 3710 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3711 } 3712 } 3713 return false; 3714 } 3715 3716 /** 3717 * Determine whether or not caller-Id information has been disabled. 3718 * 3719 * @param userHandle The user for whom to check the caller-id permission 3720 * @hide 3721 */ 3722 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) { 3723 if (mService != null) { 3724 try { 3725 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier()); 3726 } catch (RemoteException e) { 3727 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3728 } 3729 } 3730 return false; 3731 } 3732 3733 /** 3734 * Called by a profile owner of a managed profile to set whether contacts search from 3735 * the managed profile will be shown in the parent profile, for incoming calls. 3736 * 3737 * <p>The calling device admin must be a profile owner. If it is not, a 3738 * security exception will be thrown. 3739 * 3740 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3741 * @param disabled If true contacts search in the managed profile is not displayed. 3742 */ 3743 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin, 3744 boolean disabled) { 3745 if (mService != null) { 3746 try { 3747 mService.setCrossProfileContactsSearchDisabled(admin, disabled); 3748 } catch (RemoteException e) { 3749 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3750 } 3751 } 3752 } 3753 3754 /** 3755 * Called by a profile owner of a managed profile to determine whether or not contacts search 3756 * has been disabled. 3757 * 3758 * <p>The calling device admin must be a profile owner. If it is not, a 3759 * security exception will be thrown. 3760 * 3761 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3762 */ 3763 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) { 3764 if (mService != null) { 3765 try { 3766 return mService.getCrossProfileContactsSearchDisabled(admin); 3767 } catch (RemoteException e) { 3768 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3769 } 3770 } 3771 return false; 3772 } 3773 3774 3775 /** 3776 * Determine whether or not contacts search has been disabled. 3777 * 3778 * @param userHandle The user for whom to check the contacts search permission 3779 * @hide 3780 */ 3781 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) { 3782 if (mService != null) { 3783 try { 3784 return mService 3785 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier()); 3786 } catch (RemoteException e) { 3787 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3788 } 3789 } 3790 return false; 3791 } 3792 3793 /** 3794 * Start Quick Contact on the managed profile for the user, if the policy allows. 3795 * @hide 3796 */ 3797 public void startManagedQuickContact(String actualLookupKey, long actualContactId, 3798 long directoryId, Intent originalIntent) { 3799 if (mService != null) { 3800 try { 3801 mService.startManagedQuickContact( 3802 actualLookupKey, actualContactId, directoryId, originalIntent); 3803 } catch (RemoteException e) { 3804 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3805 } 3806 } 3807 } 3808 3809 /** 3810 * Start Quick Contact on the managed profile for the user, if the policy allows. 3811 * @hide 3812 */ 3813 public void startManagedQuickContact(String actualLookupKey, long actualContactId, 3814 Intent originalIntent) { 3815 startManagedQuickContact(actualLookupKey, actualContactId, Directory.DEFAULT, 3816 originalIntent); 3817 } 3818 3819 /** 3820 * Called by a profile owner of a managed profile to set whether bluetooth 3821 * devices can access enterprise contacts. 3822 * <p> 3823 * The calling device admin must be a profile owner. If it is not, a 3824 * security exception will be thrown. 3825 * <p> 3826 * This API works on managed profile only. 3827 * 3828 * @param admin Which {@link DeviceAdminReceiver} this request is associated 3829 * with. 3830 * @param disabled If true, bluetooth devices cannot access enterprise 3831 * contacts. 3832 */ 3833 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) { 3834 if (mService != null) { 3835 try { 3836 mService.setBluetoothContactSharingDisabled(admin, disabled); 3837 } catch (RemoteException e) { 3838 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3839 } 3840 } 3841 } 3842 3843 /** 3844 * Called by a profile owner of a managed profile to determine whether or 3845 * not Bluetooth devices cannot access enterprise contacts. 3846 * <p> 3847 * The calling device admin must be a profile owner. If it is not, a 3848 * security exception will be thrown. 3849 * <p> 3850 * This API works on managed profile only. 3851 * 3852 * @param admin Which {@link DeviceAdminReceiver} this request is associated 3853 * with. 3854 */ 3855 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) { 3856 if (mService != null) { 3857 try { 3858 return mService.getBluetoothContactSharingDisabled(admin); 3859 } catch (RemoteException e) { 3860 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3861 } 3862 } 3863 return true; 3864 } 3865 3866 /** 3867 * Determine whether or not Bluetooth devices cannot access contacts. 3868 * <p> 3869 * This API works on managed profile UserHandle only. 3870 * 3871 * @param userHandle The user for whom to check the caller-id permission 3872 * @hide 3873 */ 3874 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) { 3875 if (mService != null) { 3876 try { 3877 return mService.getBluetoothContactSharingDisabledForUser(userHandle 3878 .getIdentifier()); 3879 } catch (RemoteException e) { 3880 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3881 } 3882 } 3883 return true; 3884 } 3885 3886 /** 3887 * Called by the profile owner of a managed profile so that some intents sent in the managed 3888 * profile can also be resolved in the parent, or vice versa. 3889 * Only activity intents are supported. 3890 * 3891 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3892 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the 3893 * other profile 3894 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and 3895 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported. 3896 */ 3897 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) { 3898 if (mService != null) { 3899 try { 3900 mService.addCrossProfileIntentFilter(admin, filter, flags); 3901 } catch (RemoteException e) { 3902 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3903 } 3904 } 3905 } 3906 3907 /** 3908 * Called by a profile owner of a managed profile to remove the cross-profile intent filters 3909 * that go from the managed profile to the parent, or from the parent to the managed profile. 3910 * Only removes those that have been set by the profile owner. 3911 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3912 */ 3913 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) { 3914 if (mService != null) { 3915 try { 3916 mService.clearCrossProfileIntentFilters(admin); 3917 } catch (RemoteException e) { 3918 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3919 } 3920 } 3921 } 3922 3923 /** 3924 * Called by a profile or device owner to set the permitted accessibility services. When 3925 * set by a device owner or profile owner the restriction applies to all profiles of the 3926 * user the device owner or profile owner is an admin for. 3927 * 3928 * By default the user can use any accessiblity service. When zero or more packages have 3929 * been added, accessiblity services that are not in the list and not part of the system 3930 * can not be enabled by the user. 3931 * 3932 * <p> Calling with a null value for the list disables the restriction so that all services 3933 * can be used, calling with an empty list only allows the builtin system's services. 3934 * 3935 * <p> System accesibility services are always available to the user the list can't modify 3936 * this. 3937 * 3938 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3939 * @param packageNames List of accessibility service package names. 3940 * 3941 * @return true if setting the restriction succeeded. It fail if there is 3942 * one or more non-system accessibility services enabled, that are not in the list. 3943 */ 3944 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin, 3945 List<String> packageNames) { 3946 if (mService != null) { 3947 try { 3948 return mService.setPermittedAccessibilityServices(admin, packageNames); 3949 } catch (RemoteException e) { 3950 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3951 } 3952 } 3953 return false; 3954 } 3955 3956 /** 3957 * Returns the list of permitted accessibility services set by this device or profile owner. 3958 * 3959 * <p>An empty list means no accessibility services except system services are allowed. 3960 * Null means all accessibility services are allowed. 3961 * 3962 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3963 * @return List of accessiblity service package names. 3964 */ 3965 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) { 3966 if (mService != null) { 3967 try { 3968 return mService.getPermittedAccessibilityServices(admin); 3969 } catch (RemoteException e) { 3970 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3971 } 3972 } 3973 return null; 3974 } 3975 3976 /** 3977 * Returns the list of accessibility services permitted by the device or profiles 3978 * owners of this user. 3979 * 3980 * <p>Null means all accessibility services are allowed, if a non-null list is returned 3981 * it will contain the intersection of the permitted lists for any device or profile 3982 * owners that apply to this user. It will also include any system accessibility services. 3983 * 3984 * @param userId which user to check for. 3985 * @return List of accessiblity service package names. 3986 * @hide 3987 */ 3988 @SystemApi 3989 public List<String> getPermittedAccessibilityServices(int userId) { 3990 if (mService != null) { 3991 try { 3992 return mService.getPermittedAccessibilityServicesForUser(userId); 3993 } catch (RemoteException e) { 3994 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 3995 } 3996 } 3997 return null; 3998 } 3999 4000 /** 4001 * Called by a profile or device owner to set the permitted input methods services. When 4002 * set by a device owner or profile owner the restriction applies to all profiles of the 4003 * user the device owner or profile owner is an admin for. 4004 * 4005 * By default the user can use any input method. When zero or more packages have 4006 * been added, input method that are not in the list and not part of the system 4007 * can not be enabled by the user. 4008 * 4009 * This method will fail if it is called for a admin that is not for the foreground user 4010 * or a profile of the foreground user. 4011 * 4012 * <p> Calling with a null value for the list disables the restriction so that all input methods 4013 * can be used, calling with an empty list disables all but the system's own input methods. 4014 * 4015 * <p> System input methods are always available to the user this method can't modify this. 4016 * 4017 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4018 * @param packageNames List of input method package names. 4019 * @return true if setting the restriction succeeded. It will fail if there are 4020 * one or more non-system input methods currently enabled that are not in 4021 * the packageNames list. 4022 */ 4023 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) { 4024 if (mService != null) { 4025 try { 4026 return mService.setPermittedInputMethods(admin, packageNames); 4027 } catch (RemoteException e) { 4028 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4029 } 4030 } 4031 return false; 4032 } 4033 4034 4035 /** 4036 * Returns the list of permitted input methods set by this device or profile owner. 4037 * 4038 * <p>An empty list means no input methods except system input methods are allowed. 4039 * Null means all input methods are allowed. 4040 * 4041 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4042 * @return List of input method package names. 4043 */ 4044 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) { 4045 if (mService != null) { 4046 try { 4047 return mService.getPermittedInputMethods(admin); 4048 } catch (RemoteException e) { 4049 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4050 } 4051 } 4052 return null; 4053 } 4054 4055 /** 4056 * Returns the list of input methods permitted by the device or profiles 4057 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.) 4058 * 4059 * <p>Null means all input methods are allowed, if a non-null list is returned 4060 * it will contain the intersection of the permitted lists for any device or profile 4061 * owners that apply to this user. It will also include any system input methods. 4062 * 4063 * @return List of input method package names. 4064 * @hide 4065 */ 4066 @SystemApi 4067 public List<String> getPermittedInputMethodsForCurrentUser() { 4068 if (mService != null) { 4069 try { 4070 return mService.getPermittedInputMethodsForCurrentUser(); 4071 } catch (RemoteException e) { 4072 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4073 } 4074 } 4075 return null; 4076 } 4077 4078 /** 4079 * Called by a device owner to get the list of apps to keep around as APKs even if no user has 4080 * currently installed it. 4081 * 4082 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4083 * 4084 * @return List of package names to keep cached. 4085 * @hide 4086 */ 4087 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) { 4088 if (mService != null) { 4089 try { 4090 return mService.getKeepUninstalledPackages(admin); 4091 } catch (RemoteException e) { 4092 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4093 } 4094 } 4095 return null; 4096 } 4097 4098 /** 4099 * Called by a device owner to set a list of apps to keep around as APKs even if no user has 4100 * currently installed it. 4101 * 4102 * <p>Please note that setting this policy does not imply that specified apps will be 4103 * automatically pre-cached.</p> 4104 * 4105 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4106 * @param packageNames List of package names to keep cached. 4107 * @hide 4108 */ 4109 public void setKeepUninstalledPackages(@NonNull ComponentName admin, 4110 @NonNull List<String> packageNames) { 4111 if (mService != null) { 4112 try { 4113 mService.setKeepUninstalledPackages(admin, packageNames); 4114 } catch (RemoteException e) { 4115 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4116 } 4117 } 4118 } 4119 4120 /** 4121 * Called by a device owner to create a user with the specified name. The UserHandle returned 4122 * by this method should not be persisted as user handles are recycled as users are removed and 4123 * created. If you need to persist an identifier for this user, use 4124 * {@link UserManager#getSerialNumberForUser}. 4125 * 4126 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4127 * @param name the user's name 4128 * @see UserHandle 4129 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the 4130 * user could not be created. 4131 * 4132 * @deprecated From {@link android.os.Build.VERSION_CODES#M} 4133 */ 4134 @Deprecated 4135 public UserHandle createUser(@NonNull ComponentName admin, String name) { 4136 try { 4137 return mService.createUser(admin, name); 4138 } catch (RemoteException re) { 4139 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4140 } 4141 return null; 4142 } 4143 4144 /** 4145 * Called by a device owner to create a user with the specified name. The UserHandle returned 4146 * by this method should not be persisted as user handles are recycled as users are removed and 4147 * created. If you need to persist an identifier for this user, use 4148 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background 4149 * immediately. 4150 * 4151 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well 4152 * as registered as an active admin on the new user. The profile owner package will be 4153 * installed on the new user if it already is installed on the device. 4154 * 4155 * <p>If the optionalInitializeData is not null, then the extras will be passed to the 4156 * profileOwnerComponent when onEnable is called. 4157 * 4158 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4159 * @param name the user's name 4160 * @param ownerName the human readable name of the organisation associated with this DPM. 4161 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on 4162 * the user. 4163 * @param adminExtras Extras that will be passed to onEnable of the admin receiver 4164 * on the new user. 4165 * @see UserHandle 4166 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the 4167 * user could not be created. 4168 * 4169 * @deprecated From {@link android.os.Build.VERSION_CODES#M} 4170 */ 4171 @Deprecated 4172 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name, 4173 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) { 4174 try { 4175 return mService.createAndInitializeUser(admin, name, ownerName, profileOwnerComponent, 4176 adminExtras); 4177 } catch (RemoteException re) { 4178 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4179 } 4180 return null; 4181 } 4182 4183 /** 4184 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user. 4185 */ 4186 public static final int SKIP_SETUP_WIZARD = 0x0001; 4187 4188 /** 4189 * Called by a device owner to create a user with the specified name and a given component of 4190 * the calling package as profile owner. The UserHandle returned by this method should not be 4191 * persisted as user handles are recycled as users are removed and created. If you need to 4192 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new 4193 * user will not be started in the background. 4194 * 4195 * <p>admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also 4196 * a DeviceAdminReceiver in the same package as admin, and will become the profile owner and 4197 * will be registered as an active admin on the new user. The profile owner package will be 4198 * installed on the new user. 4199 * 4200 * <p>If the adminExtras are not null, they will be stored on the device until the user is 4201 * started for the first time. Then the extras will be passed to the admin when 4202 * onEnable is called. 4203 * 4204 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4205 * @param name The user's name. 4206 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the 4207 * same package as admin, otherwise no user is created and an IllegalArgumentException is 4208 * thrown. 4209 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new 4210 * user. 4211 * @param flags {@link #SKIP_SETUP_WIZARD} is supported. 4212 * @see UserHandle 4213 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the 4214 * user could not be created. 4215 */ 4216 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name, 4217 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras, 4218 int flags) { 4219 try { 4220 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags); 4221 } catch (RemoteException re) { 4222 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4223 } 4224 return null; 4225 } 4226 4227 /** 4228 * Called by a device owner to remove a user and all associated data. The primary user can 4229 * not be removed. 4230 * 4231 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4232 * @param userHandle the user to remove. 4233 * @return {@code true} if the user was removed, {@code false} otherwise. 4234 */ 4235 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) { 4236 try { 4237 return mService.removeUser(admin, userHandle); 4238 } catch (RemoteException re) { 4239 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4240 return false; 4241 } 4242 } 4243 4244 /** 4245 * Called by a device owner to switch the specified user to the foreground. 4246 * 4247 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4248 * @param userHandle the user to switch to; null will switch to primary. 4249 * @return {@code true} if the switch was successful, {@code false} otherwise. 4250 * 4251 * @see Intent#ACTION_USER_FOREGROUND 4252 */ 4253 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) { 4254 try { 4255 return mService.switchUser(admin, userHandle); 4256 } catch (RemoteException re) { 4257 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4258 return false; 4259 } 4260 } 4261 4262 /** 4263 * Retrieves the application restrictions for a given target application running in the calling 4264 * user. 4265 * 4266 * <p>The caller must be a profile or device owner on that user, or the package allowed to 4267 * manage application restrictions via {@link #setApplicationRestrictionsManagingPackage}; 4268 * otherwise a security exception will be thrown. 4269 * 4270 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or 4271 * {@code null} if called by the application restrictions managing package. 4272 * @param packageName The name of the package to fetch restricted settings of. 4273 * @return {@link Bundle} of settings corresponding to what was set last time 4274 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty {@link Bundle} 4275 * if no restrictions have been set. 4276 * 4277 * @see {@link #setApplicationRestrictionsManagingPackage} 4278 */ 4279 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) { 4280 if (mService != null) { 4281 try { 4282 return mService.getApplicationRestrictions(admin, packageName); 4283 } catch (RemoteException e) { 4284 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4285 } 4286 } 4287 return null; 4288 } 4289 4290 /** 4291 * Called by a profile or device owner to set a user restriction specified by the key. 4292 * <p> 4293 * The calling device admin must be a profile or device owner; if it is not, 4294 * a security exception will be thrown. 4295 * 4296 * @param admin Which {@link DeviceAdminReceiver} this request is associated 4297 * with. 4298 * @param key The key of the restriction. See the constants in 4299 * {@link android.os.UserManager} for the list of keys. 4300 */ 4301 public void addUserRestriction(@NonNull ComponentName admin, String key) { 4302 if (mService != null) { 4303 try { 4304 mService.setUserRestriction(admin, key, true); 4305 } catch (RemoteException e) { 4306 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4307 } 4308 } 4309 } 4310 4311 /** 4312 * Called by a profile or device owner to clear a user restriction specified by the key. 4313 * <p> 4314 * The calling device admin must be a profile or device owner; if it is not, 4315 * a security exception will be thrown. 4316 * 4317 * @param admin Which {@link DeviceAdminReceiver} this request is associated 4318 * with. 4319 * @param key The key of the restriction. See the constants in 4320 * {@link android.os.UserManager} for the list of keys. 4321 */ 4322 public void clearUserRestriction(@NonNull ComponentName admin, String key) { 4323 if (mService != null) { 4324 try { 4325 mService.setUserRestriction(admin, key, false); 4326 } catch (RemoteException e) { 4327 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4328 } 4329 } 4330 } 4331 4332 /** 4333 * Called by a profile or device owner to get user restrictions set with 4334 * {@link #addUserRestriction(ComponentName, String)}. 4335 * <p> 4336 * The target user may have more restrictions set by the system or other device owner / profile 4337 * owner. To get all the user restrictions currently set, use 4338 * {@link UserManager#getUserRestrictions()}. 4339 * 4340 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4341 * @throws SecurityException if the {@code admin} is not an active admin. 4342 */ 4343 public Bundle getUserRestrictions(@NonNull ComponentName admin) { 4344 return getUserRestrictions(admin, myUserId()); 4345 } 4346 4347 /** @hide per-user version */ 4348 public Bundle getUserRestrictions(@NonNull ComponentName admin, int userHandle) { 4349 Bundle ret = null; 4350 if (mService != null) { 4351 try { 4352 ret = mService.getUserRestrictions(admin, userHandle); 4353 } catch (RemoteException e) { 4354 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4355 } 4356 } 4357 return ret == null ? new Bundle() : ret; 4358 } 4359 4360 /** 4361 * Called by profile or device owners to hide or unhide packages. When a package is hidden it 4362 * is unavailable for use, but the data and actual package file remain. 4363 * 4364 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4365 * @param packageName The name of the package to hide or unhide. 4366 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be 4367 * unhidden. 4368 * @return boolean Whether the hidden setting of the package was successfully updated. 4369 */ 4370 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName, 4371 boolean hidden) { 4372 if (mService != null) { 4373 try { 4374 return mService.setApplicationHidden(admin, packageName, hidden); 4375 } catch (RemoteException e) { 4376 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4377 } 4378 } 4379 return false; 4380 } 4381 4382 /** 4383 * Called by profile or device owners to determine if a package is hidden. 4384 * 4385 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4386 * @param packageName The name of the package to retrieve the hidden status of. 4387 * @return boolean {@code true} if the package is hidden, {@code false} otherwise. 4388 */ 4389 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) { 4390 if (mService != null) { 4391 try { 4392 return mService.isApplicationHidden(admin, packageName); 4393 } catch (RemoteException e) { 4394 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4395 } 4396 } 4397 return false; 4398 } 4399 4400 /** 4401 * Called by profile or device owners to re-enable a system app that was disabled by default 4402 * when the user was initialized. 4403 * 4404 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4405 * @param packageName The package to be re-enabled in the calling profile. 4406 */ 4407 public void enableSystemApp(@NonNull ComponentName admin, String packageName) { 4408 if (mService != null) { 4409 try { 4410 mService.enableSystemApp(admin, packageName); 4411 } catch (RemoteException e) { 4412 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4413 } 4414 } 4415 } 4416 4417 /** 4418 * Called by profile or device owners to re-enable system apps by intent that were disabled 4419 * by default when the user was initialized. 4420 * 4421 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4422 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this 4423 * intent will be re-enabled in the calling profile. 4424 * @return int The number of activities that matched the intent and were installed. 4425 */ 4426 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) { 4427 if (mService != null) { 4428 try { 4429 return mService.enableSystemAppWithIntent(admin, intent); 4430 } catch (RemoteException e) { 4431 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4432 } 4433 } 4434 return 0; 4435 } 4436 4437 /** 4438 * Called by a device owner or profile owner to disable account management for a specific type 4439 * of account. 4440 * 4441 * <p>The calling device admin must be a device owner or profile owner. If it is not, a 4442 * security exception will be thrown. 4443 * 4444 * <p>When account management is disabled for an account type, adding or removing an account 4445 * of that type will not be possible. 4446 * 4447 * <p>From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use 4448 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account 4449 * management for a specific type is disabled. 4450 * 4451 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4452 * @param accountType For which account management is disabled or enabled. 4453 * @param disabled The boolean indicating that account management will be disabled (true) or 4454 * enabled (false). 4455 */ 4456 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType, 4457 boolean disabled) { 4458 if (mService != null) { 4459 try { 4460 mService.setAccountManagementDisabled(admin, accountType, disabled); 4461 } catch (RemoteException e) { 4462 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4463 } 4464 } 4465 } 4466 4467 /** 4468 * Gets the array of accounts for which account management is disabled by the profile owner. 4469 * 4470 * <p> Account management can be disabled/enabled by calling 4471 * {@link #setAccountManagementDisabled}. 4472 * 4473 * @return a list of account types for which account management has been disabled. 4474 * 4475 * @see #setAccountManagementDisabled 4476 */ 4477 public String[] getAccountTypesWithManagementDisabled() { 4478 return getAccountTypesWithManagementDisabledAsUser(myUserId()); 4479 } 4480 4481 /** 4482 * @see #getAccountTypesWithManagementDisabled() 4483 * @hide 4484 */ 4485 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) { 4486 if (mService != null) { 4487 try { 4488 return mService.getAccountTypesWithManagementDisabledAsUser(userId); 4489 } catch (RemoteException e) { 4490 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4491 } 4492 } 4493 4494 return null; 4495 } 4496 4497 /** 4498 * Sets which packages may enter lock task mode. 4499 * 4500 * <p>Any packages that shares uid with an allowed package will also be allowed 4501 * to activate lock task. 4502 * 4503 * From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task 4504 * package list results in locked tasks belonging to those packages to be finished. 4505 * 4506 * This function can only be called by the device owner. 4507 * @param packages The list of packages allowed to enter lock task mode 4508 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4509 * 4510 * @see Activity#startLockTask() 4511 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String) 4512 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent) 4513 * @see UserManager#DISALLOW_CREATE_WINDOWS 4514 */ 4515 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages) 4516 throws SecurityException { 4517 if (mService != null) { 4518 try { 4519 mService.setLockTaskPackages(admin, packages); 4520 } catch (RemoteException e) { 4521 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4522 } 4523 } 4524 } 4525 4526 /** 4527 * This function returns the list of packages allowed to start the lock task mode. 4528 * 4529 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4530 * @hide 4531 */ 4532 public String[] getLockTaskPackages(@NonNull ComponentName admin) { 4533 if (mService != null) { 4534 try { 4535 return mService.getLockTaskPackages(admin); 4536 } catch (RemoteException e) { 4537 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4538 } 4539 } 4540 return null; 4541 } 4542 4543 /** 4544 * This function lets the caller know whether the given component is allowed to start the 4545 * lock task mode. 4546 * @param pkg The package to check 4547 */ 4548 public boolean isLockTaskPermitted(String pkg) { 4549 if (mService != null) { 4550 try { 4551 return mService.isLockTaskPermitted(pkg); 4552 } catch (RemoteException e) { 4553 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4554 } 4555 } 4556 return false; 4557 } 4558 4559 /** 4560 * Called by device owners to update {@link Settings.Global} settings. Validation that the value 4561 * of the setting is in the correct form for the setting type should be performed by the caller. 4562 * <p>The settings that can be updated with this method are: 4563 * <ul> 4564 * <li>{@link Settings.Global#ADB_ENABLED}</li> 4565 * <li>{@link Settings.Global#AUTO_TIME}</li> 4566 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li> 4567 * <li>{@link Settings.Global#DATA_ROAMING}</li> 4568 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li> 4569 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li> 4570 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} 4571 * This setting is only available from {@link android.os.Build.VERSION_CODES#M} onwards 4572 * and can only be set if {@link #setMaximumTimeToLock} is not used to set a timeout.</li> 4573 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> 4574 * This setting is only available from {@link android.os.Build.VERSION_CODES#M} onwards. 4575 * </li> 4576 * </ul> 4577 * <p>Changing the following settings has no effect as of 4578 * {@link android.os.Build.VERSION_CODES#M}: 4579 * <ul> 4580 * <li>{@link Settings.Global#BLUETOOTH_ON}. 4581 * Use {@link android.bluetooth.BluetoothAdapter#enable()} and 4582 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li> 4583 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li> 4584 * <li>{@link Settings.Global#MODE_RINGER}. 4585 * Use {@link android.media.AudioManager#setRingerMode(int)} instead.</li> 4586 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li> 4587 * <li>{@link Settings.Global#WIFI_ON}. 4588 * Use {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li> 4589 * </ul> 4590 * 4591 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4592 * @param setting The name of the setting to update. 4593 * @param value The value to update the setting to. 4594 */ 4595 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) { 4596 if (mService != null) { 4597 try { 4598 mService.setGlobalSetting(admin, setting, value); 4599 } catch (RemoteException e) { 4600 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4601 } 4602 } 4603 } 4604 4605 /** 4606 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation 4607 * that the value of the setting is in the correct form for the setting type should be performed 4608 * by the caller. 4609 * <p>The settings that can be updated by a profile or device owner with this method are: 4610 * <ul> 4611 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li> 4612 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li> 4613 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li> 4614 * </ul> 4615 * <p>A device owner can additionally update the following settings: 4616 * <ul> 4617 * <li>{@link Settings.Secure#LOCATION_MODE}</li> 4618 * </ul> 4619 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4620 * @param setting The name of the setting to update. 4621 * @param value The value to update the setting to. 4622 */ 4623 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) { 4624 if (mService != null) { 4625 try { 4626 mService.setSecureSetting(admin, setting, value); 4627 } catch (RemoteException e) { 4628 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 4629 } 4630 } 4631 } 4632 4633 /** 4634 * Designates a specific service component as the provider for 4635 * making permission requests of a local or remote administrator of the user. 4636 * <p/> 4637 * Only a profile owner can designate the restrictions provider. 4638 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4639 * @param provider The component name of the service that implements 4640 * {@link RestrictionsReceiver}. If this param is null, 4641 * it removes the restrictions provider previously assigned. 4642 */ 4643 public void setRestrictionsProvider(@NonNull ComponentName admin, 4644 @Nullable ComponentName provider) { 4645 if (mService != null) { 4646 try { 4647 mService.setRestrictionsProvider(admin, provider); 4648 } catch (RemoteException re) { 4649 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4650 } 4651 } 4652 } 4653 4654 /** 4655 * Called by profile or device owners to set the master volume mute on or off. 4656 * 4657 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4658 * @param on {@code true} to mute master volume, {@code false} to turn mute off. 4659 */ 4660 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) { 4661 if (mService != null) { 4662 try { 4663 mService.setMasterVolumeMuted(admin, on); 4664 } catch (RemoteException re) { 4665 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4666 } 4667 } 4668 } 4669 4670 /** 4671 * Called by profile or device owners to check whether the master volume mute is on or off. 4672 * 4673 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4674 * @return {@code true} if master volume is muted, {@code false} if it's not. 4675 */ 4676 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) { 4677 if (mService != null) { 4678 try { 4679 return mService.isMasterVolumeMuted(admin); 4680 } catch (RemoteException re) { 4681 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4682 } 4683 } 4684 return false; 4685 } 4686 4687 /** 4688 * Called by profile or device owners to change whether a user can uninstall 4689 * a package. 4690 * 4691 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4692 * @param packageName package to change. 4693 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package. 4694 */ 4695 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName, 4696 boolean uninstallBlocked) { 4697 if (mService != null) { 4698 try { 4699 mService.setUninstallBlocked(admin, packageName, uninstallBlocked); 4700 } catch (RemoteException re) { 4701 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4702 } 4703 } 4704 } 4705 4706 /** 4707 * Check whether the user has been blocked by device policy from uninstalling a package. 4708 * Requires the caller to be the profile owner if checking a specific admin's policy. 4709 * <p> 4710 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the 4711 * behavior of this API is changed such that passing {@code null} as the {@code admin} 4712 * parameter will return if any admin has blocked the uninstallation. Before L MR1, passing 4713 * {@code null} will cause a NullPointerException to be raised. 4714 * 4715 * @param admin The name of the admin component whose blocking policy will be checked, or 4716 * {@code null} to check whether any admin has blocked the uninstallation. 4717 * @param packageName package to check. 4718 * @return true if uninstallation is blocked. 4719 */ 4720 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) { 4721 if (mService != null) { 4722 try { 4723 return mService.isUninstallBlocked(admin, packageName); 4724 } catch (RemoteException re) { 4725 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4726 } 4727 } 4728 return false; 4729 } 4730 4731 /** 4732 * Called by the profile owner of a managed profile to enable widget providers from a 4733 * given package to be available in the parent profile. As a result the user will be able to 4734 * add widgets from the white-listed package running under the profile to a widget 4735 * host which runs under the parent profile, for example the home screen. Note that 4736 * a package may have zero or more provider components, where each component 4737 * provides a different widget type. 4738 * <p> 4739 * <strong>Note:</strong> By default no widget provider package is white-listed. 4740 * 4741 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4742 * @param packageName The package from which widget providers are white-listed. 4743 * @return Whether the package was added. 4744 * 4745 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String) 4746 * @see #getCrossProfileWidgetProviders(android.content.ComponentName) 4747 */ 4748 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) { 4749 if (mService != null) { 4750 try { 4751 return mService.addCrossProfileWidgetProvider(admin, packageName); 4752 } catch (RemoteException re) { 4753 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4754 } 4755 } 4756 return false; 4757 } 4758 4759 /** 4760 * Called by the profile owner of a managed profile to disable widget providers from a given 4761 * package to be available in the parent profile. For this method to take effect the 4762 * package should have been added via {@link #addCrossProfileWidgetProvider( 4763 * android.content.ComponentName, String)}. 4764 * <p> 4765 * <strong>Note:</strong> By default no widget provider package is white-listed. 4766 * 4767 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4768 * @param packageName The package from which widget providers are no longer 4769 * white-listed. 4770 * @return Whether the package was removed. 4771 * 4772 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String) 4773 * @see #getCrossProfileWidgetProviders(android.content.ComponentName) 4774 */ 4775 public boolean removeCrossProfileWidgetProvider( 4776 @NonNull ComponentName admin, String packageName) { 4777 if (mService != null) { 4778 try { 4779 return mService.removeCrossProfileWidgetProvider(admin, packageName); 4780 } catch (RemoteException re) { 4781 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4782 } 4783 } 4784 return false; 4785 } 4786 4787 /** 4788 * Called by the profile owner of a managed profile to query providers from which packages are 4789 * available in the parent profile. 4790 * 4791 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4792 * @return The white-listed package list. 4793 * 4794 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String) 4795 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String) 4796 */ 4797 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) { 4798 if (mService != null) { 4799 try { 4800 List<String> providers = mService.getCrossProfileWidgetProviders(admin); 4801 if (providers != null) { 4802 return providers; 4803 } 4804 } catch (RemoteException re) { 4805 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4806 } 4807 } 4808 return Collections.emptyList(); 4809 } 4810 4811 /** 4812 * Called by profile or device owners to set the user's photo. 4813 * 4814 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4815 * @param icon the bitmap to set as the photo. 4816 */ 4817 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) { 4818 try { 4819 mService.setUserIcon(admin, icon); 4820 } catch (RemoteException re) { 4821 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4822 } 4823 } 4824 4825 /** 4826 * Called by device owners to set a local system update policy. When a new policy is set, 4827 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted. 4828 * 4829 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All 4830 * components in the device owner package can set system update policies and the 4831 * most recent policy takes 4832 * effect. 4833 * @param policy the new policy, or {@code null} to clear the current policy. 4834 * @see SystemUpdatePolicy 4835 */ 4836 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) { 4837 if (mService != null) { 4838 try { 4839 mService.setSystemUpdatePolicy(admin, policy); 4840 } catch (RemoteException re) { 4841 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4842 } 4843 } 4844 } 4845 4846 /** 4847 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}. 4848 * 4849 * @return The current policy object, or {@code null} if no policy is set. 4850 */ 4851 public SystemUpdatePolicy getSystemUpdatePolicy() { 4852 if (mService != null) { 4853 try { 4854 return mService.getSystemUpdatePolicy(); 4855 } catch (RemoteException re) { 4856 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4857 } 4858 } 4859 return null; 4860 } 4861 4862 /** 4863 * Called by a device owner to disable the keyguard altogether. 4864 * 4865 * <p>Setting the keyguard to disabled has the same effect as choosing "None" as the screen 4866 * lock type. However, this call has no effect if a password, pin or pattern is currently set. 4867 * If a password, pin or pattern is set after the keyguard was disabled, the keyguard stops 4868 * being disabled. 4869 * 4870 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4871 * @param disabled {@code true} disables the keyguard, {@code false} reenables it. 4872 * 4873 * @return {@code false} if attempting to disable the keyguard while a lock password was in 4874 * place. {@code true} otherwise. 4875 */ 4876 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) { 4877 try { 4878 return mService.setKeyguardDisabled(admin, disabled); 4879 } catch (RemoteException re) { 4880 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4881 return false; 4882 } 4883 } 4884 4885 /** 4886 * Called by device owner to disable the status bar. Disabling the status bar blocks 4887 * notifications, quick settings and other screen overlays that allow escaping from 4888 * a single use device. 4889 * 4890 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 4891 * @param disabled {@code true} disables the status bar, {@code false} reenables it. 4892 * 4893 * @return {@code false} if attempting to disable the status bar failed. 4894 * {@code true} otherwise. 4895 */ 4896 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) { 4897 try { 4898 return mService.setStatusBarDisabled(admin, disabled); 4899 } catch (RemoteException re) { 4900 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4901 return false; 4902 } 4903 } 4904 4905 /** 4906 * Callable by the system update service to notify device owners about pending updates. 4907 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE} 4908 * permission. 4909 * 4910 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating 4911 * when the current pending update was first available. -1 if no update is available. 4912 * @hide 4913 */ 4914 @SystemApi 4915 public void notifyPendingSystemUpdate(long updateReceivedTime) { 4916 if (mService != null) { 4917 try { 4918 mService.notifyPendingSystemUpdate(updateReceivedTime); 4919 } catch (RemoteException re) { 4920 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4921 } 4922 } 4923 } 4924 4925 /** 4926 * Called by profile or device owners to set the default response for future runtime permission 4927 * requests by applications. The policy can allow for normal operation which prompts the 4928 * user to grant a permission, or can allow automatic granting or denying of runtime 4929 * permission requests by an application. This also applies to new permissions declared by app 4930 * updates. When a permission is denied or granted this way, the effect is equivalent to setting 4931 * the permission grant state via {@link #setPermissionGrantState}. 4932 * 4933 * <p/>As this policy only acts on runtime permission requests, it only applies to applications 4934 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later. 4935 * 4936 * @param admin Which profile or device owner this request is associated with. 4937 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT}, 4938 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}. 4939 * 4940 * @see #setPermissionGrantState 4941 */ 4942 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) { 4943 try { 4944 mService.setPermissionPolicy(admin, policy); 4945 } catch (RemoteException re) { 4946 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4947 } 4948 } 4949 4950 /** 4951 * Returns the current runtime permission policy set by the device or profile owner. The 4952 * default is {@link #PERMISSION_POLICY_PROMPT}. 4953 * @param admin Which profile or device owner this request is associated with. 4954 * @return the current policy for future permission requests. 4955 */ 4956 public int getPermissionPolicy(ComponentName admin) { 4957 try { 4958 return mService.getPermissionPolicy(admin); 4959 } catch (RemoteException re) { 4960 return PERMISSION_POLICY_PROMPT; 4961 } 4962 } 4963 4964 /** 4965 * Sets the grant state of a runtime permission for a specific application. The state 4966 * can be {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it 4967 * through the UI, {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission 4968 * is denied and the user cannot manage it through the UI, and {@link 4969 * #PERMISSION_GRANT_STATE_GRANTED granted} in which the permission is granted and the 4970 * user cannot manage it through the UI. This might affect all permissions in a 4971 * group that the runtime permission belongs to. This method can only be called 4972 * by a profile or device owner. 4973 * 4974 * <p/>Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not 4975 * revoke the permission. It retains the previous grant, if any. 4976 * 4977 * <p/>Permissions can be granted or revoked only for applications built with a 4978 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later. 4979 * 4980 * @param admin Which profile or device owner this request is associated with. 4981 * @param packageName The application to grant or revoke a permission to. 4982 * @param permission The permission to grant or revoke. 4983 * @param grantState The permission grant state which is one of {@link 4984 * #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT}, 4985 * {@link #PERMISSION_GRANT_STATE_GRANTED}, 4986 * @return whether the permission was successfully granted or revoked. 4987 * 4988 * @see #PERMISSION_GRANT_STATE_DENIED 4989 * @see #PERMISSION_GRANT_STATE_DEFAULT 4990 * @see #PERMISSION_GRANT_STATE_GRANTED 4991 */ 4992 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName, 4993 String permission, int grantState) { 4994 try { 4995 return mService.setPermissionGrantState(admin, packageName, permission, grantState); 4996 } catch (RemoteException re) { 4997 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 4998 return false; 4999 } 5000 } 5001 5002 /** 5003 * Returns the current grant state of a runtime permission for a specific application. 5004 * 5005 * @param admin Which profile or device owner this request is associated with. 5006 * @param packageName The application to check the grant state for. 5007 * @param permission The permission to check for. 5008 * @return the current grant state specified by device policy. If the profile or device owner 5009 * has not set a grant state, the return value is {@link #PERMISSION_GRANT_STATE_DEFAULT}. 5010 * This does not indicate whether or not the permission is currently granted for the package. 5011 * 5012 * <p/>If a grant state was set by the profile or device owner, then the return value will 5013 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or {@link #PERMISSION_GRANT_STATE_GRANTED}, 5014 * which indicates if the permission is currently denied or granted. 5015 * 5016 * @see #setPermissionGrantState(ComponentName, String, String, int) 5017 * @see PackageManager#checkPermission(String, String) 5018 */ 5019 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName, 5020 String permission) { 5021 try { 5022 return mService.getPermissionGrantState(admin, packageName, permission); 5023 } catch (RemoteException re) { 5024 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5025 return PERMISSION_GRANT_STATE_DEFAULT; 5026 } 5027 } 5028 5029 /** 5030 * Returns if provisioning a managed profile or device is possible or not. 5031 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE}, 5032 * {@link #ACTION_PROVISION_MANAGED_PROFILE}. 5033 * Note that even if this method returns true, there is a slight possibility that the 5034 * provisioning will not be allowed when it is actually initiated because some event has 5035 * happened in between. 5036 * @return if provisioning a managed profile or device is possible or not. 5037 * @throws IllegalArgumentException if the supplied action is not valid. 5038 */ 5039 public boolean isProvisioningAllowed(String action) { 5040 try { 5041 return mService.isProvisioningAllowed(action); 5042 } catch (RemoteException re) { 5043 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5044 return false; 5045 } 5046 } 5047 5048 /** 5049 * @hide 5050 * Return if this user is a managed profile of another user. An admin can become the profile 5051 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed 5052 * user with {@link #ACTION_PROVISION_MANAGED_USER}. 5053 * @param admin Which profile owner this request is associated with. 5054 * @return if this user is a managed profile of another user. 5055 */ 5056 public boolean isManagedProfile(@NonNull ComponentName admin) { 5057 try { 5058 return mService.isManagedProfile(admin); 5059 } catch (RemoteException re) { 5060 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5061 return false; 5062 } 5063 } 5064 5065 /** 5066 * @hide 5067 * Return if this user is a system-only user. An admin can manage a device from a system only 5068 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}. 5069 * @param admin Which device owner this request is associated with. 5070 * @return if this user is a system-only user. 5071 */ 5072 public boolean isSystemOnlyUser(@NonNull ComponentName admin) { 5073 try { 5074 return mService.isSystemOnlyUser(admin); 5075 } catch (RemoteException re) { 5076 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5077 return false; 5078 } 5079 } 5080 5081 /** 5082 * Called by device owner to get the MAC address of the Wi-Fi device. 5083 * 5084 * @return the MAC address of the Wi-Fi device, or null when the information is not 5085 * available. (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.) 5086 * 5087 * <p>The address will be in the {@code XX:XX:XX:XX:XX:XX} format. 5088 */ 5089 public String getWifiMacAddress() { 5090 try { 5091 return mService.getWifiMacAddress(); 5092 } catch (RemoteException re) { 5093 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5094 return null; 5095 } 5096 } 5097 5098 /** 5099 * Called by device owner to reboot the device. 5100 */ 5101 public void reboot(@NonNull ComponentName admin) { 5102 try { 5103 mService.reboot(admin); 5104 } catch (RemoteException re) { 5105 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5106 } 5107 } 5108 5109 /** 5110 * Called by a device admin to set the short support message. This will 5111 * be displayed to the user in settings screens where funtionality has 5112 * been disabled by the admin. 5113 * 5114 * The message should be limited to a short statement such as 5115 * "This setting is disabled by your administrator. Contact someone@example.com 5116 * for support." 5117 * If the message is longer than 200 characters it may be truncated. 5118 * 5119 * @see #setLongSupportMessage 5120 * 5121 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5122 * @param message Short message to be displayed to the user in settings or null to 5123 * clear the existing message. 5124 */ 5125 public void setShortSupportMessage(@NonNull ComponentName admin, 5126 @Nullable String message) { 5127 if (mService != null) { 5128 try { 5129 mService.setShortSupportMessage(admin, message); 5130 } catch (RemoteException e) { 5131 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 5132 } 5133 } 5134 } 5135 5136 /** 5137 * Called by a device admin to get the short support message. 5138 * 5139 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5140 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)} 5141 * or null if no message has been set. 5142 */ 5143 public String getShortSupportMessage(@NonNull ComponentName admin) { 5144 if (mService != null) { 5145 try { 5146 return mService.getShortSupportMessage(admin); 5147 } catch (RemoteException e) { 5148 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 5149 } 5150 } 5151 return null; 5152 } 5153 5154 /** 5155 * Called by a device admin to set the long support message. This will 5156 * be displayed to the user in the device administators settings screen. 5157 * 5158 * @see #setShortSupportMessage 5159 * 5160 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5161 * @param message Long message to be displayed to the user in settings or null to 5162 * clear the existing message. 5163 */ 5164 public void setLongSupportMessage(@NonNull ComponentName admin, 5165 @Nullable String message) { 5166 if (mService != null) { 5167 try { 5168 mService.setLongSupportMessage(admin, message); 5169 } catch (RemoteException e) { 5170 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 5171 } 5172 } 5173 } 5174 5175 /** 5176 * Called by a device admin to get the long support message. 5177 * 5178 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5179 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)} 5180 * or null if no message has been set. 5181 */ 5182 public String getLongSupportMessage(@NonNull ComponentName admin) { 5183 if (mService != null) { 5184 try { 5185 return mService.getLongSupportMessage(admin); 5186 } catch (RemoteException e) { 5187 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 5188 } 5189 } 5190 return null; 5191 } 5192 5193 /** 5194 * Called by the system to get the short support message. 5195 * 5196 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5197 * @param userHandle user id the admin is running as. 5198 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)} 5199 * 5200 * @hide 5201 */ 5202 public String getShortSupportMessageForUser(@NonNull ComponentName admin, int userHandle) { 5203 if (mService != null) { 5204 try { 5205 return mService.getShortSupportMessageForUser(admin, userHandle); 5206 } catch (RemoteException e) { 5207 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 5208 } 5209 } 5210 return null; 5211 } 5212 5213 5214 /** 5215 * Called by the system to get the long support message. 5216 * 5217 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5218 * @param userHandle user id the admin is running as. 5219 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)} 5220 * 5221 * @hide 5222 */ 5223 public String getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) { 5224 if (mService != null) { 5225 try { 5226 return mService.getLongSupportMessageForUser(admin, userHandle); 5227 } catch (RemoteException e) { 5228 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 5229 } 5230 } 5231 return null; 5232 } 5233 5234 /** 5235 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager} 5236 * whose calls act on the parent profile. 5237 * 5238 * <p> Note only some methods will work on the parent Manager. 5239 * 5240 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile. 5241 */ 5242 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) { 5243 try { 5244 if (!mService.isManagedProfile(admin)) { 5245 throw new SecurityException("The current user does not have a parent profile."); 5246 } 5247 return new DevicePolicyManager(mContext, true); 5248 } catch (RemoteException re) { 5249 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5250 return null; 5251 } 5252 } 5253 5254 /** 5255 * Called by a profile owner of a managed profile to set the color used for customization. 5256 * This color is used as background color of the confirm credentials screen for that user. 5257 * The default color is {@link android.graphics.Color#GRAY}. 5258 * 5259 * <p>The confirm credentials screen can be created using 5260 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}. 5261 * 5262 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5263 * @param color The 32bit representation of the color to be used. 5264 */ 5265 public void setOrganizationColor(@NonNull ComponentName admin, int color) { 5266 try { 5267 mService.setOrganizationColor(admin, color); 5268 } catch (RemoteException re) { 5269 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5270 } 5271 } 5272 5273 /** 5274 * Called by a profile owner of a managed profile to retrieve the color used for customization. 5275 * This color is used as background color of the confirm credentials screen for that user. 5276 * 5277 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 5278 * @return The 32bit representation of the color to be used. 5279 */ 5280 public int getOrganizationColor(@NonNull ComponentName admin) { 5281 try { 5282 return mService.getOrganizationColor(admin); 5283 } catch (RemoteException re) { 5284 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5285 return 0; 5286 } 5287 } 5288 5289 /** 5290 * @hide 5291 * Retrieve the customization color for a given user. 5292 * 5293 * @param userHandle The user id of the user we're interested in. 5294 * @return The 32bit representation of the color to be used. 5295 */ 5296 public int getOrganizationColorForUser(int userHandle) { 5297 try { 5298 return mService.getOrganizationColorForUser(userHandle); 5299 } catch (RemoteException re) { 5300 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re); 5301 return 0; 5302 } 5303 } 5304 5305 /** 5306 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will 5307 * return {@link #STATE_USER_UNMANAGED} 5308 * @hide 5309 */ 5310 @UserProvisioningState 5311 public int getUserProvisioningState() { 5312 if (mService != null) { 5313 try { 5314 return mService.getUserProvisioningState(); 5315 } catch (RemoteException e) { 5316 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 5317 } 5318 } 5319 return STATE_USER_UNMANAGED; 5320 } 5321 5322 /** 5323 * Set the {@link UserProvisioningState} for the supplied user, if they are managed. 5324 * 5325 * @param state to store 5326 * @param userHandle for user 5327 * @hide 5328 */ 5329 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) { 5330 if (mService != null) { 5331 try { 5332 mService.setUserProvisioningState(state, userHandle); 5333 } catch (RemoteException e) { 5334 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e); 5335 } 5336 } 5337 } 5338 5339 /** 5340 * @hide 5341 * Indicates the entity that controls the device or profile owner. A user/profile is considered 5342 * affiliated if it is managed by the same entity as the device. 5343 * 5344 * <p> By definition, the user that the device owner runs on is always affiliated. Any other 5345 * user/profile is considered affiliated if the following conditions are both met: 5346 * <ul> 5347 * <li>The device owner and the user's/profile's profile owner have called this method, 5348 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner 5349 * and a profile owner intersect, they must have come from the same source, which means that 5350 * the device owner and profile owner are controlled by the same entity.</li> 5351 * <li>The device owner's and profile owner's package names are the same.</li> 5352 * </ul> 5353 * 5354 * @param admin Which profile or device owner this request is associated with. 5355 * @param ids A set of opaque affiliation ids. 5356 */ 5357 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) { 5358 try { 5359 mService.setAffiliationIds(admin, new ArrayList<String>(ids)); 5360 } catch (RemoteException e) { 5361 Log.w(TAG, "Failed talking with device policy service", e); 5362 } 5363 } 5364 5365 /** 5366 * @hide 5367 * Returns whether this user/profile is affiliated with the device. See 5368 * {@link #setAffiliationIds} for the definition of affiliation. 5369 * 5370 * @return whether this user/profile is affiliated with the device. 5371 */ 5372 public boolean isAffiliatedUser() { 5373 try { 5374 return mService != null && mService.isAffiliatedUser(); 5375 } catch (RemoteException e) { 5376 Log.w(TAG, "Failed talking with device policy service", e); 5377 return false; 5378 } 5379 } 5380} 5381