DevicePolicyManager.java revision 3a3d212a51974ccec6100c1e117225291edc83cc
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.SdkConstant; 20import android.annotation.SdkConstant.SdkConstantType; 21import android.annotation.SystemApi; 22import android.app.Activity; 23import android.app.admin.IDevicePolicyManager; 24import android.content.ComponentName; 25import android.content.Context; 26import android.content.Intent; 27import android.content.IntentFilter; 28import android.content.pm.ActivityInfo; 29import android.content.pm.PackageManager; 30import android.content.pm.ResolveInfo; 31import android.net.ProxyInfo; 32import android.os.Bundle; 33import android.os.Handler; 34import android.os.PersistableBundle; 35import android.os.Process; 36import android.os.RemoteCallback; 37import android.os.RemoteException; 38import android.os.ServiceManager; 39import android.os.UserHandle; 40import android.os.UserManager; 41import android.provider.Settings; 42import android.security.Credentials; 43import android.service.restrictions.RestrictionsReceiver; 44import android.service.trust.TrustAgentService; 45import android.util.Log; 46 47import com.android.org.conscrypt.TrustedCertificateStore; 48 49import org.xmlpull.v1.XmlPullParserException; 50 51import java.io.ByteArrayInputStream; 52import java.io.IOException; 53import java.net.InetSocketAddress; 54import java.net.Proxy; 55import java.security.PrivateKey; 56import java.security.cert.Certificate; 57import java.security.cert.CertificateException; 58import java.security.cert.CertificateFactory; 59import java.security.cert.X509Certificate; 60import java.util.ArrayList; 61import java.util.Collections; 62import java.util.List; 63 64/** 65 * Public interface for managing policies enforced on a device. Most clients of this class must be 66 * registered with the system as a 67 * <a href={@docRoot}guide/topics/admin/device-admin.html">device administrator</a>. Additionally, 68 * a device administrator may be registered as either a profile or device owner. A given method is 69 * accessible to all device administrators unless the documentation for that method specifies that 70 * it is restricted to either device or profile owners. 71 * 72 * <div class="special reference"> 73 * <h3>Developer Guides</h3> 74 * <p>For more information about managing policies for device administration, read the 75 * <a href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> 76 * developer guide.</p> 77 * </div> 78 */ 79public class DevicePolicyManager { 80 private static String TAG = "DevicePolicyManager"; 81 82 private final Context mContext; 83 private final IDevicePolicyManager mService; 84 85 private DevicePolicyManager(Context context, Handler handler) { 86 mContext = context; 87 mService = IDevicePolicyManager.Stub.asInterface( 88 ServiceManager.getService(Context.DEVICE_POLICY_SERVICE)); 89 } 90 91 /** @hide */ 92 public static DevicePolicyManager create(Context context, Handler handler) { 93 DevicePolicyManager me = new DevicePolicyManager(context, handler); 94 return me.mService != null ? me : null; 95 } 96 97 /** 98 * Activity action: Starts the provisioning flow which sets up a managed profile. 99 * 100 * <p>A managed profile allows data separation for example for the usage of a 101 * device as a personal and corporate device. The user which provisioning is started from and 102 * the managed profile share a launcher. 103 * 104 * <p>This intent will typically be sent by a mobile device management application (mdm). 105 * Provisioning adds a managed profile and sets the mdm as the profile owner who has full 106 * control over the profile 107 * 108 * <p>This intent must contain the extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}. 109 * 110 * <p> When managed provisioning has completed, an intent of the type 111 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcasted to the 112 * managed profile. 113 * 114 * <p> If provisioning fails, the managedProfile is removed so the device returns to its 115 * previous state. 116 * 117 * <p>Input: Nothing.</p> 118 * <p>Output: Nothing</p> 119 */ 120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 121 public static final String ACTION_PROVISION_MANAGED_PROFILE 122 = "android.app.action.PROVISION_MANAGED_PROFILE"; 123 124 /** 125 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that allows 126 * a mobile device management application that starts managed profile provisioning to pass data 127 * to itself on the managed profile when provisioning completes. The mobile device management 128 * application sends this extra in an intent with the action 129 * {@link #ACTION_PROVISION_MANAGED_PROFILE} and receives it in 130 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action 131 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed 132 * during the managed profile provisioning. 133 */ 134 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE = 135 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE"; 136 137 /** 138 * A String extra holding the package name of the mobile device management application that 139 * will be set as the profile owner or device owner. 140 * 141 * <p>If an application starts provisioning directly via an intent with action 142 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the 143 * application that started provisioning. The package will be set as profile owner in that case. 144 * 145 * <p>This package is set as device owner when device owner provisioning is started by an NFC 146 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}. 147 */ 148 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME 149 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME"; 150 151 /** 152 * An {@link android.accounts.Account} extra holding the account to migrate during managed 153 * profile provisioning. If the account supplied is present in the primary user, it will be 154 * copied, along with its credentials to the managed profile and removed from the primary user. 155 * 156 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}. 157 */ 158 159 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE 160 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE"; 161 162 /** 163 * A String extra that, holds the email address of the account which a managed profile is 164 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and 165 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. 166 * 167 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}. 168 * 169 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning 170 * contains this extra, it is forwarded in the 171 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile 172 * device management application that was set as the profile owner during provisioning. 173 * It is usually used to avoid that the user has to enter their email address twice. 174 */ 175 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS 176 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS"; 177 178 /** 179 * A Boolean extra that can be used by the mobile device management application to skip the 180 * disabling of system apps during provisioning when set to <code>true</code>. 181 * 182 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 183 * provisioning via an NFC bump. 184 */ 185 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED = 186 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED"; 187 188 /** 189 * A String extra holding the time zone {@link android.app.AlarmManager} that the device 190 * will be set to. 191 * 192 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 193 * provisioning via an NFC bump. 194 */ 195 public static final String EXTRA_PROVISIONING_TIME_ZONE 196 = "android.app.extra.PROVISIONING_TIME_ZONE"; 197 198 /** 199 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's 200 * {@link android.app.AlarmManager}. 201 * 202 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 203 * provisioning via an NFC bump. 204 */ 205 public static final String EXTRA_PROVISIONING_LOCAL_TIME 206 = "android.app.extra.PROVISIONING_LOCAL_TIME"; 207 208 /** 209 * A String extra holding the {@link java.util.Locale} that the device will be set to. 210 * Format: xx_yy, where xx is the language code, and yy the country code. 211 * 212 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 213 * provisioning via an NFC bump. 214 */ 215 public static final String EXTRA_PROVISIONING_LOCALE 216 = "android.app.extra.PROVISIONING_LOCALE"; 217 218 /** 219 * A String extra holding the ssid of the wifi network that should be used during nfc device 220 * owner provisioning for downloading the mobile device management application. 221 * 222 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 223 * provisioning via an NFC bump. 224 */ 225 public static final String EXTRA_PROVISIONING_WIFI_SSID 226 = "android.app.extra.PROVISIONING_WIFI_SSID"; 227 228 /** 229 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID} 230 * is hidden or not. 231 * 232 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 233 * provisioning via an NFC bump. 234 */ 235 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN 236 = "android.app.extra.PROVISIONING_WIFI_HIDDEN"; 237 238 /** 239 * A String extra indicating the security type of the wifi network in 240 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 241 * 242 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 243 * provisioning via an NFC bump. 244 */ 245 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE 246 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE"; 247 248 /** 249 * A String extra holding the password of the wifi network in 250 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 251 * 252 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 253 * provisioning via an NFC bump. 254 */ 255 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD 256 = "android.app.extra.PROVISIONING_WIFI_PASSWORD"; 257 258 /** 259 * A String extra holding the proxy host for the wifi network in 260 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 261 * 262 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 263 * provisioning via an NFC bump. 264 */ 265 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST 266 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST"; 267 268 /** 269 * An int extra holding the proxy port for the wifi network in 270 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 271 * 272 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 273 * provisioning via an NFC bump. 274 */ 275 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT 276 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT"; 277 278 /** 279 * A String extra holding the proxy bypass for the wifi network in 280 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 281 * 282 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 283 * provisioning via an NFC bump. 284 */ 285 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS 286 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS"; 287 288 /** 289 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in 290 * {@link #EXTRA_PROVISIONING_WIFI_SSID}. 291 * 292 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 293 * provisioning via an NFC bump. 294 */ 295 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL 296 = "android.app.extra.PROVISIONING_WIFI_PAC_URL"; 297 298 /** 299 * A String extra holding a url that specifies the download location of the device admin 300 * package. When not provided it is assumed that the device admin package is already installed. 301 * 302 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 303 * provisioning via an NFC bump. 304 */ 305 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION 306 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION"; 307 308 /** 309 * A String extra holding a http cookie header which should be used in the http request to the 310 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. 311 * 312 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 313 * provisioning via an NFC bump. 314 */ 315 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER 316 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER"; 317 318 /** 319 * A String extra holding the SHA-1 checksum of the file at download location specified in 320 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. If this doesn't match 321 * the file at the download location an error will be shown to the user and the user will be 322 * asked to factory reset the device. 323 * 324 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner 325 * provisioning via an NFC bump. 326 */ 327 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM 328 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM"; 329 330 /** 331 * This MIME type is used for starting the Device Owner provisioning. 332 * 333 * <p>During device owner provisioning a device admin app is set as the owner of the device. 334 * A device owner has full control over the device. The device owner can not be modified by the 335 * user and the only way of resetting the device is if the device owner app calls a factory 336 * reset. 337 * 338 * <p> A typical use case would be a device that is owned by a company, but used by either an 339 * employee or client. 340 * 341 * <p> The NFC message should be send to an unprovisioned device. 342 * 343 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which 344 * contains the following properties: 345 * <ul> 346 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li> 347 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}</li> 348 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li> 349 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}</li> 350 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li> 351 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li> 352 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li> 353 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li> 354 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li> 355 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li> 356 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li> 357 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li> 358 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li> 359 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li> 360 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li></ul> 361 * 362 * <p> When device owner provisioning has completed, an intent of the type 363 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcasted to the 364 * device owner. 365 * 366 * <p> 367 * If provisioning fails, the device is factory reset. 368 * 369 * <p>Input: Nothing.</p> 370 * <p>Output: Nothing</p> 371 */ 372 public static final String MIME_TYPE_PROVISIONING_NFC 373 = "application/com.android.managedprovisioning"; 374 375 /** 376 * Activity action: ask the user to add a new device administrator to the system. 377 * The desired policy is the ComponentName of the policy in the 378 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to 379 * bring the user through adding the device administrator to the system (or 380 * allowing them to reject it). 381 * 382 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION} 383 * field to provide the user with additional explanation (in addition 384 * to your component's description) about what is being added. 385 * 386 * <p>If your administrator is already active, this will ordinarily return immediately (without 387 * user intervention). However, if your administrator has been updated and is requesting 388 * additional uses-policy flags, the user will be presented with the new list. New policies 389 * will not be available to the updated administrator until the user has accepted the new list. 390 */ 391 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 392 public static final String ACTION_ADD_DEVICE_ADMIN 393 = "android.app.action.ADD_DEVICE_ADMIN"; 394 395 /** 396 * @hide 397 * Activity action: ask the user to add a new device administrator as the profile owner 398 * for this user. Only system privileged apps that have MANAGE_USERS and MANAGE_DEVICE_ADMINS 399 * permission can call this API. 400 * 401 * <p>The ComponentName of the profile owner admin is pass in {@link #EXTRA_DEVICE_ADMIN} extra 402 * field. This will invoke a UI to bring the user through adding the profile owner admin 403 * to remotely control restrictions on the user. 404 * 405 * <p>The intent must be invoked via {@link Activity#startActivityForResult()} to receive the 406 * result of whether or not the user approved the action. If approved, the result will 407 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well 408 * as a profile owner. 409 * 410 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION} 411 * field to provide the user with additional explanation (in addition 412 * to your component's description) about what is being added. 413 * 414 * <p>If there is already a profile owner active or the caller doesn't have the required 415 * permissions, the operation will return a failure result. 416 */ 417 @SystemApi 418 public static final String ACTION_SET_PROFILE_OWNER 419 = "android.app.action.SET_PROFILE_OWNER"; 420 421 /** 422 * @hide 423 * Name of the profile owner admin that controls the user. 424 */ 425 @SystemApi 426 public static final String EXTRA_PROFILE_OWNER_NAME 427 = "android.app.extra.PROFILE_OWNER_NAME"; 428 429 /** 430 * Activity action: send when any policy admin changes a policy. 431 * This is generally used to find out when a new policy is in effect. 432 * 433 * @hide 434 */ 435 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED 436 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED"; 437 438 /** 439 * The ComponentName of the administrator component. 440 * 441 * @see #ACTION_ADD_DEVICE_ADMIN 442 */ 443 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN"; 444 445 /** 446 * An optional CharSequence providing additional explanation for why the 447 * admin is being added. 448 * 449 * @see #ACTION_ADD_DEVICE_ADMIN 450 */ 451 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION"; 452 453 /** 454 * Activity action: have the user enter a new password. This activity should 455 * be launched after using {@link #setPasswordQuality(ComponentName, int)}, 456 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user 457 * enter a new password that meets the current requirements. You can use 458 * {@link #isActivePasswordSufficient()} to determine whether you need to 459 * have the user select a new password in order to meet the current 460 * constraints. Upon being resumed from this activity, you can check the new 461 * password characteristics to see if they are sufficient. 462 */ 463 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 464 public static final String ACTION_SET_NEW_PASSWORD 465 = "android.app.action.SET_NEW_PASSWORD"; 466 467 /** 468 * Flag used by {@link #addCrossProfileIntentFilter} to allow access 469 * <em>from</em> a managed profile <em>to</em> its parent. That is, any 470 * matching activities in the parent profile are included in the 471 * disambiguation list shown when an app in the managed profile calls 472 * {@link Activity#startActivity(Intent)}. 473 */ 474 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001; 475 476 /** 477 * Flag used by {@link #addCrossProfileIntentFilter} to allow access 478 * <em>from</em> a parent <em>to</em> its managed profile. That is, any 479 * matching activities in the managed profile are included in the 480 * disambiguation list shown when an app in the parent profile calls 481 * {@link Activity#startActivity(Intent)}. 482 */ 483 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002; 484 485 /** 486 * Return true if the given administrator component is currently 487 * active (enabled) in the system. 488 */ 489 public boolean isAdminActive(ComponentName who) { 490 return isAdminActiveAsUser(who, UserHandle.myUserId()); 491 } 492 493 /** 494 * @see #isAdminActive(ComponentName) 495 * @hide 496 */ 497 public boolean isAdminActiveAsUser(ComponentName who, int userId) { 498 if (mService != null) { 499 try { 500 return mService.isAdminActive(who, userId); 501 } catch (RemoteException e) { 502 Log.w(TAG, "Failed talking with device policy service", e); 503 } 504 } 505 return false; 506 } 507 508 /** 509 * Return a list of all currently active device administrator's component 510 * names. Note that if there are no administrators than null may be 511 * returned. 512 */ 513 public List<ComponentName> getActiveAdmins() { 514 return getActiveAdminsAsUser(UserHandle.myUserId()); 515 } 516 517 /** 518 * @see #getActiveAdmins() 519 * @hide 520 */ 521 public List<ComponentName> getActiveAdminsAsUser(int userId) { 522 if (mService != null) { 523 try { 524 return mService.getActiveAdmins(userId); 525 } catch (RemoteException e) { 526 Log.w(TAG, "Failed talking with device policy service", e); 527 } 528 } 529 return null; 530 } 531 532 /** 533 * Used by package administration code to determine if a package can be stopped 534 * or uninstalled. 535 * @hide 536 */ 537 public boolean packageHasActiveAdmins(String packageName) { 538 if (mService != null) { 539 try { 540 return mService.packageHasActiveAdmins(packageName, UserHandle.myUserId()); 541 } catch (RemoteException e) { 542 Log.w(TAG, "Failed talking with device policy service", e); 543 } 544 } 545 return false; 546 } 547 548 /** 549 * Remove a current administration component. This can only be called 550 * by the application that owns the administration component; if you 551 * try to remove someone else's component, a security exception will be 552 * thrown. 553 */ 554 public void removeActiveAdmin(ComponentName who) { 555 if (mService != null) { 556 try { 557 mService.removeActiveAdmin(who, UserHandle.myUserId()); 558 } catch (RemoteException e) { 559 Log.w(TAG, "Failed talking with device policy service", e); 560 } 561 } 562 } 563 564 /** 565 * Returns true if an administrator has been granted a particular device policy. This can 566 * be used to check if the administrator was activated under an earlier set of policies, 567 * but requires additional policies after an upgrade. 568 * 569 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be 570 * an active administrator, or an exception will be thrown. 571 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}. 572 */ 573 public boolean hasGrantedPolicy(ComponentName admin, int usesPolicy) { 574 if (mService != null) { 575 try { 576 return mService.hasGrantedPolicy(admin, usesPolicy, UserHandle.myUserId()); 577 } catch (RemoteException e) { 578 Log.w(TAG, "Failed talking with device policy service", e); 579 } 580 } 581 return false; 582 } 583 584 /** 585 * Constant for {@link #setPasswordQuality}: the policy has no requirements 586 * for the password. Note that quality constants are ordered so that higher 587 * values are more restrictive. 588 */ 589 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0; 590 591 /** 592 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric 593 * recognition technology. This implies technologies that can recognize the identity of 594 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000). 595 * Note that quality constants are ordered so that higher values are more restrictive. 596 */ 597 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000; 598 599 /** 600 * Constant for {@link #setPasswordQuality}: the policy requires some kind 601 * of password, but doesn't care what it is. Note that quality constants 602 * are ordered so that higher values are more restrictive. 603 */ 604 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000; 605 606 /** 607 * Constant for {@link #setPasswordQuality}: the user must have entered a 608 * password containing at least numeric characters. Note that quality 609 * constants are ordered so that higher values are more restrictive. 610 */ 611 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000; 612 613 /** 614 * Constant for {@link #setPasswordQuality}: the user must have entered a 615 * password containing at least numeric characters with no repeating (4444) 616 * or ordered (1234, 4321, 2468) sequences. Note that quality 617 * constants are ordered so that higher values are more restrictive. 618 */ 619 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000; 620 621 /** 622 * Constant for {@link #setPasswordQuality}: the user must have entered a 623 * password containing at least alphabetic (or other symbol) characters. 624 * Note that quality constants are ordered so that higher values are more 625 * restrictive. 626 */ 627 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000; 628 629 /** 630 * Constant for {@link #setPasswordQuality}: the user must have entered a 631 * password containing at least <em>both></em> numeric <em>and</em> 632 * alphabetic (or other symbol) characters. Note that quality constants are 633 * ordered so that higher values are more restrictive. 634 */ 635 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000; 636 637 /** 638 * Constant for {@link #setPasswordQuality}: the user must have entered a 639 * password containing at least a letter, a numerical digit and a special 640 * symbol, by default. With this password quality, passwords can be 641 * restricted to contain various sets of characters, like at least an 642 * uppercase letter, etc. These are specified using various methods, 643 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note 644 * that quality constants are ordered so that higher values are more 645 * restrictive. 646 */ 647 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000; 648 649 /** 650 * Called by an application that is administering the device to set the 651 * password restrictions it is imposing. After setting this, the user 652 * will not be able to enter a new password that is not at least as 653 * restrictive as what has been set. Note that the current password 654 * will remain until the user has set a new one, so the change does not 655 * take place immediately. To prompt the user for a new password, use 656 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. 657 * 658 * <p>Quality constants are ordered so that higher values are more restrictive; 659 * thus the highest requested quality constant (between the policy set here, 660 * the user's preference, and any other considerations) is the one that 661 * is in effect. 662 * 663 * <p>The calling device admin must have requested 664 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 665 * this method; if it has not, a security exception will be thrown. 666 * 667 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 668 * @param quality The new desired quality. One of 669 * {@link #PASSWORD_QUALITY_UNSPECIFIED}, {@link #PASSWORD_QUALITY_SOMETHING}, 670 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, 671 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC} 672 * or {@link #PASSWORD_QUALITY_COMPLEX}. 673 */ 674 public void setPasswordQuality(ComponentName admin, int quality) { 675 if (mService != null) { 676 try { 677 mService.setPasswordQuality(admin, quality, UserHandle.myUserId()); 678 } catch (RemoteException e) { 679 Log.w(TAG, "Failed talking with device policy service", e); 680 } 681 } 682 } 683 684 /** 685 * Retrieve the current minimum password quality for all admins of this user 686 * and its profiles or a particular one. 687 * @param admin The name of the admin component to check, or null to aggregate 688 * all admins. 689 */ 690 public int getPasswordQuality(ComponentName admin) { 691 return getPasswordQuality(admin, UserHandle.myUserId()); 692 } 693 694 /** @hide per-user version */ 695 public int getPasswordQuality(ComponentName admin, int userHandle) { 696 if (mService != null) { 697 try { 698 return mService.getPasswordQuality(admin, userHandle); 699 } catch (RemoteException e) { 700 Log.w(TAG, "Failed talking with device policy service", e); 701 } 702 } 703 return PASSWORD_QUALITY_UNSPECIFIED; 704 } 705 706 /** 707 * Called by an application that is administering the device to set the 708 * minimum allowed password length. After setting this, the user 709 * will not be able to enter a new password that is not at least as 710 * restrictive as what has been set. Note that the current password 711 * will remain until the user has set a new one, so the change does not 712 * take place immediately. To prompt the user for a new password, use 713 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 714 * constraint is only imposed if the administrator has also requested either 715 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, 716 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC}, 717 * or {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. 718 * 719 * <p>The calling device admin must have requested 720 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 721 * this method; if it has not, a security exception will be thrown. 722 * 723 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 724 * @param length The new desired minimum password length. A value of 0 725 * means there is no restriction. 726 */ 727 public void setPasswordMinimumLength(ComponentName admin, int length) { 728 if (mService != null) { 729 try { 730 mService.setPasswordMinimumLength(admin, length, UserHandle.myUserId()); 731 } catch (RemoteException e) { 732 Log.w(TAG, "Failed talking with device policy service", e); 733 } 734 } 735 } 736 737 /** 738 * Retrieve the current minimum password length for all admins of this 739 * user and its profiles or a particular one. 740 * @param admin The name of the admin component to check, or null to aggregate 741 * all admins. 742 */ 743 public int getPasswordMinimumLength(ComponentName admin) { 744 return getPasswordMinimumLength(admin, UserHandle.myUserId()); 745 } 746 747 /** @hide per-user version */ 748 public int getPasswordMinimumLength(ComponentName admin, int userHandle) { 749 if (mService != null) { 750 try { 751 return mService.getPasswordMinimumLength(admin, userHandle); 752 } catch (RemoteException e) { 753 Log.w(TAG, "Failed talking with device policy service", e); 754 } 755 } 756 return 0; 757 } 758 759 /** 760 * Called by an application that is administering the device to set the 761 * minimum number of upper case letters required in the password. After 762 * setting this, the user will not be able to enter a new password that is 763 * not at least as restrictive as what has been set. Note that the current 764 * password will remain until the user has set a new one, so the change does 765 * not take place immediately. To prompt the user for a new password, use 766 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 767 * constraint is only imposed if the administrator has also requested 768 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 769 * default value is 0. 770 * <p> 771 * The calling device admin must have requested 772 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 773 * this method; if it has not, a security exception will be thrown. 774 * 775 * @param admin Which {@link DeviceAdminReceiver} this request is associated 776 * with. 777 * @param length The new desired minimum number of upper case letters 778 * required in the password. A value of 0 means there is no 779 * restriction. 780 */ 781 public void setPasswordMinimumUpperCase(ComponentName admin, int length) { 782 if (mService != null) { 783 try { 784 mService.setPasswordMinimumUpperCase(admin, length, UserHandle.myUserId()); 785 } catch (RemoteException e) { 786 Log.w(TAG, "Failed talking with device policy service", e); 787 } 788 } 789 } 790 791 /** 792 * Retrieve the current number of upper case letters required in the 793 * password for all admins of this user and its profiles or a particular one. 794 * This is the same value as set by 795 * {#link {@link #setPasswordMinimumUpperCase(ComponentName, int)} 796 * and only applies when the password quality is 797 * {@link #PASSWORD_QUALITY_COMPLEX}. 798 * 799 * @param admin The name of the admin component to check, or null to 800 * aggregate all admins. 801 * @return The minimum number of upper case letters required in the 802 * password. 803 */ 804 public int getPasswordMinimumUpperCase(ComponentName admin) { 805 return getPasswordMinimumUpperCase(admin, UserHandle.myUserId()); 806 } 807 808 /** @hide per-user version */ 809 public int getPasswordMinimumUpperCase(ComponentName admin, int userHandle) { 810 if (mService != null) { 811 try { 812 return mService.getPasswordMinimumUpperCase(admin, userHandle); 813 } catch (RemoteException e) { 814 Log.w(TAG, "Failed talking with device policy service", e); 815 } 816 } 817 return 0; 818 } 819 820 /** 821 * Called by an application that is administering the device to set the 822 * minimum number of lower case letters required in the password. After 823 * setting this, the user will not be able to enter a new password that is 824 * not at least as restrictive as what has been set. Note that the current 825 * password will remain until the user has set a new one, so the change does 826 * not take place immediately. To prompt the user for a new password, use 827 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 828 * constraint is only imposed if the administrator has also requested 829 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 830 * default value is 0. 831 * <p> 832 * The calling device admin must have requested 833 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 834 * this method; if it has not, a security exception will be thrown. 835 * 836 * @param admin Which {@link DeviceAdminReceiver} this request is associated 837 * with. 838 * @param length The new desired minimum number of lower case letters 839 * required in the password. A value of 0 means there is no 840 * restriction. 841 */ 842 public void setPasswordMinimumLowerCase(ComponentName admin, int length) { 843 if (mService != null) { 844 try { 845 mService.setPasswordMinimumLowerCase(admin, length, UserHandle.myUserId()); 846 } catch (RemoteException e) { 847 Log.w(TAG, "Failed talking with device policy service", e); 848 } 849 } 850 } 851 852 /** 853 * Retrieve the current number of lower case letters required in the 854 * password for all admins of this user and its profiles or a particular one. 855 * This is the same value as set by 856 * {#link {@link #setPasswordMinimumLowerCase(ComponentName, int)} 857 * and only applies when the password quality is 858 * {@link #PASSWORD_QUALITY_COMPLEX}. 859 * 860 * @param admin The name of the admin component to check, or null to 861 * aggregate all admins. 862 * @return The minimum number of lower case letters required in the 863 * password. 864 */ 865 public int getPasswordMinimumLowerCase(ComponentName admin) { 866 return getPasswordMinimumLowerCase(admin, UserHandle.myUserId()); 867 } 868 869 /** @hide per-user version */ 870 public int getPasswordMinimumLowerCase(ComponentName admin, int userHandle) { 871 if (mService != null) { 872 try { 873 return mService.getPasswordMinimumLowerCase(admin, userHandle); 874 } catch (RemoteException e) { 875 Log.w(TAG, "Failed talking with device policy service", e); 876 } 877 } 878 return 0; 879 } 880 881 /** 882 * Called by an application that is administering the device to set the 883 * minimum number of letters required in the password. After setting this, 884 * the user will not be able to enter a new password that is not at least as 885 * restrictive as what has been set. Note that the current password will 886 * remain until the user has set a new one, so the change does not take 887 * place immediately. To prompt the user for a new password, use 888 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 889 * constraint is only imposed if the administrator has also requested 890 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 891 * default value is 1. 892 * <p> 893 * The calling device admin must have requested 894 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 895 * this method; if it has not, a security exception will be thrown. 896 * 897 * @param admin Which {@link DeviceAdminReceiver} this request is associated 898 * with. 899 * @param length The new desired minimum number of letters required in the 900 * password. A value of 0 means there is no restriction. 901 */ 902 public void setPasswordMinimumLetters(ComponentName admin, int length) { 903 if (mService != null) { 904 try { 905 mService.setPasswordMinimumLetters(admin, length, UserHandle.myUserId()); 906 } catch (RemoteException e) { 907 Log.w(TAG, "Failed talking with device policy service", e); 908 } 909 } 910 } 911 912 /** 913 * Retrieve the current number of letters required in the password for all 914 * admins or a particular one. This is the same value as 915 * set by {#link {@link #setPasswordMinimumLetters(ComponentName, int)} 916 * and only applies when the password quality is 917 * {@link #PASSWORD_QUALITY_COMPLEX}. 918 * 919 * @param admin The name of the admin component to check, or null to 920 * aggregate all admins. 921 * @return The minimum number of letters required in the password. 922 */ 923 public int getPasswordMinimumLetters(ComponentName admin) { 924 return getPasswordMinimumLetters(admin, UserHandle.myUserId()); 925 } 926 927 /** @hide per-user version */ 928 public int getPasswordMinimumLetters(ComponentName admin, int userHandle) { 929 if (mService != null) { 930 try { 931 return mService.getPasswordMinimumLetters(admin, userHandle); 932 } catch (RemoteException e) { 933 Log.w(TAG, "Failed talking with device policy service", e); 934 } 935 } 936 return 0; 937 } 938 939 /** 940 * Called by an application that is administering the device to set the 941 * minimum number of numerical digits required in the password. After 942 * setting this, the user will not be able to enter a new password that is 943 * not at least as restrictive as what has been set. Note that the current 944 * password will remain until the user has set a new one, so the change does 945 * not take place immediately. To prompt the user for a new password, use 946 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 947 * constraint is only imposed if the administrator has also requested 948 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 949 * default value is 1. 950 * <p> 951 * The calling device admin must have requested 952 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 953 * this method; if it has not, a security exception will be thrown. 954 * 955 * @param admin Which {@link DeviceAdminReceiver} this request is associated 956 * with. 957 * @param length The new desired minimum number of numerical digits required 958 * in the password. A value of 0 means there is no restriction. 959 */ 960 public void setPasswordMinimumNumeric(ComponentName admin, int length) { 961 if (mService != null) { 962 try { 963 mService.setPasswordMinimumNumeric(admin, length, UserHandle.myUserId()); 964 } catch (RemoteException e) { 965 Log.w(TAG, "Failed talking with device policy service", e); 966 } 967 } 968 } 969 970 /** 971 * Retrieve the current number of numerical digits required in the password 972 * for all admins of this user and its profiles or a particular one. 973 * This is the same value as set by 974 * {#link {@link #setPasswordMinimumNumeric(ComponentName, int)} 975 * and only applies when the password quality is 976 * {@link #PASSWORD_QUALITY_COMPLEX}. 977 * 978 * @param admin The name of the admin component to check, or null to 979 * aggregate all admins. 980 * @return The minimum number of numerical digits required in the password. 981 */ 982 public int getPasswordMinimumNumeric(ComponentName admin) { 983 return getPasswordMinimumNumeric(admin, UserHandle.myUserId()); 984 } 985 986 /** @hide per-user version */ 987 public int getPasswordMinimumNumeric(ComponentName admin, int userHandle) { 988 if (mService != null) { 989 try { 990 return mService.getPasswordMinimumNumeric(admin, userHandle); 991 } catch (RemoteException e) { 992 Log.w(TAG, "Failed talking with device policy service", e); 993 } 994 } 995 return 0; 996 } 997 998 /** 999 * Called by an application that is administering the device to set the 1000 * minimum number of symbols required in the password. After setting this, 1001 * the user will not be able to enter a new password that is not at least as 1002 * restrictive as what has been set. Note that the current password will 1003 * remain until the user has set a new one, so the change does not take 1004 * place immediately. To prompt the user for a new password, use 1005 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This 1006 * constraint is only imposed if the administrator has also requested 1007 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The 1008 * default value is 1. 1009 * <p> 1010 * The calling device admin must have requested 1011 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1012 * this method; if it has not, a security exception will be thrown. 1013 * 1014 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1015 * with. 1016 * @param length The new desired minimum number of symbols required in the 1017 * password. A value of 0 means there is no restriction. 1018 */ 1019 public void setPasswordMinimumSymbols(ComponentName admin, int length) { 1020 if (mService != null) { 1021 try { 1022 mService.setPasswordMinimumSymbols(admin, length, UserHandle.myUserId()); 1023 } catch (RemoteException e) { 1024 Log.w(TAG, "Failed talking with device policy service", e); 1025 } 1026 } 1027 } 1028 1029 /** 1030 * Retrieve the current number of symbols required in the password for all 1031 * admins or a particular one. This is the same value as 1032 * set by {#link {@link #setPasswordMinimumSymbols(ComponentName, int)} 1033 * and only applies when the password quality is 1034 * {@link #PASSWORD_QUALITY_COMPLEX}. 1035 * 1036 * @param admin The name of the admin component to check, or null to 1037 * aggregate all admins. 1038 * @return The minimum number of symbols required in the password. 1039 */ 1040 public int getPasswordMinimumSymbols(ComponentName admin) { 1041 return getPasswordMinimumSymbols(admin, UserHandle.myUserId()); 1042 } 1043 1044 /** @hide per-user version */ 1045 public int getPasswordMinimumSymbols(ComponentName admin, int userHandle) { 1046 if (mService != null) { 1047 try { 1048 return mService.getPasswordMinimumSymbols(admin, userHandle); 1049 } catch (RemoteException e) { 1050 Log.w(TAG, "Failed talking with device policy service", e); 1051 } 1052 } 1053 return 0; 1054 } 1055 1056 /** 1057 * Called by an application that is administering the device to set the 1058 * minimum number of non-letter characters (numerical digits or symbols) 1059 * required in the password. After setting this, the user will not be able 1060 * to enter a new password that is not at least as restrictive as what has 1061 * been set. Note that the current password will remain until the user has 1062 * set a new one, so the change does not take place immediately. To prompt 1063 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} after 1064 * setting this value. This constraint is only imposed if the administrator 1065 * has also requested {@link #PASSWORD_QUALITY_COMPLEX} with 1066 * {@link #setPasswordQuality}. The default value is 0. 1067 * <p> 1068 * The calling device admin must have requested 1069 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1070 * this method; if it has not, a security exception will be thrown. 1071 * 1072 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1073 * with. 1074 * @param length The new desired minimum number of letters required in the 1075 * password. A value of 0 means there is no restriction. 1076 */ 1077 public void setPasswordMinimumNonLetter(ComponentName admin, int length) { 1078 if (mService != null) { 1079 try { 1080 mService.setPasswordMinimumNonLetter(admin, length, UserHandle.myUserId()); 1081 } catch (RemoteException e) { 1082 Log.w(TAG, "Failed talking with device policy service", e); 1083 } 1084 } 1085 } 1086 1087 /** 1088 * Retrieve the current number of non-letter characters required in the 1089 * password for all admins of this user and its profiles or a particular one. 1090 * This is the same value as set by 1091 * {#link {@link #setPasswordMinimumNonLetter(ComponentName, int)} 1092 * and only applies when the password quality is 1093 * {@link #PASSWORD_QUALITY_COMPLEX}. 1094 * 1095 * @param admin The name of the admin component to check, or null to 1096 * aggregate all admins. 1097 * @return The minimum number of letters required in the password. 1098 */ 1099 public int getPasswordMinimumNonLetter(ComponentName admin) { 1100 return getPasswordMinimumNonLetter(admin, UserHandle.myUserId()); 1101 } 1102 1103 /** @hide per-user version */ 1104 public int getPasswordMinimumNonLetter(ComponentName admin, int userHandle) { 1105 if (mService != null) { 1106 try { 1107 return mService.getPasswordMinimumNonLetter(admin, userHandle); 1108 } catch (RemoteException e) { 1109 Log.w(TAG, "Failed talking with device policy service", e); 1110 } 1111 } 1112 return 0; 1113 } 1114 1115 /** 1116 * Called by an application that is administering the device to set the length 1117 * of the password history. After setting this, the user will not be able to 1118 * enter a new password that is the same as any password in the history. Note 1119 * that the current password will remain until the user has set a new one, so 1120 * the change does not take place immediately. To prompt the user for a new 1121 * password, use {@link #ACTION_SET_NEW_PASSWORD} after setting this value. 1122 * This constraint is only imposed if the administrator has also requested 1123 * either {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} 1124 * {@link #PASSWORD_QUALITY_ALPHABETIC}, or {@link #PASSWORD_QUALITY_ALPHANUMERIC} 1125 * with {@link #setPasswordQuality}. 1126 * 1127 * <p> 1128 * The calling device admin must have requested 1129 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this 1130 * method; if it has not, a security exception will be thrown. 1131 * 1132 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1133 * with. 1134 * @param length The new desired length of password history. A value of 0 1135 * means there is no restriction. 1136 */ 1137 public void setPasswordHistoryLength(ComponentName admin, int length) { 1138 if (mService != null) { 1139 try { 1140 mService.setPasswordHistoryLength(admin, length, UserHandle.myUserId()); 1141 } catch (RemoteException e) { 1142 Log.w(TAG, "Failed talking with device policy service", e); 1143 } 1144 } 1145 } 1146 1147 /** 1148 * Called by a device admin to set the password expiration timeout. Calling this method 1149 * will restart the countdown for password expiration for the given admin, as will changing 1150 * the device password (for all admins). 1151 * 1152 * <p>The provided timeout is the time delta in ms and will be added to the current time. 1153 * For example, to have the password expire 5 days from now, timeout would be 1154 * 5 * 86400 * 1000 = 432000000 ms for timeout. 1155 * 1156 * <p>To disable password expiration, a value of 0 may be used for timeout. 1157 * 1158 * <p>The calling device admin must have requested 1159 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this 1160 * method; if it has not, a security exception will be thrown. 1161 * 1162 * <p> Note that setting the password will automatically reset the expiration time for all 1163 * active admins. Active admins do not need to explicitly call this method in that case. 1164 * 1165 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1166 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 1167 * means there is no restriction (unlimited). 1168 */ 1169 public void setPasswordExpirationTimeout(ComponentName admin, long timeout) { 1170 if (mService != null) { 1171 try { 1172 mService.setPasswordExpirationTimeout(admin, timeout, UserHandle.myUserId()); 1173 } catch (RemoteException e) { 1174 Log.w(TAG, "Failed talking with device policy service", e); 1175 } 1176 } 1177 } 1178 1179 /** 1180 * Get the password expiration timeout for the given admin. The expiration timeout is the 1181 * recurring expiration timeout provided in the call to 1182 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the 1183 * aggregate of all policy administrators if admin is null. 1184 * 1185 * @param admin The name of the admin component to check, or null to aggregate all admins. 1186 * @return The timeout for the given admin or the minimum of all timeouts 1187 */ 1188 public long getPasswordExpirationTimeout(ComponentName admin) { 1189 if (mService != null) { 1190 try { 1191 return mService.getPasswordExpirationTimeout(admin, UserHandle.myUserId()); 1192 } catch (RemoteException e) { 1193 Log.w(TAG, "Failed talking with device policy service", e); 1194 } 1195 } 1196 return 0; 1197 } 1198 1199 /** 1200 * Get the current password expiration time for the given admin or an aggregate of 1201 * all admins of this user and its profiles if admin is null. If the password is 1202 * expired, this will return the time since the password expired as a negative number. 1203 * If admin is null, then a composite of all expiration timeouts is returned 1204 * - which will be the minimum of all timeouts. 1205 * 1206 * @param admin The name of the admin component to check, or null to aggregate all admins. 1207 * @return The password expiration time, in ms. 1208 */ 1209 public long getPasswordExpiration(ComponentName admin) { 1210 if (mService != null) { 1211 try { 1212 return mService.getPasswordExpiration(admin, UserHandle.myUserId()); 1213 } catch (RemoteException e) { 1214 Log.w(TAG, "Failed talking with device policy service", e); 1215 } 1216 } 1217 return 0; 1218 } 1219 1220 /** 1221 * Retrieve the current password history length for all admins of this 1222 * user and its profiles or a particular one. 1223 * @param admin The name of the admin component to check, or null to aggregate 1224 * all admins. 1225 * @return The length of the password history 1226 */ 1227 public int getPasswordHistoryLength(ComponentName admin) { 1228 return getPasswordHistoryLength(admin, UserHandle.myUserId()); 1229 } 1230 1231 /** @hide per-user version */ 1232 public int getPasswordHistoryLength(ComponentName admin, int userHandle) { 1233 if (mService != null) { 1234 try { 1235 return mService.getPasswordHistoryLength(admin, userHandle); 1236 } catch (RemoteException e) { 1237 Log.w(TAG, "Failed talking with device policy service", e); 1238 } 1239 } 1240 return 0; 1241 } 1242 1243 /** 1244 * Return the maximum password length that the device supports for a 1245 * particular password quality. 1246 * @param quality The quality being interrogated. 1247 * @return Returns the maximum length that the user can enter. 1248 */ 1249 public int getPasswordMaximumLength(int quality) { 1250 // Kind-of arbitrary. 1251 return 16; 1252 } 1253 1254 /** 1255 * Determine whether the current password the user has set is sufficient 1256 * to meet the policy requirements (quality, minimum length) that have been 1257 * requested by the admins of this user and its profiles. 1258 * 1259 * <p>The calling device admin must have requested 1260 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call 1261 * this method; if it has not, a security exception will be thrown. 1262 * 1263 * @return Returns true if the password meets the current requirements, else false. 1264 */ 1265 public boolean isActivePasswordSufficient() { 1266 if (mService != null) { 1267 try { 1268 return mService.isActivePasswordSufficient(UserHandle.myUserId()); 1269 } catch (RemoteException e) { 1270 Log.w(TAG, "Failed talking with device policy service", e); 1271 } 1272 } 1273 return false; 1274 } 1275 1276 /** 1277 * Retrieve the number of times the user has failed at entering a 1278 * password since that last successful password entry. 1279 * 1280 * <p>The calling device admin must have requested 1281 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call 1282 * this method; if it has not, a security exception will be thrown. 1283 */ 1284 public int getCurrentFailedPasswordAttempts() { 1285 if (mService != null) { 1286 try { 1287 return mService.getCurrentFailedPasswordAttempts(UserHandle.myUserId()); 1288 } catch (RemoteException e) { 1289 Log.w(TAG, "Failed talking with device policy service", e); 1290 } 1291 } 1292 return -1; 1293 } 1294 1295 /** 1296 * Setting this to a value greater than zero enables a built-in policy 1297 * that will perform a device wipe after too many incorrect 1298 * device-unlock passwords have been entered. This built-in policy combines 1299 * watching for failed passwords and wiping the device, and requires 1300 * that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and 1301 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}. 1302 * 1303 * <p>To implement any other policy (e.g. wiping data for a particular 1304 * application only, erasing or revoking credentials, or reporting the 1305 * failure to a server), you should implement 1306 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} 1307 * instead. Do not use this API, because if the maximum count is reached, 1308 * the device will be wiped immediately, and your callback will not be invoked. 1309 * 1310 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1311 * @param num The number of failed password attempts at which point the 1312 * device will wipe its data. 1313 */ 1314 public void setMaximumFailedPasswordsForWipe(ComponentName admin, int num) { 1315 if (mService != null) { 1316 try { 1317 mService.setMaximumFailedPasswordsForWipe(admin, num, UserHandle.myUserId()); 1318 } catch (RemoteException e) { 1319 Log.w(TAG, "Failed talking with device policy service", e); 1320 } 1321 } 1322 } 1323 1324 /** 1325 * Retrieve the current maximum number of login attempts that are allowed 1326 * before the device wipes itself, for all admins of this user and its profiles 1327 * or a particular one. 1328 * @param admin The name of the admin component to check, or null to aggregate 1329 * all admins. 1330 */ 1331 public int getMaximumFailedPasswordsForWipe(ComponentName admin) { 1332 return getMaximumFailedPasswordsForWipe(admin, UserHandle.myUserId()); 1333 } 1334 1335 /** @hide per-user version */ 1336 public int getMaximumFailedPasswordsForWipe(ComponentName admin, int userHandle) { 1337 if (mService != null) { 1338 try { 1339 return mService.getMaximumFailedPasswordsForWipe(admin, userHandle); 1340 } catch (RemoteException e) { 1341 Log.w(TAG, "Failed talking with device policy service", e); 1342 } 1343 } 1344 return 0; 1345 } 1346 1347 /** 1348 * Returns the profile with the smallest maximum failed passwords for wipe, 1349 * for the given user. So for primary user, it might return the primary or 1350 * a managed profile. For a secondary user, it would be the same as the 1351 * user passed in. 1352 * @hide Used only by Keyguard 1353 */ 1354 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) { 1355 if (mService != null) { 1356 try { 1357 return mService.getProfileWithMinimumFailedPasswordsForWipe(userHandle); 1358 } catch (RemoteException e) { 1359 Log.w(TAG, "Failed talking with device policy service", e); 1360 } 1361 } 1362 return UserHandle.USER_NULL; 1363 } 1364 1365 /** 1366 * Flag for {@link #resetPassword}: don't allow other admins to change 1367 * the password again until the user has entered it. 1368 */ 1369 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001; 1370 1371 /** 1372 * Force a new device unlock password (the password needed to access the 1373 * entire device, not for individual accounts) on the user. This takes 1374 * effect immediately. 1375 * The given password must be sufficient for the 1376 * current password quality and length constraints as returned by 1377 * {@link #getPasswordQuality(ComponentName)} and 1378 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet 1379 * these constraints, then it will be rejected and false returned. Note 1380 * that the password may be a stronger quality (containing alphanumeric 1381 * characters when the requested quality is only numeric), in which case 1382 * the currently active quality will be increased to match. 1383 * 1384 * <p>The calling device admin must have requested 1385 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call 1386 * this method; if it has not, a security exception will be thrown. 1387 * 1388 * <p>Calling this from a managed profile will throw a security exception. 1389 * 1390 * @param password The new password for the user. 1391 * @param flags May be 0 or {@link #RESET_PASSWORD_REQUIRE_ENTRY}. 1392 * @return Returns true if the password was applied, or false if it is 1393 * not acceptable for the current constraints. 1394 */ 1395 public boolean resetPassword(String password, int flags) { 1396 if (mService != null) { 1397 try { 1398 return mService.resetPassword(password, flags, UserHandle.myUserId()); 1399 } catch (RemoteException e) { 1400 Log.w(TAG, "Failed talking with device policy service", e); 1401 } 1402 } 1403 return false; 1404 } 1405 1406 /** 1407 * Called by an application that is administering the device to set the 1408 * maximum time for user activity until the device will lock. This limits 1409 * the length that the user can set. It takes effect immediately. 1410 * 1411 * <p>The calling device admin must have requested 1412 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call 1413 * this method; if it has not, a security exception will be thrown. 1414 * 1415 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1416 * @param timeMs The new desired maximum time to lock in milliseconds. 1417 * A value of 0 means there is no restriction. 1418 */ 1419 public void setMaximumTimeToLock(ComponentName admin, long timeMs) { 1420 if (mService != null) { 1421 try { 1422 mService.setMaximumTimeToLock(admin, timeMs, UserHandle.myUserId()); 1423 } catch (RemoteException e) { 1424 Log.w(TAG, "Failed talking with device policy service", e); 1425 } 1426 } 1427 } 1428 1429 /** 1430 * Retrieve the current maximum time to unlock for all admins of this user 1431 * and its profiles or a particular one. 1432 * @param admin The name of the admin component to check, or null to aggregate 1433 * all admins. 1434 * @return time in milliseconds for the given admin or the minimum value (strictest) of 1435 * all admins if admin is null. Returns 0 if there are no restrictions. 1436 */ 1437 public long getMaximumTimeToLock(ComponentName admin) { 1438 return getMaximumTimeToLock(admin, UserHandle.myUserId()); 1439 } 1440 1441 /** @hide per-user version */ 1442 public long getMaximumTimeToLock(ComponentName admin, int userHandle) { 1443 if (mService != null) { 1444 try { 1445 return mService.getMaximumTimeToLock(admin, userHandle); 1446 } catch (RemoteException e) { 1447 Log.w(TAG, "Failed talking with device policy service", e); 1448 } 1449 } 1450 return 0; 1451 } 1452 1453 /** 1454 * Make the device lock immediately, as if the lock screen timeout has 1455 * expired at the point of this call. 1456 * 1457 * <p>The calling device admin must have requested 1458 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call 1459 * this method; if it has not, a security exception will be thrown. 1460 */ 1461 public void lockNow() { 1462 if (mService != null) { 1463 try { 1464 mService.lockNow(); 1465 } catch (RemoteException e) { 1466 Log.w(TAG, "Failed talking with device policy service", e); 1467 } 1468 } 1469 } 1470 1471 /** 1472 * Flag for {@link #wipeData(int)}: also erase the device's external 1473 * storage. 1474 */ 1475 public static final int WIPE_EXTERNAL_STORAGE = 0x0001; 1476 1477 /** 1478 * Ask the user data be wiped. This will cause the device to reboot, 1479 * erasing all user data while next booting up. External storage such 1480 * as SD cards will be also erased if the flag {@link #WIPE_EXTERNAL_STORAGE} 1481 * is set. 1482 * 1483 * <p>The calling device admin must have requested 1484 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to be able to call 1485 * this method; if it has not, a security exception will be thrown. 1486 * 1487 * @param flags Bit mask of additional options: currently 0 and 1488 * {@link #WIPE_EXTERNAL_STORAGE} are supported. 1489 */ 1490 public void wipeData(int flags) { 1491 if (mService != null) { 1492 try { 1493 mService.wipeData(flags, UserHandle.myUserId()); 1494 } catch (RemoteException e) { 1495 Log.w(TAG, "Failed talking with device policy service", e); 1496 } 1497 } 1498 } 1499 1500 /** 1501 * Called by an application that is administering the device to set the 1502 * global proxy and exclusion list. 1503 * <p> 1504 * The calling device admin must have requested 1505 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call 1506 * this method; if it has not, a security exception will be thrown. 1507 * Only the first device admin can set the proxy. If a second admin attempts 1508 * to set the proxy, the {@link ComponentName} of the admin originally setting the 1509 * proxy will be returned. If successful in setting the proxy, null will 1510 * be returned. 1511 * The method can be called repeatedly by the device admin alrady setting the 1512 * proxy to update the proxy and exclusion list. 1513 * 1514 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1515 * with. 1516 * @param proxySpec the global proxy desired. Must be an HTTP Proxy. 1517 * Pass Proxy.NO_PROXY to reset the proxy. 1518 * @param exclusionList a list of domains to be excluded from the global proxy. 1519 * @return returns null if the proxy was successfully set, or a {@link ComponentName} 1520 * of the device admin that sets thew proxy otherwise. 1521 * @hide 1522 */ 1523 public ComponentName setGlobalProxy(ComponentName admin, Proxy proxySpec, 1524 List<String> exclusionList ) { 1525 if (proxySpec == null) { 1526 throw new NullPointerException(); 1527 } 1528 if (mService != null) { 1529 try { 1530 String hostSpec; 1531 String exclSpec; 1532 if (proxySpec.equals(Proxy.NO_PROXY)) { 1533 hostSpec = null; 1534 exclSpec = null; 1535 } else { 1536 if (!proxySpec.type().equals(Proxy.Type.HTTP)) { 1537 throw new IllegalArgumentException(); 1538 } 1539 InetSocketAddress sa = (InetSocketAddress)proxySpec.address(); 1540 String hostName = sa.getHostName(); 1541 int port = sa.getPort(); 1542 StringBuilder hostBuilder = new StringBuilder(); 1543 hostSpec = hostBuilder.append(hostName) 1544 .append(":").append(Integer.toString(port)).toString(); 1545 if (exclusionList == null) { 1546 exclSpec = ""; 1547 } else { 1548 StringBuilder listBuilder = new StringBuilder(); 1549 boolean firstDomain = true; 1550 for (String exclDomain : exclusionList) { 1551 if (!firstDomain) { 1552 listBuilder = listBuilder.append(","); 1553 } else { 1554 firstDomain = false; 1555 } 1556 listBuilder = listBuilder.append(exclDomain.trim()); 1557 } 1558 exclSpec = listBuilder.toString(); 1559 } 1560 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec) 1561 != android.net.Proxy.PROXY_VALID) 1562 throw new IllegalArgumentException(); 1563 } 1564 return mService.setGlobalProxy(admin, hostSpec, exclSpec, UserHandle.myUserId()); 1565 } catch (RemoteException e) { 1566 Log.w(TAG, "Failed talking with device policy service", e); 1567 } 1568 } 1569 return null; 1570 } 1571 1572 /** 1573 * Set a network-independent global HTTP proxy. This is not normally what you want 1574 * for typical HTTP proxies - they are generally network dependent. However if you're 1575 * doing something unusual like general internal filtering this may be useful. On 1576 * a private network where the proxy is not accessible, you may break HTTP using this. 1577 * 1578 * <p>This method requires the caller to be the device owner. 1579 * 1580 * <p>This proxy is only a recommendation and it is possible that some apps will ignore it. 1581 * @see ProxyInfo 1582 * 1583 * @param admin Which {@link DeviceAdminReceiver} this request is associated 1584 * with. 1585 * @param proxyInfo The a {@link ProxyInfo} object defining the new global 1586 * HTTP proxy. A {@code null} value will clear the global HTTP proxy. 1587 */ 1588 public void setRecommendedGlobalProxy(ComponentName admin, ProxyInfo proxyInfo) { 1589 if (mService != null) { 1590 try { 1591 mService.setRecommendedGlobalProxy(admin, proxyInfo); 1592 } catch (RemoteException e) { 1593 Log.w(TAG, "Failed talking with device policy service", e); 1594 } 1595 } 1596 } 1597 1598 /** 1599 * Returns the component name setting the global proxy. 1600 * @return ComponentName object of the device admin that set the global proxy, or 1601 * null if no admin has set the proxy. 1602 * @hide 1603 */ 1604 public ComponentName getGlobalProxyAdmin() { 1605 if (mService != null) { 1606 try { 1607 return mService.getGlobalProxyAdmin(UserHandle.myUserId()); 1608 } catch (RemoteException e) { 1609 Log.w(TAG, "Failed talking with device policy service", e); 1610 } 1611 } 1612 return null; 1613 } 1614 1615 /** 1616 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 1617 * indicating that encryption is not supported. 1618 */ 1619 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0; 1620 1621 /** 1622 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 1623 * indicating that encryption is supported, but is not currently active. 1624 */ 1625 public static final int ENCRYPTION_STATUS_INACTIVE = 1; 1626 1627 /** 1628 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 1629 * indicating that encryption is not currently active, but is currently 1630 * being activated. This is only reported by devices that support 1631 * encryption of data and only when the storage is currently 1632 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data 1633 * to become encrypted will never return this value. 1634 */ 1635 public static final int ENCRYPTION_STATUS_ACTIVATING = 2; 1636 1637 /** 1638 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}: 1639 * indicating that encryption is active. 1640 */ 1641 public static final int ENCRYPTION_STATUS_ACTIVE = 3; 1642 1643 /** 1644 * Activity action: begin the process of encrypting data on the device. This activity should 1645 * be launched after using {@link #setStorageEncryption} to request encryption be activated. 1646 * After resuming from this activity, use {@link #getStorageEncryption} 1647 * to check encryption status. However, on some devices this activity may never return, as 1648 * it may trigger a reboot and in some cases a complete data wipe of the device. 1649 */ 1650 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 1651 public static final String ACTION_START_ENCRYPTION 1652 = "android.app.action.START_ENCRYPTION"; 1653 1654 /** 1655 * Widgets are enabled in keyguard 1656 */ 1657 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0; 1658 1659 /** 1660 * Disable all keyguard widgets. Has no effect. 1661 */ 1662 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0; 1663 1664 /** 1665 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password) 1666 */ 1667 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1; 1668 1669 /** 1670 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password) 1671 */ 1672 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2; 1673 1674 /** 1675 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password) 1676 */ 1677 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3; 1678 1679 /** 1680 * Ignore trust agent state on secure keyguard screens 1681 * (e.g. PIN/Pattern/Password). 1682 */ 1683 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4; 1684 1685 /** 1686 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password). 1687 */ 1688 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5; 1689 1690 /** 1691 * Disable all current and future keyguard customizations. 1692 */ 1693 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff; 1694 1695 /** 1696 * Called by an application that is administering the device to 1697 * request that the storage system be encrypted. 1698 * 1699 * <p>When multiple device administrators attempt to control device 1700 * encryption, the most secure, supported setting will always be 1701 * used. If any device administrator requests device encryption, 1702 * it will be enabled; Conversely, if a device administrator 1703 * attempts to disable device encryption while another 1704 * device administrator has enabled it, the call to disable will 1705 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}). 1706 * 1707 * <p>This policy controls encryption of the secure (application data) storage area. Data 1708 * written to other storage areas may or may not be encrypted, and this policy does not require 1709 * or control the encryption of any other storage areas. 1710 * There is one exception: If {@link android.os.Environment#isExternalStorageEmulated()} is 1711 * {@code true}, then the directory returned by 1712 * {@link android.os.Environment#getExternalStorageDirectory()} must be written to disk 1713 * within the encrypted storage area. 1714 * 1715 * <p>Important Note: On some devices, it is possible to encrypt storage without requiring 1716 * the user to create a device PIN or Password. In this case, the storage is encrypted, but 1717 * the encryption key may not be fully secured. For maximum security, the administrator should 1718 * also require (and check for) a pattern, PIN, or password. 1719 * 1720 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1721 * @param encrypt true to request encryption, false to release any previous request 1722 * @return the new request status (for all active admins) - will be one of 1723 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or 1724 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use 1725 * {@link #getStorageEncryptionStatus()} to query the actual device state. 1726 */ 1727 public int setStorageEncryption(ComponentName admin, boolean encrypt) { 1728 if (mService != null) { 1729 try { 1730 return mService.setStorageEncryption(admin, encrypt, UserHandle.myUserId()); 1731 } catch (RemoteException e) { 1732 Log.w(TAG, "Failed talking with device policy service", e); 1733 } 1734 } 1735 return ENCRYPTION_STATUS_UNSUPPORTED; 1736 } 1737 1738 /** 1739 * Called by an application that is administering the device to 1740 * determine the requested setting for secure storage. 1741 * 1742 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null, 1743 * this will return the requested encryption setting as an aggregate of all active 1744 * administrators. 1745 * @return true if the admin(s) are requesting encryption, false if not. 1746 */ 1747 public boolean getStorageEncryption(ComponentName admin) { 1748 if (mService != null) { 1749 try { 1750 return mService.getStorageEncryption(admin, UserHandle.myUserId()); 1751 } catch (RemoteException e) { 1752 Log.w(TAG, "Failed talking with device policy service", e); 1753 } 1754 } 1755 return false; 1756 } 1757 1758 /** 1759 * Called by an application that is administering the device to 1760 * determine the current encryption status of the device. 1761 * 1762 * Depending on the returned status code, the caller may proceed in different 1763 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the 1764 * storage system does not support encryption. If the 1765 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link 1766 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the 1767 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or 1768 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required. 1769 * 1770 * @return current status of encryption. The value will be one of 1771 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, 1772 * {@link #ENCRYPTION_STATUS_ACTIVATING}, or{@link #ENCRYPTION_STATUS_ACTIVE}. 1773 */ 1774 public int getStorageEncryptionStatus() { 1775 return getStorageEncryptionStatus(UserHandle.myUserId()); 1776 } 1777 1778 /** @hide per-user version */ 1779 public int getStorageEncryptionStatus(int userHandle) { 1780 if (mService != null) { 1781 try { 1782 return mService.getStorageEncryptionStatus(userHandle); 1783 } catch (RemoteException e) { 1784 Log.w(TAG, "Failed talking with device policy service", e); 1785 } 1786 } 1787 return ENCRYPTION_STATUS_UNSUPPORTED; 1788 } 1789 1790 /** 1791 * Installs the given certificate as a user CA. 1792 * 1793 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1794 * @param certBuffer encoded form of the certificate to install. 1795 * 1796 * @return false if the certBuffer cannot be parsed or installation is 1797 * interrupted, true otherwise. 1798 */ 1799 public boolean installCaCert(ComponentName admin, byte[] certBuffer) { 1800 if (mService != null) { 1801 try { 1802 return mService.installCaCert(admin, certBuffer); 1803 } catch (RemoteException e) { 1804 Log.w(TAG, "Failed talking with device policy service", e); 1805 } 1806 } 1807 return false; 1808 } 1809 1810 /** 1811 * Uninstalls the given certificate from trusted user CAs, if present. 1812 * 1813 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1814 * @param certBuffer encoded form of the certificate to remove. 1815 */ 1816 public void uninstallCaCert(ComponentName admin, byte[] certBuffer) { 1817 if (mService != null) { 1818 try { 1819 final String alias = getCaCertAlias(certBuffer); 1820 mService.uninstallCaCert(admin, alias); 1821 } catch (CertificateException e) { 1822 Log.w(TAG, "Unable to parse certificate", e); 1823 } catch (RemoteException e) { 1824 Log.w(TAG, "Failed talking with device policy service", e); 1825 } 1826 } 1827 } 1828 1829 /** 1830 * Returns all CA certificates that are currently trusted, excluding system CA certificates. 1831 * If a user has installed any certificates by other means than device policy these will be 1832 * included too. 1833 * 1834 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1835 * @return a List of byte[] arrays, each encoding one user CA certificate. 1836 */ 1837 public List<byte[]> getInstalledCaCerts(ComponentName admin) { 1838 List<byte[]> certs = new ArrayList<byte[]>(); 1839 if (mService != null) { 1840 try { 1841 mService.enforceCanManageCaCerts(admin); 1842 final TrustedCertificateStore certStore = new TrustedCertificateStore(); 1843 for (String alias : certStore.userAliases()) { 1844 try { 1845 certs.add(certStore.getCertificate(alias).getEncoded()); 1846 } catch (CertificateException ce) { 1847 Log.w(TAG, "Could not encode certificate: " + alias, ce); 1848 } 1849 } 1850 } catch (RemoteException re) { 1851 Log.w(TAG, "Failed talking with device policy service", re); 1852 } 1853 } 1854 return certs; 1855 } 1856 1857 /** 1858 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by 1859 * means other than device policy will also be removed, except for system CA certificates. 1860 * 1861 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1862 */ 1863 public void uninstallAllUserCaCerts(ComponentName admin) { 1864 if (mService != null) { 1865 for (String alias : new TrustedCertificateStore().userAliases()) { 1866 try { 1867 mService.uninstallCaCert(admin, alias); 1868 } catch (RemoteException re) { 1869 Log.w(TAG, "Failed talking with device policy service", re); 1870 } 1871 } 1872 } 1873 } 1874 1875 /** 1876 * Returns whether this certificate is installed as a trusted CA. 1877 * 1878 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1879 * @param certBuffer encoded form of the certificate to look up. 1880 */ 1881 public boolean hasCaCertInstalled(ComponentName admin, byte[] certBuffer) { 1882 if (mService != null) { 1883 try { 1884 mService.enforceCanManageCaCerts(admin); 1885 return getCaCertAlias(certBuffer) != null; 1886 } catch (RemoteException re) { 1887 Log.w(TAG, "Failed talking with device policy service", re); 1888 } catch (CertificateException ce) { 1889 Log.w(TAG, "Could not parse certificate", ce); 1890 } 1891 } 1892 return false; 1893 } 1894 1895 /** 1896 * Called by a device or profile owner to install a certificate and private key pair. The 1897 * keypair will be visible to all apps within the profile. 1898 * 1899 * @param who Which {@link DeviceAdminReceiver} this request is associated with. 1900 * @param privKey The private key to install. 1901 * @param cert The certificate to install. 1902 * @param alias The private key alias under which to install the certificate. If a certificate 1903 * with that alias already exists, it will be overwritten. 1904 * @return {@code true} if the keys were installed, {@code false} otherwise. 1905 */ 1906 public boolean installKeyPair(ComponentName who, PrivateKey privKey, Certificate cert, 1907 String alias) { 1908 try { 1909 final byte[] pemCert = Credentials.convertToPem(cert); 1910 return mService.installKeyPair(who, privKey.getEncoded(), pemCert, alias); 1911 } catch (CertificateException e) { 1912 Log.w(TAG, "Error encoding certificate", e); 1913 } catch (IOException e) { 1914 Log.w(TAG, "Error writing certificate", e); 1915 } catch (RemoteException e) { 1916 Log.w(TAG, "Failed talking with device policy service", e); 1917 } 1918 return false; 1919 } 1920 1921 /** 1922 * Returns the alias of a given CA certificate in the certificate store, or null if it 1923 * doesn't exist. 1924 */ 1925 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException { 1926 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509"); 1927 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate( 1928 new ByteArrayInputStream(certBuffer)); 1929 return new TrustedCertificateStore().getCertificateAlias(cert); 1930 } 1931 1932 /** 1933 * Called by an application that is administering the device to disable all cameras 1934 * on the device, for this user. After setting this, no applications running as this user 1935 * will be able to access any cameras on the device. 1936 * 1937 * <p>The calling device admin must have requested 1938 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call 1939 * this method; if it has not, a security exception will be thrown. 1940 * 1941 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1942 * @param disabled Whether or not the camera should be disabled. 1943 */ 1944 public void setCameraDisabled(ComponentName admin, boolean disabled) { 1945 if (mService != null) { 1946 try { 1947 mService.setCameraDisabled(admin, disabled, UserHandle.myUserId()); 1948 } catch (RemoteException e) { 1949 Log.w(TAG, "Failed talking with device policy service", e); 1950 } 1951 } 1952 } 1953 1954 /** 1955 * Determine whether or not the device's cameras have been disabled for this user, 1956 * either by the current admin, if specified, or all admins. 1957 * @param admin The name of the admin component to check, or null to check if any admins 1958 * have disabled the camera 1959 */ 1960 public boolean getCameraDisabled(ComponentName admin) { 1961 return getCameraDisabled(admin, UserHandle.myUserId()); 1962 } 1963 1964 /** @hide per-user version */ 1965 public boolean getCameraDisabled(ComponentName admin, int userHandle) { 1966 if (mService != null) { 1967 try { 1968 return mService.getCameraDisabled(admin, userHandle); 1969 } catch (RemoteException e) { 1970 Log.w(TAG, "Failed talking with device policy service", e); 1971 } 1972 } 1973 return false; 1974 } 1975 1976 /** 1977 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling 1978 * screen capture also prevents the content from being shown on display devices that do not have 1979 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about 1980 * secure surfaces and secure displays. 1981 * 1982 * <p>The calling device admin must be a device or profile owner. If it is not, a 1983 * security exception will be thrown. 1984 * 1985 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 1986 * @param disabled Whether screen capture is disabled or not. 1987 */ 1988 public void setScreenCaptureDisabled(ComponentName admin, boolean disabled) { 1989 if (mService != null) { 1990 try { 1991 mService.setScreenCaptureDisabled(admin, UserHandle.myUserId(), disabled); 1992 } catch (RemoteException e) { 1993 Log.w(TAG, "Failed talking with device policy service", e); 1994 } 1995 } 1996 } 1997 1998 /** 1999 * Determine whether or not screen capture has been disabled by the current 2000 * admin, if specified, or all admins. 2001 * @param admin The name of the admin component to check, or null to check if any admins 2002 * have disabled screen capture. 2003 */ 2004 public boolean getScreenCaptureDisabled(ComponentName admin) { 2005 return getScreenCaptureDisabled(admin, UserHandle.myUserId()); 2006 } 2007 2008 /** @hide per-user version */ 2009 public boolean getScreenCaptureDisabled(ComponentName admin, int userHandle) { 2010 if (mService != null) { 2011 try { 2012 return mService.getScreenCaptureDisabled(admin, userHandle); 2013 } catch (RemoteException e) { 2014 Log.w(TAG, "Failed talking with device policy service", e); 2015 } 2016 } 2017 return false; 2018 } 2019 2020 /** 2021 * Called by a device owner to set whether auto time is required. If auto time is 2022 * required the user cannot set the date and time, but has to use network date and time. 2023 * 2024 * <p>Note: if auto time is required the user can still manually set the time zone. 2025 * 2026 * <p>The calling device admin must be a device owner. If it is not, a security exception will 2027 * be thrown. 2028 * 2029 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2030 * @param required Whether auto time is set required or not. 2031 */ 2032 public void setAutoTimeRequired(ComponentName admin, boolean required) { 2033 if (mService != null) { 2034 try { 2035 mService.setAutoTimeRequired(admin, UserHandle.myUserId(), required); 2036 } catch (RemoteException e) { 2037 Log.w(TAG, "Failed talking with device policy service", e); 2038 } 2039 } 2040 } 2041 2042 /** 2043 * @return true if auto time is required. 2044 */ 2045 public boolean getAutoTimeRequired() { 2046 if (mService != null) { 2047 try { 2048 return mService.getAutoTimeRequired(); 2049 } catch (RemoteException e) { 2050 Log.w(TAG, "Failed talking with device policy service", e); 2051 } 2052 } 2053 return false; 2054 } 2055 2056 /** 2057 * Called by an application that is administering the device to disable keyguard customizations, 2058 * such as widgets. After setting this, keyguard features will be disabled according to the 2059 * provided feature list. 2060 * 2061 * <p>The calling device admin must have requested 2062 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call 2063 * this method; if it has not, a security exception will be thrown. 2064 * 2065 * <p>Calling this from a managed profile will throw a security exception. 2066 * 2067 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2068 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default), 2069 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA}, 2070 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, 2071 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_FEATURES_ALL} 2072 */ 2073 public void setKeyguardDisabledFeatures(ComponentName admin, int which) { 2074 if (mService != null) { 2075 try { 2076 mService.setKeyguardDisabledFeatures(admin, which, UserHandle.myUserId()); 2077 } catch (RemoteException e) { 2078 Log.w(TAG, "Failed talking with device policy service", e); 2079 } 2080 } 2081 } 2082 2083 /** 2084 * Determine whether or not features have been disabled in keyguard either by the current 2085 * admin, if specified, or all admins. 2086 * @param admin The name of the admin component to check, or null to check if any admins 2087 * have disabled features in keyguard. 2088 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)} 2089 * for a list. 2090 */ 2091 public int getKeyguardDisabledFeatures(ComponentName admin) { 2092 return getKeyguardDisabledFeatures(admin, UserHandle.myUserId()); 2093 } 2094 2095 /** @hide per-user version */ 2096 public int getKeyguardDisabledFeatures(ComponentName admin, int userHandle) { 2097 if (mService != null) { 2098 try { 2099 return mService.getKeyguardDisabledFeatures(admin, userHandle); 2100 } catch (RemoteException e) { 2101 Log.w(TAG, "Failed talking with device policy service", e); 2102 } 2103 } 2104 return KEYGUARD_DISABLE_FEATURES_NONE; 2105 } 2106 2107 /** 2108 * @hide 2109 */ 2110 public void setActiveAdmin(ComponentName policyReceiver, boolean refreshing, int userHandle) { 2111 if (mService != null) { 2112 try { 2113 mService.setActiveAdmin(policyReceiver, refreshing, userHandle); 2114 } catch (RemoteException e) { 2115 Log.w(TAG, "Failed talking with device policy service", e); 2116 } 2117 } 2118 } 2119 2120 /** 2121 * @hide 2122 */ 2123 public void setActiveAdmin(ComponentName policyReceiver, boolean refreshing) { 2124 setActiveAdmin(policyReceiver, refreshing, UserHandle.myUserId()); 2125 } 2126 2127 /** 2128 * Returns the DeviceAdminInfo as defined by the administrator's package info & meta-data 2129 * @hide 2130 */ 2131 public DeviceAdminInfo getAdminInfo(ComponentName cn) { 2132 ActivityInfo ai; 2133 try { 2134 ai = mContext.getPackageManager().getReceiverInfo(cn, 2135 PackageManager.GET_META_DATA); 2136 } catch (PackageManager.NameNotFoundException e) { 2137 Log.w(TAG, "Unable to retrieve device policy " + cn, e); 2138 return null; 2139 } 2140 2141 ResolveInfo ri = new ResolveInfo(); 2142 ri.activityInfo = ai; 2143 2144 try { 2145 return new DeviceAdminInfo(mContext, ri); 2146 } catch (XmlPullParserException e) { 2147 Log.w(TAG, "Unable to parse device policy " + cn, e); 2148 return null; 2149 } catch (IOException e) { 2150 Log.w(TAG, "Unable to parse device policy " + cn, e); 2151 return null; 2152 } 2153 } 2154 2155 /** 2156 * @hide 2157 */ 2158 public void getRemoveWarning(ComponentName admin, RemoteCallback result) { 2159 if (mService != null) { 2160 try { 2161 mService.getRemoveWarning(admin, result, UserHandle.myUserId()); 2162 } catch (RemoteException e) { 2163 Log.w(TAG, "Failed talking with device policy service", e); 2164 } 2165 } 2166 } 2167 2168 /** 2169 * @hide 2170 */ 2171 public void setActivePasswordState(int quality, int length, int letters, int uppercase, 2172 int lowercase, int numbers, int symbols, int nonletter, int userHandle) { 2173 if (mService != null) { 2174 try { 2175 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase, 2176 numbers, symbols, nonletter, userHandle); 2177 } catch (RemoteException e) { 2178 Log.w(TAG, "Failed talking with device policy service", e); 2179 } 2180 } 2181 } 2182 2183 /** 2184 * @hide 2185 */ 2186 public void reportFailedPasswordAttempt(int userHandle) { 2187 if (mService != null) { 2188 try { 2189 mService.reportFailedPasswordAttempt(userHandle); 2190 } catch (RemoteException e) { 2191 Log.w(TAG, "Failed talking with device policy service", e); 2192 } 2193 } 2194 } 2195 2196 /** 2197 * @hide 2198 */ 2199 public void reportSuccessfulPasswordAttempt(int userHandle) { 2200 if (mService != null) { 2201 try { 2202 mService.reportSuccessfulPasswordAttempt(userHandle); 2203 } catch (RemoteException e) { 2204 Log.w(TAG, "Failed talking with device policy service", e); 2205 } 2206 } 2207 } 2208 2209 /** 2210 * @hide 2211 * Sets the given package as the device owner. The package must already be installed and there 2212 * shouldn't be an existing device owner registered, for this call to succeed. Also, this 2213 * method must be called before the device is provisioned. 2214 * @param packageName the package name of the application to be registered as the device owner. 2215 * @return whether the package was successfully registered as the device owner. 2216 * @throws IllegalArgumentException if the package name is null or invalid 2217 * @throws IllegalStateException if a device owner is already registered or the device has 2218 * already been provisioned. 2219 */ 2220 public boolean setDeviceOwner(String packageName) throws IllegalArgumentException, 2221 IllegalStateException { 2222 return setDeviceOwner(packageName, null); 2223 } 2224 2225 /** 2226 * @hide 2227 * Sets the given package as the device owner. The package must already be installed and there 2228 * shouldn't be an existing device owner registered, for this call to succeed. Also, this 2229 * method must be called before the device is provisioned. 2230 * @param packageName the package name of the application to be registered as the device owner. 2231 * @param ownerName the human readable name of the institution that owns this device. 2232 * @return whether the package was successfully registered as the device owner. 2233 * @throws IllegalArgumentException if the package name is null or invalid 2234 * @throws IllegalStateException if a device owner is already registered or the device has 2235 * already been provisioned. 2236 */ 2237 public boolean setDeviceOwner(String packageName, String ownerName) 2238 throws IllegalArgumentException, IllegalStateException { 2239 if (mService != null) { 2240 try { 2241 return mService.setDeviceOwner(packageName, ownerName); 2242 } catch (RemoteException re) { 2243 Log.w(TAG, "Failed to set device owner"); 2244 } 2245 } 2246 return false; 2247 } 2248 2249 /** 2250 * Used to determine if a particular package has been registered as a Device Owner app. 2251 * A device owner app is a special device admin that cannot be deactivated by the user, once 2252 * activated as a device admin. It also cannot be uninstalled. To check if a particular 2253 * package is currently registered as the device owner app, pass in the package name from 2254 * {@link Context#getPackageName()} to this method.<p/>This is useful for device 2255 * admin apps that want to check if they are also registered as the device owner app. The 2256 * exact mechanism by which a device admin app is registered as a device owner app is defined by 2257 * the setup process. 2258 * @param packageName the package name of the app, to compare with the registered device owner 2259 * app, if any. 2260 * @return whether or not the package is registered as the device owner app. 2261 */ 2262 public boolean isDeviceOwnerApp(String packageName) { 2263 if (mService != null) { 2264 try { 2265 return mService.isDeviceOwner(packageName); 2266 } catch (RemoteException re) { 2267 Log.w(TAG, "Failed to check device owner"); 2268 } 2269 } 2270 return false; 2271 } 2272 2273 /** 2274 * @hide 2275 * Redirect to isDeviceOwnerApp. 2276 */ 2277 public boolean isDeviceOwner(String packageName) { 2278 return isDeviceOwnerApp(packageName); 2279 } 2280 2281 /** 2282 * Clears the current device owner. The caller must be the device owner. 2283 * 2284 * This function should be used cautiously as once it is called it cannot 2285 * be undone. The device owner can only be set as a part of device setup 2286 * before setup completes. 2287 * 2288 * @param packageName The package name of the device owner. 2289 */ 2290 public void clearDeviceOwnerApp(String packageName) { 2291 if (mService != null) { 2292 try { 2293 mService.clearDeviceOwner(packageName); 2294 } catch (RemoteException re) { 2295 Log.w(TAG, "Failed to clear device owner"); 2296 } 2297 } 2298 } 2299 2300 /** @hide */ 2301 @SystemApi 2302 public String getDeviceOwner() { 2303 if (mService != null) { 2304 try { 2305 return mService.getDeviceOwner(); 2306 } catch (RemoteException re) { 2307 Log.w(TAG, "Failed to get device owner"); 2308 } 2309 } 2310 return null; 2311 } 2312 2313 /** @hide */ 2314 public String getDeviceOwnerName() { 2315 if (mService != null) { 2316 try { 2317 return mService.getDeviceOwnerName(); 2318 } catch (RemoteException re) { 2319 Log.w(TAG, "Failed to get device owner"); 2320 } 2321 } 2322 return null; 2323 } 2324 2325 /** 2326 * @hide 2327 * @deprecated Use #ACTION_SET_PROFILE_OWNER 2328 * Sets the given component as an active admin and registers the package as the profile 2329 * owner for this user. The package must already be installed and there shouldn't be 2330 * an existing profile owner registered for this user. Also, this method must be called 2331 * before the user setup has been completed. 2332 * <p> 2333 * This method can only be called by system apps that hold MANAGE_USERS permission and 2334 * MANAGE_DEVICE_ADMINS permission. 2335 * @param admin The component to register as an active admin and profile owner. 2336 * @param ownerName The user-visible name of the entity that is managing this user. 2337 * @return whether the admin was successfully registered as the profile owner. 2338 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or 2339 * the user has already been set up. 2340 */ 2341 @SystemApi 2342 public boolean setActiveProfileOwner(ComponentName admin, String ownerName) 2343 throws IllegalArgumentException { 2344 if (mService != null) { 2345 try { 2346 final int myUserId = UserHandle.myUserId(); 2347 mService.setActiveAdmin(admin, false, myUserId); 2348 return mService.setProfileOwner(admin, ownerName, myUserId); 2349 } catch (RemoteException re) { 2350 Log.w(TAG, "Failed to set profile owner " + re); 2351 throw new IllegalArgumentException("Couldn't set profile owner.", re); 2352 } 2353 } 2354 return false; 2355 } 2356 2357 /** 2358 * @hide 2359 * Clears the active profile owner and removes all user restrictions. The caller must 2360 * be from the same package as the active profile owner for this user, otherwise a 2361 * SecurityException will be thrown. 2362 * 2363 * @param admin The component to remove as the profile owner. 2364 * @return 2365 */ 2366 @SystemApi 2367 public void clearProfileOwner(ComponentName admin) { 2368 if (mService != null) { 2369 try { 2370 mService.clearProfileOwner(admin); 2371 } catch (RemoteException re) { 2372 Log.w(TAG, "Failed to clear profile owner " + admin + re); 2373 } 2374 } 2375 } 2376 2377 /** 2378 * @hide 2379 * Checks if the user was already setup. 2380 */ 2381 public boolean hasUserSetupCompleted() { 2382 if (mService != null) { 2383 try { 2384 return mService.hasUserSetupCompleted(); 2385 } catch (RemoteException re) { 2386 Log.w(TAG, "Failed to check if user setup has completed"); 2387 } 2388 } 2389 return true; 2390 } 2391 2392 /** 2393 * @deprecated Use setProfileOwner(ComponentName ...) 2394 * @hide 2395 * Sets the given package as the profile owner of the given user profile. The package must 2396 * already be installed and there shouldn't be an existing profile owner registered for this 2397 * user. Also, this method must be called before the user has been used for the first time. 2398 * @param packageName the package name of the application to be registered as profile owner. 2399 * @param ownerName the human readable name of the organisation associated with this DPM. 2400 * @param userHandle the userId to set the profile owner for. 2401 * @return whether the package was successfully registered as the profile owner. 2402 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or 2403 * the user has already been set up. 2404 */ 2405 public boolean setProfileOwner(String packageName, String ownerName, int userHandle) 2406 throws IllegalArgumentException { 2407 if (packageName == null) { 2408 throw new NullPointerException("packageName cannot be null"); 2409 } 2410 return setProfileOwner(new ComponentName(packageName, ""), ownerName, userHandle); 2411 } 2412 2413 /** 2414 * @hide 2415 * Sets the given component as the profile owner of the given user profile. The package must 2416 * already be installed and there shouldn't be an existing profile owner registered for this 2417 * user. Only the system can call this API if the user has already completed setup. 2418 * @param admin the component name to be registered as profile owner. 2419 * @param ownerName the human readable name of the organisation associated with this DPM. 2420 * @param userHandle the userId to set the profile owner for. 2421 * @return whether the component was successfully registered as the profile owner. 2422 * @throws IllegalArgumentException if admin is null, the package isn't installed, or 2423 * the user has already been set up. 2424 */ 2425 public boolean setProfileOwner(ComponentName admin, String ownerName, int userHandle) 2426 throws IllegalArgumentException { 2427 if (admin == null) { 2428 throw new NullPointerException("admin cannot be null"); 2429 } 2430 if (mService != null) { 2431 try { 2432 if (ownerName == null) { 2433 ownerName = ""; 2434 } 2435 return mService.setProfileOwner(admin, ownerName, userHandle); 2436 } catch (RemoteException re) { 2437 Log.w(TAG, "Failed to set profile owner", re); 2438 throw new IllegalArgumentException("Couldn't set profile owner.", re); 2439 } 2440 } 2441 return false; 2442 } 2443 2444 /** 2445 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to 2446 * be used. Only the profile owner can call this. 2447 * 2448 * @see #isProfileOwnerApp 2449 * 2450 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2451 */ 2452 public void setProfileEnabled(ComponentName admin) { 2453 if (mService != null) { 2454 try { 2455 mService.setProfileEnabled(admin); 2456 } catch (RemoteException e) { 2457 Log.w(TAG, "Failed talking with device policy service", e); 2458 } 2459 } 2460 } 2461 2462 /** 2463 * Sets the name of the profile. In the device owner case it sets the name of the user 2464 * which it is called from. Only a profile owner or device owner can call this. If this is 2465 * never called by the profile or device owner, the name will be set to default values. 2466 * 2467 * @see #isProfileOwnerApp 2468 * @see #isDeviceOwnerApp 2469 * 2470 * @param profileName The name of the profile. 2471 */ 2472 public void setProfileName(ComponentName who, String profileName) { 2473 if (mService != null) { 2474 try { 2475 mService.setProfileName(who, profileName); 2476 } catch (RemoteException e) { 2477 Log.w(TAG, "Failed talking with device policy service", e); 2478 } 2479 } 2480} 2481 2482 /** 2483 * Used to determine if a particular package is registered as the profile owner for the 2484 * current user. A profile owner is a special device admin that has additional privileges 2485 * within the profile. 2486 * 2487 * @param packageName The package name of the app to compare with the registered profile owner. 2488 * @return Whether or not the package is registered as the profile owner. 2489 */ 2490 public boolean isProfileOwnerApp(String packageName) { 2491 if (mService != null) { 2492 try { 2493 ComponentName profileOwner = mService.getProfileOwner( 2494 Process.myUserHandle().getIdentifier()); 2495 return profileOwner != null 2496 && profileOwner.getPackageName().equals(packageName); 2497 } catch (RemoteException re) { 2498 Log.w(TAG, "Failed to check profile owner"); 2499 } 2500 } 2501 return false; 2502 } 2503 2504 /** 2505 * @hide 2506 * @return the packageName of the owner of the given user profile or null if no profile 2507 * owner has been set for that user. 2508 * @throws IllegalArgumentException if the userId is invalid. 2509 */ 2510 @SystemApi 2511 public ComponentName getProfileOwner() throws IllegalArgumentException { 2512 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier()); 2513 } 2514 2515 /** 2516 * @see #getProfileOwner() 2517 * @hide 2518 */ 2519 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException { 2520 if (mService != null) { 2521 try { 2522 return mService.getProfileOwner(userId); 2523 } catch (RemoteException re) { 2524 Log.w(TAG, "Failed to get profile owner"); 2525 throw new IllegalArgumentException( 2526 "Requested profile owner for invalid userId", re); 2527 } 2528 } 2529 return null; 2530 } 2531 2532 /** 2533 * @hide 2534 * @return the human readable name of the organisation associated with this DPM or null if 2535 * one is not set. 2536 * @throws IllegalArgumentException if the userId is invalid. 2537 */ 2538 public String getProfileOwnerName() throws IllegalArgumentException { 2539 if (mService != null) { 2540 try { 2541 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier()); 2542 } catch (RemoteException re) { 2543 Log.w(TAG, "Failed to get profile owner"); 2544 throw new IllegalArgumentException( 2545 "Requested profile owner for invalid userId", re); 2546 } 2547 } 2548 return null; 2549 } 2550 2551 /** 2552 * @hide 2553 * @param user The user for whom to fetch the profile owner name, if any. 2554 * @return the human readable name of the organisation associated with this profile owner or 2555 * null if one is not set. 2556 * @throws IllegalArgumentException if the userId is invalid. 2557 */ 2558 @SystemApi 2559 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException { 2560 if (mService != null) { 2561 try { 2562 return mService.getProfileOwnerName(userId); 2563 } catch (RemoteException re) { 2564 Log.w(TAG, "Failed to get profile owner"); 2565 throw new IllegalArgumentException( 2566 "Requested profile owner for invalid userId", re); 2567 } 2568 } 2569 return null; 2570 } 2571 2572 /** 2573 * Called by a profile owner or device owner to add a default intent handler activity for 2574 * intents that match a certain intent filter. This activity will remain the default intent 2575 * handler even if the set of potential event handlers for the intent filter changes and if 2576 * the intent preferences are reset. 2577 * 2578 * <p>The default disambiguation mechanism takes over if the activity is not installed 2579 * (anymore). When the activity is (re)installed, it is automatically reset as default 2580 * intent handler for the filter. 2581 * 2582 * <p>The calling device admin must be a profile owner or device owner. If it is not, a 2583 * security exception will be thrown. 2584 * 2585 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2586 * @param filter The IntentFilter for which a default handler is added. 2587 * @param activity The Activity that is added as default intent handler. 2588 */ 2589 public void addPersistentPreferredActivity(ComponentName admin, IntentFilter filter, 2590 ComponentName activity) { 2591 if (mService != null) { 2592 try { 2593 mService.addPersistentPreferredActivity(admin, filter, activity); 2594 } catch (RemoteException e) { 2595 Log.w(TAG, "Failed talking with device policy service", e); 2596 } 2597 } 2598 } 2599 2600 /** 2601 * Called by a profile owner or device owner to remove all persistent intent handler preferences 2602 * associated with the given package that were set by {@link #addPersistentPreferredActivity}. 2603 * 2604 * <p>The calling device admin must be a profile owner. If it is not, a security 2605 * exception will be thrown. 2606 * 2607 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2608 * @param packageName The name of the package for which preferences are removed. 2609 */ 2610 public void clearPackagePersistentPreferredActivities(ComponentName admin, 2611 String packageName) { 2612 if (mService != null) { 2613 try { 2614 mService.clearPackagePersistentPreferredActivities(admin, packageName); 2615 } catch (RemoteException e) { 2616 Log.w(TAG, "Failed talking with device policy service", e); 2617 } 2618 } 2619 } 2620 2621 /** 2622 * Called by a profile or device owner to set the application restrictions for a given target 2623 * application running in the profile. 2624 * 2625 * <p>The provided {@link Bundle} consists of key-value pairs, where the types of values may be 2626 * boolean, int, String, or String[]. 2627 * 2628 * <p>The application restrictions are only made visible to the target application and the 2629 * profile or device owner. 2630 * 2631 * <p>If the restrictions are not available yet, but may be applied in the near future, 2632 * the admin can notify the target application of that by adding 2633 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter. 2634 * 2635 * <p>The calling device admin must be a profile or device owner; if it is not, a security 2636 * exception will be thrown. 2637 * 2638 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2639 * @param packageName The name of the package to update restricted settings for. 2640 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new 2641 * set of active restrictions. 2642 * 2643 * @see UserManager#KEY_RESTRICTIONS_PENDING 2644 */ 2645 public void setApplicationRestrictions(ComponentName admin, String packageName, 2646 Bundle settings) { 2647 if (mService != null) { 2648 try { 2649 mService.setApplicationRestrictions(admin, packageName, settings); 2650 } catch (RemoteException e) { 2651 Log.w(TAG, "Failed talking with device policy service", e); 2652 } 2653 } 2654 } 2655 2656 /** 2657 * Sets a list of configuration features to enable for a TrustAgent component. This is meant 2658 * to be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all 2659 * trust agents but those enabled by this function call. If flag 2660 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect. 2661 * 2662 * <p>The calling device admin must have requested 2663 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call 2664 * this method; if not, a security exception will be thrown. 2665 * 2666 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2667 * @param target Component name of the agent to be enabled. 2668 * @param options TrustAgent-specific feature bundle. If null for any admin, agent 2669 * will be strictly disabled according to the state of the 2670 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag. 2671 * <p>If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all admins, 2672 * then it's up to the TrustAgent itself to aggregate the values from all device admins. 2673 * <p>Consult documentation for the specific TrustAgent to determine legal options parameters. 2674 */ 2675 public void setTrustAgentConfiguration(ComponentName admin, ComponentName target, 2676 PersistableBundle options) { 2677 if (mService != null) { 2678 try { 2679 mService.setTrustAgentConfiguration(admin, target, options, UserHandle.myUserId()); 2680 } catch (RemoteException e) { 2681 Log.w(TAG, "Failed talking with device policy service", e); 2682 } 2683 } 2684 } 2685 2686 /** 2687 * Gets configuration for the given trust agent based on aggregating all calls to 2688 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for 2689 * all device admins. 2690 * 2691 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2692 * @param agent Which component to get enabled features for. 2693 * @return configuration for the given trust agent. 2694 */ 2695 public List<PersistableBundle> getTrustAgentConfiguration(ComponentName admin, 2696 ComponentName agent) { 2697 return getTrustAgentConfiguration(admin, agent, UserHandle.myUserId()); 2698 } 2699 2700 /** @hide per-user version */ 2701 public List<PersistableBundle> getTrustAgentConfiguration(ComponentName admin, 2702 ComponentName agent, int userHandle) { 2703 if (mService != null) { 2704 try { 2705 return mService.getTrustAgentConfiguration(admin, agent, userHandle); 2706 } catch (RemoteException e) { 2707 Log.w(TAG, "Failed talking with device policy service", e); 2708 } 2709 } 2710 return new ArrayList<PersistableBundle>(); // empty list 2711 } 2712 2713 /** 2714 * Called by a profile owner of a managed profile to set whether caller-Id information from 2715 * the managed profile will be shown in the parent profile, for incoming calls. 2716 * 2717 * <p>The calling device admin must be a profile owner. If it is not, a 2718 * security exception will be thrown. 2719 * 2720 * @param who Which {@link DeviceAdminReceiver} this request is associated with. 2721 * @param disabled If true caller-Id information in the managed profile is not displayed. 2722 */ 2723 public void setCrossProfileCallerIdDisabled(ComponentName who, boolean disabled) { 2724 if (mService != null) { 2725 try { 2726 mService.setCrossProfileCallerIdDisabled(who, disabled); 2727 } catch (RemoteException e) { 2728 Log.w(TAG, "Failed talking with device policy service", e); 2729 } 2730 } 2731 } 2732 2733 /** 2734 * Called by a profile owner of a managed profile to determine whether or not caller-Id 2735 * information has been disabled. 2736 * 2737 * <p>The calling device admin must be a profile owner. If it is not, a 2738 * security exception will be thrown. 2739 * 2740 * @param who Which {@link DeviceAdminReceiver} this request is associated with. 2741 */ 2742 public boolean getCrossProfileCallerIdDisabled(ComponentName who) { 2743 if (mService != null) { 2744 try { 2745 return mService.getCrossProfileCallerIdDisabled(who); 2746 } catch (RemoteException e) { 2747 Log.w(TAG, "Failed talking with device policy service", e); 2748 } 2749 } 2750 return false; 2751 } 2752 2753 /** 2754 * Determine whether or not caller-Id information has been disabled. 2755 * 2756 * @param userHandle The user for whom to check the caller-id permission 2757 * @hide 2758 */ 2759 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) { 2760 if (mService != null) { 2761 try { 2762 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier()); 2763 } catch (RemoteException e) { 2764 Log.w(TAG, "Failed talking with device policy service", e); 2765 } 2766 } 2767 return false; 2768 } 2769 2770 /** 2771 * Called by the profile owner of a managed profile so that some intents sent in the managed 2772 * profile can also be resolved in the parent, or vice versa. 2773 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2774 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the 2775 * other profile 2776 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and 2777 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported. 2778 */ 2779 public void addCrossProfileIntentFilter(ComponentName admin, IntentFilter filter, int flags) { 2780 if (mService != null) { 2781 try { 2782 mService.addCrossProfileIntentFilter(admin, filter, flags); 2783 } catch (RemoteException e) { 2784 Log.w(TAG, "Failed talking with device policy service", e); 2785 } 2786 } 2787 } 2788 2789 /** 2790 * Called by a profile owner of a managed profile to remove the cross-profile intent filters 2791 * that go from the managed profile to the parent, or from the parent to the managed profile. 2792 * Only removes those that have been set by the profile owner. 2793 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2794 */ 2795 public void clearCrossProfileIntentFilters(ComponentName admin) { 2796 if (mService != null) { 2797 try { 2798 mService.clearCrossProfileIntentFilters(admin); 2799 } catch (RemoteException e) { 2800 Log.w(TAG, "Failed talking with device policy service", e); 2801 } 2802 } 2803 } 2804 2805 /** 2806 * Called by a profile or device owner to set the permitted accessibility services. When 2807 * set by a device owner or profile owner the restriction applies to all profiles of the 2808 * user the device owner or profile owner is an admin for. 2809 * 2810 * By default the user can use any accessiblity service. When zero or more packages have 2811 * been added, accessiblity services that are not in the list and not part of the system 2812 * can not be enabled by the user. 2813 * 2814 * <p> Calling with a null value for the list disables the restriction so that all services 2815 * can be used, calling with an empty list only allows the builtin system's services. 2816 * 2817 * <p> System accesibility services are always available to the user the list can't modify 2818 * this. 2819 * 2820 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2821 * @param packageNames List of accessibility service package names. 2822 * 2823 * @return true if setting the restriction succeeded. It fail if there is 2824 * one or more non-system accessibility services enabled, that are not in the list. 2825 */ 2826 public boolean setPermittedAccessibilityServices(ComponentName admin, 2827 List<String> packageNames) { 2828 if (mService != null) { 2829 try { 2830 return mService.setPermittedAccessibilityServices(admin, packageNames); 2831 } catch (RemoteException e) { 2832 Log.w(TAG, "Failed talking with device policy service", e); 2833 } 2834 } 2835 return false; 2836 } 2837 2838 /** 2839 * Returns the list of permitted accessibility services set by this device or profile owner. 2840 * 2841 * <p>An empty list means no accessibility services except system services are allowed. 2842 * Null means all accessibility services are allowed. 2843 * 2844 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2845 * @return List of accessiblity service package names. 2846 */ 2847 public List<String> getPermittedAccessibilityServices(ComponentName admin) { 2848 if (mService != null) { 2849 try { 2850 return mService.getPermittedAccessibilityServices(admin); 2851 } catch (RemoteException e) { 2852 Log.w(TAG, "Failed talking with device policy service", e); 2853 } 2854 } 2855 return null; 2856 } 2857 2858 /** 2859 * Returns the list of accessibility services permitted by the device or profiles 2860 * owners of this user. 2861 * 2862 * <p>Null means all accessibility services are allowed, if a non-null list is returned 2863 * it will contain the intersection of the permitted lists for any device or profile 2864 * owners that apply to this user. It will also include any system accessibility services. 2865 * 2866 * @param userId which user to check for. 2867 * @return List of accessiblity service package names. 2868 * @hide 2869 */ 2870 @SystemApi 2871 public List<String> getPermittedAccessibilityServices(int userId) { 2872 if (mService != null) { 2873 try { 2874 return mService.getPermittedAccessibilityServicesForUser(userId); 2875 } catch (RemoteException e) { 2876 Log.w(TAG, "Failed talking with device policy service", e); 2877 } 2878 } 2879 return null; 2880 } 2881 2882 /** 2883 * Called by a profile or device owner to set the permitted input methods services. When 2884 * set by a device owner or profile owner the restriction applies to all profiles of the 2885 * user the device owner or profile owner is an admin for. 2886 * 2887 * By default the user can use any input method. When zero or more packages have 2888 * been added, input method that are not in the list and not part of the system 2889 * can not be enabled by the user. 2890 * 2891 * This method will fail if it is called for a admin that is not for the foreground user 2892 * or a profile of the foreground user. 2893 * 2894 * <p> Calling with a null value for the list disables the restriction so that all input methods 2895 * can be used, calling with an empty list disables all but the system's own input methods. 2896 * 2897 * <p> System input methods are always available to the user this method can't modify this. 2898 * 2899 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2900 * @param packageNames List of input method package names. 2901 * @return true if setting the restriction succeeded. It will fail if there is 2902 * one or more input method enabled, that are not in the list or user if the foreground 2903 * user. 2904 */ 2905 public boolean setPermittedInputMethods(ComponentName admin, List<String> packageNames) { 2906 if (mService != null) { 2907 try { 2908 return mService.setPermittedInputMethods(admin, packageNames); 2909 } catch (RemoteException e) { 2910 Log.w(TAG, "Failed talking with device policy service", e); 2911 } 2912 } 2913 return false; 2914 } 2915 2916 2917 /** 2918 * Returns the list of permitted input methods set by this device or profile owner. 2919 * 2920 * <p>An empty list means no input methods except system input methods are allowed. 2921 * Null means all input methods are allowed. 2922 * 2923 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2924 * @return List of input method package names. 2925 */ 2926 public List<String> getPermittedInputMethods(ComponentName admin) { 2927 if (mService != null) { 2928 try { 2929 return mService.getPermittedInputMethods(admin); 2930 } catch (RemoteException e) { 2931 Log.w(TAG, "Failed talking with device policy service", e); 2932 } 2933 } 2934 return null; 2935 } 2936 2937 /** 2938 * Returns the list of input methods permitted by the device or profiles 2939 * owners of the current user. 2940 * 2941 * <p>Null means all input methods are allowed, if a non-null list is returned 2942 * it will contain the intersection of the permitted lists for any device or profile 2943 * owners that apply to this user. It will also include any system input methods. 2944 * 2945 * @return List of input method package names. 2946 * @hide 2947 */ 2948 @SystemApi 2949 public List<String> getPermittedInputMethodsForCurrentUser() { 2950 if (mService != null) { 2951 try { 2952 return mService.getPermittedInputMethodsForCurrentUser(); 2953 } catch (RemoteException e) { 2954 Log.w(TAG, "Failed talking with device policy service", e); 2955 } 2956 } 2957 return null; 2958 } 2959 2960 /** 2961 * Called by a device owner to create a user with the specified name. The UserHandle returned 2962 * by this method should not be persisted as user handles are recycled as users are removed and 2963 * created. If you need to persist an identifier for this user, use 2964 * {@link UserManager#getSerialNumberForUser}. 2965 * 2966 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2967 * @param name the user's name 2968 * @see UserHandle 2969 * @return the UserHandle object for the created user, or null if the user could not be created. 2970 */ 2971 public UserHandle createUser(ComponentName admin, String name) { 2972 try { 2973 return mService.createUser(admin, name); 2974 } catch (RemoteException re) { 2975 Log.w(TAG, "Could not create a user", re); 2976 } 2977 return null; 2978 } 2979 2980 /** 2981 * Called by a device owner to create a user with the specified name. The UserHandle returned 2982 * by this method should not be persisted as user handles are recycled as users are removed and 2983 * created. If you need to persist an identifier for this user, use 2984 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background 2985 * immediately. 2986 * 2987 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well 2988 * as registered as an active admin on the new user. The profile owner package will be 2989 * installed on the new user if it already is installed on the device. 2990 * 2991 * <p>If the optionalInitializeData is not null, then the extras will be passed to the 2992 * profileOwnerComponent when onEnable is called. 2993 * 2994 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 2995 * @param name the user's name 2996 * @param ownerName the human readable name of the organisation associated with this DPM. 2997 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on 2998 * the user. 2999 * @param adminExtras Extras that will be passed to onEnable of the admin receiver 3000 * on the new user. 3001 * @see UserHandle 3002 * @return the UserHandle object for the created user, or null if the user could not be created. 3003 */ 3004 public UserHandle createAndInitializeUser(ComponentName admin, String name, String ownerName, 3005 ComponentName profileOwnerComponent, Bundle adminExtras) { 3006 try { 3007 return mService.createAndInitializeUser(admin, name, ownerName, profileOwnerComponent, 3008 adminExtras); 3009 } catch (RemoteException re) { 3010 Log.w(TAG, "Could not create a user", re); 3011 } 3012 return null; 3013 } 3014 3015 /** 3016 * Called by a device owner to remove a user and all associated data. The primary user can 3017 * not be removed. 3018 * 3019 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3020 * @param userHandle the user to remove. 3021 * @return {@code true} if the user was removed, {@code false} otherwise. 3022 */ 3023 public boolean removeUser(ComponentName admin, UserHandle userHandle) { 3024 try { 3025 return mService.removeUser(admin, userHandle); 3026 } catch (RemoteException re) { 3027 Log.w(TAG, "Could not remove user ", re); 3028 return false; 3029 } 3030 } 3031 3032 /** 3033 * Called by a device owner to switch the specified user to the foreground. 3034 * 3035 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3036 * @param userHandle the user to switch to; null will switch to primary. 3037 * @return {@code true} if the switch was successful, {@code false} otherwise. 3038 * 3039 * @see Intent#ACTION_USER_FOREGROUND 3040 */ 3041 public boolean switchUser(ComponentName admin, UserHandle userHandle) { 3042 try { 3043 return mService.switchUser(admin, userHandle); 3044 } catch (RemoteException re) { 3045 Log.w(TAG, "Could not switch user ", re); 3046 return false; 3047 } 3048 } 3049 3050 /** 3051 * Called by a profile or device owner to get the application restrictions for a given target 3052 * application running in the profile. 3053 * 3054 * <p>The calling device admin must be a profile or device owner; if it is not, a security 3055 * exception will be thrown. 3056 * 3057 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3058 * @param packageName The name of the package to fetch restricted settings of. 3059 * @return {@link Bundle} of settings corresponding to what was set last time 3060 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty {@link Bundle} 3061 * if no restrictions have been set. 3062 */ 3063 public Bundle getApplicationRestrictions(ComponentName admin, String packageName) { 3064 if (mService != null) { 3065 try { 3066 return mService.getApplicationRestrictions(admin, packageName); 3067 } catch (RemoteException e) { 3068 Log.w(TAG, "Failed talking with device policy service", e); 3069 } 3070 } 3071 return null; 3072 } 3073 3074 /** 3075 * Called by a profile or device owner to set a user restriction specified 3076 * by the key. 3077 * <p> 3078 * The calling device admin must be a profile or device owner; if it is not, 3079 * a security exception will be thrown. 3080 * 3081 * @param admin Which {@link DeviceAdminReceiver} this request is associated 3082 * with. 3083 * @param key The key of the restriction. See the constants in 3084 * {@link android.os.UserManager} for the list of keys. 3085 */ 3086 public void addUserRestriction(ComponentName admin, String key) { 3087 if (mService != null) { 3088 try { 3089 mService.setUserRestriction(admin, key, true); 3090 } catch (RemoteException e) { 3091 Log.w(TAG, "Failed talking with device policy service", e); 3092 } 3093 } 3094 } 3095 3096 /** 3097 * Called by a profile or device owner to clear a user restriction specified 3098 * by the key. 3099 * <p> 3100 * The calling device admin must be a profile or device owner; if it is not, 3101 * a security exception will be thrown. 3102 * 3103 * @param admin Which {@link DeviceAdminReceiver} this request is associated 3104 * with. 3105 * @param key The key of the restriction. See the constants in 3106 * {@link android.os.UserManager} for the list of keys. 3107 */ 3108 public void clearUserRestriction(ComponentName admin, String key) { 3109 if (mService != null) { 3110 try { 3111 mService.setUserRestriction(admin, key, false); 3112 } catch (RemoteException e) { 3113 Log.w(TAG, "Failed talking with device policy service", e); 3114 } 3115 } 3116 } 3117 3118 /** 3119 * Called by device or profile owner to hide or unhide packages. When a package is hidden it 3120 * is unavailable for use, but the data and actual package file remain. 3121 * 3122 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3123 * @param packageName The name of the package to hide or unhide. 3124 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be 3125 * unhidden. 3126 * @return boolean Whether the hidden setting of the package was successfully updated. 3127 */ 3128 public boolean setApplicationHidden(ComponentName admin, String packageName, 3129 boolean hidden) { 3130 if (mService != null) { 3131 try { 3132 return mService.setApplicationHidden(admin, packageName, hidden); 3133 } catch (RemoteException e) { 3134 Log.w(TAG, "Failed talking with device policy service", e); 3135 } 3136 } 3137 return false; 3138 } 3139 3140 /** 3141 * Called by device or profile owner to determine if a package is hidden. 3142 * 3143 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3144 * @param packageName The name of the package to retrieve the hidden status of. 3145 * @return boolean {@code true} if the package is hidden, {@code false} otherwise. 3146 */ 3147 public boolean isApplicationHidden(ComponentName admin, String packageName) { 3148 if (mService != null) { 3149 try { 3150 return mService.isApplicationHidden(admin, packageName); 3151 } catch (RemoteException e) { 3152 Log.w(TAG, "Failed talking with device policy service", e); 3153 } 3154 } 3155 return false; 3156 } 3157 3158 /** 3159 * Called by profile or device owner to re-enable a system app that was disabled by default 3160 * when the user was initialized. 3161 * 3162 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3163 * @param packageName The package to be re-enabled in the current profile. 3164 */ 3165 public void enableSystemApp(ComponentName admin, String packageName) { 3166 if (mService != null) { 3167 try { 3168 mService.enableSystemApp(admin, packageName); 3169 } catch (RemoteException e) { 3170 Log.w(TAG, "Failed to install package: " + packageName); 3171 } 3172 } 3173 } 3174 3175 /** 3176 * Called by profile or device owner to re-enable system apps by intent that were disabled 3177 * by default when the user was initialized. 3178 * 3179 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3180 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this 3181 * intent will be re-enabled in the current profile. 3182 * @return int The number of activities that matched the intent and were installed. 3183 */ 3184 public int enableSystemApp(ComponentName admin, Intent intent) { 3185 if (mService != null) { 3186 try { 3187 return mService.enableSystemAppWithIntent(admin, intent); 3188 } catch (RemoteException e) { 3189 Log.w(TAG, "Failed to install packages matching filter: " + intent); 3190 } 3191 } 3192 return 0; 3193 } 3194 3195 /** 3196 * Called by a device owner or profile owner to disable account management for a specific type 3197 * of account. 3198 * 3199 * <p>The calling device admin must be a device owner or profile owner. If it is not, a 3200 * security exception will be thrown. 3201 * 3202 * <p>When account management is disabled for an account type, adding or removing an account 3203 * of that type will not be possible. 3204 * 3205 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3206 * @param accountType For which account management is disabled or enabled. 3207 * @param disabled The boolean indicating that account management will be disabled (true) or 3208 * enabled (false). 3209 */ 3210 public void setAccountManagementDisabled(ComponentName admin, String accountType, 3211 boolean disabled) { 3212 if (mService != null) { 3213 try { 3214 mService.setAccountManagementDisabled(admin, accountType, disabled); 3215 } catch (RemoteException e) { 3216 Log.w(TAG, "Failed talking with device policy service", e); 3217 } 3218 } 3219 } 3220 3221 /** 3222 * Gets the array of accounts for which account management is disabled by the profile owner. 3223 * 3224 * <p> Account management can be disabled/enabled by calling 3225 * {@link #setAccountManagementDisabled}. 3226 * 3227 * @return a list of account types for which account management has been disabled. 3228 * 3229 * @see #setAccountManagementDisabled 3230 */ 3231 public String[] getAccountTypesWithManagementDisabled() { 3232 return getAccountTypesWithManagementDisabledAsUser(UserHandle.myUserId()); 3233 } 3234 3235 /** 3236 * @see #getAccountTypesWithManagementDisabled() 3237 * @hide 3238 */ 3239 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) { 3240 if (mService != null) { 3241 try { 3242 return mService.getAccountTypesWithManagementDisabledAsUser(userId); 3243 } catch (RemoteException e) { 3244 Log.w(TAG, "Failed talking with device policy service", e); 3245 } 3246 } 3247 3248 return null; 3249 } 3250 3251 /** 3252 * Sets which packages may enter lock task mode. 3253 * 3254 * <p>Any packages that shares uid with an allowed package will also be allowed 3255 * to activate lock task. 3256 * 3257 * This function can only be called by the device owner. 3258 * @param packages The list of packages allowed to enter lock task mode 3259 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3260 * 3261 * @see Activity#startLockTask() 3262 * @see DeviceAdminReceiver#onLockTaskModeChanged(Context, Intent, boolean, String) 3263 * @see UserManager#DISALLOW_CREATE_WINDOWS 3264 */ 3265 public void setLockTaskPackages(ComponentName admin, String[] packages) 3266 throws SecurityException { 3267 if (mService != null) { 3268 try { 3269 mService.setLockTaskPackages(admin, packages); 3270 } catch (RemoteException e) { 3271 Log.w(TAG, "Failed talking with device policy service", e); 3272 } 3273 } 3274 } 3275 3276 /** 3277 * This function returns the list of packages allowed to start the lock task mode. 3278 * 3279 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3280 * @hide 3281 */ 3282 public String[] getLockTaskPackages(ComponentName admin) { 3283 if (mService != null) { 3284 try { 3285 return mService.getLockTaskPackages(admin); 3286 } catch (RemoteException e) { 3287 Log.w(TAG, "Failed talking with device policy service", e); 3288 } 3289 } 3290 return null; 3291 } 3292 3293 /** 3294 * This function lets the caller know whether the given component is allowed to start the 3295 * lock task mode. 3296 * @param pkg The package to check 3297 */ 3298 public boolean isLockTaskPermitted(String pkg) { 3299 if (mService != null) { 3300 try { 3301 return mService.isLockTaskPermitted(pkg); 3302 } catch (RemoteException e) { 3303 Log.w(TAG, "Failed talking with device policy service", e); 3304 } 3305 } 3306 return false; 3307 } 3308 3309 /** 3310 * Called by device owners to update {@link Settings.Global} settings. Validation that the value 3311 * of the setting is in the correct form for the setting type should be performed by the caller. 3312 * <p>The settings that can be updated with this method are: 3313 * <ul> 3314 * <li>{@link Settings.Global#ADB_ENABLED}</li> 3315 * <li>{@link Settings.Global#AUTO_TIME}</li> 3316 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li> 3317 * <li>{@link Settings.Global#BLUETOOTH_ON}</li> 3318 * <li>{@link Settings.Global#DATA_ROAMING}</li> 3319 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li> 3320 * <li>{@link Settings.Global#MODE_RINGER}</li> 3321 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li> 3322 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li> 3323 * <li>{@link Settings.Global#WIFI_ON}</li> 3324 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li> 3325 * </ul> 3326 * 3327 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3328 * @param setting The name of the setting to update. 3329 * @param value The value to update the setting to. 3330 */ 3331 public void setGlobalSetting(ComponentName admin, String setting, String value) { 3332 if (mService != null) { 3333 try { 3334 mService.setGlobalSetting(admin, setting, value); 3335 } catch (RemoteException e) { 3336 Log.w(TAG, "Failed talking with device policy service", e); 3337 } 3338 } 3339 } 3340 3341 /** 3342 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation 3343 * that the value of the setting is in the correct form for the setting type should be performed 3344 * by the caller. 3345 * <p>The settings that can be updated by a profile or device owner with this method are: 3346 * <ul> 3347 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li> 3348 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li> 3349 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li> 3350 * </ul> 3351 * <p>A device owner can additionally update the following settings: 3352 * <ul> 3353 * <li>{@link Settings.Secure#LOCATION_MODE}</li> 3354 * </ul> 3355 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3356 * @param setting The name of the setting to update. 3357 * @param value The value to update the setting to. 3358 */ 3359 public void setSecureSetting(ComponentName admin, String setting, String value) { 3360 if (mService != null) { 3361 try { 3362 mService.setSecureSetting(admin, setting, value); 3363 } catch (RemoteException e) { 3364 Log.w(TAG, "Failed talking with device policy service", e); 3365 } 3366 } 3367 } 3368 3369 /** 3370 * Designates a specific service component as the provider for 3371 * making permission requests of a local or remote administrator of the user. 3372 * <p/> 3373 * Only a profile owner can designate the restrictions provider. 3374 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3375 * @param provider The component name of the service that implements 3376 * {@link RestrictionsReceiver}. If this param is null, 3377 * it removes the restrictions provider previously assigned. 3378 */ 3379 public void setRestrictionsProvider(ComponentName admin, ComponentName provider) { 3380 if (mService != null) { 3381 try { 3382 mService.setRestrictionsProvider(admin, provider); 3383 } catch (RemoteException re) { 3384 Log.w(TAG, "Failed to set permission provider on device policy service"); 3385 } 3386 } 3387 } 3388 3389 /** 3390 * Called by profile or device owners to set the master volume mute on or off. 3391 * 3392 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3393 * @param on {@code true} to mute master volume, {@code false} to turn mute off. 3394 */ 3395 public void setMasterVolumeMuted(ComponentName admin, boolean on) { 3396 if (mService != null) { 3397 try { 3398 mService.setMasterVolumeMuted(admin, on); 3399 } catch (RemoteException re) { 3400 Log.w(TAG, "Failed to setMasterMute on device policy service"); 3401 } 3402 } 3403 } 3404 3405 /** 3406 * Called by profile or device owners to check whether the master volume mute is on or off. 3407 * 3408 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3409 * @return {@code true} if master volume is muted, {@code false} if it's not. 3410 */ 3411 public boolean isMasterVolumeMuted(ComponentName admin) { 3412 if (mService != null) { 3413 try { 3414 return mService.isMasterVolumeMuted(admin); 3415 } catch (RemoteException re) { 3416 Log.w(TAG, "Failed to get isMasterMute on device policy service"); 3417 } 3418 } 3419 return false; 3420 } 3421 3422 /** 3423 * Called by profile or device owners to change whether a user can uninstall 3424 * a package. 3425 * 3426 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3427 * @param packageName package to change. 3428 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package. 3429 */ 3430 public void setUninstallBlocked(ComponentName admin, String packageName, 3431 boolean uninstallBlocked) { 3432 if (mService != null) { 3433 try { 3434 mService.setUninstallBlocked(admin, packageName, uninstallBlocked); 3435 } catch (RemoteException re) { 3436 Log.w(TAG, "Failed to call block uninstall on device policy service"); 3437 } 3438 } 3439 } 3440 3441 /** 3442 * Check whether the current user has been blocked by device policy from uninstalling a package. 3443 * Requires the caller to be the profile owner if checking a specific admin's policy. 3444 * 3445 * @param admin The name of the admin component whose blocking policy will be checked, or null 3446 * to check if any admin has blocked the uninstallation. 3447 * @param packageName package to check. 3448 * @return true if uninstallation is blocked. 3449 */ 3450 public boolean isUninstallBlocked(ComponentName admin, String packageName) { 3451 if (mService != null) { 3452 try { 3453 return mService.isUninstallBlocked(admin, packageName); 3454 } catch (RemoteException re) { 3455 Log.w(TAG, "Failed to call block uninstall on device policy service"); 3456 } 3457 } 3458 return false; 3459 } 3460 3461 /** 3462 * Called by the profile owner of a managed profile to enable widget providers from a 3463 * given package to be available in the parent profile. As a result the user will be able to 3464 * add widgets from the white-listed package running under the profile to a widget 3465 * host which runs under the parent profile, for example the home screen. Note that 3466 * a package may have zero or more provider components, where each component 3467 * provides a different widget type. 3468 * <p> 3469 * <strong>Note:</strong> By default no widget provider package is white-listed. 3470 * </p> 3471 * 3472 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3473 * @param packageName The package from which widget providers are white-listed. 3474 * @return Whether the package was added. 3475 * 3476 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String) 3477 * @see #getCrossProfileWidgetProviders(android.content.ComponentName) 3478 */ 3479 public boolean addCrossProfileWidgetProvider(ComponentName admin, String packageName) { 3480 if (mService != null) { 3481 try { 3482 return mService.addCrossProfileWidgetProvider(admin, packageName); 3483 } catch (RemoteException re) { 3484 Log.w(TAG, "Error calling addCrossProfileWidgetProvider", re); 3485 } 3486 } 3487 return false; 3488 } 3489 3490 /** 3491 * Called by the profile owner of a managed profile to disable widget providers from a given 3492 * package to be available in the parent profile. For this method to take effect the 3493 * package should have been added via {@link #addCrossProfileWidgetProvider( 3494 * android.content.ComponentName, String)}. 3495 * <p> 3496 * <strong>Note:</strong> By default no widget provider package is white-listed. 3497 * </p> 3498 * 3499 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3500 * @param packageName The package from which widget providers are no longer 3501 * white-listed. 3502 * @return Whether the package was removed. 3503 * 3504 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String) 3505 * @see #getCrossProfileWidgetProviders(android.content.ComponentName) 3506 */ 3507 public boolean removeCrossProfileWidgetProvider(ComponentName admin, String packageName) { 3508 if (mService != null) { 3509 try { 3510 return mService.removeCrossProfileWidgetProvider(admin, packageName); 3511 } catch (RemoteException re) { 3512 Log.w(TAG, "Error calling removeCrossProfileWidgetProvider", re); 3513 } 3514 } 3515 return false; 3516 } 3517 3518 /** 3519 * Called by the profile owner of a managed profile to query providers from which packages are 3520 * available in the parent profile. 3521 * 3522 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. 3523 * @return The white-listed package list. 3524 * 3525 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String) 3526 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String) 3527 */ 3528 public List<String> getCrossProfileWidgetProviders(ComponentName admin) { 3529 if (mService != null) { 3530 try { 3531 List<String> providers = mService.getCrossProfileWidgetProviders(admin); 3532 if (providers != null) { 3533 return providers; 3534 } 3535 } catch (RemoteException re) { 3536 Log.w(TAG, "Error calling getCrossProfileWidgetProviders", re); 3537 } 3538 } 3539 return Collections.emptyList(); 3540 } 3541} 3542