blob: 69b1139ae85c37fce3064332cd7d12a4ecd3ab30 [file] [log] [blame]
Dianne Hackbornd6847842010-01-12 18:14:19 -08001/*
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
Dianne Hackborn87bba1e2010-02-26 17:25:54 -080017package android.app.admin;
Dianne Hackbornd6847842010-01-12 18:14:19 -080018
Dianne Hackbornd6847842010-01-12 18:14:19 -080019import android.annotation.SdkConstant;
20import android.annotation.SdkConstant.SdkConstantType;
Justin Moreyb5deda72014-07-24 10:53:40 -050021import android.annotation.SystemApi;
Jason Monkd7b86212014-06-16 13:15:38 -040022import android.app.Activity;
Svetoslav976e8bd2014-07-16 15:12:03 -070023import android.app.admin.IDevicePolicyManager;
Dianne Hackbornd6847842010-01-12 18:14:19 -080024import android.content.ComponentName;
25import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010026import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000027import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080028import android.content.pm.ActivityInfo;
29import android.content.pm.PackageManager;
30import android.content.pm.ResolveInfo;
Jason Monk03bc9912014-05-13 09:44:57 -040031import android.net.ProxyInfo;
Robin Lee66e5d962014-04-09 16:44:21 +010032import android.os.Bundle;
Dianne Hackbornd6847842010-01-12 18:14:19 -080033import android.os.Handler;
Adam Connors776c5552014-01-09 10:42:56 +000034import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080035import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080036import android.os.RemoteException;
37import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070038import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040039import android.os.UserManager;
Julia Reynoldsda551652014-05-14 17:15:16 -040040import android.provider.Settings;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070041import android.service.restrictions.RestrictionsReceiver;
Dianne Hackbornd6847842010-01-12 18:14:19 -080042import android.util.Log;
43
Maggie Benthallda51e682013-08-08 22:35:44 -040044import com.android.org.conscrypt.TrustedCertificateStore;
45
Jessica Hummel91da58d2014-04-10 17:39:43 +010046import org.xmlpull.v1.XmlPullParserException;
47
Maggie Benthallda51e682013-08-08 22:35:44 -040048import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080049import java.io.IOException;
Oscar Montemayor69238c62010-08-03 10:51:06 -070050import java.net.InetSocketAddress;
51import java.net.Proxy;
Maggie Benthallda51e682013-08-08 22:35:44 -040052import java.security.cert.CertificateException;
53import java.security.cert.CertificateFactory;
54import java.security.cert.X509Certificate;
Jim Miller604e7552014-07-18 19:00:02 -070055import java.util.ArrayList;
Svetoslav976e8bd2014-07-16 15:12:03 -070056import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080057import java.util.List;
Dianne Hackbornd6847842010-01-12 18:14:19 -080058
59/**
60 * Public interface for managing policies enforced on a device. Most clients
Dianne Hackbornef6b22f2010-02-16 20:38:49 -080061 * of this class must have published a {@link DeviceAdminReceiver} that the user
Dianne Hackbornd6847842010-01-12 18:14:19 -080062 * has currently enabled.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For more information about managing policies for device adminstration, read the
67 * <a href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a>
68 * developer guide.</p>
69 * </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080070 */
71public class DevicePolicyManager {
72 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -080073
74 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -080075 private final IDevicePolicyManager mService;
Konstantin Lopyrev32558232010-05-20 16:18:05 -070076
Dianne Hackborn21f1bd12010-02-19 17:02:21 -080077 private DevicePolicyManager(Context context, Handler handler) {
Dianne Hackbornd6847842010-01-12 18:14:19 -080078 mContext = context;
Dianne Hackbornd6847842010-01-12 18:14:19 -080079 mService = IDevicePolicyManager.Stub.asInterface(
80 ServiceManager.getService(Context.DEVICE_POLICY_SERVICE));
81 }
82
Dianne Hackborn87bba1e2010-02-26 17:25:54 -080083 /** @hide */
84 public static DevicePolicyManager create(Context context, Handler handler) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -080085 DevicePolicyManager me = new DevicePolicyManager(context, handler);
86 return me.mService != null ? me : null;
87 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -070088
Dianne Hackbornd6847842010-01-12 18:14:19 -080089 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +000090 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +000091 *
Jessica Hummel9da60392014-05-21 12:32:57 +010092 * <p>A managed profile allows data separation for example for the usage of a
93 * device as a personal and corporate device. The user which provisioning is started from and
94 * the managed profile share a launcher.
95 *
96 * <p>This intent will typically be sent by a mobile device management application (mdm).
97 * Provisioning adds a managed profile and sets the mdm as the profile owner who has full
98 * control over the profile
99 *
100 * <p>This intent must contain the extras {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}
101 * {@link #EXTRA_PROVISIONING_DEFAULT_MANAGED_PROFILE_NAME} and {@link #EXTRA_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000102 *
103 * <p> When managed provisioning has completed, an intent of the type
104 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcasted to the
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100105 * managed profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100106 *
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100107 * <p> If provisioning fails, the managedProfile is removed so the device returns to its
108 * previous state.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000109 *
110 * <p>Input: Nothing.</p>
111 * <p>Output: Nothing</p>
112 */
113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
114 public static final String ACTION_PROVISION_MANAGED_PROFILE
Jessica Hummel03dd2202014-03-13 16:05:26 +0000115 = "android.app.action.ACTION_PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000116
117 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100118 * A String extra holding the package name of the mobile device management application that
119 * will be set as the profile owner or device owner.
120 *
121 * <p>If an application starts provisioning directly via an intent with action
122 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
123 * application that started provisioning. The package will be set as profile owner in that case.
124 *
125 * <p>This package is set as device owner when device owner provisioning is started by an Nfc
Esteban Talaveraf057f062014-08-20 14:27:45 +0100126 * message containing an Nfc record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000127 */
128 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaverafbb28df2014-08-26 15:38:17 +0100129 = "android.app.extra.deviceAdminPackageName";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000130
131 /**
132 * A String extra holding the default name of the profile that is created during managed profile
133 * provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100134 *
Jessica Hummelf72078b2014-03-06 16:13:12 +0000135 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}
136 */
137 public static final String EXTRA_PROVISIONING_DEFAULT_MANAGED_PROFILE_NAME
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100138 = "android.app.extra.DEFAULT_MANAGED_PROFILE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000139
140 /**
Jessica Hummeledb7ae72014-06-26 12:55:38 +0100141 * A String extra that, holds the email address of the account which a managed profile is
142 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100143 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Jessica Hummeledb7ae72014-06-26 12:55:38 +0100144 *
145 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
146 * contains this extra, it is forwarded in the
147 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
148 * device management application that was set as the profile owner during provisioning.
149 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100150 */
151 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
Esteban Talaverafbb28df2014-08-26 15:38:17 +0100152 = "android.app.extra.ManagedProfileEmailAddress";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100153
154 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100155 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
156 * will be set to.
157 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100158 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100159 * provisioning via an Nfc bump.
160 */
161 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100162 = "android.app.extra.TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100163
164 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100165 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
166 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100167 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100168 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100169 * provisioning via an Nfc bump.
170 */
171 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100172 = "android.app.extra.LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100173
174 /**
175 * A String extra holding the {@link java.util.Locale} that the device will be set to.
176 * Format: xx_yy, where xx is the language code, and yy the country code.
177 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100178 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100179 * provisioning via an Nfc bump.
180 */
181 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100182 = "android.app.extra.LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100183
184 /**
185 * A String extra holding the ssid of the wifi network that should be used during nfc device
186 * owner provisioning for downloading the mobile device management application.
187 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100188 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100189 * provisioning via an Nfc bump.
190 */
191 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100192 = "android.app.extra.WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100193
194 /**
195 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
196 * is hidden or not.
197 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100198 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100199 * provisioning via an Nfc bump.
200 */
201 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100202 = "android.app.extra.WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100203
204 /**
205 * A String extra indicating the security type of the wifi network in
206 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
207 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100208 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100209 * provisioning via an Nfc bump.
210 */
211 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100212 = "android.app.extra.WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100213
214 /**
215 * A String extra holding the password of the wifi network in
216 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
217 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100218 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100219 * provisioning via an Nfc bump.
220 */
221 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100222 = "android.app.extra.WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100223
224 /**
225 * A String extra holding the proxy host for the wifi network in
226 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
227 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100228 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100229 * provisioning via an Nfc bump.
230 */
231 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100232 = "android.app.extra.WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100233
234 /**
235 * An int extra holding the proxy port for the wifi network in
236 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
237 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100238 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100239 * provisioning via an Nfc bump.
240 */
241 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100242 = "android.app.extra.WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100243
244 /**
245 * A String extra holding the proxy bypass for the wifi network in
246 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
247 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100248 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100249 * provisioning via an Nfc bump.
250 */
251 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100252 = "android.app.extra.WIFI_PROXY_BYPASS_HOSTS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100253
254 /**
255 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
256 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
257 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100258 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100259 * provisioning via an Nfc bump.
260 */
261 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100262 = "android.app.extra.WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100263
264 /**
265 * A String extra holding a url that specifies the download location of the device admin
266 * package. When not provided it is assumed that the device admin package is already installed.
267 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100268 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100269 * provisioning via an Nfc bump.
270 */
271 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100272 = "android.app.extra.DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100273
274 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100275 * A String extra holding a http cookie header which should be used in the http request to the
276 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
277 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100278 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse681bce92014-07-24 16:46:26 +0100279 * provisioning via an Nfc bump.
280 */
281 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100282 = "android.app.extra.DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100283
284 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100285 * A String extra holding the SHA-1 checksum of the file at download location specified in
286 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. If this doesn't match
287 * the file at the download location an error will be shown to the user and the user will be
288 * asked to factory reset the device.
289 *
Esteban Talaveraf057f062014-08-20 14:27:45 +0100290 * <p>Use in an Nfc record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100291 * provisioning via an Nfc bump.
292 */
293 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100294 = "android.app.extra.DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100295
296 /**
297 * This MIME type is used for starting the Device Owner provisioning.
298 *
299 * <p>During device owner provisioning a device admin app is set as the owner of the device.
300 * A device owner has full control over the device. The device owner can not be modified by the
301 * user and the only way of resetting the device is if the device owner app calls a factory
302 * reset.
303 *
304 * <p> A typical use case would be a device that is owned by a company, but used by either an
305 * employee or client.
306 *
307 * <p> The Nfc message should be send to an unprovisioned device.
308 *
309 * <p>The Nfc record must contain a serialized {@link java.util.Properties} object which
310 * contains the following properties:
311 * <ul>
312 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
313 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100314 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100315 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}</li>
316 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
317 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
318 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
319 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
320 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
321 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
322 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
323 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
324 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
325 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
326 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li></ul>
327 *
328 * <p> When device owner provisioning has completed, an intent of the type
329 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcasted to the
330 * device owner.
331 *
332 * <p>
333 * If provisioning fails, the device is factory reset.
334 *
335 * <p>Input: Nothing.</p>
336 * <p>Output: Nothing</p>
337 */
Esteban Talaveraf057f062014-08-20 14:27:45 +0100338 public static final String MIME_TYPE_PROVISIONING_NFC
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100339 = "application/com.android.managedprovisioning";
340
341 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800342 * Activity action: ask the user to add a new device administrator to the system.
343 * The desired policy is the ComponentName of the policy in the
344 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
345 * bring the user through adding the device administrator to the system (or
346 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700347 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800348 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
349 * field to provide the user with additional explanation (in addition
350 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800351 *
352 * <p>If your administrator is already active, this will ordinarily return immediately (without
353 * user intervention). However, if your administrator has been updated and is requesting
354 * additional uses-policy flags, the user will be presented with the new list. New policies
355 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800356 */
357 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
358 public static final String ACTION_ADD_DEVICE_ADMIN
359 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700360
Dianne Hackbornd6847842010-01-12 18:14:19 -0800361 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700362 * @hide
363 * Activity action: ask the user to add a new device administrator as the profile owner
364 * for this user. Only system privileged apps that have MANAGE_USERS and MANAGE_DEVICE_ADMINS
365 * permission can call this API.
366 *
367 * <p>The ComponentName of the profile owner admin is pass in {@link #EXTRA_DEVICE_ADMIN} extra
368 * field. This will invoke a UI to bring the user through adding the profile owner admin
369 * to remotely control restrictions on the user.
370 *
371 * <p>The intent must be invoked via {@link Activity#startActivityForResult()} to receive the
372 * result of whether or not the user approved the action. If approved, the result will
373 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
374 * as a profile owner.
375 *
376 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
377 * field to provide the user with additional explanation (in addition
378 * to your component's description) about what is being added.
379 *
380 * <p>If there is already a profile owner active or the caller doesn't have the required
381 * permissions, the operation will return a failure result.
382 */
383 @SystemApi
384 public static final String ACTION_SET_PROFILE_OWNER
385 = "android.app.action.SET_PROFILE_OWNER";
386
387 /**
388 * @hide
389 * Name of the profile owner admin that controls the user.
390 */
391 @SystemApi
392 public static final String EXTRA_PROFILE_OWNER_NAME
393 = "android.app.extra.PROFILE_OWNER_NAME";
394
395 /**
Jim Miller284b62e2010-06-08 14:27:42 -0700396 * Activity action: send when any policy admin changes a policy.
397 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700398 *
Jim Miller284b62e2010-06-08 14:27:42 -0700399 * @hide
400 */
401 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
402 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
403
404 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800405 * The ComponentName of the administrator component.
406 *
407 * @see #ACTION_ADD_DEVICE_ADMIN
408 */
409 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700410
Dianne Hackbornd6847842010-01-12 18:14:19 -0800411 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800412 * An optional CharSequence providing additional explanation for why the
413 * admin is being added.
414 *
415 * @see #ACTION_ADD_DEVICE_ADMIN
416 */
417 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700418
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800419 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700420 * Activity action: have the user enter a new password. This activity should
421 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
422 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
423 * enter a new password that meets the current requirements. You can use
424 * {@link #isActivePasswordSufficient()} to determine whether you need to
425 * have the user select a new password in order to meet the current
426 * constraints. Upon being resumed from this activity, you can check the new
427 * password characteristics to see if they are sufficient.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800428 */
429 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
430 public static final String ACTION_SET_NEW_PASSWORD
431 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700432
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000433 /**
Nicolas Prevot81948992014-05-16 18:25:26 +0100434 * Flag used by {@link #addCrossProfileIntentFilter} to allow access of certain intents from a
435 * managed profile to its parent.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000436 */
Nicolas Prevot81948992014-05-16 18:25:26 +0100437 public static int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000438
439 /**
Nicolas Prevot81948992014-05-16 18:25:26 +0100440 * Flag used by {@link #addCrossProfileIntentFilter} to allow access of certain intents from the
441 * parent to its managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000442 */
Nicolas Prevot81948992014-05-16 18:25:26 +0100443 public static int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700444
Dianne Hackbornd6847842010-01-12 18:14:19 -0800445 /**
446 * Return true if the given administrator component is currently
447 * active (enabled) in the system.
448 */
449 public boolean isAdminActive(ComponentName who) {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +0100450 return isAdminActiveAsUser(who, UserHandle.myUserId());
451 }
452
453 /**
454 * @see #isAdminActive(ComponentName)
455 * @hide
456 */
457 public boolean isAdminActiveAsUser(ComponentName who, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800458 if (mService != null) {
459 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +0100460 return mService.isAdminActive(who, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800461 } catch (RemoteException e) {
462 Log.w(TAG, "Failed talking with device policy service", e);
463 }
464 }
465 return false;
466 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700467
Dianne Hackbornd6847842010-01-12 18:14:19 -0800468 /**
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800469 * Return a list of all currently active device administrator's component
470 * names. Note that if there are no administrators than null may be
471 * returned.
472 */
473 public List<ComponentName> getActiveAdmins() {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +0100474 return getActiveAdminsAsUser(UserHandle.myUserId());
475 }
476
477 /**
478 * @see #getActiveAdmins()
479 * @hide
480 */
481 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800482 if (mService != null) {
483 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +0100484 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800485 } catch (RemoteException e) {
486 Log.w(TAG, "Failed talking with device policy service", e);
487 }
488 }
489 return null;
490 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700491
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800492 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700493 * Used by package administration code to determine if a package can be stopped
494 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800495 * @hide
496 */
497 public boolean packageHasActiveAdmins(String packageName) {
498 if (mService != null) {
499 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700500 return mService.packageHasActiveAdmins(packageName, UserHandle.myUserId());
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800501 } catch (RemoteException e) {
502 Log.w(TAG, "Failed talking with device policy service", e);
503 }
504 }
505 return false;
506 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700507
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800508 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800509 * Remove a current administration component. This can only be called
510 * by the application that owns the administration component; if you
511 * try to remove someone else's component, a security exception will be
512 * thrown.
513 */
514 public void removeActiveAdmin(ComponentName who) {
515 if (mService != null) {
516 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700517 mService.removeActiveAdmin(who, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -0800518 } catch (RemoteException e) {
519 Log.w(TAG, "Failed talking with device policy service", e);
520 }
521 }
522 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700523
Dianne Hackbornd6847842010-01-12 18:14:19 -0800524 /**
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800525 * Returns true if an administrator has been granted a particular device policy. This can
526 * be used to check if the administrator was activated under an earlier set of policies,
527 * but requires additional policies after an upgrade.
528 *
529 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be
530 * an active administrator, or an exception will be thrown.
531 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
532 */
533 public boolean hasGrantedPolicy(ComponentName admin, int usesPolicy) {
534 if (mService != null) {
535 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700536 return mService.hasGrantedPolicy(admin, usesPolicy, UserHandle.myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800537 } catch (RemoteException e) {
538 Log.w(TAG, "Failed talking with device policy service", e);
539 }
540 }
541 return false;
542 }
543
544 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800545 * Constant for {@link #setPasswordQuality}: the policy has no requirements
546 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800547 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800548 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800549 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700550
Dianne Hackbornd6847842010-01-12 18:14:19 -0800551 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700552 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
553 * recognition technology. This implies technologies that can recognize the identity of
554 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
555 * Note that quality constants are ordered so that higher values are more restrictive.
556 */
557 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
558
559 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800560 * Constant for {@link #setPasswordQuality}: the policy requires some kind
561 * of password, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800562 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800563 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800564 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700565
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800566 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800567 * Constant for {@link #setPasswordQuality}: the user must have entered a
568 * password containing at least numeric characters. Note that quality
569 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800570 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800571 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700572
Dianne Hackbornd6847842010-01-12 18:14:19 -0800573 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800574 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -0800575 * password containing at least numeric characters with no repeating (4444)
576 * or ordered (1234, 4321, 2468) sequences. Note that quality
577 * constants are ordered so that higher values are more restrictive.
578 */
579 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
580
581 /**
582 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -0700583 * password containing at least alphabetic (or other symbol) characters.
584 * Note that quality constants are ordered so that higher values are more
585 * restrictive.
586 */
587 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700588
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -0700589 /**
590 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800591 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -0700592 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800593 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800594 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -0700595 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700596
Dianne Hackbornd6847842010-01-12 18:14:19 -0800597 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700598 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700599 * password containing at least a letter, a numerical digit and a special
600 * symbol, by default. With this password quality, passwords can be
601 * restricted to contain various sets of characters, like at least an
602 * uppercase letter, etc. These are specified using various methods,
603 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
604 * that quality constants are ordered so that higher values are more
605 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700606 */
607 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
608
609 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800610 * Called by an application that is administering the device to set the
611 * password restrictions it is imposing. After setting this, the user
612 * will not be able to enter a new password that is not at least as
613 * restrictive as what has been set. Note that the current password
614 * will remain until the user has set a new one, so the change does not
615 * take place immediately. To prompt the user for a new password, use
616 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700617 *
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800618 * <p>Quality constants are ordered so that higher values are more restrictive;
619 * thus the highest requested quality constant (between the policy set here,
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800620 * the user's preference, and any other considerations) is the one that
621 * is in effect.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700622 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -0800623 * <p>The calling device admin must have requested
624 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
625 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700626 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -0800627 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800628 * @param quality The new desired quality. One of
629 * {@link #PASSWORD_QUALITY_UNSPECIFIED}, {@link #PASSWORD_QUALITY_SOMETHING},
Jim Miller85516d02014-01-31 17:08:37 -0800630 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
631 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC}
632 * or {@link #PASSWORD_QUALITY_COMPLEX}.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800633 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800634 public void setPasswordQuality(ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800635 if (mService != null) {
636 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700637 mService.setPasswordQuality(admin, quality, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -0800638 } catch (RemoteException e) {
639 Log.w(TAG, "Failed talking with device policy service", e);
640 }
641 }
642 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700643
Dianne Hackbornd6847842010-01-12 18:14:19 -0800644 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +0100645 * Retrieve the current minimum password quality for all admins of this user
646 * and its profiles or a particular one.
Dianne Hackborn254cb442010-01-27 19:23:59 -0800647 * @param admin The name of the admin component to check, or null to aggregate
648 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800649 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800650 public int getPasswordQuality(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700651 return getPasswordQuality(admin, UserHandle.myUserId());
652 }
653
654 /** @hide per-user version */
655 public int getPasswordQuality(ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800656 if (mService != null) {
657 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700658 return mService.getPasswordQuality(admin, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800659 } catch (RemoteException e) {
660 Log.w(TAG, "Failed talking with device policy service", e);
661 }
662 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800663 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -0800664 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700665
Dianne Hackbornd6847842010-01-12 18:14:19 -0800666 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800667 * Called by an application that is administering the device to set the
668 * minimum allowed password length. After setting this, the user
669 * will not be able to enter a new password that is not at least as
670 * restrictive as what has been set. Note that the current password
671 * will remain until the user has set a new one, so the change does not
672 * take place immediately. To prompt the user for a new password, use
673 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
674 * constraint is only imposed if the administrator has also requested either
Jim Miller85516d02014-01-31 17:08:37 -0800675 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
676 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC},
677 * or {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700678 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -0800679 * <p>The calling device admin must have requested
680 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
681 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700682 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -0800683 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800684 * @param length The new desired minimum password length. A value of 0
685 * means there is no restriction.
686 */
Dianne Hackborn254cb442010-01-27 19:23:59 -0800687 public void setPasswordMinimumLength(ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800688 if (mService != null) {
689 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700690 mService.setPasswordMinimumLength(admin, length, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -0800691 } catch (RemoteException e) {
692 Log.w(TAG, "Failed talking with device policy service", e);
693 }
694 }
695 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700696
Dianne Hackbornd6847842010-01-12 18:14:19 -0800697 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +0100698 * Retrieve the current minimum password length for all admins of this
699 * user and its profiles or a particular one.
Dianne Hackborn254cb442010-01-27 19:23:59 -0800700 * @param admin The name of the admin component to check, or null to aggregate
701 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800702 */
Dianne Hackborn254cb442010-01-27 19:23:59 -0800703 public int getPasswordMinimumLength(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700704 return getPasswordMinimumLength(admin, UserHandle.myUserId());
705 }
706
707 /** @hide per-user version */
708 public int getPasswordMinimumLength(ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800709 if (mService != null) {
710 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700711 return mService.getPasswordMinimumLength(admin, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800712 } catch (RemoteException e) {
713 Log.w(TAG, "Failed talking with device policy service", e);
714 }
715 }
716 return 0;
717 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700718
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700719 /**
720 * Called by an application that is administering the device to set the
721 * minimum number of upper case letters required in the password. After
722 * setting this, the user will not be able to enter a new password that is
723 * not at least as restrictive as what has been set. Note that the current
724 * password will remain until the user has set a new one, so the change does
725 * not take place immediately. To prompt the user for a new password, use
726 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
727 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700728 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
729 * default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700730 * <p>
731 * The calling device admin must have requested
732 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
733 * this method; if it has not, a security exception will be thrown.
734 *
735 * @param admin Which {@link DeviceAdminReceiver} this request is associated
736 * with.
737 * @param length The new desired minimum number of upper case letters
738 * required in the password. A value of 0 means there is no
739 * restriction.
740 */
741 public void setPasswordMinimumUpperCase(ComponentName admin, int length) {
742 if (mService != null) {
743 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700744 mService.setPasswordMinimumUpperCase(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700745 } catch (RemoteException e) {
746 Log.w(TAG, "Failed talking with device policy service", e);
747 }
748 }
749 }
750
751 /**
752 * Retrieve the current number of upper case letters required in the
Jessica Hummel91da58d2014-04-10 17:39:43 +0100753 * password for all admins of this user and its profiles or a particular one.
754 * This is the same value as set by
755 * {#link {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700756 * and only applies when the password quality is
757 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700758 *
759 * @param admin The name of the admin component to check, or null to
760 * aggregate all admins.
761 * @return The minimum number of upper case letters required in the
762 * password.
763 */
764 public int getPasswordMinimumUpperCase(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700765 return getPasswordMinimumUpperCase(admin, UserHandle.myUserId());
766 }
767
768 /** @hide per-user version */
769 public int getPasswordMinimumUpperCase(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700770 if (mService != null) {
771 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700772 return mService.getPasswordMinimumUpperCase(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700773 } catch (RemoteException e) {
774 Log.w(TAG, "Failed talking with device policy service", e);
775 }
776 }
777 return 0;
778 }
779
780 /**
781 * Called by an application that is administering the device to set the
782 * minimum number of lower case letters required in the password. After
783 * setting this, the user will not be able to enter a new password that is
784 * not at least as restrictive as what has been set. Note that the current
785 * password will remain until the user has set a new one, so the change does
786 * not take place immediately. To prompt the user for a new password, use
787 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
788 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700789 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
790 * default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700791 * <p>
792 * The calling device admin must have requested
793 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
794 * this method; if it has not, a security exception will be thrown.
795 *
796 * @param admin Which {@link DeviceAdminReceiver} this request is associated
797 * with.
798 * @param length The new desired minimum number of lower case letters
799 * required in the password. A value of 0 means there is no
800 * restriction.
801 */
802 public void setPasswordMinimumLowerCase(ComponentName admin, int length) {
803 if (mService != null) {
804 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700805 mService.setPasswordMinimumLowerCase(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700806 } catch (RemoteException e) {
807 Log.w(TAG, "Failed talking with device policy service", e);
808 }
809 }
810 }
811
812 /**
813 * Retrieve the current number of lower case letters required in the
Jessica Hummel91da58d2014-04-10 17:39:43 +0100814 * password for all admins of this user and its profiles or a particular one.
815 * This is the same value as set by
816 * {#link {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700817 * and only applies when the password quality is
818 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700819 *
820 * @param admin The name of the admin component to check, or null to
821 * aggregate all admins.
822 * @return The minimum number of lower case letters required in the
823 * password.
824 */
825 public int getPasswordMinimumLowerCase(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700826 return getPasswordMinimumLowerCase(admin, UserHandle.myUserId());
827 }
828
829 /** @hide per-user version */
830 public int getPasswordMinimumLowerCase(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700831 if (mService != null) {
832 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700833 return mService.getPasswordMinimumLowerCase(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700834 } catch (RemoteException e) {
835 Log.w(TAG, "Failed talking with device policy service", e);
836 }
837 }
838 return 0;
839 }
840
841 /**
842 * Called by an application that is administering the device to set the
843 * minimum number of letters required in the password. After setting this,
844 * the user will not be able to enter a new password that is not at least as
845 * restrictive as what has been set. Note that the current password will
846 * remain until the user has set a new one, so the change does not take
847 * place immediately. To prompt the user for a new password, use
848 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
849 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700850 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
851 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700852 * <p>
853 * The calling device admin must have requested
854 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
855 * this method; if it has not, a security exception will be thrown.
856 *
857 * @param admin Which {@link DeviceAdminReceiver} this request is associated
858 * with.
859 * @param length The new desired minimum number of letters required in the
860 * password. A value of 0 means there is no restriction.
861 */
862 public void setPasswordMinimumLetters(ComponentName admin, int length) {
863 if (mService != null) {
864 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700865 mService.setPasswordMinimumLetters(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700866 } catch (RemoteException e) {
867 Log.w(TAG, "Failed talking with device policy service", e);
868 }
869 }
870 }
871
872 /**
873 * Retrieve the current number of letters required in the password for all
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700874 * admins or a particular one. This is the same value as
875 * set by {#link {@link #setPasswordMinimumLetters(ComponentName, int)}
876 * and only applies when the password quality is
877 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700878 *
879 * @param admin The name of the admin component to check, or null to
880 * aggregate all admins.
881 * @return The minimum number of letters required in the password.
882 */
883 public int getPasswordMinimumLetters(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700884 return getPasswordMinimumLetters(admin, UserHandle.myUserId());
885 }
886
887 /** @hide per-user version */
888 public int getPasswordMinimumLetters(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700889 if (mService != null) {
890 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700891 return mService.getPasswordMinimumLetters(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700892 } catch (RemoteException e) {
893 Log.w(TAG, "Failed talking with device policy service", e);
894 }
895 }
896 return 0;
897 }
898
899 /**
900 * Called by an application that is administering the device to set the
901 * minimum number of numerical digits required in the password. After
902 * setting this, the user will not be able to enter a new password that is
903 * not at least as restrictive as what has been set. Note that the current
904 * password will remain until the user has set a new one, so the change does
905 * not take place immediately. To prompt the user for a new password, use
906 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
907 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700908 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
909 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700910 * <p>
911 * The calling device admin must have requested
912 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
913 * this method; if it has not, a security exception will be thrown.
914 *
915 * @param admin Which {@link DeviceAdminReceiver} this request is associated
916 * with.
917 * @param length The new desired minimum number of numerical digits required
918 * in the password. A value of 0 means there is no restriction.
919 */
920 public void setPasswordMinimumNumeric(ComponentName admin, int length) {
921 if (mService != null) {
922 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700923 mService.setPasswordMinimumNumeric(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700924 } catch (RemoteException e) {
925 Log.w(TAG, "Failed talking with device policy service", e);
926 }
927 }
928 }
929
930 /**
931 * Retrieve the current number of numerical digits required in the password
Jessica Hummel91da58d2014-04-10 17:39:43 +0100932 * for all admins of this user and its profiles or a particular one.
933 * This is the same value as set by
934 * {#link {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700935 * and only applies when the password quality is
936 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700937 *
938 * @param admin The name of the admin component to check, or null to
939 * aggregate all admins.
940 * @return The minimum number of numerical digits required in the password.
941 */
942 public int getPasswordMinimumNumeric(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700943 return getPasswordMinimumNumeric(admin, UserHandle.myUserId());
944 }
945
946 /** @hide per-user version */
947 public int getPasswordMinimumNumeric(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700948 if (mService != null) {
949 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700950 return mService.getPasswordMinimumNumeric(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700951 } catch (RemoteException e) {
952 Log.w(TAG, "Failed talking with device policy service", e);
953 }
954 }
955 return 0;
956 }
957
958 /**
959 * Called by an application that is administering the device to set the
960 * minimum number of symbols required in the password. After setting this,
961 * the user will not be able to enter a new password that is not at least as
962 * restrictive as what has been set. Note that the current password will
963 * remain until the user has set a new one, so the change does not take
964 * place immediately. To prompt the user for a new password, use
965 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
966 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700967 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
968 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700969 * <p>
970 * The calling device admin must have requested
971 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
972 * this method; if it has not, a security exception will be thrown.
973 *
974 * @param admin Which {@link DeviceAdminReceiver} this request is associated
975 * with.
976 * @param length The new desired minimum number of symbols required in the
977 * password. A value of 0 means there is no restriction.
978 */
979 public void setPasswordMinimumSymbols(ComponentName admin, int length) {
980 if (mService != null) {
981 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700982 mService.setPasswordMinimumSymbols(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700983 } catch (RemoteException e) {
984 Log.w(TAG, "Failed talking with device policy service", e);
985 }
986 }
987 }
988
989 /**
990 * Retrieve the current number of symbols required in the password for all
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700991 * admins or a particular one. This is the same value as
992 * set by {#link {@link #setPasswordMinimumSymbols(ComponentName, int)}
993 * and only applies when the password quality is
994 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700995 *
996 * @param admin The name of the admin component to check, or null to
997 * aggregate all admins.
998 * @return The minimum number of symbols required in the password.
999 */
1000 public int getPasswordMinimumSymbols(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001001 return getPasswordMinimumSymbols(admin, UserHandle.myUserId());
1002 }
1003
1004 /** @hide per-user version */
1005 public int getPasswordMinimumSymbols(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001006 if (mService != null) {
1007 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001008 return mService.getPasswordMinimumSymbols(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001009 } catch (RemoteException e) {
1010 Log.w(TAG, "Failed talking with device policy service", e);
1011 }
1012 }
1013 return 0;
1014 }
1015
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001016 /**
1017 * Called by an application that is administering the device to set the
1018 * minimum number of non-letter characters (numerical digits or symbols)
1019 * required in the password. After setting this, the user will not be able
1020 * to enter a new password that is not at least as restrictive as what has
1021 * been set. Note that the current password will remain until the user has
1022 * set a new one, so the change does not take place immediately. To prompt
1023 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} after
1024 * setting this value. This constraint is only imposed if the administrator
1025 * has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1026 * {@link #setPasswordQuality}. The default value is 0.
1027 * <p>
1028 * The calling device admin must have requested
1029 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1030 * this method; if it has not, a security exception will be thrown.
1031 *
1032 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1033 * with.
1034 * @param length The new desired minimum number of letters required in the
1035 * password. A value of 0 means there is no restriction.
1036 */
1037 public void setPasswordMinimumNonLetter(ComponentName admin, int length) {
1038 if (mService != null) {
1039 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001040 mService.setPasswordMinimumNonLetter(admin, length, UserHandle.myUserId());
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001041 } catch (RemoteException e) {
1042 Log.w(TAG, "Failed talking with device policy service", e);
1043 }
1044 }
1045 }
1046
1047 /**
1048 * Retrieve the current number of non-letter characters required in the
Jessica Hummel91da58d2014-04-10 17:39:43 +01001049 * password for all admins of this user and its profiles or a particular one.
1050 * This is the same value as set by
1051 * {#link {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001052 * and only applies when the password quality is
1053 * {@link #PASSWORD_QUALITY_COMPLEX}.
1054 *
1055 * @param admin The name of the admin component to check, or null to
1056 * aggregate all admins.
1057 * @return The minimum number of letters required in the password.
1058 */
1059 public int getPasswordMinimumNonLetter(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001060 return getPasswordMinimumNonLetter(admin, UserHandle.myUserId());
1061 }
1062
1063 /** @hide per-user version */
1064 public int getPasswordMinimumNonLetter(ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001065 if (mService != null) {
1066 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001067 return mService.getPasswordMinimumNonLetter(admin, userHandle);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001068 } catch (RemoteException e) {
1069 Log.w(TAG, "Failed talking with device policy service", e);
1070 }
1071 }
1072 return 0;
1073 }
1074
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001075 /**
1076 * Called by an application that is administering the device to set the length
1077 * of the password history. After setting this, the user will not be able to
1078 * enter a new password that is the same as any password in the history. Note
1079 * that the current password will remain until the user has set a new one, so
1080 * the change does not take place immediately. To prompt the user for a new
1081 * password, use {@link #ACTION_SET_NEW_PASSWORD} after setting this value.
1082 * This constraint is only imposed if the administrator has also requested
Jim Miller85516d02014-01-31 17:08:37 -08001083 * either {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}
1084 * {@link #PASSWORD_QUALITY_ALPHABETIC}, or {@link #PASSWORD_QUALITY_ALPHANUMERIC}
1085 * with {@link #setPasswordQuality}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001086 *
1087 * <p>
1088 * The calling device admin must have requested
1089 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this
1090 * method; if it has not, a security exception will be thrown.
1091 *
1092 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1093 * with.
1094 * @param length The new desired length of password history. A value of 0
1095 * means there is no restriction.
1096 */
1097 public void setPasswordHistoryLength(ComponentName admin, int length) {
1098 if (mService != null) {
1099 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001100 mService.setPasswordHistoryLength(admin, length, UserHandle.myUserId());
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001101 } catch (RemoteException e) {
1102 Log.w(TAG, "Failed talking with device policy service", e);
1103 }
1104 }
1105 }
1106
1107 /**
Jim Millera4e28d12010-11-08 16:15:47 -08001108 * Called by a device admin to set the password expiration timeout. Calling this method
1109 * will restart the countdown for password expiration for the given admin, as will changing
1110 * the device password (for all admins).
1111 *
1112 * <p>The provided timeout is the time delta in ms and will be added to the current time.
1113 * For example, to have the password expire 5 days from now, timeout would be
1114 * 5 * 86400 * 1000 = 432000000 ms for timeout.
1115 *
1116 * <p>To disable password expiration, a value of 0 may be used for timeout.
1117 *
Jim Millera4e28d12010-11-08 16:15:47 -08001118 * <p>The calling device admin must have requested
1119 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this
1120 * method; if it has not, a security exception will be thrown.
1121 *
Jessica Hummel9da60392014-05-21 12:32:57 +01001122 * <p> Note that setting the password will automatically reset the expiration time for all
1123 * active admins. Active admins do not need to explicitly call this method in that case.
1124 *
Jim Millera4e28d12010-11-08 16:15:47 -08001125 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1126 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0
1127 * means there is no restriction (unlimited).
1128 */
1129 public void setPasswordExpirationTimeout(ComponentName admin, long timeout) {
1130 if (mService != null) {
1131 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001132 mService.setPasswordExpirationTimeout(admin, timeout, UserHandle.myUserId());
Jim Millera4e28d12010-11-08 16:15:47 -08001133 } catch (RemoteException e) {
1134 Log.w(TAG, "Failed talking with device policy service", e);
1135 }
1136 }
1137 }
1138
1139 /**
Jim Miller6b857682011-02-16 16:27:41 -08001140 * Get the password expiration timeout for the given admin. The expiration timeout is the
1141 * recurring expiration timeout provided in the call to
1142 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
1143 * aggregate of all policy administrators if admin is null.
Jim Millera4e28d12010-11-08 16:15:47 -08001144 *
1145 * @param admin The name of the admin component to check, or null to aggregate all admins.
1146 * @return The timeout for the given admin or the minimum of all timeouts
1147 */
1148 public long getPasswordExpirationTimeout(ComponentName admin) {
1149 if (mService != null) {
1150 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001151 return mService.getPasswordExpirationTimeout(admin, UserHandle.myUserId());
Jim Millera4e28d12010-11-08 16:15:47 -08001152 } catch (RemoteException e) {
1153 Log.w(TAG, "Failed talking with device policy service", e);
1154 }
1155 }
1156 return 0;
1157 }
1158
1159 /**
1160 * Get the current password expiration time for the given admin or an aggregate of
Jessica Hummel91da58d2014-04-10 17:39:43 +01001161 * all admins of this user and its profiles if admin is null. If the password is
1162 * expired, this will return the time since the password expired as a negative number.
1163 * If admin is null, then a composite of all expiration timeouts is returned
1164 * - which will be the minimum of all timeouts.
Jim Millera4e28d12010-11-08 16:15:47 -08001165 *
1166 * @param admin The name of the admin component to check, or null to aggregate all admins.
1167 * @return The password expiration time, in ms.
1168 */
1169 public long getPasswordExpiration(ComponentName admin) {
1170 if (mService != null) {
1171 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001172 return mService.getPasswordExpiration(admin, UserHandle.myUserId());
Jim Millera4e28d12010-11-08 16:15:47 -08001173 } catch (RemoteException e) {
1174 Log.w(TAG, "Failed talking with device policy service", e);
1175 }
1176 }
1177 return 0;
1178 }
1179
1180 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +01001181 * Retrieve the current password history length for all admins of this
1182 * user and its profiles or a particular one.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001183 * @param admin The name of the admin component to check, or null to aggregate
1184 * all admins.
1185 * @return The length of the password history
1186 */
1187 public int getPasswordHistoryLength(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001188 return getPasswordHistoryLength(admin, UserHandle.myUserId());
1189 }
1190
1191 /** @hide per-user version */
1192 public int getPasswordHistoryLength(ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001193 if (mService != null) {
1194 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001195 return mService.getPasswordHistoryLength(admin, userHandle);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001196 } catch (RemoteException e) {
1197 Log.w(TAG, "Failed talking with device policy service", e);
1198 }
1199 }
1200 return 0;
1201 }
1202
Dianne Hackbornd6847842010-01-12 18:14:19 -08001203 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001204 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001205 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001206 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001207 * @return Returns the maximum length that the user can enter.
1208 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001209 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001210 // Kind-of arbitrary.
1211 return 16;
1212 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001213
Dianne Hackborn254cb442010-01-27 19:23:59 -08001214 /**
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001215 * Determine whether the current password the user has set is sufficient
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001216 * to meet the policy requirements (quality, minimum length) that have been
Jessica Hummel91da58d2014-04-10 17:39:43 +01001217 * requested by the admins of this user and its profiles.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001218 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001219 * <p>The calling device admin must have requested
1220 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1221 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001222 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001223 * @return Returns true if the password meets the current requirements, else false.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001224 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001225 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001226 if (mService != null) {
1227 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001228 return mService.isActivePasswordSufficient(UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001229 } catch (RemoteException e) {
1230 Log.w(TAG, "Failed talking with device policy service", e);
1231 }
1232 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001233 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001234 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001235
Dianne Hackbornd6847842010-01-12 18:14:19 -08001236 /**
1237 * Retrieve the number of times the user has failed at entering a
1238 * password since that last successful password entry.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001239 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001240 * <p>The calling device admin must have requested
1241 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call
1242 * this method; if it has not, a security exception will be thrown.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001243 */
1244 public int getCurrentFailedPasswordAttempts() {
1245 if (mService != null) {
1246 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001247 return mService.getCurrentFailedPasswordAttempts(UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001248 } catch (RemoteException e) {
1249 Log.w(TAG, "Failed talking with device policy service", e);
1250 }
1251 }
1252 return -1;
1253 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001254
1255 /**
Andrew Stadler88209d12010-02-08 22:59:36 -08001256 * Setting this to a value greater than zero enables a built-in policy
1257 * that will perform a device wipe after too many incorrect
1258 * device-unlock passwords have been entered. This built-in policy combines
1259 * watching for failed passwords and wiping the device, and requires
1260 * that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001261 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001262 *
Andrew Stadler88209d12010-02-08 22:59:36 -08001263 * <p>To implement any other policy (e.g. wiping data for a particular
1264 * application only, erasing or revoking credentials, or reporting the
1265 * failure to a server), you should implement
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001266 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)}
Andrew Stadler88209d12010-02-08 22:59:36 -08001267 * instead. Do not use this API, because if the maximum count is reached,
1268 * the device will be wiped immediately, and your callback will not be invoked.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001269 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001270 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001271 * @param num The number of failed password attempts at which point the
1272 * device will wipe its data.
1273 */
1274 public void setMaximumFailedPasswordsForWipe(ComponentName admin, int num) {
1275 if (mService != null) {
1276 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001277 mService.setMaximumFailedPasswordsForWipe(admin, num, UserHandle.myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001278 } catch (RemoteException e) {
1279 Log.w(TAG, "Failed talking with device policy service", e);
1280 }
1281 }
1282 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001283
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001284 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001285 * Retrieve the current maximum number of login attempts that are allowed
Jessica Hummel91da58d2014-04-10 17:39:43 +01001286 * before the device wipes itself, for all admins of this user and its profiles
Dianne Hackborn254cb442010-01-27 19:23:59 -08001287 * or a particular one.
1288 * @param admin The name of the admin component to check, or null to aggregate
1289 * all admins.
1290 */
1291 public int getMaximumFailedPasswordsForWipe(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001292 return getMaximumFailedPasswordsForWipe(admin, UserHandle.myUserId());
1293 }
1294
1295 /** @hide per-user version */
1296 public int getMaximumFailedPasswordsForWipe(ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001297 if (mService != null) {
1298 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001299 return mService.getMaximumFailedPasswordsForWipe(admin, userHandle);
Dianne Hackborn254cb442010-01-27 19:23:59 -08001300 } catch (RemoteException e) {
1301 Log.w(TAG, "Failed talking with device policy service", e);
1302 }
1303 }
1304 return 0;
1305 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001306
Dianne Hackborn254cb442010-01-27 19:23:59 -08001307 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001308 * Flag for {@link #resetPassword}: don't allow other admins to change
1309 * the password again until the user has entered it.
1310 */
1311 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001312
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001313 /**
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001314 * Force a new device unlock password (the password needed to access the
1315 * entire device, not for individual accounts) on the user. This takes
1316 * effect immediately.
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001317 * The given password must be sufficient for the
1318 * current password quality and length constraints as returned by
1319 * {@link #getPasswordQuality(ComponentName)} and
1320 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet
1321 * these constraints, then it will be rejected and false returned. Note
1322 * that the password may be a stronger quality (containing alphanumeric
1323 * characters when the requested quality is only numeric), in which case
1324 * the currently active quality will be increased to match.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001325 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001326 * <p>The calling device admin must have requested
1327 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call
1328 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001329 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001330 * Can not be called from a managed profile.
1331 *
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001332 * @param password The new password for the user.
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001333 * @param flags May be 0 or {@link #RESET_PASSWORD_REQUIRE_ENTRY}.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001334 * @return Returns true if the password was applied, or false if it is
1335 * not acceptable for the current constraints.
1336 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001337 public boolean resetPassword(String password, int flags) {
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001338 if (mService != null) {
1339 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001340 return mService.resetPassword(password, flags, UserHandle.myUserId());
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001341 } catch (RemoteException e) {
1342 Log.w(TAG, "Failed talking with device policy service", e);
1343 }
1344 }
1345 return false;
1346 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001347
Dianne Hackbornd6847842010-01-12 18:14:19 -08001348 /**
1349 * Called by an application that is administering the device to set the
1350 * maximum time for user activity until the device will lock. This limits
1351 * the length that the user can set. It takes effect immediately.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001352 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001353 * <p>The calling device admin must have requested
Dianne Hackborn315ada72010-02-11 12:14:08 -08001354 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001355 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001356 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001357 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001358 * @param timeMs The new desired maximum time to lock in milliseconds.
1359 * A value of 0 means there is no restriction.
1360 */
1361 public void setMaximumTimeToLock(ComponentName admin, long timeMs) {
1362 if (mService != null) {
1363 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001364 mService.setMaximumTimeToLock(admin, timeMs, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001365 } catch (RemoteException e) {
1366 Log.w(TAG, "Failed talking with device policy service", e);
1367 }
1368 }
1369 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001370
Dianne Hackbornd6847842010-01-12 18:14:19 -08001371 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +01001372 * Retrieve the current maximum time to unlock for all admins of this user
1373 * and its profiles or a particular one.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001374 * @param admin The name of the admin component to check, or null to aggregate
1375 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07001376 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07001377 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001378 */
Dianne Hackborn254cb442010-01-27 19:23:59 -08001379 public long getMaximumTimeToLock(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001380 return getMaximumTimeToLock(admin, UserHandle.myUserId());
1381 }
1382
1383 /** @hide per-user version */
1384 public long getMaximumTimeToLock(ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001385 if (mService != null) {
1386 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001387 return mService.getMaximumTimeToLock(admin, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001388 } catch (RemoteException e) {
1389 Log.w(TAG, "Failed talking with device policy service", e);
1390 }
1391 }
1392 return 0;
1393 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001394
Dianne Hackbornd6847842010-01-12 18:14:19 -08001395 /**
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001396 * Make the device lock immediately, as if the lock screen timeout has
1397 * expired at the point of this call.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001398 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001399 * <p>The calling device admin must have requested
1400 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
1401 * this method; if it has not, a security exception will be thrown.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001402 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001403 public void lockNow() {
1404 if (mService != null) {
1405 try {
1406 mService.lockNow();
1407 } catch (RemoteException e) {
1408 Log.w(TAG, "Failed talking with device policy service", e);
1409 }
1410 }
1411 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001412
Dianne Hackbornd6847842010-01-12 18:14:19 -08001413 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07001414 * Flag for {@link #wipeData(int)}: also erase the device's external
1415 * storage.
1416 */
1417 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
1418
1419 /**
Paul Quei2450a0e2013-09-20 09:26:21 +08001420 * Ask the user data be wiped. This will cause the device to reboot,
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001421 * erasing all user data while next booting up. External storage such
Masanori Oginof535cb042012-02-15 19:25:50 +09001422 * as SD cards will be also erased if the flag {@link #WIPE_EXTERNAL_STORAGE}
1423 * is set.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001424 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001425 * <p>The calling device admin must have requested
1426 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to be able to call
1427 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001428 *
Masanori Oginof535cb042012-02-15 19:25:50 +09001429 * @param flags Bit mask of additional options: currently 0 and
1430 * {@link #WIPE_EXTERNAL_STORAGE} are supported.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001431 */
1432 public void wipeData(int flags) {
1433 if (mService != null) {
1434 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001435 mService.wipeData(flags, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001436 } catch (RemoteException e) {
1437 Log.w(TAG, "Failed talking with device policy service", e);
1438 }
1439 }
1440 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001441
Dianne Hackbornd6847842010-01-12 18:14:19 -08001442 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07001443 * Called by an application that is administering the device to set the
1444 * global proxy and exclusion list.
1445 * <p>
1446 * The calling device admin must have requested
1447 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
1448 * this method; if it has not, a security exception will be thrown.
1449 * Only the first device admin can set the proxy. If a second admin attempts
1450 * to set the proxy, the {@link ComponentName} of the admin originally setting the
1451 * proxy will be returned. If successful in setting the proxy, null will
1452 * be returned.
1453 * The method can be called repeatedly by the device admin alrady setting the
1454 * proxy to update the proxy and exclusion list.
1455 *
1456 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1457 * with.
1458 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
1459 * Pass Proxy.NO_PROXY to reset the proxy.
1460 * @param exclusionList a list of domains to be excluded from the global proxy.
Oscar Montemayor69238c62010-08-03 10:51:06 -07001461 * @return returns null if the proxy was successfully set, or a {@link ComponentName}
1462 * of the device admin that sets thew proxy otherwise.
Andy Stadlerd2672722011-02-16 10:53:33 -08001463 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07001464 */
1465 public ComponentName setGlobalProxy(ComponentName admin, Proxy proxySpec,
1466 List<String> exclusionList ) {
1467 if (proxySpec == null) {
1468 throw new NullPointerException();
1469 }
1470 if (mService != null) {
1471 try {
1472 String hostSpec;
1473 String exclSpec;
1474 if (proxySpec.equals(Proxy.NO_PROXY)) {
1475 hostSpec = null;
1476 exclSpec = null;
1477 } else {
1478 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
1479 throw new IllegalArgumentException();
1480 }
1481 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
1482 String hostName = sa.getHostName();
1483 int port = sa.getPort();
1484 StringBuilder hostBuilder = new StringBuilder();
1485 hostSpec = hostBuilder.append(hostName)
1486 .append(":").append(Integer.toString(port)).toString();
1487 if (exclusionList == null) {
1488 exclSpec = "";
1489 } else {
1490 StringBuilder listBuilder = new StringBuilder();
1491 boolean firstDomain = true;
1492 for (String exclDomain : exclusionList) {
1493 if (!firstDomain) {
1494 listBuilder = listBuilder.append(",");
1495 } else {
1496 firstDomain = false;
1497 }
1498 listBuilder = listBuilder.append(exclDomain.trim());
1499 }
1500 exclSpec = listBuilder.toString();
1501 }
Yuhao Zheng90704842014-02-28 17:22:45 -08001502 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
1503 != android.net.Proxy.PROXY_VALID)
1504 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07001505 }
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001506 return mService.setGlobalProxy(admin, hostSpec, exclSpec, UserHandle.myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07001507 } catch (RemoteException e) {
1508 Log.w(TAG, "Failed talking with device policy service", e);
1509 }
1510 }
1511 return null;
1512 }
1513
1514 /**
Jason Monk03bc9912014-05-13 09:44:57 -04001515 * Set a network-independent global HTTP proxy. This is not normally what you want
1516 * for typical HTTP proxies - they are generally network dependent. However if you're
1517 * doing something unusual like general internal filtering this may be useful. On
1518 * a private network where the proxy is not accessible, you may break HTTP using this.
1519 *
1520 * <p>This method requires the caller to be the device owner.
1521 *
1522 * <p>This proxy is only a recommendation and it is possible that some apps will ignore it.
1523 * @see ProxyInfo
1524 *
1525 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1526 * with.
1527 * @param proxyInfo The a {@link ProxyInfo} object defining the new global
1528 * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
1529 */
1530 public void setRecommendedGlobalProxy(ComponentName admin, ProxyInfo proxyInfo) {
1531 if (mService != null) {
1532 try {
1533 mService.setRecommendedGlobalProxy(admin, proxyInfo);
1534 } catch (RemoteException e) {
1535 Log.w(TAG, "Failed talking with device policy service", e);
1536 }
1537 }
1538 }
1539
1540 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07001541 * Returns the component name setting the global proxy.
1542 * @return ComponentName object of the device admin that set the global proxy, or
1543 * null if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08001544 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07001545 */
1546 public ComponentName getGlobalProxyAdmin() {
1547 if (mService != null) {
1548 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001549 return mService.getGlobalProxyAdmin(UserHandle.myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07001550 } catch (RemoteException e) {
1551 Log.w(TAG, "Failed talking with device policy service", e);
1552 }
1553 }
1554 return null;
1555 }
1556
1557 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08001558 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001559 * indicating that encryption is not supported.
1560 */
1561 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
1562
1563 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08001564 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001565 * indicating that encryption is supported, but is not currently active.
1566 */
1567 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
1568
1569 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08001570 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001571 * indicating that encryption is not currently active, but is currently
1572 * being activated. This is only reported by devices that support
1573 * encryption of data and only when the storage is currently
1574 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
1575 * to become encrypted will never return this value.
1576 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08001577 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001578
1579 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08001580 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001581 * indicating that encryption is active.
1582 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08001583 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001584
1585 /**
1586 * Activity action: begin the process of encrypting data on the device. This activity should
1587 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
1588 * After resuming from this activity, use {@link #getStorageEncryption}
1589 * to check encryption status. However, on some devices this activity may never return, as
1590 * it may trigger a reboot and in some cases a complete data wipe of the device.
1591 */
1592 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1593 public static final String ACTION_START_ENCRYPTION
1594 = "android.app.action.START_ENCRYPTION";
1595
1596 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07001597 * Widgets are enabled in keyguard
1598 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001599 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07001600
1601 /**
Jim Miller50e62182014-04-23 17:25:00 -07001602 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07001603 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001604 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
1605
1606 /**
1607 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
1608 */
1609 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
1610
1611 /**
Jim Miller50e62182014-04-23 17:25:00 -07001612 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
1613 */
1614 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
1615
1616 /**
1617 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
1618 */
1619 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
1620
1621 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02001622 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07001623 * (e.g. PIN/Pattern/Password).
1624 */
1625 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
1626
1627 /**
Jim Miller06e34502014-07-17 14:46:05 -07001628 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
1629 */
1630 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
1631
1632 /**
Jim Miller35207742012-11-02 15:33:20 -07001633 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07001634 */
1635 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07001636
1637 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001638 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08001639 * request that the storage system be encrypted.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001640 *
1641 * <p>When multiple device administrators attempt to control device
1642 * encryption, the most secure, supported setting will always be
1643 * used. If any device administrator requests device encryption,
1644 * it will be enabled; Conversely, if a device administrator
1645 * attempts to disable device encryption while another
1646 * device administrator has enabled it, the call to disable will
1647 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
1648 *
1649 * <p>This policy controls encryption of the secure (application data) storage area. Data
Andy Stadler50c294f2011-03-07 19:13:42 -08001650 * written to other storage areas may or may not be encrypted, and this policy does not require
1651 * or control the encryption of any other storage areas.
1652 * There is one exception: If {@link android.os.Environment#isExternalStorageEmulated()} is
1653 * {@code true}, then the directory returned by
1654 * {@link android.os.Environment#getExternalStorageDirectory()} must be written to disk
1655 * within the encrypted storage area.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001656 *
1657 * <p>Important Note: On some devices, it is possible to encrypt storage without requiring
1658 * the user to create a device PIN or Password. In this case, the storage is encrypted, but
1659 * the encryption key may not be fully secured. For maximum security, the administrator should
1660 * also require (and check for) a pattern, PIN, or password.
1661 *
1662 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1663 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08001664 * @return the new request status (for all active admins) - will be one of
1665 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
1666 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
1667 * {@link #getStorageEncryptionStatus()} to query the actual device state.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001668 */
1669 public int setStorageEncryption(ComponentName admin, boolean encrypt) {
1670 if (mService != null) {
1671 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001672 return mService.setStorageEncryption(admin, encrypt, UserHandle.myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001673 } catch (RemoteException e) {
1674 Log.w(TAG, "Failed talking with device policy service", e);
1675 }
1676 }
1677 return ENCRYPTION_STATUS_UNSUPPORTED;
1678 }
1679
1680 /**
1681 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08001682 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001683 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08001684 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
1685 * this will return the requested encryption setting as an aggregate of all active
1686 * administrators.
1687 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001688 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08001689 public boolean getStorageEncryption(ComponentName admin) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001690 if (mService != null) {
1691 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001692 return mService.getStorageEncryption(admin, UserHandle.myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001693 } catch (RemoteException e) {
1694 Log.w(TAG, "Failed talking with device policy service", e);
1695 }
1696 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08001697 return false;
1698 }
1699
1700 /**
1701 * Called by an application that is administering the device to
1702 * determine the current encryption status of the device.
1703 *
1704 * Depending on the returned status code, the caller may proceed in different
1705 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
1706 * storage system does not support encryption. If the
1707 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
1708 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
1709 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or
1710 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required.
1711 *
Robin Lee7e678712014-07-24 16:41:31 +01001712 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08001713 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
1714 * {@link #ENCRYPTION_STATUS_ACTIVATING}, or{@link #ENCRYPTION_STATUS_ACTIVE}.
1715 */
1716 public int getStorageEncryptionStatus() {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001717 return getStorageEncryptionStatus(UserHandle.myUserId());
1718 }
1719
1720 /** @hide per-user version */
1721 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08001722 if (mService != null) {
1723 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001724 return mService.getStorageEncryptionStatus(userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08001725 } catch (RemoteException e) {
1726 Log.w(TAG, "Failed talking with device policy service", e);
1727 }
1728 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001729 return ENCRYPTION_STATUS_UNSUPPORTED;
1730 }
1731
1732 /**
Robin Lee7e678712014-07-24 16:41:31 +01001733 * Installs the given certificate as a user CA.
1734 *
1735 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1736 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04001737 *
1738 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01001739 * interrupted, true otherwise.
Maggie Benthallda51e682013-08-08 22:35:44 -04001740 */
Robin Lee7e678712014-07-24 16:41:31 +01001741 public boolean installCaCert(ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04001742 if (mService != null) {
1743 try {
Robin Lee7e678712014-07-24 16:41:31 +01001744 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04001745 } catch (RemoteException e) {
1746 Log.w(TAG, "Failed talking with device policy service", e);
1747 }
1748 }
1749 return false;
1750 }
1751
1752 /**
Robin Lee7e678712014-07-24 16:41:31 +01001753 * Uninstalls the given certificate from trusted user CAs, if present.
1754 *
1755 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1756 * @param certBuffer encoded form of the certificate to remove.
Maggie Benthallda51e682013-08-08 22:35:44 -04001757 */
Robin Lee7e678712014-07-24 16:41:31 +01001758 public void uninstallCaCert(ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04001759 if (mService != null) {
1760 try {
Robin Lee306fe082014-06-19 14:04:24 +00001761 final String alias = getCaCertAlias(certBuffer);
Robin Lee7e678712014-07-24 16:41:31 +01001762 mService.uninstallCaCert(admin, alias);
Robin Lee306fe082014-06-19 14:04:24 +00001763 } catch (CertificateException e) {
1764 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04001765 } catch (RemoteException e) {
1766 Log.w(TAG, "Failed talking with device policy service", e);
1767 }
1768 }
1769 }
1770
1771 /**
Robin Lee7e678712014-07-24 16:41:31 +01001772 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
1773 * If a user has installed any certificates by other means than device policy these will be
1774 * included too.
1775 *
1776 * @return a List of byte[] arrays, each encoding one user CA certificate.
Maggie Benthallda51e682013-08-08 22:35:44 -04001777 */
Robin Lee7e678712014-07-24 16:41:31 +01001778 public List<byte[]> getInstalledCaCerts() {
1779 final TrustedCertificateStore certStore = new TrustedCertificateStore();
1780 List<byte[]> certs = new ArrayList<byte[]>();
1781 for (String alias : certStore.userAliases()) {
1782 try {
1783 certs.add(certStore.getCertificate(alias).getEncoded());
1784 } catch (CertificateException ce) {
1785 Log.w(TAG, "Could not encode certificate: " + alias, ce);
1786 }
1787 }
1788 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04001789 }
1790
1791 /**
Robin Lee7e678712014-07-24 16:41:31 +01001792 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
1793 * means other than device policy will also be removed, except for system CA certificates.
1794 *
1795 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1796 */
1797 public void uninstallAllUserCaCerts(ComponentName admin) {
1798 if (mService != null) {
1799 for (String alias : new TrustedCertificateStore().userAliases()) {
1800 try {
1801 mService.uninstallCaCert(admin, alias);
1802 } catch (RemoteException re) {
1803 Log.w(TAG, "Failed talking with device policy service", re);
1804 }
1805 }
1806 }
1807 }
1808
1809 /**
1810 * Returns whether this certificate is installed as a trusted CA.
1811 *
1812 * @param certBuffer encoded form of the certificate to look up.
Maggie Benthallda51e682013-08-08 22:35:44 -04001813 */
1814 public boolean hasCaCertInstalled(byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04001815 try {
Robin Lee306fe082014-06-19 14:04:24 +00001816 return getCaCertAlias(certBuffer) != null;
Maggie Benthallda51e682013-08-08 22:35:44 -04001817 } catch (CertificateException ce) {
1818 Log.w(TAG, "Could not parse certificate", ce);
1819 }
1820 return false;
1821 }
1822
1823 /**
Robin Lee306fe082014-06-19 14:04:24 +00001824 * Returns the alias of a given CA certificate in the certificate store, or null if it
1825 * doesn't exist.
1826 */
1827 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
1828 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
1829 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
1830 new ByteArrayInputStream(certBuffer));
1831 return new TrustedCertificateStore().getCertificateAlias(cert);
1832 }
1833
1834 /**
Ben Komalo2447edd2011-05-09 16:05:33 -07001835 * Called by an application that is administering the device to disable all cameras
1836 * on the device. After setting this, no applications will be able to access any cameras
1837 * on the device.
1838 *
1839 * <p>The calling device admin must have requested
1840 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call
1841 * this method; if it has not, a security exception will be thrown.
1842 *
1843 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1844 * @param disabled Whether or not the camera should be disabled.
1845 */
1846 public void setCameraDisabled(ComponentName admin, boolean disabled) {
1847 if (mService != null) {
1848 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001849 mService.setCameraDisabled(admin, disabled, UserHandle.myUserId());
Ben Komalo2447edd2011-05-09 16:05:33 -07001850 } catch (RemoteException e) {
1851 Log.w(TAG, "Failed talking with device policy service", e);
1852 }
1853 }
1854 }
1855
1856 /**
1857 * Determine whether or not the device's cameras have been disabled either by the current
1858 * admin, if specified, or all admins.
1859 * @param admin The name of the admin component to check, or null to check if any admins
1860 * have disabled the camera
1861 */
1862 public boolean getCameraDisabled(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001863 return getCameraDisabled(admin, UserHandle.myUserId());
1864 }
1865
1866 /** @hide per-user version */
1867 public boolean getCameraDisabled(ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07001868 if (mService != null) {
1869 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001870 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07001871 } catch (RemoteException e) {
1872 Log.w(TAG, "Failed talking with device policy service", e);
1873 }
1874 }
1875 return false;
1876 }
1877
1878 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01001879 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
1880 * screen capture also prevents the content from being shown on display devices that do not have
1881 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
1882 * secure surfaces and secure displays.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01001883 *
1884 * <p>The calling device admin must be a device or profile owner. If it is not, a
1885 * security exception will be thrown.
1886 *
1887 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01001888 * @param disabled Whether screen capture is disabled or not.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01001889 */
1890 public void setScreenCaptureDisabled(ComponentName admin, boolean disabled) {
1891 if (mService != null) {
1892 try {
1893 mService.setScreenCaptureDisabled(admin, UserHandle.myUserId(), disabled);
1894 } catch (RemoteException e) {
1895 Log.w(TAG, "Failed talking with device policy service", e);
1896 }
1897 }
1898 }
1899
1900 /**
1901 * Determine whether or not screen capture has been disabled by the current
1902 * admin, if specified, or all admins.
1903 * @param admin The name of the admin component to check, or null to check if any admins
1904 * have disabled screen capture.
1905 */
1906 public boolean getScreenCaptureDisabled(ComponentName admin) {
1907 return getScreenCaptureDisabled(admin, UserHandle.myUserId());
1908 }
1909
1910 /** @hide per-user version */
1911 public boolean getScreenCaptureDisabled(ComponentName admin, int userHandle) {
1912 if (mService != null) {
1913 try {
1914 return mService.getScreenCaptureDisabled(admin, userHandle);
1915 } catch (RemoteException e) {
1916 Log.w(TAG, "Failed talking with device policy service", e);
1917 }
1918 }
1919 return false;
1920 }
1921
1922 /**
Sander Alewijnse0ced6272014-08-26 11:18:26 +01001923 * Called by a device owner to set whether auto time is required. If auto time is
1924 * required the user cannot set the date and time, but has to use network date and time.
1925 *
1926 * <p>Note: if auto time is required the user can still manually set the time zone.
1927 *
1928 * <p>The calling device admin must be a device owner. If it is not, a security exception will
1929 * be thrown.
1930 *
1931 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1932 * @param required Whether auto time is set required or not.
1933 */
1934 public void setAutoTimeRequired(ComponentName admin, boolean required) {
1935 if (mService != null) {
1936 try {
1937 mService.setAutoTimeRequired(admin, UserHandle.myUserId(), required);
1938 } catch (RemoteException e) {
1939 Log.w(TAG, "Failed talking with device policy service", e);
1940 }
1941 }
1942 }
1943
1944 /**
1945 * @return true if auto time is required.
1946 */
1947 public boolean getAutoTimeRequired() {
1948 if (mService != null) {
1949 try {
1950 return mService.getAutoTimeRequired();
1951 } catch (RemoteException e) {
1952 Log.w(TAG, "Failed talking with device policy service", e);
1953 }
1954 }
1955 return false;
1956 }
1957
1958 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07001959 * Called by an application that is administering the device to disable keyguard customizations,
1960 * such as widgets. After setting this, keyguard features will be disabled according to the
1961 * provided feature list.
Jim Millerb8ec4702012-08-31 17:19:10 -07001962 *
1963 * <p>The calling device admin must have requested
Jim Miller48b9b0d2012-09-19 23:16:50 -07001964 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call
Jim Millerb8ec4702012-08-31 17:19:10 -07001965 * this method; if it has not, a security exception will be thrown.
1966 *
1967 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07001968 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
1969 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
Jim Miller50e62182014-04-23 17:25:00 -07001970 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
1971 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
Jim Millerb8ec4702012-08-31 17:19:10 -07001972 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001973 public void setKeyguardDisabledFeatures(ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07001974 if (mService != null) {
1975 try {
Jim Miller48b9b0d2012-09-19 23:16:50 -07001976 mService.setKeyguardDisabledFeatures(admin, which, UserHandle.myUserId());
Jim Millerb8ec4702012-08-31 17:19:10 -07001977 } catch (RemoteException e) {
1978 Log.w(TAG, "Failed talking with device policy service", e);
1979 }
1980 }
1981 }
1982
1983 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07001984 * Determine whether or not features have been disabled in keyguard either by the current
Jim Millerb8ec4702012-08-31 17:19:10 -07001985 * admin, if specified, or all admins.
1986 * @param admin The name of the admin component to check, or null to check if any admins
Jim Miller48b9b0d2012-09-19 23:16:50 -07001987 * have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07001988 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
1989 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07001990 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001991 public int getKeyguardDisabledFeatures(ComponentName admin) {
1992 return getKeyguardDisabledFeatures(admin, UserHandle.myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001993 }
1994
1995 /** @hide per-user version */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001996 public int getKeyguardDisabledFeatures(ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07001997 if (mService != null) {
1998 try {
Jim Miller48b9b0d2012-09-19 23:16:50 -07001999 return mService.getKeyguardDisabledFeatures(admin, userHandle);
Jim Millerb8ec4702012-08-31 17:19:10 -07002000 } catch (RemoteException e) {
2001 Log.w(TAG, "Failed talking with device policy service", e);
2002 }
2003 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07002004 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07002005 }
2006
2007 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08002008 * @hide
2009 */
Jessica Hummel6d36b602014-04-04 12:42:17 +01002010 public void setActiveAdmin(ComponentName policyReceiver, boolean refreshing, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002011 if (mService != null) {
2012 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01002013 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002014 } catch (RemoteException e) {
2015 Log.w(TAG, "Failed talking with device policy service", e);
2016 }
2017 }
2018 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002019
Dianne Hackbornd6847842010-01-12 18:14:19 -08002020 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01002021 * @hide
2022 */
2023 public void setActiveAdmin(ComponentName policyReceiver, boolean refreshing) {
2024 setActiveAdmin(policyReceiver, refreshing, UserHandle.myUserId());
2025 }
2026
2027 /**
Andy Stadlerc25f70a2010-12-08 15:56:45 -08002028 * Returns the DeviceAdminInfo as defined by the administrator's package info & meta-data
Dianne Hackbornd6847842010-01-12 18:14:19 -08002029 * @hide
2030 */
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08002031 public DeviceAdminInfo getAdminInfo(ComponentName cn) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002032 ActivityInfo ai;
2033 try {
2034 ai = mContext.getPackageManager().getReceiverInfo(cn,
2035 PackageManager.GET_META_DATA);
2036 } catch (PackageManager.NameNotFoundException e) {
2037 Log.w(TAG, "Unable to retrieve device policy " + cn, e);
2038 return null;
2039 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002040
Dianne Hackbornd6847842010-01-12 18:14:19 -08002041 ResolveInfo ri = new ResolveInfo();
2042 ri.activityInfo = ai;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002043
Dianne Hackbornd6847842010-01-12 18:14:19 -08002044 try {
2045 return new DeviceAdminInfo(mContext, ri);
2046 } catch (XmlPullParserException e) {
2047 Log.w(TAG, "Unable to parse device policy " + cn, e);
2048 return null;
2049 } catch (IOException e) {
2050 Log.w(TAG, "Unable to parse device policy " + cn, e);
2051 return null;
2052 }
2053 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002054
Dianne Hackbornd6847842010-01-12 18:14:19 -08002055 /**
2056 * @hide
2057 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002058 public void getRemoveWarning(ComponentName admin, RemoteCallback result) {
2059 if (mService != null) {
2060 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002061 mService.getRemoveWarning(admin, result, UserHandle.myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002062 } catch (RemoteException e) {
2063 Log.w(TAG, "Failed talking with device policy service", e);
2064 }
2065 }
2066 }
2067
2068 /**
2069 * @hide
2070 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002071 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002072 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002073 if (mService != null) {
2074 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002075 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002076 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002077 } catch (RemoteException e) {
2078 Log.w(TAG, "Failed talking with device policy service", e);
2079 }
2080 }
2081 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002082
Dianne Hackbornd6847842010-01-12 18:14:19 -08002083 /**
2084 * @hide
2085 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002086 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002087 if (mService != null) {
2088 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002089 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002090 } catch (RemoteException e) {
2091 Log.w(TAG, "Failed talking with device policy service", e);
2092 }
2093 }
2094 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002095
Dianne Hackbornd6847842010-01-12 18:14:19 -08002096 /**
2097 * @hide
2098 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002099 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002100 if (mService != null) {
2101 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002102 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002103 } catch (RemoteException e) {
2104 Log.w(TAG, "Failed talking with device policy service", e);
2105 }
2106 }
2107 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07002108
2109 /**
2110 * @hide
2111 * Sets the given package as the device owner. The package must already be installed and there
2112 * shouldn't be an existing device owner registered, for this call to succeed. Also, this
2113 * method must be called before the device is provisioned.
2114 * @param packageName the package name of the application to be registered as the device owner.
2115 * @return whether the package was successfully registered as the device owner.
2116 * @throws IllegalArgumentException if the package name is null or invalid
2117 * @throws IllegalStateException if a device owner is already registered or the device has
2118 * already been provisioned.
2119 */
2120 public boolean setDeviceOwner(String packageName) throws IllegalArgumentException,
2121 IllegalStateException {
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04002122 return setDeviceOwner(packageName, null);
2123 }
2124
2125 /**
2126 * @hide
2127 * Sets the given package as the device owner. The package must already be installed and there
2128 * shouldn't be an existing device owner registered, for this call to succeed. Also, this
2129 * method must be called before the device is provisioned.
2130 * @param packageName the package name of the application to be registered as the device owner.
2131 * @param ownerName the human readable name of the institution that owns this device.
2132 * @return whether the package was successfully registered as the device owner.
2133 * @throws IllegalArgumentException if the package name is null or invalid
2134 * @throws IllegalStateException if a device owner is already registered or the device has
2135 * already been provisioned.
2136 */
2137 public boolean setDeviceOwner(String packageName, String ownerName)
2138 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07002139 if (mService != null) {
2140 try {
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04002141 return mService.setDeviceOwner(packageName, ownerName);
Amith Yamasani71e6c692013-03-24 17:39:28 -07002142 } catch (RemoteException re) {
2143 Log.w(TAG, "Failed to set device owner");
2144 }
2145 }
2146 return false;
2147 }
2148
2149 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002150 * Used to determine if a particular package has been registered as a Device Owner app.
2151 * A device owner app is a special device admin that cannot be deactivated by the user, once
2152 * activated as a device admin. It also cannot be uninstalled. To check if a particular
2153 * package is currently registered as the device owner app, pass in the package name from
2154 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
2155 * admin apps that want to check if they are also registered as the device owner app. The
2156 * exact mechanism by which a device admin app is registered as a device owner app is defined by
2157 * the setup process.
2158 * @param packageName the package name of the app, to compare with the registered device owner
2159 * app, if any.
2160 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07002161 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002162 public boolean isDeviceOwnerApp(String packageName) {
Amith Yamasani71e6c692013-03-24 17:39:28 -07002163 if (mService != null) {
2164 try {
2165 return mService.isDeviceOwner(packageName);
2166 } catch (RemoteException re) {
2167 Log.w(TAG, "Failed to check device owner");
2168 }
2169 }
2170 return false;
2171 }
2172
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002173 /**
2174 * @hide
2175 * Redirect to isDeviceOwnerApp.
2176 */
2177 public boolean isDeviceOwner(String packageName) {
2178 return isDeviceOwnerApp(packageName);
2179 }
2180
Jason Monkb0dced82014-06-06 14:36:20 -04002181 /**
2182 * Clears the current device owner. The caller must be the device owner.
2183 *
2184 * This function should be used cautiously as once it is called it cannot
2185 * be undone. The device owner can only be set as a part of device setup
2186 * before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04002187 *
2188 * @param packageName The package name of the device owner.
Jason Monkb0dced82014-06-06 14:36:20 -04002189 */
Jason Monk94d2cf92014-06-18 09:53:34 -04002190 public void clearDeviceOwnerApp(String packageName) {
Jason Monkb0dced82014-06-06 14:36:20 -04002191 if (mService != null) {
2192 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04002193 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04002194 } catch (RemoteException re) {
2195 Log.w(TAG, "Failed to clear device owner");
2196 }
2197 }
2198 }
2199
Amith Yamasani71e6c692013-03-24 17:39:28 -07002200 /** @hide */
Nicolas Prevot465acf32014-08-06 17:03:25 +01002201 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07002202 public String getDeviceOwner() {
2203 if (mService != null) {
2204 try {
2205 return mService.getDeviceOwner();
2206 } catch (RemoteException re) {
2207 Log.w(TAG, "Failed to get device owner");
2208 }
2209 }
2210 return null;
2211 }
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04002212
2213 /** @hide */
2214 public String getDeviceOwnerName() {
2215 if (mService != null) {
2216 try {
2217 return mService.getDeviceOwnerName();
2218 } catch (RemoteException re) {
2219 Log.w(TAG, "Failed to get device owner");
2220 }
2221 }
2222 return null;
2223 }
Adam Connors776c5552014-01-09 10:42:56 +00002224
2225 /**
2226 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07002227 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05302228 * Sets the given component as an active admin and registers the package as the profile
2229 * owner for this user. The package must already be installed and there shouldn't be
2230 * an existing profile owner registered for this user. Also, this method must be called
2231 * before the user setup has been completed.
2232 * <p>
2233 * This method can only be called by system apps that hold MANAGE_USERS permission and
2234 * MANAGE_DEVICE_ADMINS permission.
2235 * @param admin The component to register as an active admin and profile owner.
2236 * @param ownerName The user-visible name of the entity that is managing this user.
2237 * @return whether the admin was successfully registered as the profile owner.
2238 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
2239 * the user has already been set up.
2240 */
Justin Morey80440cc2014-07-24 09:16:35 -05002241 @SystemApi
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05302242 public boolean setActiveProfileOwner(ComponentName admin, String ownerName)
2243 throws IllegalArgumentException {
2244 if (mService != null) {
2245 try {
2246 final int myUserId = UserHandle.myUserId();
2247 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07002248 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05302249 } catch (RemoteException re) {
2250 Log.w(TAG, "Failed to set profile owner " + re);
2251 throw new IllegalArgumentException("Couldn't set profile owner.", re);
2252 }
2253 }
2254 return false;
2255 }
2256
2257 /**
2258 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07002259 * Clears the active profile owner and removes all user restrictions. The caller must
2260 * be from the same package as the active profile owner for this user, otherwise a
2261 * SecurityException will be thrown.
2262 *
2263 * @param admin The component to remove as the profile owner.
2264 * @return
2265 */
2266 @SystemApi
2267 public void clearProfileOwner(ComponentName admin) {
2268 if (mService != null) {
2269 try {
2270 mService.clearProfileOwner(admin);
2271 } catch (RemoteException re) {
2272 Log.w(TAG, "Failed to clear profile owner " + admin + re);
2273 }
2274 }
2275 }
2276
2277 /**
2278 * @hide
2279 * Checks if the user was already setup.
2280 */
2281 public boolean hasUserSetupCompleted() {
2282 if (mService != null) {
2283 try {
2284 return mService.hasUserSetupCompleted();
2285 } catch (RemoteException re) {
2286 Log.w(TAG, "Failed to check if user setup has completed");
2287 }
2288 }
2289 return true;
2290 }
2291
2292 /**
2293 * @deprecated Use setProfileOwner(ComponentName ...)
2294 * @hide
Adam Connors776c5552014-01-09 10:42:56 +00002295 * Sets the given package as the profile owner of the given user profile. The package must
2296 * already be installed and there shouldn't be an existing profile owner registered for this
2297 * user. Also, this method must be called before the user has been used for the first time.
2298 * @param packageName the package name of the application to be registered as profile owner.
2299 * @param ownerName the human readable name of the organisation associated with this DPM.
Adam Connors661ec472014-02-11 13:59:46 +00002300 * @param userHandle the userId to set the profile owner for.
Adam Connors776c5552014-01-09 10:42:56 +00002301 * @return whether the package was successfully registered as the profile owner.
2302 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
2303 * the user has already been set up.
2304 */
Adam Connors661ec472014-02-11 13:59:46 +00002305 public boolean setProfileOwner(String packageName, String ownerName, int userHandle)
Adam Connors776c5552014-01-09 10:42:56 +00002306 throws IllegalArgumentException {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07002307 if (packageName == null) {
2308 throw new NullPointerException("packageName cannot be null");
2309 }
2310 return setProfileOwner(new ComponentName(packageName, ""), ownerName, userHandle);
2311 }
2312
2313 /**
2314 * @hide
2315 * Sets the given component as the profile owner of the given user profile. The package must
2316 * already be installed and there shouldn't be an existing profile owner registered for this
2317 * user. Only the system can call this API if the user has already completed setup.
2318 * @param admin the component name to be registered as profile owner.
2319 * @param ownerName the human readable name of the organisation associated with this DPM.
2320 * @param userHandle the userId to set the profile owner for.
2321 * @return whether the component was successfully registered as the profile owner.
2322 * @throws IllegalArgumentException if admin is null, the package isn't installed, or
2323 * the user has already been set up.
2324 */
2325 public boolean setProfileOwner(ComponentName admin, String ownerName, int userHandle)
2326 throws IllegalArgumentException {
2327 if (admin == null) {
2328 throw new NullPointerException("admin cannot be null");
2329 }
Adam Connors776c5552014-01-09 10:42:56 +00002330 if (mService != null) {
2331 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07002332 if (ownerName == null) {
2333 ownerName = "";
2334 }
2335 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00002336 } catch (RemoteException re) {
2337 Log.w(TAG, "Failed to set profile owner", re);
2338 throw new IllegalArgumentException("Couldn't set profile owner.", re);
2339 }
2340 }
2341 return false;
2342 }
2343
2344 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01002345 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
2346 * be used. Only the profile owner can call this.
2347 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01002348 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01002349 *
2350 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2351 */
2352 public void setProfileEnabled(ComponentName admin) {
2353 if (mService != null) {
2354 try {
2355 mService.setProfileEnabled(admin);
2356 } catch (RemoteException e) {
2357 Log.w(TAG, "Failed talking with device policy service", e);
2358 }
2359 }
2360 }
2361
2362 /**
Jessica Hummel1333ea12014-06-23 11:20:10 +01002363 * Sets the name of the Managed profile. In the device owner case it sets the name of the user
2364 * which it is called from. Only the profile owner or device owner can call this. If this is
2365 * never called by the profile or device owner, the name will be set to default values.
2366 *
2367 * @see #isProfileOwnerApp
2368 * @see #isDeviceOwnerApp
2369 *
2370 * @param profileName The name of the profile.
2371 */
2372 public void setProfileName(ComponentName who, String profileName) {
2373 if (mService != null) {
2374 try {
2375 mService.setProfileName(who, profileName);
2376 } catch (RemoteException e) {
2377 Log.w(TAG, "Failed talking with device policy service", e);
2378 }
2379 }
2380}
2381
2382 /**
Adam Connors776c5552014-01-09 10:42:56 +00002383 * Used to determine if a particular package is registered as the Profile Owner for the
Alexandra Gherghina512675b2014-04-02 11:23:54 +01002384 * current user. A profile owner is a special device admin that has additional privileges
Adam Connors776c5552014-01-09 10:42:56 +00002385 * within the managed profile.
2386 *
2387 * @param packageName The package name of the app to compare with the registered profile owner.
2388 * @return Whether or not the package is registered as the profile owner.
2389 */
2390 public boolean isProfileOwnerApp(String packageName) {
2391 if (mService != null) {
2392 try {
Nicolas Prevot90af6d72014-07-30 14:19:12 +01002393 ComponentName profileOwner = mService.getProfileOwner(
2394 Process.myUserHandle().getIdentifier());
2395 return profileOwner != null
2396 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00002397 } catch (RemoteException re) {
2398 Log.w(TAG, "Failed to check profile owner");
2399 }
2400 }
2401 return false;
2402 }
2403
2404 /**
2405 * @hide
2406 * @return the packageName of the owner of the given user profile or null if no profile
2407 * owner has been set for that user.
2408 * @throws IllegalArgumentException if the userId is invalid.
2409 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01002410 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07002411 public ComponentName getProfileOwner() throws IllegalArgumentException {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01002412 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
2413 }
2414
2415 /**
2416 * @see #getProfileOwner()
2417 * @hide
2418 */
2419 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00002420 if (mService != null) {
2421 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01002422 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00002423 } catch (RemoteException re) {
2424 Log.w(TAG, "Failed to get profile owner");
2425 throw new IllegalArgumentException(
2426 "Requested profile owner for invalid userId", re);
2427 }
2428 }
2429 return null;
2430 }
2431
2432 /**
2433 * @hide
2434 * @return the human readable name of the organisation associated with this DPM or null if
2435 * one is not set.
2436 * @throws IllegalArgumentException if the userId is invalid.
2437 */
2438 public String getProfileOwnerName() throws IllegalArgumentException {
2439 if (mService != null) {
2440 try {
2441 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
2442 } catch (RemoteException re) {
2443 Log.w(TAG, "Failed to get profile owner");
2444 throw new IllegalArgumentException(
2445 "Requested profile owner for invalid userId", re);
2446 }
2447 }
2448 return null;
2449 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00002450
2451 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07002452 * @hide
2453 * @param user The user for whom to fetch the profile owner name, if any.
2454 * @return the human readable name of the organisation associated with this profile owner or
2455 * null if one is not set.
2456 * @throws IllegalArgumentException if the userId is invalid.
2457 */
2458 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02002459 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Amith Yamasani38f836b2014-08-20 14:51:15 -07002460 if (mService != null) {
2461 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02002462 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07002463 } catch (RemoteException re) {
2464 Log.w(TAG, "Failed to get profile owner");
2465 throw new IllegalArgumentException(
2466 "Requested profile owner for invalid userId", re);
2467 }
2468 }
2469 return null;
2470 }
2471
2472 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00002473 * Called by a profile owner or device owner to add a default intent handler activity for
2474 * intents that match a certain intent filter. This activity will remain the default intent
2475 * handler even if the set of potential event handlers for the intent filter changes and if
2476 * the intent preferences are reset.
2477 *
2478 * <p>The default disambiguation mechanism takes over if the activity is not installed
2479 * (anymore). When the activity is (re)installed, it is automatically reset as default
2480 * intent handler for the filter.
2481 *
2482 * <p>The calling device admin must be a profile owner or device owner. If it is not, a
2483 * security exception will be thrown.
2484 *
2485 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2486 * @param filter The IntentFilter for which a default handler is added.
2487 * @param activity The Activity that is added as default intent handler.
2488 */
2489 public void addPersistentPreferredActivity(ComponentName admin, IntentFilter filter,
2490 ComponentName activity) {
2491 if (mService != null) {
2492 try {
2493 mService.addPersistentPreferredActivity(admin, filter, activity);
2494 } catch (RemoteException e) {
2495 Log.w(TAG, "Failed talking with device policy service", e);
2496 }
2497 }
2498 }
2499
2500 /**
2501 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00002502 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00002503 *
2504 * <p>The calling device admin must be a profile owner. If it is not, a security
2505 * exception will be thrown.
2506 *
2507 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2508 * @param packageName The name of the package for which preferences are removed.
2509 */
2510 public void clearPackagePersistentPreferredActivities(ComponentName admin,
2511 String packageName) {
2512 if (mService != null) {
2513 try {
2514 mService.clearPackagePersistentPreferredActivities(admin, packageName);
2515 } catch (RemoteException e) {
2516 Log.w(TAG, "Failed talking with device policy service", e);
2517 }
2518 }
2519 }
Robin Lee66e5d962014-04-09 16:44:21 +01002520
2521 /**
2522 * Called by a profile or device owner to set the application restrictions for a given target
2523 * application running in the managed profile.
2524 *
2525 * <p>The provided {@link Bundle} consists of key-value pairs, where the types of values may be
Amith Yamasanic8c84252014-07-13 17:12:12 -07002526 * boolean, int, String, or String[]. The recommended format for keys
Robin Lee66e5d962014-04-09 16:44:21 +01002527 * is "com.example.packagename/example-setting" to avoid naming conflicts with library
2528 * components such as {@link android.webkit.WebView}.
2529 *
2530 * <p>The application restrictions are only made visible to the target application and the
2531 * profile or device owner.
2532 *
2533 * <p>The calling device admin must be a profile or device owner; if it is not, a security
2534 * exception will be thrown.
2535 *
2536 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2537 * @param packageName The name of the package to update restricted settings for.
2538 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
2539 * set of active restrictions.
2540 */
2541 public void setApplicationRestrictions(ComponentName admin, String packageName,
2542 Bundle settings) {
2543 if (mService != null) {
2544 try {
2545 mService.setApplicationRestrictions(admin, packageName, settings);
2546 } catch (RemoteException e) {
2547 Log.w(TAG, "Failed talking with device policy service", e);
2548 }
2549 }
2550 }
2551
2552 /**
Adrian Roos489d2df2014-07-29 21:01:39 +02002553 * Sets a list of features to enable for a TrustAgent component. This is meant to be
Jim Miller604e7552014-07-18 19:00:02 -07002554 * used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which will disable all
2555 * trust agents but those with features enabled by this function call.
2556 *
2557 * <p>The calling device admin must have requested
2558 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call
2559 * this method; if it has not, a security exception will be thrown.
2560 *
2561 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2562 * @param agent Which component to enable features for.
2563 * @param features List of features to enable. Consult specific TrustAgent documentation for
2564 * the feature list.
Jim Millerb1474f42014-08-26 18:42:58 -07002565 * @hide
Jim Miller604e7552014-07-18 19:00:02 -07002566 */
2567 public void setTrustAgentFeaturesEnabled(ComponentName admin, ComponentName agent,
2568 List<String> features) {
2569 if (mService != null) {
2570 try {
2571 mService.setTrustAgentFeaturesEnabled(admin, agent, features, UserHandle.myUserId());
2572 } catch (RemoteException e) {
2573 Log.w(TAG, "Failed talking with device policy service", e);
2574 }
2575 }
2576 }
2577
2578 /**
Adrian Roos489d2df2014-07-29 21:01:39 +02002579 * Gets list of enabled features for the given TrustAgent component. If admin is
Jim Miller604e7552014-07-18 19:00:02 -07002580 * null, this will return the intersection of all features enabled for the given agent by all
2581 * admins.
2582 *
2583 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2584 * @param agent Which component to get enabled features for.
2585 * @return List of enabled features.
Jim Millerb1474f42014-08-26 18:42:58 -07002586 * @hide
Jim Miller604e7552014-07-18 19:00:02 -07002587 */
2588 public List<String> getTrustAgentFeaturesEnabled(ComponentName admin, ComponentName agent) {
2589 if (mService != null) {
2590 try {
2591 return mService.getTrustAgentFeaturesEnabled(admin, agent, UserHandle.myUserId());
2592 } catch (RemoteException e) {
2593 Log.w(TAG, "Failed talking with device policy service", e);
2594 }
2595 }
2596 return new ArrayList<String>(); // empty list
2597 }
2598
2599 /**
Adam Connors210fe212014-07-17 15:41:43 +01002600 * Called by a profile owner to set whether caller-Id information from the managed
2601 * profile will be shown for incoming calls.
2602 *
2603 * <p>The calling device admin must be a profile owner. If it is not, a
2604 * security exception will be thrown.
2605 *
2606 * @param who Which {@link DeviceAdminReceiver} this request is associated with.
2607 * @param disabled If true caller-Id information in the managed profile is not displayed.
2608 */
2609 public void setCrossProfileCallerIdDisabled(ComponentName who, boolean disabled) {
2610 if (mService != null) {
2611 try {
2612 mService.setCrossProfileCallerIdDisabled(who, disabled);
2613 } catch (RemoteException e) {
2614 Log.w(TAG, "Failed talking with device policy service", e);
2615 }
2616 }
2617 }
2618
2619 /**
2620 * Determine whether or not caller-Id information has been disabled.
2621 *
2622 * <p>The calling device admin must be a profile owner. If it is not, a
2623 * security exception will be thrown.
2624 *
2625 * @param who Which {@link DeviceAdminReceiver} this request is associated with.
2626 */
2627 public boolean getCrossProfileCallerIdDisabled(ComponentName who) {
2628 if (mService != null) {
2629 try {
2630 return mService.getCrossProfileCallerIdDisabled(who);
2631 } catch (RemoteException e) {
2632 Log.w(TAG, "Failed talking with device policy service", e);
2633 }
2634 }
2635 return false;
2636 }
2637
2638 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07002639 * Determine whether or not caller-Id information has been disabled.
2640 *
2641 * @param userHandle The user for whom to check the caller-id permission
2642 * @hide
2643 */
2644 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
2645 if (mService != null) {
2646 try {
2647 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
2648 } catch (RemoteException e) {
2649 Log.w(TAG, "Failed talking with device policy service", e);
2650 }
2651 }
2652 return false;
2653 }
2654
2655 /**
Nicolas Prevot81948992014-05-16 18:25:26 +01002656 * Called by the profile owner so that some intents sent in the managed profile can also be
2657 * resolved in the parent, or vice versa.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002658 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01002659 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
2660 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01002661 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
2662 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002663 */
Nicolas Prevot81948992014-05-16 18:25:26 +01002664 public void addCrossProfileIntentFilter(ComponentName admin, IntentFilter filter, int flags) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002665 if (mService != null) {
2666 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01002667 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002668 } catch (RemoteException e) {
2669 Log.w(TAG, "Failed talking with device policy service", e);
2670 }
2671 }
2672 }
2673
2674 /**
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01002675 * Called by a profile owner to remove the cross-profile intent filters that go from the
2676 * managed profile to the parent, or from the parent to the managed profile.
2677 * Only removes those that have been set by the profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002678 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2679 */
Nicolas Prevot81948992014-05-16 18:25:26 +01002680 public void clearCrossProfileIntentFilters(ComponentName admin) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002681 if (mService != null) {
2682 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01002683 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002684 } catch (RemoteException e) {
2685 Log.w(TAG, "Failed talking with device policy service", e);
2686 }
2687 }
2688 }
2689
2690 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01002691 * Called by a profile or device owner to set the permitted accessibility services. When
2692 * set by a device owner or profile owner the restriction applies to all profiles of the
2693 * user the device owner or profile owner is an admin for.
Jim Millerb1474f42014-08-26 18:42:58 -07002694 *
Kenny Guyfa80a4f2014-08-20 19:40:59 +01002695 * By default the user can use any accessiblity service. When zero or more packages have
2696 * been added, accessiblity services that are not in the list and not part of the system
Jim Millerb1474f42014-08-26 18:42:58 -07002697 * can not be enabled by the user.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01002698 *
2699 * <p> Calling with a null value for the list disables the restriction so that all services
2700 * can be used, calling with an empty list only allows the builtin system's services.
2701 *
2702 * <p> System accesibility services are always available to the user the list can't modify
2703 * this.
2704 *
2705 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2706 * @param packageNames List of accessibility service package names.
2707 *
2708 * @return true if setting the restriction succeeded. It fail if there is
2709 * one or more non-system accessibility services enabled, that are not in the list.
2710 */
2711 public boolean setPermittedAccessibilityServices(ComponentName admin,
2712 List<String> packageNames) {
2713 if (mService != null) {
2714 try {
2715 return mService.setPermittedAccessibilityServices(admin, packageNames);
2716 } catch (RemoteException e) {
2717 Log.w(TAG, "Failed talking with device policy service", e);
2718 }
2719 }
2720 return false;
2721 }
2722
2723 /**
2724 * Returns the list of permitted accessibility services set by this device or profile owner.
2725 *
2726 * <p>An empty list means no accessibility services except system services are allowed.
2727 * Null means all accessibility services are allowed.
2728 *
2729 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2730 * @return List of accessiblity service package names.
2731 */
2732 public List<String> getPermittedAccessibilityServices(ComponentName admin) {
2733 if (mService != null) {
2734 try {
2735 return mService.getPermittedAccessibilityServices(admin);
2736 } catch (RemoteException e) {
2737 Log.w(TAG, "Failed talking with device policy service", e);
2738 }
2739 }
2740 return null;
2741 }
2742
2743 /**
2744 * Returns the list of accessibility services permitted by the device or profiles
2745 * owners of this user.
2746 *
2747 * <p>Null means all accessibility services are allowed, if a non-null list is returned
2748 * it will contain the intersection of the permitted lists for any device or profile
2749 * owners that apply to this user. It will also include any system accessibility services.
2750 *
2751 * @param userId which user to check for.
2752 * @return List of accessiblity service package names.
2753 * @hide
2754 */
2755 @SystemApi
2756 public List<String> getPermittedAccessibilityServices(int userId) {
2757 if (mService != null) {
2758 try {
2759 return mService.getPermittedAccessibilityServicesForUser(userId);
2760 } catch (RemoteException e) {
2761 Log.w(TAG, "Failed talking with device policy service", e);
2762 }
2763 }
2764 return null;
2765 }
2766
2767 /**
2768 * Called by a profile or device owner to set the permitted input methods services. When
2769 * set by a device owner or profile owner the restriction applies to all profiles of the
2770 * user the device owner or profile owner is an admin for.
2771 *
2772 * By default the user can use any input method. When zero or more packages have
2773 * been added, input method that are not in the list and not part of the system
2774 * can not be enabled by the user.
2775 *
2776 * This method will fail if it is called for a admin that is not for the foreground user
2777 * or a profile of the foreground user.
2778 *
2779 * <p> Calling with a null value for the list disables the restriction so that all input methods
2780 * can be used, calling with an empty list disables all but the system's own input methods.
2781 *
2782 * <p> System input methods are always available to the user this method can't modify this.
2783 *
2784 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2785 * @param packageNames List of input method package names.
2786 * @return true if setting the restriction succeeded. It will fail if there is
2787 * one or more input method enabled, that are not in the list or user if the foreground
2788 * user.
2789 */
2790 public boolean setPermittedInputMethods(ComponentName admin, List<String> packageNames) {
2791 if (mService != null) {
2792 try {
2793 return mService.setPermittedInputMethods(admin, packageNames);
2794 } catch (RemoteException e) {
2795 Log.w(TAG, "Failed talking with device policy service", e);
2796 }
2797 }
2798 return false;
2799 }
2800
2801
2802 /**
2803 * Returns the list of permitted input methods set by this device or profile owner.
2804 *
2805 * <p>An empty list means no input methods except system input methods are allowed.
2806 * Null means all input methods are allowed.
2807 *
2808 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2809 * @return List of input method package names.
2810 */
2811 public List<String> getPermittedInputMethods(ComponentName admin) {
2812 if (mService != null) {
2813 try {
2814 return mService.getPermittedInputMethods(admin);
2815 } catch (RemoteException e) {
2816 Log.w(TAG, "Failed talking with device policy service", e);
2817 }
2818 }
2819 return null;
2820 }
2821
2822 /**
2823 * Returns the list of input methods permitted by the device or profiles
2824 * owners of the current user.
2825 *
2826 * <p>Null means all input methods are allowed, if a non-null list is returned
2827 * it will contain the intersection of the permitted lists for any device or profile
2828 * owners that apply to this user. It will also include any system input methods.
2829 *
2830 * @return List of input method package names.
2831 * @hide
2832 */
2833 @SystemApi
2834 public List<String> getPermittedInputMethodsForCurrentUser() {
2835 if (mService != null) {
2836 try {
2837 return mService.getPermittedInputMethodsForCurrentUser();
2838 } catch (RemoteException e) {
2839 Log.w(TAG, "Failed talking with device policy service", e);
2840 }
2841 }
2842 return null;
2843 }
2844
2845 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04002846 * Called by a device owner to create a user with the specified name. The UserHandle returned
2847 * by this method should not be persisted as user handles are recycled as users are removed and
2848 * created. If you need to persist an identifier for this user, use
2849 * {@link UserManager#getSerialNumberForUser}.
2850 *
2851 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2852 * @param name the user's name
2853 * @see UserHandle
2854 * @return the UserHandle object for the created user, or null if the user could not be created.
2855 */
2856 public UserHandle createUser(ComponentName admin, String name) {
2857 try {
2858 return mService.createUser(admin, name);
2859 } catch (RemoteException re) {
2860 Log.w(TAG, "Could not create a user", re);
2861 }
2862 return null;
2863 }
2864
2865 /**
Jason Monk03978a42014-06-10 15:05:30 -04002866 * Called by a device owner to create a user with the specified name. The UserHandle returned
2867 * by this method should not be persisted as user handles are recycled as users are removed and
2868 * created. If you need to persist an identifier for this user, use
2869 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
2870 * immediately.
2871 *
2872 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
2873 * as registered as an active admin on the new user. The profile owner package will be
2874 * installed on the new user if it already is installed on the device.
2875 *
2876 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
2877 * profileOwnerComponent when onEnable is called.
2878 *
2879 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2880 * @param name the user's name
2881 * @param ownerName the human readable name of the organisation associated with this DPM.
2882 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
2883 * the user.
2884 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
2885 * on the new user.
2886 * @see UserHandle
2887 * @return the UserHandle object for the created user, or null if the user could not be created.
2888 */
2889 public UserHandle createAndInitializeUser(ComponentName admin, String name, String ownerName,
2890 ComponentName profileOwnerComponent, Bundle adminExtras) {
2891 try {
2892 return mService.createAndInitializeUser(admin, name, ownerName, profileOwnerComponent,
2893 adminExtras);
2894 } catch (RemoteException re) {
2895 Log.w(TAG, "Could not create a user", re);
2896 }
2897 return null;
2898 }
2899
2900 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04002901 * Called by a device owner to remove a user and all associated data. The primary user can
2902 * not be removed.
2903 *
2904 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2905 * @param userHandle the user to remove.
2906 * @return {@code true} if the user was removed, {@code false} otherwise.
2907 */
2908 public boolean removeUser(ComponentName admin, UserHandle userHandle) {
2909 try {
2910 return mService.removeUser(admin, userHandle);
2911 } catch (RemoteException re) {
2912 Log.w(TAG, "Could not remove user ", re);
2913 return false;
2914 }
2915 }
2916
2917 /**
Jason Monk582d9112014-07-09 19:57:08 -04002918 * Called by a device owner to switch the specified user to the foreground.
2919 *
2920 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2921 * @param userHandle the user to switch to; null will switch to primary.
2922 * @return {@code true} if the switch was successful, {@code false} otherwise.
2923 *
2924 * @see Intent#ACTION_USER_FOREGROUND
2925 */
2926 public boolean switchUser(ComponentName admin, UserHandle userHandle) {
2927 try {
2928 return mService.switchUser(admin, userHandle);
2929 } catch (RemoteException re) {
2930 Log.w(TAG, "Could not switch user ", re);
2931 return false;
2932 }
2933 }
2934
2935 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002936 * Called by a profile or device owner to get the application restrictions for a given target
2937 * application running in the managed profile.
2938 *
2939 * <p>The calling device admin must be a profile or device owner; if it is not, a security
2940 * exception will be thrown.
2941 *
2942 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2943 * @param packageName The name of the package to fetch restricted settings of.
2944 * @return {@link Bundle} of settings corresponding to what was set last time
2945 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty {@link Bundle}
2946 * if no restrictions have been set.
2947 */
2948 public Bundle getApplicationRestrictions(ComponentName admin, String packageName) {
2949 if (mService != null) {
2950 try {
2951 return mService.getApplicationRestrictions(admin, packageName);
2952 } catch (RemoteException e) {
2953 Log.w(TAG, "Failed talking with device policy service", e);
2954 }
2955 }
2956 return null;
2957 }
Amith Yamasanibe465322014-04-24 13:45:17 -07002958
2959 /**
2960 * Called by a profile or device owner to set a user restriction specified
2961 * by the key.
2962 * <p>
2963 * The calling device admin must be a profile or device owner; if it is not,
2964 * a security exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07002965 *
Amith Yamasanibe465322014-04-24 13:45:17 -07002966 * @param admin Which {@link DeviceAdminReceiver} this request is associated
2967 * with.
2968 * @param key The key of the restriction. See the constants in
2969 * {@link android.os.UserManager} for the list of keys.
2970 */
2971 public void addUserRestriction(ComponentName admin, String key) {
2972 if (mService != null) {
2973 try {
2974 mService.setUserRestriction(admin, key, true);
2975 } catch (RemoteException e) {
2976 Log.w(TAG, "Failed talking with device policy service", e);
2977 }
2978 }
2979 }
2980
2981 /**
2982 * Called by a profile or device owner to clear a user restriction specified
2983 * by the key.
2984 * <p>
2985 * The calling device admin must be a profile or device owner; if it is not,
2986 * a security exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07002987 *
Amith Yamasanibe465322014-04-24 13:45:17 -07002988 * @param admin Which {@link DeviceAdminReceiver} this request is associated
2989 * with.
2990 * @param key The key of the restriction. See the constants in
2991 * {@link android.os.UserManager} for the list of keys.
2992 */
2993 public void clearUserRestriction(ComponentName admin, String key) {
2994 if (mService != null) {
2995 try {
2996 mService.setUserRestriction(admin, key, false);
2997 } catch (RemoteException e) {
2998 Log.w(TAG, "Failed talking with device policy service", e);
2999 }
3000 }
3001 }
Adam Connors010cfd42014-04-16 12:48:13 +01003002
3003 /**
Amith Yamasanie5bcff62014-07-19 15:44:09 -07003004 * Called by device or profile owner to hide or unhide packages. When a package is hidden it
Julia Reynolds966881e2014-05-14 12:23:08 -04003005 * is unavailable for use, but the data and actual package file remain.
3006 *
3007 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07003008 * @param packageName The name of the package to hide or unhide.
3009 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
3010 * unhidden.
3011 * @return boolean Whether the hidden setting of the package was successfully updated.
Julia Reynolds966881e2014-05-14 12:23:08 -04003012 */
Amith Yamasanie5bcff62014-07-19 15:44:09 -07003013 public boolean setApplicationHidden(ComponentName admin, String packageName,
3014 boolean hidden) {
Julia Reynolds966881e2014-05-14 12:23:08 -04003015 if (mService != null) {
3016 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07003017 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04003018 } catch (RemoteException e) {
3019 Log.w(TAG, "Failed talking with device policy service", e);
3020 }
3021 }
3022 return false;
3023 }
3024
3025 /**
Amith Yamasanie5bcff62014-07-19 15:44:09 -07003026 * Called by device or profile owner to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04003027 *
3028 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07003029 * @param packageName The name of the package to retrieve the hidden status of.
3030 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Julia Reynolds966881e2014-05-14 12:23:08 -04003031 */
Amith Yamasanie5bcff62014-07-19 15:44:09 -07003032 public boolean isApplicationHidden(ComponentName admin, String packageName) {
Julia Reynolds966881e2014-05-14 12:23:08 -04003033 if (mService != null) {
3034 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07003035 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04003036 } catch (RemoteException e) {
3037 Log.w(TAG, "Failed talking with device policy service", e);
3038 }
3039 }
3040 return false;
3041 }
3042
3043 /**
Adam Connors655be2a2014-07-14 09:01:25 +00003044 * Called by profile or device owner to re-enable a system app that was disabled by default
3045 * when the managed profile was created. This can only be called from a profile or device
3046 * owner running within a managed profile.
3047 *
3048 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3049 * @param packageName The package to be re-enabled in the current profile.
3050 */
3051 public void enableSystemApp(ComponentName admin, String packageName) {
3052 if (mService != null) {
3053 try {
3054 mService.enableSystemApp(admin, packageName);
3055 } catch (RemoteException e) {
3056 Log.w(TAG, "Failed to install package: " + packageName);
3057 }
3058 }
3059 }
3060
3061 /**
3062 * Called by profile or device owner to re-enable system apps by intent that were disabled
3063 * by default when the managed profile was created. This can only be called from a profile
3064 * or device owner running within a managed profile.
3065 *
3066 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3067 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
3068 * intent will be re-enabled in the current profile.
3069 * @return int The number of activities that matched the intent and were installed.
3070 */
3071 public int enableSystemApp(ComponentName admin, Intent intent) {
3072 if (mService != null) {
3073 try {
3074 return mService.enableSystemAppWithIntent(admin, intent);
3075 } catch (RemoteException e) {
3076 Log.w(TAG, "Failed to install packages matching filter: " + intent);
3077 }
3078 }
3079 return 0;
3080 }
3081
3082 /**
Sander Alewijnse650c3342014-05-08 18:00:50 +01003083 * Called by a profile owner to disable account management for a specific type of account.
3084 *
3085 * <p>The calling device admin must be a profile owner. If it is not, a
3086 * security exception will be thrown.
3087 *
3088 * <p>When account management is disabled for an account type, adding or removing an account
3089 * of that type will not be possible.
3090 *
3091 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3092 * @param accountType For which account management is disabled or enabled.
3093 * @param disabled The boolean indicating that account management will be disabled (true) or
3094 * enabled (false).
3095 */
3096 public void setAccountManagementDisabled(ComponentName admin, String accountType,
3097 boolean disabled) {
3098 if (mService != null) {
3099 try {
3100 mService.setAccountManagementDisabled(admin, accountType, disabled);
3101 } catch (RemoteException e) {
3102 Log.w(TAG, "Failed talking with device policy service", e);
3103 }
3104 }
3105 }
3106
3107 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01003108 * Gets the array of accounts for which account management is disabled by the profile owner.
3109 *
3110 * <p> Account management can be disabled/enabled by calling
3111 * {@link #setAccountManagementDisabled}.
3112 *
3113 * @return a list of account types for which account management has been disabled.
3114 *
3115 * @see #setAccountManagementDisabled
3116 */
3117 public String[] getAccountTypesWithManagementDisabled() {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01003118 return getAccountTypesWithManagementDisabledAsUser(UserHandle.myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01003119 }
3120
3121 /**
3122 * @see #getAccountTypesWithManagementDisabled()
3123 * @hide
3124 */
3125 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01003126 if (mService != null) {
3127 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01003128 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01003129 } catch (RemoteException e) {
3130 Log.w(TAG, "Failed talking with device policy service", e);
3131 }
3132 }
3133
3134 return null;
3135 }
justinzhang511e0d82014-03-24 16:09:24 -04003136
3137 /**
Jason Monkd7b86212014-06-16 13:15:38 -04003138 * Sets which packages may enter lock task mode.
3139 *
3140 * <p>Any packages that shares uid with an allowed package will also be allowed
3141 * to activate lock task.
justinzhang511e0d82014-03-24 16:09:24 -04003142 *
Jason Monkc5185f22014-06-24 11:12:42 -04003143 * This function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04003144 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04003145 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jason Monkd7b86212014-06-16 13:15:38 -04003146 *
3147 * @see Activity#startLockTask()
Jason Monk1c7c3192014-06-26 12:52:18 -04003148 * @see DeviceAdminReceiver#onLockTaskModeChanged(Context, Intent, boolean, String)
3149 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04003150 */
Jason Monk48aacba2014-08-13 16:29:08 -04003151 public void setLockTaskPackages(ComponentName admin, String[] packages)
3152 throws SecurityException {
justinzhang511e0d82014-03-24 16:09:24 -04003153 if (mService != null) {
3154 try {
Jason Monk48aacba2014-08-13 16:29:08 -04003155 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04003156 } catch (RemoteException e) {
3157 Log.w(TAG, "Failed talking with device policy service", e);
3158 }
3159 }
3160 }
3161
3162 /**
Jason Monkd7b86212014-06-16 13:15:38 -04003163 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04003164 *
3165 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04003166 * @hide
3167 */
Jason Monk48aacba2014-08-13 16:29:08 -04003168 public String[] getLockTaskPackages(ComponentName admin) {
justinzhang511e0d82014-03-24 16:09:24 -04003169 if (mService != null) {
3170 try {
Jason Monk48aacba2014-08-13 16:29:08 -04003171 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04003172 } catch (RemoteException e) {
3173 Log.w(TAG, "Failed talking with device policy service", e);
3174 }
3175 }
3176 return null;
3177 }
3178
3179 /**
3180 * This function lets the caller know whether the given component is allowed to start the
3181 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04003182 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04003183 */
Jason Monkd7b86212014-06-16 13:15:38 -04003184 public boolean isLockTaskPermitted(String pkg) {
justinzhang511e0d82014-03-24 16:09:24 -04003185 if (mService != null) {
3186 try {
Jason Monkd7b86212014-06-16 13:15:38 -04003187 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04003188 } catch (RemoteException e) {
3189 Log.w(TAG, "Failed talking with device policy service", e);
3190 }
3191 }
3192 return false;
3193 }
Julia Reynoldsda551652014-05-14 17:15:16 -04003194
3195 /**
3196 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
3197 * of the setting is in the correct form for the setting type should be performed by the caller.
Julia Reynolds9ed66da2014-08-26 15:42:03 -04003198 * <p>The settings that can be updated with this method are:
3199 * <ul>
3200 * <li>{@link Settings.Global#ADB_ENABLED}</li>
3201 * <li>{@link Settings.Global#AUTO_TIME}</li>
3202 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
3203 * <li>{@link Settings.Global#BLUETOOTH_ON}</li>
3204 * <li>{@link Settings.Global#DATA_ROAMING}</li>
3205 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
3206 * <li>{@link Settings.Global#MODE_RINGER}</li>
3207 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
3208 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
3209 * <li>{@link Settings.Global#WIFI_ON}</li>
3210 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
3211 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04003212 *
3213 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3214 * @param setting The name of the setting to update.
3215 * @param value The value to update the setting to.
3216 */
3217 public void setGlobalSetting(ComponentName admin, String setting, String value) {
3218 if (mService != null) {
3219 try {
3220 mService.setGlobalSetting(admin, setting, value);
3221 } catch (RemoteException e) {
3222 Log.w(TAG, "Failed talking with device policy service", e);
3223 }
3224 }
3225 }
3226
3227 /**
3228 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
3229 * that the value of the setting is in the correct form for the setting type should be performed
3230 * by the caller.
Julia Reynolds9ed66da2014-08-26 15:42:03 -04003231 * <p>The settings that can be updated with this method are:
3232 * <ul>
3233 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
3234 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
3235 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04003236 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3237 * @param setting The name of the setting to update.
3238 * @param value The value to update the setting to.
3239 */
3240 public void setSecureSetting(ComponentName admin, String setting, String value) {
3241 if (mService != null) {
3242 try {
3243 mService.setSecureSetting(admin, setting, value);
3244 } catch (RemoteException e) {
3245 Log.w(TAG, "Failed talking with device policy service", e);
3246 }
3247 }
3248 }
3249
Amith Yamasanif20d6402014-05-24 15:34:37 -07003250 /**
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07003251 * Designates a specific service component as the provider for
Amith Yamasanif20d6402014-05-24 15:34:37 -07003252 * making permission requests of a local or remote administrator of the user.
3253 * <p/>
3254 * Only a profile owner can designate the restrictions provider.
3255 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07003256 * @param provider The component name of the service that implements
Amith Yamasanid1d7c022014-08-19 17:03:41 -07003257 * {@link RestrictionsReceiver}. If this param is null,
Amith Yamasanif20d6402014-05-24 15:34:37 -07003258 * it removes the restrictions provider previously assigned.
3259 */
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07003260 public void setRestrictionsProvider(ComponentName admin, ComponentName provider) {
Amith Yamasanif20d6402014-05-24 15:34:37 -07003261 if (mService != null) {
3262 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07003263 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07003264 } catch (RemoteException re) {
3265 Log.w(TAG, "Failed to set permission provider on device policy service");
3266 }
3267 }
3268 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04003269
3270 /**
3271 * Called by profile or device owners to set the master volume mute on or off.
3272 *
3273 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3274 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
3275 */
3276 public void setMasterVolumeMuted(ComponentName admin, boolean on) {
3277 if (mService != null) {
3278 try {
3279 mService.setMasterVolumeMuted(admin, on);
3280 } catch (RemoteException re) {
3281 Log.w(TAG, "Failed to setMasterMute on device policy service");
3282 }
3283 }
3284 }
3285
3286 /**
3287 * Called by profile or device owners to check whether the master volume mute is on or off.
3288 *
3289 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3290 * @return {@code true} if master volume is muted, {@code false} if it's not.
3291 */
3292 public boolean isMasterVolumeMuted(ComponentName admin) {
3293 if (mService != null) {
3294 try {
3295 return mService.isMasterVolumeMuted(admin);
3296 } catch (RemoteException re) {
3297 Log.w(TAG, "Failed to get isMasterMute on device policy service");
3298 }
3299 }
3300 return false;
3301 }
Kenny Guyc13053b2014-05-29 14:17:17 +01003302
3303 /**
3304 * Called by profile or device owners to change whether a user can uninstall
3305 * a package.
3306 *
3307 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3308 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01003309 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Kenny Guyc13053b2014-05-29 14:17:17 +01003310 */
Esteban Talaverad5c5c132014-08-20 11:35:57 +01003311 public void setUninstallBlocked(ComponentName admin, String packageName,
3312 boolean uninstallBlocked) {
Kenny Guyc13053b2014-05-29 14:17:17 +01003313 if (mService != null) {
3314 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01003315 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01003316 } catch (RemoteException re) {
3317 Log.w(TAG, "Failed to call block uninstall on device policy service");
3318 }
3319 }
3320 }
3321
3322 /**
3323 * Called by profile or device owners to check whether a user has been blocked from
3324 * uninstalling a package.
3325 *
3326 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3327 * @param packageName package to check.
3328 * @return true if the user shouldn't be able to uninstall the package.
3329 */
Esteban Talavera729b2a62014-08-27 18:01:58 +01003330 public boolean isUninstallBlocked(ComponentName admin, String packageName) {
Kenny Guyc13053b2014-05-29 14:17:17 +01003331 if (mService != null) {
3332 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01003333 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01003334 } catch (RemoteException re) {
3335 Log.w(TAG, "Failed to call block uninstall on device policy service");
3336 }
3337 }
3338 return false;
3339 }
Svetoslav976e8bd2014-07-16 15:12:03 -07003340
3341 /**
3342 * Called by the profile owner to enable widget providers from a given package
3343 * to be available in the parent profile. As a result the user will be able to
3344 * add widgets from the white-listed package running under the profile to a widget
3345 * host which runs under the device owner, for example the home screen. Note that
3346 * a package may have zero or more provider components, where each component
3347 * provides a different widget type.
3348 * <p>
3349 * <strong>Note:</strong> By default no widget provider package is white-listed.
3350 * </p>
3351 *
3352 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3353 * @param packageName The package from which widget providers are white-listed.
3354 * @return Whether the package was added.
3355 *
3356 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
3357 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
3358 */
3359 public boolean addCrossProfileWidgetProvider(ComponentName admin, String packageName) {
3360 if (mService != null) {
3361 try {
3362 return mService.addCrossProfileWidgetProvider(admin, packageName);
3363 } catch (RemoteException re) {
3364 Log.w(TAG, "Error calling addCrossProfileWidgetProvider", re);
3365 }
3366 }
3367 return false;
3368 }
3369
3370 /**
3371 * Called by the profile owner to disable widget providers from a given package
3372 * to be available in the parent profile. For this method to take effect the
3373 * package should have been added via {@link #addCrossProfileWidgetProvider(
3374 * android.content.ComponentName, String)}.
3375 * <p>
3376 * <strong>Note:</strong> By default no widget provider package is white-listed.
3377 * </p>
3378 *
3379 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3380 * @param packageName The package from which widget providers are no longer
3381 * white-listed.
3382 * @return Whether the package was removed.
3383 *
3384 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
3385 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
3386 */
3387 public boolean removeCrossProfileWidgetProvider(ComponentName admin, String packageName) {
3388 if (mService != null) {
3389 try {
3390 return mService.removeCrossProfileWidgetProvider(admin, packageName);
3391 } catch (RemoteException re) {
3392 Log.w(TAG, "Error calling removeCrossProfileWidgetProvider", re);
3393 }
3394 }
3395 return false;
3396 }
3397
3398 /**
3399 * Called by the profile owner to query providers from which packages are
3400 * available in the parent profile.
3401 *
3402 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3403 * @return The white-listed package list.
3404 *
3405 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
3406 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
3407 */
3408 public List<String> getCrossProfileWidgetProviders(ComponentName admin) {
3409 if (mService != null) {
3410 try {
3411 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
3412 if (providers != null) {
3413 return providers;
3414 }
3415 } catch (RemoteException re) {
3416 Log.w(TAG, "Error calling getCrossProfileWidgetProviders", re);
3417 }
3418 }
3419 return Collections.emptyList();
3420 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08003421}