blob: 7a7fdecb160b809f84020c3bb2704d07ba314533 [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;
Jason Monkd7b86212014-06-16 13:15:38 -040021import android.app.Activity;
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -070022import android.content.AbstractRestrictionsProvider;
Dianne Hackbornd6847842010-01-12 18:14:19 -080023import android.content.ComponentName;
24import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010025import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000026import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080027import android.content.pm.ActivityInfo;
28import android.content.pm.PackageManager;
29import android.content.pm.ResolveInfo;
Amith Yamasanif20d6402014-05-24 15:34:37 -070030import android.content.RestrictionsManager;
Julia Reynolds4a21b252014-06-04 11:11:43 -040031import android.media.AudioService;
Jason Monk03bc9912014-05-13 09:44:57 -040032import android.net.ProxyInfo;
Robin Lee66e5d962014-04-09 16:44:21 +010033import android.os.Bundle;
Dianne Hackbornd6847842010-01-12 18:14:19 -080034import android.os.Handler;
Adam Connors776c5552014-01-09 10:42:56 +000035import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080036import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080037import android.os.RemoteException;
38import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070039import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040040import android.os.UserManager;
Julia Reynoldsda551652014-05-14 17:15:16 -040041import android.provider.Settings;
Jim Miller50e62182014-04-23 17:25:00 -070042import android.service.trust.TrustAgentService;
Dianne Hackbornd6847842010-01-12 18:14:19 -080043import android.util.Log;
44
Maggie Benthallda51e682013-08-08 22:35:44 -040045import com.android.org.conscrypt.TrustedCertificateStore;
46
Jessica Hummel91da58d2014-04-10 17:39:43 +010047import org.xmlpull.v1.XmlPullParserException;
48
Maggie Benthallda51e682013-08-08 22:35:44 -040049import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080050import java.io.IOException;
Oscar Montemayor69238c62010-08-03 10:51:06 -070051import java.net.InetSocketAddress;
52import java.net.Proxy;
Maggie Benthallda51e682013-08-08 22:35:44 -040053import java.security.cert.CertificateException;
54import java.security.cert.CertificateFactory;
55import java.security.cert.X509Certificate;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080056import java.util.List;
Maggie Benthallda51e682013-08-08 22:35:44 -040057import java.util.Set;
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
126 * message containing an Nfc record with MIME type {@link #PROVISIONING_NFC_MIME_TYPE}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000127 */
128 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Jessica Hummel9da60392014-05-21 12:32:57 +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
Jessica Hummel9da60392014-05-21 12:32:57 +0100138 = "android.app.extra.defaultManagedProfileName";
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
152 = "android.app.extra.ManagedProfileEmailAddress";
153
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 *
158 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
159 * provisioning via an Nfc bump.
160 */
161 public static final String EXTRA_PROVISIONING_TIME_ZONE
162 = "android.app.extra.timeZone";
163
164 /**
165 * A Long extra holding the local time {@link android.app.AlarmManager} that the device
166 * will be set to.
167 *
168 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
169 * provisioning via an Nfc bump.
170 */
171 public static final String EXTRA_PROVISIONING_LOCAL_TIME
172 = "android.app.extra.localTime";
173
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 *
178 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
179 * provisioning via an Nfc bump.
180 */
181 public static final String EXTRA_PROVISIONING_LOCALE
182 = "android.app.extra.locale";
183
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 *
188 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
189 * provisioning via an Nfc bump.
190 */
191 public static final String EXTRA_PROVISIONING_WIFI_SSID
192 = "android.app.extra.wifiSsid";
193
194 /**
195 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
196 * is hidden or not.
197 *
198 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
199 * provisioning via an Nfc bump.
200 */
201 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
202 = "android.app.extra.wifiHidden";
203
204 /**
205 * A String extra indicating the security type of the wifi network in
206 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
207 *
208 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
209 * provisioning via an Nfc bump.
210 */
211 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
212 = "android.app.extra.wifiSecurityType";
213
214 /**
215 * A String extra holding the password of the wifi network in
216 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
217 *
218 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
219 * provisioning via an Nfc bump.
220 */
221 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
222 = "android.app.extra.wifiPassword";
223
224 /**
225 * A String extra holding the proxy host for the wifi network in
226 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
227 *
228 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
229 * provisioning via an Nfc bump.
230 */
231 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
232 = "android.app.extra.wifiProxyHost";
233
234 /**
235 * An int extra holding the proxy port for the wifi network in
236 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
237 *
238 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
239 * provisioning via an Nfc bump.
240 */
241 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
242 = "android.app.extra.wifiProxyPort";
243
244 /**
245 * A String extra holding the proxy bypass for the wifi network in
246 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
247 *
248 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
249 * provisioning via an Nfc bump.
250 */
251 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
252 = "android.app.extra.wifiProxyBypassHosts";
253
254 /**
255 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
256 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
257 *
258 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
259 * provisioning via an Nfc bump.
260 */
261 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
262 = "android.app.extra.wifiPacUrl";
263
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 *
268 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
269 * provisioning via an Nfc bump.
270 */
271 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
272 = "android.app.extra.deviceAdminPackageDownloadLocation";
273
274 /**
275 * A String extra holding the SHA-1 checksum of the file at download location specified in
276 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. If this doesn't match
277 * the file at the download location an error will be shown to the user and the user will be
278 * asked to factory reset the device.
279 *
280 * <p>Use in an Nfc record with {@link #PROVISIONING_NFC_MIME_TYPE} that starts device owner
281 * provisioning via an Nfc bump.
282 */
283 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
284 = "android.app.extra.deviceAdminPackageChecksum";
285
286 /**
287 * This MIME type is used for starting the Device Owner provisioning.
288 *
289 * <p>During device owner provisioning a device admin app is set as the owner of the device.
290 * A device owner has full control over the device. The device owner can not be modified by the
291 * user and the only way of resetting the device is if the device owner app calls a factory
292 * reset.
293 *
294 * <p> A typical use case would be a device that is owned by a company, but used by either an
295 * employee or client.
296 *
297 * <p> The Nfc message should be send to an unprovisioned device.
298 *
299 * <p>The Nfc record must contain a serialized {@link java.util.Properties} object which
300 * contains the following properties:
301 * <ul>
302 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
303 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}</li>
304 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}</li>
305 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
306 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
307 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
308 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
309 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
310 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
311 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
312 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
313 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
314 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
315 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li></ul>
316 *
317 * <p> When device owner provisioning has completed, an intent of the type
318 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcasted to the
319 * device owner.
320 *
321 * <p>
322 * If provisioning fails, the device is factory reset.
323 *
324 * <p>Input: Nothing.</p>
325 * <p>Output: Nothing</p>
326 */
327 public static final String PROVISIONING_NFC_MIME_TYPE
328 = "application/com.android.managedprovisioning";
329
330 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800331 * Activity action: ask the user to add a new device administrator to the system.
332 * The desired policy is the ComponentName of the policy in the
333 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
334 * bring the user through adding the device administrator to the system (or
335 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700336 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800337 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
338 * field to provide the user with additional explanation (in addition
339 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800340 *
341 * <p>If your administrator is already active, this will ordinarily return immediately (without
342 * user intervention). However, if your administrator has been updated and is requesting
343 * additional uses-policy flags, the user will be presented with the new list. New policies
344 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800345 */
346 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
347 public static final String ACTION_ADD_DEVICE_ADMIN
348 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700349
Dianne Hackbornd6847842010-01-12 18:14:19 -0800350 /**
Jim Miller284b62e2010-06-08 14:27:42 -0700351 * Activity action: send when any policy admin changes a policy.
352 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700353 *
Jim Miller284b62e2010-06-08 14:27:42 -0700354 * @hide
355 */
356 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
357 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
358
359 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800360 * The ComponentName of the administrator component.
361 *
362 * @see #ACTION_ADD_DEVICE_ADMIN
363 */
364 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700365
Dianne Hackbornd6847842010-01-12 18:14:19 -0800366 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800367 * An optional CharSequence providing additional explanation for why the
368 * admin is being added.
369 *
370 * @see #ACTION_ADD_DEVICE_ADMIN
371 */
372 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700373
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800374 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700375 * Activity action: have the user enter a new password. This activity should
376 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
377 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
378 * enter a new password that meets the current requirements. You can use
379 * {@link #isActivePasswordSufficient()} to determine whether you need to
380 * have the user select a new password in order to meet the current
381 * constraints. Upon being resumed from this activity, you can check the new
382 * password characteristics to see if they are sufficient.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800383 */
384 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
385 public static final String ACTION_SET_NEW_PASSWORD
386 = "android.app.action.SET_NEW_PASSWORD";
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000387 /**
Nicolas Prevot81948992014-05-16 18:25:26 +0100388 * Flag used by {@link #addCrossProfileIntentFilter} to allow access of certain intents from a
389 * managed profile to its parent.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000390 */
Nicolas Prevot81948992014-05-16 18:25:26 +0100391 public static int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000392
393 /**
Nicolas Prevot81948992014-05-16 18:25:26 +0100394 * Flag used by {@link #addCrossProfileIntentFilter} to allow access of certain intents from the
395 * parent to its managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000396 */
Nicolas Prevot81948992014-05-16 18:25:26 +0100397 public static int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700398
Dianne Hackbornd6847842010-01-12 18:14:19 -0800399 /**
400 * Return true if the given administrator component is currently
401 * active (enabled) in the system.
402 */
403 public boolean isAdminActive(ComponentName who) {
404 if (mService != null) {
405 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700406 return mService.isAdminActive(who, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -0800407 } catch (RemoteException e) {
408 Log.w(TAG, "Failed talking with device policy service", e);
409 }
410 }
411 return false;
412 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700413
Dianne Hackbornd6847842010-01-12 18:14:19 -0800414 /**
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800415 * Return a list of all currently active device administrator's component
416 * names. Note that if there are no administrators than null may be
417 * returned.
418 */
419 public List<ComponentName> getActiveAdmins() {
420 if (mService != null) {
421 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700422 return mService.getActiveAdmins(UserHandle.myUserId());
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800423 } catch (RemoteException e) {
424 Log.w(TAG, "Failed talking with device policy service", e);
425 }
426 }
427 return null;
428 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700429
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800430 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700431 * Used by package administration code to determine if a package can be stopped
432 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800433 * @hide
434 */
435 public boolean packageHasActiveAdmins(String packageName) {
436 if (mService != null) {
437 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700438 return mService.packageHasActiveAdmins(packageName, UserHandle.myUserId());
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800439 } catch (RemoteException e) {
440 Log.w(TAG, "Failed talking with device policy service", e);
441 }
442 }
443 return false;
444 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700445
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800446 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800447 * Remove a current administration component. This can only be called
448 * by the application that owns the administration component; if you
449 * try to remove someone else's component, a security exception will be
450 * thrown.
451 */
452 public void removeActiveAdmin(ComponentName who) {
453 if (mService != null) {
454 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700455 mService.removeActiveAdmin(who, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -0800456 } catch (RemoteException e) {
457 Log.w(TAG, "Failed talking with device policy service", e);
458 }
459 }
460 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700461
Dianne Hackbornd6847842010-01-12 18:14:19 -0800462 /**
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800463 * Returns true if an administrator has been granted a particular device policy. This can
464 * be used to check if the administrator was activated under an earlier set of policies,
465 * but requires additional policies after an upgrade.
466 *
467 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be
468 * an active administrator, or an exception will be thrown.
469 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
470 */
471 public boolean hasGrantedPolicy(ComponentName admin, int usesPolicy) {
472 if (mService != null) {
473 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700474 return mService.hasGrantedPolicy(admin, usesPolicy, UserHandle.myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800475 } catch (RemoteException e) {
476 Log.w(TAG, "Failed talking with device policy service", e);
477 }
478 }
479 return false;
480 }
481
482 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800483 * Constant for {@link #setPasswordQuality}: the policy has no requirements
484 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800485 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800486 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800487 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700488
Dianne Hackbornd6847842010-01-12 18:14:19 -0800489 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700490 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
491 * recognition technology. This implies technologies that can recognize the identity of
492 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
493 * Note that quality constants are ordered so that higher values are more restrictive.
494 */
495 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
496
497 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800498 * Constant for {@link #setPasswordQuality}: the policy requires some kind
499 * of password, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800500 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800501 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800502 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700503
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800504 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800505 * Constant for {@link #setPasswordQuality}: the user must have entered a
506 * password containing at least numeric characters. Note that quality
507 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800508 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800509 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700510
Dianne Hackbornd6847842010-01-12 18:14:19 -0800511 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800512 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -0800513 * password containing at least numeric characters with no repeating (4444)
514 * or ordered (1234, 4321, 2468) sequences. Note that quality
515 * constants are ordered so that higher values are more restrictive.
516 */
517 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
518
519 /**
520 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -0700521 * password containing at least alphabetic (or other symbol) characters.
522 * Note that quality constants are ordered so that higher values are more
523 * restrictive.
524 */
525 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700526
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -0700527 /**
528 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800529 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -0700530 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800531 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800532 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -0700533 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700534
Dianne Hackbornd6847842010-01-12 18:14:19 -0800535 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700536 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700537 * password containing at least a letter, a numerical digit and a special
538 * symbol, by default. With this password quality, passwords can be
539 * restricted to contain various sets of characters, like at least an
540 * uppercase letter, etc. These are specified using various methods,
541 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
542 * that quality constants are ordered so that higher values are more
543 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700544 */
545 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
546
547 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800548 * Called by an application that is administering the device to set the
549 * password restrictions it is imposing. After setting this, the user
550 * will not be able to enter a new password that is not at least as
551 * restrictive as what has been set. Note that the current password
552 * will remain until the user has set a new one, so the change does not
553 * take place immediately. To prompt the user for a new password, use
554 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700555 *
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800556 * <p>Quality constants are ordered so that higher values are more restrictive;
557 * thus the highest requested quality constant (between the policy set here,
Dianne Hackborndf83afa2010-01-20 13:37:26 -0800558 * the user's preference, and any other considerations) is the one that
559 * is in effect.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700560 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -0800561 * <p>The calling device admin must have requested
562 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
563 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700564 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -0800565 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800566 * @param quality The new desired quality. One of
567 * {@link #PASSWORD_QUALITY_UNSPECIFIED}, {@link #PASSWORD_QUALITY_SOMETHING},
Jim Miller85516d02014-01-31 17:08:37 -0800568 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
569 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC}
570 * or {@link #PASSWORD_QUALITY_COMPLEX}.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800571 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800572 public void setPasswordQuality(ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800573 if (mService != null) {
574 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700575 mService.setPasswordQuality(admin, quality, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -0800576 } catch (RemoteException e) {
577 Log.w(TAG, "Failed talking with device policy service", e);
578 }
579 }
580 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700581
Dianne Hackbornd6847842010-01-12 18:14:19 -0800582 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +0100583 * Retrieve the current minimum password quality for all admins of this user
584 * and its profiles or a particular one.
Dianne Hackborn254cb442010-01-27 19:23:59 -0800585 * @param admin The name of the admin component to check, or null to aggregate
586 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800587 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800588 public int getPasswordQuality(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700589 return getPasswordQuality(admin, UserHandle.myUserId());
590 }
591
592 /** @hide per-user version */
593 public int getPasswordQuality(ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800594 if (mService != null) {
595 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700596 return mService.getPasswordQuality(admin, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800597 } catch (RemoteException e) {
598 Log.w(TAG, "Failed talking with device policy service", e);
599 }
600 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -0800601 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -0800602 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700603
Dianne Hackbornd6847842010-01-12 18:14:19 -0800604 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800605 * Called by an application that is administering the device to set the
606 * minimum allowed password length. After setting this, the user
607 * will not be able to enter a new password that is not at least as
608 * restrictive as what has been set. Note that the current password
609 * will remain until the user has set a new one, so the change does not
610 * take place immediately. To prompt the user for a new password, use
611 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
612 * constraint is only imposed if the administrator has also requested either
Jim Miller85516d02014-01-31 17:08:37 -0800613 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
614 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC},
615 * or {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700616 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -0800617 * <p>The calling device admin must have requested
618 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
619 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700620 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -0800621 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800622 * @param length The new desired minimum password length. A value of 0
623 * means there is no restriction.
624 */
Dianne Hackborn254cb442010-01-27 19:23:59 -0800625 public void setPasswordMinimumLength(ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800626 if (mService != null) {
627 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700628 mService.setPasswordMinimumLength(admin, length, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -0800629 } catch (RemoteException e) {
630 Log.w(TAG, "Failed talking with device policy service", e);
631 }
632 }
633 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700634
Dianne Hackbornd6847842010-01-12 18:14:19 -0800635 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +0100636 * Retrieve the current minimum password length for all admins of this
637 * user and its profiles or a particular one.
Dianne Hackborn254cb442010-01-27 19:23:59 -0800638 * @param admin The name of the admin component to check, or null to aggregate
639 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800640 */
Dianne Hackborn254cb442010-01-27 19:23:59 -0800641 public int getPasswordMinimumLength(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700642 return getPasswordMinimumLength(admin, UserHandle.myUserId());
643 }
644
645 /** @hide per-user version */
646 public int getPasswordMinimumLength(ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800647 if (mService != null) {
648 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700649 return mService.getPasswordMinimumLength(admin, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800650 } catch (RemoteException e) {
651 Log.w(TAG, "Failed talking with device policy service", e);
652 }
653 }
654 return 0;
655 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700656
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700657 /**
658 * Called by an application that is administering the device to set the
659 * minimum number of upper case letters required in the password. After
660 * setting this, the user will not be able to enter a new password that is
661 * not at least as restrictive as what has been set. Note that the current
662 * password will remain until the user has set a new one, so the change does
663 * not take place immediately. To prompt the user for a new password, use
664 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
665 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700666 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
667 * default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700668 * <p>
669 * The calling device admin must have requested
670 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
671 * this method; if it has not, a security exception will be thrown.
672 *
673 * @param admin Which {@link DeviceAdminReceiver} this request is associated
674 * with.
675 * @param length The new desired minimum number of upper case letters
676 * required in the password. A value of 0 means there is no
677 * restriction.
678 */
679 public void setPasswordMinimumUpperCase(ComponentName admin, int length) {
680 if (mService != null) {
681 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700682 mService.setPasswordMinimumUpperCase(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700683 } catch (RemoteException e) {
684 Log.w(TAG, "Failed talking with device policy service", e);
685 }
686 }
687 }
688
689 /**
690 * Retrieve the current number of upper case letters required in the
Jessica Hummel91da58d2014-04-10 17:39:43 +0100691 * password for all admins of this user and its profiles or a particular one.
692 * This is the same value as set by
693 * {#link {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700694 * and only applies when the password quality is
695 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700696 *
697 * @param admin The name of the admin component to check, or null to
698 * aggregate all admins.
699 * @return The minimum number of upper case letters required in the
700 * password.
701 */
702 public int getPasswordMinimumUpperCase(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700703 return getPasswordMinimumUpperCase(admin, UserHandle.myUserId());
704 }
705
706 /** @hide per-user version */
707 public int getPasswordMinimumUpperCase(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700708 if (mService != null) {
709 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700710 return mService.getPasswordMinimumUpperCase(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700711 } catch (RemoteException e) {
712 Log.w(TAG, "Failed talking with device policy service", e);
713 }
714 }
715 return 0;
716 }
717
718 /**
719 * Called by an application that is administering the device to set the
720 * minimum number of lower case letters required in the password. After
721 * setting this, the user will not be able to enter a new password that is
722 * not at least as restrictive as what has been set. Note that the current
723 * password will remain until the user has set a new one, so the change does
724 * not take place immediately. To prompt the user for a new password, use
725 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
726 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700727 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
728 * default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700729 * <p>
730 * The calling device admin must have requested
731 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
732 * this method; if it has not, a security exception will be thrown.
733 *
734 * @param admin Which {@link DeviceAdminReceiver} this request is associated
735 * with.
736 * @param length The new desired minimum number of lower case letters
737 * required in the password. A value of 0 means there is no
738 * restriction.
739 */
740 public void setPasswordMinimumLowerCase(ComponentName admin, int length) {
741 if (mService != null) {
742 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700743 mService.setPasswordMinimumLowerCase(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700744 } catch (RemoteException e) {
745 Log.w(TAG, "Failed talking with device policy service", e);
746 }
747 }
748 }
749
750 /**
751 * Retrieve the current number of lower case letters required in the
Jessica Hummel91da58d2014-04-10 17:39:43 +0100752 * password for all admins of this user and its profiles or a particular one.
753 * This is the same value as set by
754 * {#link {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700755 * and only applies when the password quality is
756 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700757 *
758 * @param admin The name of the admin component to check, or null to
759 * aggregate all admins.
760 * @return The minimum number of lower case letters required in the
761 * password.
762 */
763 public int getPasswordMinimumLowerCase(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700764 return getPasswordMinimumLowerCase(admin, UserHandle.myUserId());
765 }
766
767 /** @hide per-user version */
768 public int getPasswordMinimumLowerCase(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700769 if (mService != null) {
770 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700771 return mService.getPasswordMinimumLowerCase(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700772 } catch (RemoteException e) {
773 Log.w(TAG, "Failed talking with device policy service", e);
774 }
775 }
776 return 0;
777 }
778
779 /**
780 * Called by an application that is administering the device to set the
781 * minimum number of letters required in the password. After setting this,
782 * the user will not be able to enter a new password that is not at least as
783 * restrictive as what has been set. Note that the current password will
784 * remain until the user has set a new one, so the change does not take
785 * place immediately. To prompt the user for a new password, use
786 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
787 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700788 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
789 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700790 * <p>
791 * The calling device admin must have requested
792 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
793 * this method; if it has not, a security exception will be thrown.
794 *
795 * @param admin Which {@link DeviceAdminReceiver} this request is associated
796 * with.
797 * @param length The new desired minimum number of letters required in the
798 * password. A value of 0 means there is no restriction.
799 */
800 public void setPasswordMinimumLetters(ComponentName admin, int length) {
801 if (mService != null) {
802 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700803 mService.setPasswordMinimumLetters(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700804 } catch (RemoteException e) {
805 Log.w(TAG, "Failed talking with device policy service", e);
806 }
807 }
808 }
809
810 /**
811 * Retrieve the current number of letters required in the password for all
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700812 * admins or a particular one. This is the same value as
813 * set by {#link {@link #setPasswordMinimumLetters(ComponentName, int)}
814 * and only applies when the password quality is
815 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700816 *
817 * @param admin The name of the admin component to check, or null to
818 * aggregate all admins.
819 * @return The minimum number of letters required in the password.
820 */
821 public int getPasswordMinimumLetters(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700822 return getPasswordMinimumLetters(admin, UserHandle.myUserId());
823 }
824
825 /** @hide per-user version */
826 public int getPasswordMinimumLetters(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700827 if (mService != null) {
828 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700829 return mService.getPasswordMinimumLetters(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700830 } catch (RemoteException e) {
831 Log.w(TAG, "Failed talking with device policy service", e);
832 }
833 }
834 return 0;
835 }
836
837 /**
838 * Called by an application that is administering the device to set the
839 * minimum number of numerical digits required in the password. After
840 * setting this, the user will not be able to enter a new password that is
841 * not at least as restrictive as what has been set. Note that the current
842 * password will remain until the user has set a new one, so the change does
843 * not take place immediately. To prompt the user for a new password, use
844 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
845 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700846 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
847 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700848 * <p>
849 * The calling device admin must have requested
850 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
851 * this method; if it has not, a security exception will be thrown.
852 *
853 * @param admin Which {@link DeviceAdminReceiver} this request is associated
854 * with.
855 * @param length The new desired minimum number of numerical digits required
856 * in the password. A value of 0 means there is no restriction.
857 */
858 public void setPasswordMinimumNumeric(ComponentName admin, int length) {
859 if (mService != null) {
860 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700861 mService.setPasswordMinimumNumeric(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700862 } catch (RemoteException e) {
863 Log.w(TAG, "Failed talking with device policy service", e);
864 }
865 }
866 }
867
868 /**
869 * Retrieve the current number of numerical digits required in the password
Jessica Hummel91da58d2014-04-10 17:39:43 +0100870 * for all admins of this user and its profiles or a particular one.
871 * This is the same value as set by
872 * {#link {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700873 * and only applies when the password quality is
874 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700875 *
876 * @param admin The name of the admin component to check, or null to
877 * aggregate all admins.
878 * @return The minimum number of numerical digits required in the password.
879 */
880 public int getPasswordMinimumNumeric(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700881 return getPasswordMinimumNumeric(admin, UserHandle.myUserId());
882 }
883
884 /** @hide per-user version */
885 public int getPasswordMinimumNumeric(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700886 if (mService != null) {
887 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700888 return mService.getPasswordMinimumNumeric(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700889 } catch (RemoteException e) {
890 Log.w(TAG, "Failed talking with device policy service", e);
891 }
892 }
893 return 0;
894 }
895
896 /**
897 * Called by an application that is administering the device to set the
898 * minimum number of symbols required in the password. After setting this,
899 * the user will not be able to enter a new password that is not at least as
900 * restrictive as what has been set. Note that the current password will
901 * remain until the user has set a new one, so the change does not take
902 * place immediately. To prompt the user for a new password, use
903 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
904 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700905 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
906 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700907 * <p>
908 * The calling device admin must have requested
909 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
910 * this method; if it has not, a security exception will be thrown.
911 *
912 * @param admin Which {@link DeviceAdminReceiver} this request is associated
913 * with.
914 * @param length The new desired minimum number of symbols required in the
915 * password. A value of 0 means there is no restriction.
916 */
917 public void setPasswordMinimumSymbols(ComponentName admin, int length) {
918 if (mService != null) {
919 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700920 mService.setPasswordMinimumSymbols(admin, length, UserHandle.myUserId());
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700921 } catch (RemoteException e) {
922 Log.w(TAG, "Failed talking with device policy service", e);
923 }
924 }
925 }
926
927 /**
928 * Retrieve the current number of symbols required in the password for all
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700929 * admins or a particular one. This is the same value as
930 * set by {#link {@link #setPasswordMinimumSymbols(ComponentName, int)}
931 * and only applies when the password quality is
932 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700933 *
934 * @param admin The name of the admin component to check, or null to
935 * aggregate all admins.
936 * @return The minimum number of symbols required in the password.
937 */
938 public int getPasswordMinimumSymbols(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700939 return getPasswordMinimumSymbols(admin, UserHandle.myUserId());
940 }
941
942 /** @hide per-user version */
943 public int getPasswordMinimumSymbols(ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700944 if (mService != null) {
945 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700946 return mService.getPasswordMinimumSymbols(admin, userHandle);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -0700947 } catch (RemoteException e) {
948 Log.w(TAG, "Failed talking with device policy service", e);
949 }
950 }
951 return 0;
952 }
953
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700954 /**
955 * Called by an application that is administering the device to set the
956 * minimum number of non-letter characters (numerical digits or symbols)
957 * required in the password. After setting this, the user will not be able
958 * to enter a new password that is not at least as restrictive as what has
959 * been set. Note that the current password will remain until the user has
960 * set a new one, so the change does not take place immediately. To prompt
961 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} after
962 * setting this value. This constraint is only imposed if the administrator
963 * has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
964 * {@link #setPasswordQuality}. The default value is 0.
965 * <p>
966 * The calling device admin must have requested
967 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
968 * this method; if it has not, a security exception will be thrown.
969 *
970 * @param admin Which {@link DeviceAdminReceiver} this request is associated
971 * with.
972 * @param length The new desired minimum number of letters required in the
973 * password. A value of 0 means there is no restriction.
974 */
975 public void setPasswordMinimumNonLetter(ComponentName admin, int length) {
976 if (mService != null) {
977 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700978 mService.setPasswordMinimumNonLetter(admin, length, UserHandle.myUserId());
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700979 } catch (RemoteException e) {
980 Log.w(TAG, "Failed talking with device policy service", e);
981 }
982 }
983 }
984
985 /**
986 * Retrieve the current number of non-letter characters required in the
Jessica Hummel91da58d2014-04-10 17:39:43 +0100987 * password for all admins of this user and its profiles or a particular one.
988 * This is the same value as set by
989 * {#link {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -0700990 * and only applies when the password quality is
991 * {@link #PASSWORD_QUALITY_COMPLEX}.
992 *
993 * @param admin The name of the admin component to check, or null to
994 * aggregate all admins.
995 * @return The minimum number of letters required in the password.
996 */
997 public int getPasswordMinimumNonLetter(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700998 return getPasswordMinimumNonLetter(admin, UserHandle.myUserId());
999 }
1000
1001 /** @hide per-user version */
1002 public int getPasswordMinimumNonLetter(ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001003 if (mService != null) {
1004 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001005 return mService.getPasswordMinimumNonLetter(admin, userHandle);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001006 } catch (RemoteException e) {
1007 Log.w(TAG, "Failed talking with device policy service", e);
1008 }
1009 }
1010 return 0;
1011 }
1012
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001013 /**
1014 * Called by an application that is administering the device to set the length
1015 * of the password history. After setting this, the user will not be able to
1016 * enter a new password that is the same as any password in the history. Note
1017 * that the current password will remain until the user has set a new one, so
1018 * the change does not take place immediately. To prompt the user for a new
1019 * password, use {@link #ACTION_SET_NEW_PASSWORD} after setting this value.
1020 * This constraint is only imposed if the administrator has also requested
Jim Miller85516d02014-01-31 17:08:37 -08001021 * either {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}
1022 * {@link #PASSWORD_QUALITY_ALPHABETIC}, or {@link #PASSWORD_QUALITY_ALPHANUMERIC}
1023 * with {@link #setPasswordQuality}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001024 *
1025 * <p>
1026 * The calling device admin must have requested
1027 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this
1028 * method; if it has not, a security exception will be thrown.
1029 *
1030 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1031 * with.
1032 * @param length The new desired length of password history. A value of 0
1033 * means there is no restriction.
1034 */
1035 public void setPasswordHistoryLength(ComponentName admin, int length) {
1036 if (mService != null) {
1037 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001038 mService.setPasswordHistoryLength(admin, length, UserHandle.myUserId());
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001039 } catch (RemoteException e) {
1040 Log.w(TAG, "Failed talking with device policy service", e);
1041 }
1042 }
1043 }
1044
1045 /**
Jim Millera4e28d12010-11-08 16:15:47 -08001046 * Called by a device admin to set the password expiration timeout. Calling this method
1047 * will restart the countdown for password expiration for the given admin, as will changing
1048 * the device password (for all admins).
1049 *
1050 * <p>The provided timeout is the time delta in ms and will be added to the current time.
1051 * For example, to have the password expire 5 days from now, timeout would be
1052 * 5 * 86400 * 1000 = 432000000 ms for timeout.
1053 *
1054 * <p>To disable password expiration, a value of 0 may be used for timeout.
1055 *
Jim Millera4e28d12010-11-08 16:15:47 -08001056 * <p>The calling device admin must have requested
1057 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this
1058 * method; if it has not, a security exception will be thrown.
1059 *
Jessica Hummel9da60392014-05-21 12:32:57 +01001060 * <p> Note that setting the password will automatically reset the expiration time for all
1061 * active admins. Active admins do not need to explicitly call this method in that case.
1062 *
Jim Millera4e28d12010-11-08 16:15:47 -08001063 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1064 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0
1065 * means there is no restriction (unlimited).
1066 */
1067 public void setPasswordExpirationTimeout(ComponentName admin, long timeout) {
1068 if (mService != null) {
1069 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001070 mService.setPasswordExpirationTimeout(admin, timeout, UserHandle.myUserId());
Jim Millera4e28d12010-11-08 16:15:47 -08001071 } catch (RemoteException e) {
1072 Log.w(TAG, "Failed talking with device policy service", e);
1073 }
1074 }
1075 }
1076
1077 /**
Jim Miller6b857682011-02-16 16:27:41 -08001078 * Get the password expiration timeout for the given admin. The expiration timeout is the
1079 * recurring expiration timeout provided in the call to
1080 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
1081 * aggregate of all policy administrators if admin is null.
Jim Millera4e28d12010-11-08 16:15:47 -08001082 *
1083 * @param admin The name of the admin component to check, or null to aggregate all admins.
1084 * @return The timeout for the given admin or the minimum of all timeouts
1085 */
1086 public long getPasswordExpirationTimeout(ComponentName admin) {
1087 if (mService != null) {
1088 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001089 return mService.getPasswordExpirationTimeout(admin, UserHandle.myUserId());
Jim Millera4e28d12010-11-08 16:15:47 -08001090 } catch (RemoteException e) {
1091 Log.w(TAG, "Failed talking with device policy service", e);
1092 }
1093 }
1094 return 0;
1095 }
1096
1097 /**
1098 * Get the current password expiration time for the given admin or an aggregate of
Jessica Hummel91da58d2014-04-10 17:39:43 +01001099 * all admins of this user and its profiles if admin is null. If the password is
1100 * expired, this will return the time since the password expired as a negative number.
1101 * If admin is null, then a composite of all expiration timeouts is returned
1102 * - which will be the minimum of all timeouts.
Jim Millera4e28d12010-11-08 16:15:47 -08001103 *
1104 * @param admin The name of the admin component to check, or null to aggregate all admins.
1105 * @return The password expiration time, in ms.
1106 */
1107 public long getPasswordExpiration(ComponentName admin) {
1108 if (mService != null) {
1109 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001110 return mService.getPasswordExpiration(admin, UserHandle.myUserId());
Jim Millera4e28d12010-11-08 16:15:47 -08001111 } catch (RemoteException e) {
1112 Log.w(TAG, "Failed talking with device policy service", e);
1113 }
1114 }
1115 return 0;
1116 }
1117
1118 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +01001119 * Retrieve the current password history length for all admins of this
1120 * user and its profiles or a particular one.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001121 * @param admin The name of the admin component to check, or null to aggregate
1122 * all admins.
1123 * @return The length of the password history
1124 */
1125 public int getPasswordHistoryLength(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001126 return getPasswordHistoryLength(admin, UserHandle.myUserId());
1127 }
1128
1129 /** @hide per-user version */
1130 public int getPasswordHistoryLength(ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001131 if (mService != null) {
1132 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001133 return mService.getPasswordHistoryLength(admin, userHandle);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001134 } catch (RemoteException e) {
1135 Log.w(TAG, "Failed talking with device policy service", e);
1136 }
1137 }
1138 return 0;
1139 }
1140
Dianne Hackbornd6847842010-01-12 18:14:19 -08001141 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001142 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001143 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001144 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001145 * @return Returns the maximum length that the user can enter.
1146 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001147 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001148 // Kind-of arbitrary.
1149 return 16;
1150 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001151
Dianne Hackborn254cb442010-01-27 19:23:59 -08001152 /**
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001153 * Determine whether the current password the user has set is sufficient
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001154 * to meet the policy requirements (quality, minimum length) that have been
Jessica Hummel91da58d2014-04-10 17:39:43 +01001155 * requested by the admins of this user and its profiles.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001156 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001157 * <p>The calling device admin must have requested
1158 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1159 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001160 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001161 * @return Returns true if the password meets the current requirements, else false.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001162 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001163 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001164 if (mService != null) {
1165 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001166 return mService.isActivePasswordSufficient(UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001167 } catch (RemoteException e) {
1168 Log.w(TAG, "Failed talking with device policy service", e);
1169 }
1170 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001171 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001172 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001173
Dianne Hackbornd6847842010-01-12 18:14:19 -08001174 /**
1175 * Retrieve the number of times the user has failed at entering a
1176 * password since that last successful password entry.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001177 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001178 * <p>The calling device admin must have requested
1179 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call
1180 * this method; if it has not, a security exception will be thrown.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001181 */
1182 public int getCurrentFailedPasswordAttempts() {
1183 if (mService != null) {
1184 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001185 return mService.getCurrentFailedPasswordAttempts(UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001186 } catch (RemoteException e) {
1187 Log.w(TAG, "Failed talking with device policy service", e);
1188 }
1189 }
1190 return -1;
1191 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001192
1193 /**
Andrew Stadler88209d12010-02-08 22:59:36 -08001194 * Setting this to a value greater than zero enables a built-in policy
1195 * that will perform a device wipe after too many incorrect
1196 * device-unlock passwords have been entered. This built-in policy combines
1197 * watching for failed passwords and wiping the device, and requires
1198 * that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001199 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001200 *
Andrew Stadler88209d12010-02-08 22:59:36 -08001201 * <p>To implement any other policy (e.g. wiping data for a particular
1202 * application only, erasing or revoking credentials, or reporting the
1203 * failure to a server), you should implement
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001204 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)}
Andrew Stadler88209d12010-02-08 22:59:36 -08001205 * instead. Do not use this API, because if the maximum count is reached,
1206 * the device will be wiped immediately, and your callback will not be invoked.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001207 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001208 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001209 * @param num The number of failed password attempts at which point the
1210 * device will wipe its data.
1211 */
1212 public void setMaximumFailedPasswordsForWipe(ComponentName admin, int num) {
1213 if (mService != null) {
1214 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001215 mService.setMaximumFailedPasswordsForWipe(admin, num, UserHandle.myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001216 } catch (RemoteException e) {
1217 Log.w(TAG, "Failed talking with device policy service", e);
1218 }
1219 }
1220 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001221
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001222 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001223 * Retrieve the current maximum number of login attempts that are allowed
Jessica Hummel91da58d2014-04-10 17:39:43 +01001224 * before the device wipes itself, for all admins of this user and its profiles
Dianne Hackborn254cb442010-01-27 19:23:59 -08001225 * or a particular one.
1226 * @param admin The name of the admin component to check, or null to aggregate
1227 * all admins.
1228 */
1229 public int getMaximumFailedPasswordsForWipe(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001230 return getMaximumFailedPasswordsForWipe(admin, UserHandle.myUserId());
1231 }
1232
1233 /** @hide per-user version */
1234 public int getMaximumFailedPasswordsForWipe(ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001235 if (mService != null) {
1236 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001237 return mService.getMaximumFailedPasswordsForWipe(admin, userHandle);
Dianne Hackborn254cb442010-01-27 19:23:59 -08001238 } catch (RemoteException e) {
1239 Log.w(TAG, "Failed talking with device policy service", e);
1240 }
1241 }
1242 return 0;
1243 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001244
Dianne Hackborn254cb442010-01-27 19:23:59 -08001245 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001246 * Flag for {@link #resetPassword}: don't allow other admins to change
1247 * the password again until the user has entered it.
1248 */
1249 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001250
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001251 /**
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001252 * Force a new device unlock password (the password needed to access the
1253 * entire device, not for individual accounts) on the user. This takes
1254 * effect immediately.
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001255 * The given password must be sufficient for the
1256 * current password quality and length constraints as returned by
1257 * {@link #getPasswordQuality(ComponentName)} and
1258 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet
1259 * these constraints, then it will be rejected and false returned. Note
1260 * that the password may be a stronger quality (containing alphanumeric
1261 * characters when the requested quality is only numeric), in which case
1262 * the currently active quality will be increased to match.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001263 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001264 * <p>The calling device admin must have requested
1265 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call
1266 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001267 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001268 * Can not be called from a managed profile.
1269 *
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001270 * @param password The new password for the user.
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001271 * @param flags May be 0 or {@link #RESET_PASSWORD_REQUIRE_ENTRY}.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001272 * @return Returns true if the password was applied, or false if it is
1273 * not acceptable for the current constraints.
1274 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001275 public boolean resetPassword(String password, int flags) {
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001276 if (mService != null) {
1277 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001278 return mService.resetPassword(password, flags, UserHandle.myUserId());
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001279 } catch (RemoteException e) {
1280 Log.w(TAG, "Failed talking with device policy service", e);
1281 }
1282 }
1283 return false;
1284 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001285
Dianne Hackbornd6847842010-01-12 18:14:19 -08001286 /**
1287 * Called by an application that is administering the device to set the
1288 * maximum time for user activity until the device will lock. This limits
1289 * the length that the user can set. It takes effect immediately.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001290 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001291 * <p>The calling device admin must have requested
Dianne Hackborn315ada72010-02-11 12:14:08 -08001292 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001293 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001294 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001295 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001296 * @param timeMs The new desired maximum time to lock in milliseconds.
1297 * A value of 0 means there is no restriction.
1298 */
1299 public void setMaximumTimeToLock(ComponentName admin, long timeMs) {
1300 if (mService != null) {
1301 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001302 mService.setMaximumTimeToLock(admin, timeMs, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001303 } catch (RemoteException e) {
1304 Log.w(TAG, "Failed talking with device policy service", e);
1305 }
1306 }
1307 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001308
Dianne Hackbornd6847842010-01-12 18:14:19 -08001309 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +01001310 * Retrieve the current maximum time to unlock for all admins of this user
1311 * and its profiles or a particular one.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001312 * @param admin The name of the admin component to check, or null to aggregate
1313 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001314 */
Dianne Hackborn254cb442010-01-27 19:23:59 -08001315 public long getMaximumTimeToLock(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001316 return getMaximumTimeToLock(admin, UserHandle.myUserId());
1317 }
1318
1319 /** @hide per-user version */
1320 public long getMaximumTimeToLock(ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001321 if (mService != null) {
1322 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001323 return mService.getMaximumTimeToLock(admin, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001324 } catch (RemoteException e) {
1325 Log.w(TAG, "Failed talking with device policy service", e);
1326 }
1327 }
1328 return 0;
1329 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001330
Dianne Hackbornd6847842010-01-12 18:14:19 -08001331 /**
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001332 * Make the device lock immediately, as if the lock screen timeout has
1333 * expired at the point of this call.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001334 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001335 * <p>The calling device admin must have requested
1336 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
1337 * this method; if it has not, a security exception will be thrown.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001338 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001339 public void lockNow() {
1340 if (mService != null) {
1341 try {
1342 mService.lockNow();
1343 } catch (RemoteException e) {
1344 Log.w(TAG, "Failed talking with device policy service", e);
1345 }
1346 }
1347 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001348
Dianne Hackbornd6847842010-01-12 18:14:19 -08001349 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07001350 * Flag for {@link #wipeData(int)}: also erase the device's external
1351 * storage.
1352 */
1353 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
1354
1355 /**
Paul Quei2450a0e2013-09-20 09:26:21 +08001356 * Ask the user data be wiped. This will cause the device to reboot,
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001357 * erasing all user data while next booting up. External storage such
Masanori Oginof535cb042012-02-15 19:25:50 +09001358 * as SD cards will be also erased if the flag {@link #WIPE_EXTERNAL_STORAGE}
1359 * is set.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001360 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001361 * <p>The calling device admin must have requested
1362 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to be able to call
1363 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001364 *
Masanori Oginof535cb042012-02-15 19:25:50 +09001365 * @param flags Bit mask of additional options: currently 0 and
1366 * {@link #WIPE_EXTERNAL_STORAGE} are supported.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001367 */
1368 public void wipeData(int flags) {
1369 if (mService != null) {
1370 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001371 mService.wipeData(flags, UserHandle.myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001372 } catch (RemoteException e) {
1373 Log.w(TAG, "Failed talking with device policy service", e);
1374 }
1375 }
1376 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001377
Dianne Hackbornd6847842010-01-12 18:14:19 -08001378 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07001379 * Called by an application that is administering the device to set the
1380 * global proxy and exclusion list.
1381 * <p>
1382 * The calling device admin must have requested
1383 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
1384 * this method; if it has not, a security exception will be thrown.
1385 * Only the first device admin can set the proxy. If a second admin attempts
1386 * to set the proxy, the {@link ComponentName} of the admin originally setting the
1387 * proxy will be returned. If successful in setting the proxy, null will
1388 * be returned.
1389 * The method can be called repeatedly by the device admin alrady setting the
1390 * proxy to update the proxy and exclusion list.
1391 *
1392 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1393 * with.
1394 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
1395 * Pass Proxy.NO_PROXY to reset the proxy.
1396 * @param exclusionList a list of domains to be excluded from the global proxy.
Oscar Montemayor69238c62010-08-03 10:51:06 -07001397 * @return returns null if the proxy was successfully set, or a {@link ComponentName}
1398 * of the device admin that sets thew proxy otherwise.
Andy Stadlerd2672722011-02-16 10:53:33 -08001399 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07001400 */
1401 public ComponentName setGlobalProxy(ComponentName admin, Proxy proxySpec,
1402 List<String> exclusionList ) {
1403 if (proxySpec == null) {
1404 throw new NullPointerException();
1405 }
1406 if (mService != null) {
1407 try {
1408 String hostSpec;
1409 String exclSpec;
1410 if (proxySpec.equals(Proxy.NO_PROXY)) {
1411 hostSpec = null;
1412 exclSpec = null;
1413 } else {
1414 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
1415 throw new IllegalArgumentException();
1416 }
1417 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
1418 String hostName = sa.getHostName();
1419 int port = sa.getPort();
1420 StringBuilder hostBuilder = new StringBuilder();
1421 hostSpec = hostBuilder.append(hostName)
1422 .append(":").append(Integer.toString(port)).toString();
1423 if (exclusionList == null) {
1424 exclSpec = "";
1425 } else {
1426 StringBuilder listBuilder = new StringBuilder();
1427 boolean firstDomain = true;
1428 for (String exclDomain : exclusionList) {
1429 if (!firstDomain) {
1430 listBuilder = listBuilder.append(",");
1431 } else {
1432 firstDomain = false;
1433 }
1434 listBuilder = listBuilder.append(exclDomain.trim());
1435 }
1436 exclSpec = listBuilder.toString();
1437 }
Yuhao Zheng90704842014-02-28 17:22:45 -08001438 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
1439 != android.net.Proxy.PROXY_VALID)
1440 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07001441 }
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001442 return mService.setGlobalProxy(admin, hostSpec, exclSpec, UserHandle.myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07001443 } catch (RemoteException e) {
1444 Log.w(TAG, "Failed talking with device policy service", e);
1445 }
1446 }
1447 return null;
1448 }
1449
1450 /**
Jason Monk03bc9912014-05-13 09:44:57 -04001451 * Set a network-independent global HTTP proxy. This is not normally what you want
1452 * for typical HTTP proxies - they are generally network dependent. However if you're
1453 * doing something unusual like general internal filtering this may be useful. On
1454 * a private network where the proxy is not accessible, you may break HTTP using this.
1455 *
1456 * <p>This method requires the caller to be the device owner.
1457 *
1458 * <p>This proxy is only a recommendation and it is possible that some apps will ignore it.
1459 * @see ProxyInfo
1460 *
1461 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1462 * with.
1463 * @param proxyInfo The a {@link ProxyInfo} object defining the new global
1464 * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
1465 */
1466 public void setRecommendedGlobalProxy(ComponentName admin, ProxyInfo proxyInfo) {
1467 if (mService != null) {
1468 try {
1469 mService.setRecommendedGlobalProxy(admin, proxyInfo);
1470 } catch (RemoteException e) {
1471 Log.w(TAG, "Failed talking with device policy service", e);
1472 }
1473 }
1474 }
1475
1476 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07001477 * Returns the component name setting the global proxy.
1478 * @return ComponentName object of the device admin that set the global proxy, or
1479 * null if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08001480 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07001481 */
1482 public ComponentName getGlobalProxyAdmin() {
1483 if (mService != null) {
1484 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001485 return mService.getGlobalProxyAdmin(UserHandle.myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07001486 } catch (RemoteException e) {
1487 Log.w(TAG, "Failed talking with device policy service", e);
1488 }
1489 }
1490 return null;
1491 }
1492
1493 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08001494 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001495 * indicating that encryption is not supported.
1496 */
1497 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
1498
1499 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08001500 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001501 * indicating that encryption is supported, but is not currently active.
1502 */
1503 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
1504
1505 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08001506 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001507 * indicating that encryption is not currently active, but is currently
1508 * being activated. This is only reported by devices that support
1509 * encryption of data and only when the storage is currently
1510 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
1511 * to become encrypted will never return this value.
1512 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08001513 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001514
1515 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08001516 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001517 * indicating that encryption is active.
1518 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08001519 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001520
1521 /**
1522 * Activity action: begin the process of encrypting data on the device. This activity should
1523 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
1524 * After resuming from this activity, use {@link #getStorageEncryption}
1525 * to check encryption status. However, on some devices this activity may never return, as
1526 * it may trigger a reboot and in some cases a complete data wipe of the device.
1527 */
1528 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1529 public static final String ACTION_START_ENCRYPTION
1530 = "android.app.action.START_ENCRYPTION";
1531
1532 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07001533 * Widgets are enabled in keyguard
1534 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001535 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07001536
1537 /**
Jim Miller50e62182014-04-23 17:25:00 -07001538 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07001539 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001540 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
1541
1542 /**
1543 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
1544 */
1545 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
1546
1547 /**
Jim Miller50e62182014-04-23 17:25:00 -07001548 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
1549 */
1550 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
1551
1552 /**
1553 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
1554 */
1555 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
1556
1557 /**
1558 * Ignore {@link TrustAgentService} state on secure keyguard screens
1559 * (e.g. PIN/Pattern/Password).
1560 */
1561 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
1562
1563 /**
Jim Miller35207742012-11-02 15:33:20 -07001564 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07001565 */
1566 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07001567
1568 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001569 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08001570 * request that the storage system be encrypted.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001571 *
1572 * <p>When multiple device administrators attempt to control device
1573 * encryption, the most secure, supported setting will always be
1574 * used. If any device administrator requests device encryption,
1575 * it will be enabled; Conversely, if a device administrator
1576 * attempts to disable device encryption while another
1577 * device administrator has enabled it, the call to disable will
1578 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
1579 *
1580 * <p>This policy controls encryption of the secure (application data) storage area. Data
Andy Stadler50c294f2011-03-07 19:13:42 -08001581 * written to other storage areas may or may not be encrypted, and this policy does not require
1582 * or control the encryption of any other storage areas.
1583 * There is one exception: If {@link android.os.Environment#isExternalStorageEmulated()} is
1584 * {@code true}, then the directory returned by
1585 * {@link android.os.Environment#getExternalStorageDirectory()} must be written to disk
1586 * within the encrypted storage area.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001587 *
1588 * <p>Important Note: On some devices, it is possible to encrypt storage without requiring
1589 * the user to create a device PIN or Password. In this case, the storage is encrypted, but
1590 * the encryption key may not be fully secured. For maximum security, the administrator should
1591 * also require (and check for) a pattern, PIN, or password.
1592 *
1593 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1594 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08001595 * @return the new request status (for all active admins) - will be one of
1596 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
1597 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
1598 * {@link #getStorageEncryptionStatus()} to query the actual device state.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001599 */
1600 public int setStorageEncryption(ComponentName admin, boolean encrypt) {
1601 if (mService != null) {
1602 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001603 return mService.setStorageEncryption(admin, encrypt, UserHandle.myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001604 } catch (RemoteException e) {
1605 Log.w(TAG, "Failed talking with device policy service", e);
1606 }
1607 }
1608 return ENCRYPTION_STATUS_UNSUPPORTED;
1609 }
1610
1611 /**
1612 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08001613 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001614 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08001615 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
1616 * this will return the requested encryption setting as an aggregate of all active
1617 * administrators.
1618 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001619 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08001620 public boolean getStorageEncryption(ComponentName admin) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001621 if (mService != null) {
1622 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001623 return mService.getStorageEncryption(admin, UserHandle.myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001624 } catch (RemoteException e) {
1625 Log.w(TAG, "Failed talking with device policy service", e);
1626 }
1627 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08001628 return false;
1629 }
1630
1631 /**
1632 * Called by an application that is administering the device to
1633 * determine the current encryption status of the device.
1634 *
1635 * Depending on the returned status code, the caller may proceed in different
1636 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
1637 * storage system does not support encryption. If the
1638 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
1639 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
1640 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or
1641 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required.
1642 *
1643 * @return current status of encryption. The value will be one of
1644 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
1645 * {@link #ENCRYPTION_STATUS_ACTIVATING}, or{@link #ENCRYPTION_STATUS_ACTIVE}.
1646 */
1647 public int getStorageEncryptionStatus() {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001648 return getStorageEncryptionStatus(UserHandle.myUserId());
1649 }
1650
1651 /** @hide per-user version */
1652 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08001653 if (mService != null) {
1654 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001655 return mService.getStorageEncryptionStatus(userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08001656 } catch (RemoteException e) {
1657 Log.w(TAG, "Failed talking with device policy service", e);
1658 }
1659 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08001660 return ENCRYPTION_STATUS_UNSUPPORTED;
1661 }
1662
1663 /**
Maggie Benthallda51e682013-08-08 22:35:44 -04001664 * Installs the given certificate as a User CA.
1665 *
1666 * @return false if the certBuffer cannot be parsed or installation is
1667 * interrupted, otherwise true
Maggie Benthallda51e682013-08-08 22:35:44 -04001668 */
Robin Lee306fe082014-06-19 14:04:24 +00001669 public boolean installCaCert(ComponentName who, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04001670 if (mService != null) {
1671 try {
Robin Lee306fe082014-06-19 14:04:24 +00001672 return mService.installCaCert(who, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04001673 } catch (RemoteException e) {
1674 Log.w(TAG, "Failed talking with device policy service", e);
1675 }
1676 }
1677 return false;
1678 }
1679
1680 /**
1681 * Uninstalls the given certificate from the list of User CAs, if present.
Maggie Benthallda51e682013-08-08 22:35:44 -04001682 */
Robin Lee306fe082014-06-19 14:04:24 +00001683 public void uninstallCaCert(ComponentName who, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04001684 if (mService != null) {
1685 try {
Robin Lee306fe082014-06-19 14:04:24 +00001686 final String alias = getCaCertAlias(certBuffer);
1687 mService.uninstallCaCert(who, alias);
1688 } catch (CertificateException e) {
1689 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04001690 } catch (RemoteException e) {
1691 Log.w(TAG, "Failed talking with device policy service", e);
1692 }
1693 }
1694 }
1695
1696 /**
1697 * Returns whether there are any user-installed CA certificates.
Maggie Benthallda51e682013-08-08 22:35:44 -04001698 */
Robin Lee306fe082014-06-19 14:04:24 +00001699 public boolean hasAnyCaCertsInstalled() {
Maggie Benthallda51e682013-08-08 22:35:44 -04001700 TrustedCertificateStore certStore = new TrustedCertificateStore();
1701 Set<String> aliases = certStore.userAliases();
1702 return aliases != null && !aliases.isEmpty();
1703 }
1704
1705 /**
1706 * Returns whether this certificate has been installed as a User CA.
Maggie Benthallda51e682013-08-08 22:35:44 -04001707 */
1708 public boolean hasCaCertInstalled(byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04001709 try {
Robin Lee306fe082014-06-19 14:04:24 +00001710 return getCaCertAlias(certBuffer) != null;
Maggie Benthallda51e682013-08-08 22:35:44 -04001711 } catch (CertificateException ce) {
1712 Log.w(TAG, "Could not parse certificate", ce);
1713 }
1714 return false;
1715 }
1716
1717 /**
Robin Lee306fe082014-06-19 14:04:24 +00001718 * Returns the alias of a given CA certificate in the certificate store, or null if it
1719 * doesn't exist.
1720 */
1721 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
1722 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
1723 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
1724 new ByteArrayInputStream(certBuffer));
1725 return new TrustedCertificateStore().getCertificateAlias(cert);
1726 }
1727
1728 /**
Ben Komalo2447edd2011-05-09 16:05:33 -07001729 * Called by an application that is administering the device to disable all cameras
1730 * on the device. After setting this, no applications will be able to access any cameras
1731 * on the device.
1732 *
1733 * <p>The calling device admin must have requested
1734 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call
1735 * this method; if it has not, a security exception will be thrown.
1736 *
1737 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1738 * @param disabled Whether or not the camera should be disabled.
1739 */
1740 public void setCameraDisabled(ComponentName admin, boolean disabled) {
1741 if (mService != null) {
1742 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001743 mService.setCameraDisabled(admin, disabled, UserHandle.myUserId());
Ben Komalo2447edd2011-05-09 16:05:33 -07001744 } catch (RemoteException e) {
1745 Log.w(TAG, "Failed talking with device policy service", e);
1746 }
1747 }
1748 }
1749
1750 /**
1751 * Determine whether or not the device's cameras have been disabled either by the current
1752 * admin, if specified, or all admins.
1753 * @param admin The name of the admin component to check, or null to check if any admins
1754 * have disabled the camera
1755 */
1756 public boolean getCameraDisabled(ComponentName admin) {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001757 return getCameraDisabled(admin, UserHandle.myUserId());
1758 }
1759
1760 /** @hide per-user version */
1761 public boolean getCameraDisabled(ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07001762 if (mService != null) {
1763 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001764 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07001765 } catch (RemoteException e) {
1766 Log.w(TAG, "Failed talking with device policy service", e);
1767 }
1768 }
1769 return false;
1770 }
1771
1772 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07001773 * Called by an application that is administering the device to disable keyguard customizations,
1774 * such as widgets. After setting this, keyguard features will be disabled according to the
1775 * provided feature list.
Jim Millerb8ec4702012-08-31 17:19:10 -07001776 *
1777 * <p>The calling device admin must have requested
Jim Miller48b9b0d2012-09-19 23:16:50 -07001778 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call
Jim Millerb8ec4702012-08-31 17:19:10 -07001779 * this method; if it has not, a security exception will be thrown.
1780 *
1781 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07001782 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
1783 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
Jim Miller50e62182014-04-23 17:25:00 -07001784 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
1785 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
Jim Millerb8ec4702012-08-31 17:19:10 -07001786 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001787 public void setKeyguardDisabledFeatures(ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07001788 if (mService != null) {
1789 try {
Jim Miller48b9b0d2012-09-19 23:16:50 -07001790 mService.setKeyguardDisabledFeatures(admin, which, UserHandle.myUserId());
Jim Millerb8ec4702012-08-31 17:19:10 -07001791 } catch (RemoteException e) {
1792 Log.w(TAG, "Failed talking with device policy service", e);
1793 }
1794 }
1795 }
1796
1797 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07001798 * Determine whether or not features have been disabled in keyguard either by the current
Jim Millerb8ec4702012-08-31 17:19:10 -07001799 * admin, if specified, or all admins.
1800 * @param admin The name of the admin component to check, or null to check if any admins
Jim Miller48b9b0d2012-09-19 23:16:50 -07001801 * have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07001802 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
1803 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07001804 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001805 public int getKeyguardDisabledFeatures(ComponentName admin) {
1806 return getKeyguardDisabledFeatures(admin, UserHandle.myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001807 }
1808
1809 /** @hide per-user version */
Jim Miller48b9b0d2012-09-19 23:16:50 -07001810 public int getKeyguardDisabledFeatures(ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07001811 if (mService != null) {
1812 try {
Jim Miller48b9b0d2012-09-19 23:16:50 -07001813 return mService.getKeyguardDisabledFeatures(admin, userHandle);
Jim Millerb8ec4702012-08-31 17:19:10 -07001814 } catch (RemoteException e) {
1815 Log.w(TAG, "Failed talking with device policy service", e);
1816 }
1817 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07001818 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07001819 }
1820
1821 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001822 * @hide
1823 */
Jessica Hummel6d36b602014-04-04 12:42:17 +01001824 public void setActiveAdmin(ComponentName policyReceiver, boolean refreshing, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001825 if (mService != null) {
1826 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01001827 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001828 } catch (RemoteException e) {
1829 Log.w(TAG, "Failed talking with device policy service", e);
1830 }
1831 }
1832 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001833
Dianne Hackbornd6847842010-01-12 18:14:19 -08001834 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01001835 * @hide
1836 */
1837 public void setActiveAdmin(ComponentName policyReceiver, boolean refreshing) {
1838 setActiveAdmin(policyReceiver, refreshing, UserHandle.myUserId());
1839 }
1840
1841 /**
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001842 * Returns the DeviceAdminInfo as defined by the administrator's package info & meta-data
Dianne Hackbornd6847842010-01-12 18:14:19 -08001843 * @hide
1844 */
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001845 public DeviceAdminInfo getAdminInfo(ComponentName cn) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001846 ActivityInfo ai;
1847 try {
1848 ai = mContext.getPackageManager().getReceiverInfo(cn,
1849 PackageManager.GET_META_DATA);
1850 } catch (PackageManager.NameNotFoundException e) {
1851 Log.w(TAG, "Unable to retrieve device policy " + cn, e);
1852 return null;
1853 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001854
Dianne Hackbornd6847842010-01-12 18:14:19 -08001855 ResolveInfo ri = new ResolveInfo();
1856 ri.activityInfo = ai;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001857
Dianne Hackbornd6847842010-01-12 18:14:19 -08001858 try {
1859 return new DeviceAdminInfo(mContext, ri);
1860 } catch (XmlPullParserException e) {
1861 Log.w(TAG, "Unable to parse device policy " + cn, e);
1862 return null;
1863 } catch (IOException e) {
1864 Log.w(TAG, "Unable to parse device policy " + cn, e);
1865 return null;
1866 }
1867 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001868
Dianne Hackbornd6847842010-01-12 18:14:19 -08001869 /**
1870 * @hide
1871 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001872 public void getRemoveWarning(ComponentName admin, RemoteCallback result) {
1873 if (mService != null) {
1874 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001875 mService.getRemoveWarning(admin, result, UserHandle.myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001876 } catch (RemoteException e) {
1877 Log.w(TAG, "Failed talking with device policy service", e);
1878 }
1879 }
1880 }
1881
1882 /**
1883 * @hide
1884 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001885 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001886 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001887 if (mService != null) {
1888 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001889 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001890 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001891 } catch (RemoteException e) {
1892 Log.w(TAG, "Failed talking with device policy service", e);
1893 }
1894 }
1895 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001896
Dianne Hackbornd6847842010-01-12 18:14:19 -08001897 /**
1898 * @hide
1899 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001900 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001901 if (mService != null) {
1902 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001903 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001904 } catch (RemoteException e) {
1905 Log.w(TAG, "Failed talking with device policy service", e);
1906 }
1907 }
1908 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001909
Dianne Hackbornd6847842010-01-12 18:14:19 -08001910 /**
1911 * @hide
1912 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001913 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001914 if (mService != null) {
1915 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001916 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001917 } catch (RemoteException e) {
1918 Log.w(TAG, "Failed talking with device policy service", e);
1919 }
1920 }
1921 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07001922
1923 /**
1924 * @hide
1925 * Sets the given package as the device owner. The package must already be installed and there
1926 * shouldn't be an existing device owner registered, for this call to succeed. Also, this
1927 * method must be called before the device is provisioned.
1928 * @param packageName the package name of the application to be registered as the device owner.
1929 * @return whether the package was successfully registered as the device owner.
1930 * @throws IllegalArgumentException if the package name is null or invalid
1931 * @throws IllegalStateException if a device owner is already registered or the device has
1932 * already been provisioned.
1933 */
1934 public boolean setDeviceOwner(String packageName) throws IllegalArgumentException,
1935 IllegalStateException {
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04001936 return setDeviceOwner(packageName, null);
1937 }
1938
1939 /**
1940 * @hide
1941 * Sets the given package as the device owner. The package must already be installed and there
1942 * shouldn't be an existing device owner registered, for this call to succeed. Also, this
1943 * method must be called before the device is provisioned.
1944 * @param packageName the package name of the application to be registered as the device owner.
1945 * @param ownerName the human readable name of the institution that owns this device.
1946 * @return whether the package was successfully registered as the device owner.
1947 * @throws IllegalArgumentException if the package name is null or invalid
1948 * @throws IllegalStateException if a device owner is already registered or the device has
1949 * already been provisioned.
1950 */
1951 public boolean setDeviceOwner(String packageName, String ownerName)
1952 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07001953 if (mService != null) {
1954 try {
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04001955 return mService.setDeviceOwner(packageName, ownerName);
Amith Yamasani71e6c692013-03-24 17:39:28 -07001956 } catch (RemoteException re) {
1957 Log.w(TAG, "Failed to set device owner");
1958 }
1959 }
1960 return false;
1961 }
1962
Amith Yamasani3b458ad2013-04-18 18:40:07 -07001963
Amith Yamasani71e6c692013-03-24 17:39:28 -07001964 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07001965 * Used to determine if a particular package has been registered as a Device Owner app.
1966 * A device owner app is a special device admin that cannot be deactivated by the user, once
1967 * activated as a device admin. It also cannot be uninstalled. To check if a particular
1968 * package is currently registered as the device owner app, pass in the package name from
1969 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
1970 * admin apps that want to check if they are also registered as the device owner app. The
1971 * exact mechanism by which a device admin app is registered as a device owner app is defined by
1972 * the setup process.
1973 * @param packageName the package name of the app, to compare with the registered device owner
1974 * app, if any.
1975 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07001976 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07001977 public boolean isDeviceOwnerApp(String packageName) {
Amith Yamasani71e6c692013-03-24 17:39:28 -07001978 if (mService != null) {
1979 try {
1980 return mService.isDeviceOwner(packageName);
1981 } catch (RemoteException re) {
1982 Log.w(TAG, "Failed to check device owner");
1983 }
1984 }
1985 return false;
1986 }
1987
Amith Yamasani3b458ad2013-04-18 18:40:07 -07001988 /**
1989 * @hide
1990 * Redirect to isDeviceOwnerApp.
1991 */
1992 public boolean isDeviceOwner(String packageName) {
1993 return isDeviceOwnerApp(packageName);
1994 }
1995
Jason Monkb0dced82014-06-06 14:36:20 -04001996 /**
1997 * Clears the current device owner. The caller must be the device owner.
1998 *
1999 * This function should be used cautiously as once it is called it cannot
2000 * be undone. The device owner can only be set as a part of device setup
2001 * before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04002002 *
2003 * @param packageName The package name of the device owner.
Jason Monkb0dced82014-06-06 14:36:20 -04002004 */
Jason Monk94d2cf92014-06-18 09:53:34 -04002005 public void clearDeviceOwnerApp(String packageName) {
Jason Monkb0dced82014-06-06 14:36:20 -04002006 if (mService != null) {
2007 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04002008 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04002009 } catch (RemoteException re) {
2010 Log.w(TAG, "Failed to clear device owner");
2011 }
2012 }
2013 }
2014
Amith Yamasani71e6c692013-03-24 17:39:28 -07002015 /** @hide */
2016 public String getDeviceOwner() {
2017 if (mService != null) {
2018 try {
2019 return mService.getDeviceOwner();
2020 } catch (RemoteException re) {
2021 Log.w(TAG, "Failed to get device owner");
2022 }
2023 }
2024 return null;
2025 }
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04002026
2027 /** @hide */
2028 public String getDeviceOwnerName() {
2029 if (mService != null) {
2030 try {
2031 return mService.getDeviceOwnerName();
2032 } catch (RemoteException re) {
2033 Log.w(TAG, "Failed to get device owner");
2034 }
2035 }
2036 return null;
2037 }
Adam Connors776c5552014-01-09 10:42:56 +00002038
2039 /**
2040 * @hide
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05302041 * @SystemApi
2042 * Sets the given component as an active admin and registers the package as the profile
2043 * owner for this user. The package must already be installed and there shouldn't be
2044 * an existing profile owner registered for this user. Also, this method must be called
2045 * before the user setup has been completed.
2046 * <p>
2047 * This method can only be called by system apps that hold MANAGE_USERS permission and
2048 * MANAGE_DEVICE_ADMINS permission.
2049 * @param admin The component to register as an active admin and profile owner.
2050 * @param ownerName The user-visible name of the entity that is managing this user.
2051 * @return whether the admin was successfully registered as the profile owner.
2052 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
2053 * the user has already been set up.
2054 */
2055 public boolean setActiveProfileOwner(ComponentName admin, String ownerName)
2056 throws IllegalArgumentException {
2057 if (mService != null) {
2058 try {
2059 final int myUserId = UserHandle.myUserId();
2060 mService.setActiveAdmin(admin, false, myUserId);
2061 return mService.setProfileOwner(admin.getPackageName(), ownerName, myUserId);
2062 } catch (RemoteException re) {
2063 Log.w(TAG, "Failed to set profile owner " + re);
2064 throw new IllegalArgumentException("Couldn't set profile owner.", re);
2065 }
2066 }
2067 return false;
2068 }
2069
2070 /**
2071 * @hide
Adam Connors776c5552014-01-09 10:42:56 +00002072 * Sets the given package as the profile owner of the given user profile. The package must
2073 * already be installed and there shouldn't be an existing profile owner registered for this
2074 * user. Also, this method must be called before the user has been used for the first time.
2075 * @param packageName the package name of the application to be registered as profile owner.
2076 * @param ownerName the human readable name of the organisation associated with this DPM.
Adam Connors661ec472014-02-11 13:59:46 +00002077 * @param userHandle the userId to set the profile owner for.
Adam Connors776c5552014-01-09 10:42:56 +00002078 * @return whether the package was successfully registered as the profile owner.
2079 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
2080 * the user has already been set up.
2081 */
Adam Connors661ec472014-02-11 13:59:46 +00002082 public boolean setProfileOwner(String packageName, String ownerName, int userHandle)
Adam Connors776c5552014-01-09 10:42:56 +00002083 throws IllegalArgumentException {
2084 if (mService != null) {
2085 try {
Adam Connors661ec472014-02-11 13:59:46 +00002086 return mService.setProfileOwner(packageName, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00002087 } catch (RemoteException re) {
2088 Log.w(TAG, "Failed to set profile owner", re);
2089 throw new IllegalArgumentException("Couldn't set profile owner.", re);
2090 }
2091 }
2092 return false;
2093 }
2094
2095 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01002096 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
2097 * be used. Only the profile owner can call this.
2098 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01002099 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01002100 *
2101 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2102 */
2103 public void setProfileEnabled(ComponentName admin) {
2104 if (mService != null) {
2105 try {
2106 mService.setProfileEnabled(admin);
2107 } catch (RemoteException e) {
2108 Log.w(TAG, "Failed talking with device policy service", e);
2109 }
2110 }
2111 }
2112
2113 /**
Jessica Hummel1333ea12014-06-23 11:20:10 +01002114 * Sets the name of the Managed profile. In the device owner case it sets the name of the user
2115 * which it is called from. Only the profile owner or device owner can call this. If this is
2116 * never called by the profile or device owner, the name will be set to default values.
2117 *
2118 * @see #isProfileOwnerApp
2119 * @see #isDeviceOwnerApp
2120 *
2121 * @param profileName The name of the profile.
2122 */
2123 public void setProfileName(ComponentName who, String profileName) {
2124 if (mService != null) {
2125 try {
2126 mService.setProfileName(who, profileName);
2127 } catch (RemoteException e) {
2128 Log.w(TAG, "Failed talking with device policy service", e);
2129 }
2130 }
2131}
2132
2133 /**
Adam Connors776c5552014-01-09 10:42:56 +00002134 * Used to determine if a particular package is registered as the Profile Owner for the
Alexandra Gherghina512675b2014-04-02 11:23:54 +01002135 * current user. A profile owner is a special device admin that has additional privileges
Adam Connors776c5552014-01-09 10:42:56 +00002136 * within the managed profile.
2137 *
2138 * @param packageName The package name of the app to compare with the registered profile owner.
2139 * @return Whether or not the package is registered as the profile owner.
2140 */
2141 public boolean isProfileOwnerApp(String packageName) {
2142 if (mService != null) {
2143 try {
2144 String profileOwnerPackage = mService.getProfileOwner(
2145 Process.myUserHandle().getIdentifier());
2146 return profileOwnerPackage != null && profileOwnerPackage.equals(packageName);
2147 } catch (RemoteException re) {
2148 Log.w(TAG, "Failed to check profile owner");
2149 }
2150 }
2151 return false;
2152 }
2153
2154 /**
2155 * @hide
2156 * @return the packageName of the owner of the given user profile or null if no profile
2157 * owner has been set for that user.
2158 * @throws IllegalArgumentException if the userId is invalid.
2159 */
2160 public String getProfileOwner() throws IllegalArgumentException {
2161 if (mService != null) {
2162 try {
2163 return mService.getProfileOwner(Process.myUserHandle().getIdentifier());
2164 } catch (RemoteException re) {
2165 Log.w(TAG, "Failed to get profile owner");
2166 throw new IllegalArgumentException(
2167 "Requested profile owner for invalid userId", re);
2168 }
2169 }
2170 return null;
2171 }
2172
2173 /**
2174 * @hide
2175 * @return the human readable name of the organisation associated with this DPM or null if
2176 * one is not set.
2177 * @throws IllegalArgumentException if the userId is invalid.
2178 */
2179 public String getProfileOwnerName() throws IllegalArgumentException {
2180 if (mService != null) {
2181 try {
2182 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
2183 } catch (RemoteException re) {
2184 Log.w(TAG, "Failed to get profile owner");
2185 throw new IllegalArgumentException(
2186 "Requested profile owner for invalid userId", re);
2187 }
2188 }
2189 return null;
2190 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00002191
2192 /**
2193 * Called by a profile owner or device owner to add a default intent handler activity for
2194 * intents that match a certain intent filter. This activity will remain the default intent
2195 * handler even if the set of potential event handlers for the intent filter changes and if
2196 * the intent preferences are reset.
2197 *
2198 * <p>The default disambiguation mechanism takes over if the activity is not installed
2199 * (anymore). When the activity is (re)installed, it is automatically reset as default
2200 * intent handler for the filter.
2201 *
2202 * <p>The calling device admin must be a profile owner or device owner. If it is not, a
2203 * security exception will be thrown.
2204 *
2205 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2206 * @param filter The IntentFilter for which a default handler is added.
2207 * @param activity The Activity that is added as default intent handler.
2208 */
2209 public void addPersistentPreferredActivity(ComponentName admin, IntentFilter filter,
2210 ComponentName activity) {
2211 if (mService != null) {
2212 try {
2213 mService.addPersistentPreferredActivity(admin, filter, activity);
2214 } catch (RemoteException e) {
2215 Log.w(TAG, "Failed talking with device policy service", e);
2216 }
2217 }
2218 }
2219
2220 /**
2221 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00002222 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00002223 *
2224 * <p>The calling device admin must be a profile owner. If it is not, a security
2225 * exception will be thrown.
2226 *
2227 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2228 * @param packageName The name of the package for which preferences are removed.
2229 */
2230 public void clearPackagePersistentPreferredActivities(ComponentName admin,
2231 String packageName) {
2232 if (mService != null) {
2233 try {
2234 mService.clearPackagePersistentPreferredActivities(admin, packageName);
2235 } catch (RemoteException e) {
2236 Log.w(TAG, "Failed talking with device policy service", e);
2237 }
2238 }
2239 }
Robin Lee66e5d962014-04-09 16:44:21 +01002240
2241 /**
2242 * Called by a profile or device owner to set the application restrictions for a given target
2243 * application running in the managed profile.
2244 *
2245 * <p>The provided {@link Bundle} consists of key-value pairs, where the types of values may be
Amith Yamasanic8c84252014-07-13 17:12:12 -07002246 * boolean, int, String, or String[]. The recommended format for keys
Robin Lee66e5d962014-04-09 16:44:21 +01002247 * is "com.example.packagename/example-setting" to avoid naming conflicts with library
2248 * components such as {@link android.webkit.WebView}.
2249 *
2250 * <p>The application restrictions are only made visible to the target application and the
2251 * profile or device owner.
2252 *
2253 * <p>The calling device admin must be a profile or device owner; if it is not, a security
2254 * exception will be thrown.
2255 *
2256 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2257 * @param packageName The name of the package to update restricted settings for.
2258 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
2259 * set of active restrictions.
2260 */
2261 public void setApplicationRestrictions(ComponentName admin, String packageName,
2262 Bundle settings) {
2263 if (mService != null) {
2264 try {
2265 mService.setApplicationRestrictions(admin, packageName, settings);
2266 } catch (RemoteException e) {
2267 Log.w(TAG, "Failed talking with device policy service", e);
2268 }
2269 }
2270 }
2271
2272 /**
Nicolas Prevot81948992014-05-16 18:25:26 +01002273 * Called by the profile owner so that some intents sent in the managed profile can also be
2274 * resolved in the parent, or vice versa.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002275 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01002276 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
2277 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01002278 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
2279 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002280 */
Nicolas Prevot81948992014-05-16 18:25:26 +01002281 public void addCrossProfileIntentFilter(ComponentName admin, IntentFilter filter, int flags) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002282 if (mService != null) {
2283 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01002284 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002285 } catch (RemoteException e) {
2286 Log.w(TAG, "Failed talking with device policy service", e);
2287 }
2288 }
2289 }
2290
2291 /**
Nicolas Prevot81948992014-05-16 18:25:26 +01002292 * Called by a profile owner to remove the cross-profile intent filters from the managed profile
2293 * and from the parent.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002294 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2295 */
Nicolas Prevot81948992014-05-16 18:25:26 +01002296 public void clearCrossProfileIntentFilters(ComponentName admin) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002297 if (mService != null) {
2298 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01002299 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00002300 } catch (RemoteException e) {
2301 Log.w(TAG, "Failed talking with device policy service", e);
2302 }
2303 }
2304 }
2305
2306 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04002307 * Called by a device owner to create a user with the specified name. The UserHandle returned
2308 * by this method should not be persisted as user handles are recycled as users are removed and
2309 * created. If you need to persist an identifier for this user, use
2310 * {@link UserManager#getSerialNumberForUser}.
2311 *
2312 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2313 * @param name the user's name
2314 * @see UserHandle
2315 * @return the UserHandle object for the created user, or null if the user could not be created.
2316 */
2317 public UserHandle createUser(ComponentName admin, String name) {
2318 try {
2319 return mService.createUser(admin, name);
2320 } catch (RemoteException re) {
2321 Log.w(TAG, "Could not create a user", re);
2322 }
2323 return null;
2324 }
2325
2326 /**
Jason Monk03978a42014-06-10 15:05:30 -04002327 * Called by a device owner to create a user with the specified name. The UserHandle returned
2328 * by this method should not be persisted as user handles are recycled as users are removed and
2329 * created. If you need to persist an identifier for this user, use
2330 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
2331 * immediately.
2332 *
2333 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
2334 * as registered as an active admin on the new user. The profile owner package will be
2335 * installed on the new user if it already is installed on the device.
2336 *
2337 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
2338 * profileOwnerComponent when onEnable is called.
2339 *
2340 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2341 * @param name the user's name
2342 * @param ownerName the human readable name of the organisation associated with this DPM.
2343 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
2344 * the user.
2345 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
2346 * on the new user.
2347 * @see UserHandle
2348 * @return the UserHandle object for the created user, or null if the user could not be created.
2349 */
2350 public UserHandle createAndInitializeUser(ComponentName admin, String name, String ownerName,
2351 ComponentName profileOwnerComponent, Bundle adminExtras) {
2352 try {
2353 return mService.createAndInitializeUser(admin, name, ownerName, profileOwnerComponent,
2354 adminExtras);
2355 } catch (RemoteException re) {
2356 Log.w(TAG, "Could not create a user", re);
2357 }
2358 return null;
2359 }
2360
2361 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04002362 * Called by a device owner to remove a user and all associated data. The primary user can
2363 * not be removed.
2364 *
2365 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2366 * @param userHandle the user to remove.
2367 * @return {@code true} if the user was removed, {@code false} otherwise.
2368 */
2369 public boolean removeUser(ComponentName admin, UserHandle userHandle) {
2370 try {
2371 return mService.removeUser(admin, userHandle);
2372 } catch (RemoteException re) {
2373 Log.w(TAG, "Could not remove user ", re);
2374 return false;
2375 }
2376 }
2377
2378 /**
Jason Monk582d9112014-07-09 19:57:08 -04002379 * Called by a device owner to switch the specified user to the foreground.
2380 *
2381 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2382 * @param userHandle the user to switch to; null will switch to primary.
2383 * @return {@code true} if the switch was successful, {@code false} otherwise.
2384 *
2385 * @see Intent#ACTION_USER_FOREGROUND
2386 */
2387 public boolean switchUser(ComponentName admin, UserHandle userHandle) {
2388 try {
2389 return mService.switchUser(admin, userHandle);
2390 } catch (RemoteException re) {
2391 Log.w(TAG, "Could not switch user ", re);
2392 return false;
2393 }
2394 }
2395
2396 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002397 * Called by a profile or device owner to get the application restrictions for a given target
2398 * application running in the managed profile.
2399 *
2400 * <p>The calling device admin must be a profile or device owner; if it is not, a security
2401 * exception will be thrown.
2402 *
2403 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2404 * @param packageName The name of the package to fetch restricted settings of.
2405 * @return {@link Bundle} of settings corresponding to what was set last time
2406 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty {@link Bundle}
2407 * if no restrictions have been set.
2408 */
2409 public Bundle getApplicationRestrictions(ComponentName admin, String packageName) {
2410 if (mService != null) {
2411 try {
2412 return mService.getApplicationRestrictions(admin, packageName);
2413 } catch (RemoteException e) {
2414 Log.w(TAG, "Failed talking with device policy service", e);
2415 }
2416 }
2417 return null;
2418 }
Amith Yamasanibe465322014-04-24 13:45:17 -07002419
2420 /**
2421 * Called by a profile or device owner to set a user restriction specified
2422 * by the key.
2423 * <p>
2424 * The calling device admin must be a profile or device owner; if it is not,
2425 * a security exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07002426 *
Amith Yamasanibe465322014-04-24 13:45:17 -07002427 * @param admin Which {@link DeviceAdminReceiver} this request is associated
2428 * with.
2429 * @param key The key of the restriction. See the constants in
2430 * {@link android.os.UserManager} for the list of keys.
2431 */
2432 public void addUserRestriction(ComponentName admin, String key) {
2433 if (mService != null) {
2434 try {
2435 mService.setUserRestriction(admin, key, true);
2436 } catch (RemoteException e) {
2437 Log.w(TAG, "Failed talking with device policy service", e);
2438 }
2439 }
2440 }
2441
2442 /**
2443 * Called by a profile or device owner to clear a user restriction specified
2444 * by the key.
2445 * <p>
2446 * The calling device admin must be a profile or device owner; if it is not,
2447 * a security exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07002448 *
Amith Yamasanibe465322014-04-24 13:45:17 -07002449 * @param admin Which {@link DeviceAdminReceiver} this request is associated
2450 * with.
2451 * @param key The key of the restriction. See the constants in
2452 * {@link android.os.UserManager} for the list of keys.
2453 */
2454 public void clearUserRestriction(ComponentName admin, String key) {
2455 if (mService != null) {
2456 try {
2457 mService.setUserRestriction(admin, key, false);
2458 } catch (RemoteException e) {
2459 Log.w(TAG, "Failed talking with device policy service", e);
2460 }
2461 }
2462 }
Adam Connors010cfd42014-04-16 12:48:13 +01002463
2464 /**
Julia Reynolds966881e2014-05-14 12:23:08 -04002465 * Called by device or profile owner to block or unblock packages. When a package is blocked it
2466 * is unavailable for use, but the data and actual package file remain.
2467 *
2468 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2469 * @param packageName The name of the package to block or unblock.
2470 * @param blocked {@code true} if the package should be blocked, {@code false} if it should be
2471 * unblocked.
2472 * @return boolean Whether the blocked setting of the package was successfully updated.
2473 */
2474 public boolean setApplicationBlocked(ComponentName admin, String packageName,
2475 boolean blocked) {
2476 if (mService != null) {
2477 try {
2478 return mService.setApplicationBlocked(admin, packageName, blocked);
2479 } catch (RemoteException e) {
2480 Log.w(TAG, "Failed talking with device policy service", e);
2481 }
2482 }
2483 return false;
2484 }
2485
2486 /**
2487 * Called by profile or device owner to block or unblock currently installed packages. This
2488 * should only be called by a profile or device owner running within a managed profile.
2489 *
2490 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2491 * @param intent An intent matching the app(s) to be updated. All apps that resolve for this
2492 * intent will be updated in the current profile.
2493 * @param blocked {@code true} if the packages should be blocked, {@code false} if they should
2494 * be unblocked.
2495 * @return int The number of activities that matched the intent and were updated.
2496 */
2497 public int setApplicationsBlocked(ComponentName admin, Intent intent, boolean blocked) {
2498 if (mService != null) {
2499 try {
2500 return mService.setApplicationsBlocked(admin, intent, blocked);
2501 } catch (RemoteException e) {
2502 Log.w(TAG, "Failed talking with device policy service", e);
2503 }
2504 }
2505 return 0;
2506 }
2507
2508 /**
2509 * Called by device or profile owner to determine if a package is blocked.
2510 *
2511 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2512 * @param packageName The name of the package to retrieve the blocked status of.
2513 * @return boolean {@code true} if the package is blocked, {@code false} otherwise.
2514 */
2515 public boolean isApplicationBlocked(ComponentName admin, String packageName) {
2516 if (mService != null) {
2517 try {
2518 return mService.isApplicationBlocked(admin, packageName);
2519 } catch (RemoteException e) {
2520 Log.w(TAG, "Failed talking with device policy service", e);
2521 }
2522 }
2523 return false;
2524 }
2525
2526 /**
Adam Connors655be2a2014-07-14 09:01:25 +00002527 * Called by profile or device owner to re-enable a system app that was disabled by default
2528 * when the managed profile was created. This can only be called from a profile or device
2529 * owner running within a managed profile.
2530 *
2531 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2532 * @param packageName The package to be re-enabled in the current profile.
2533 */
2534 public void enableSystemApp(ComponentName admin, String packageName) {
2535 if (mService != null) {
2536 try {
2537 mService.enableSystemApp(admin, packageName);
2538 } catch (RemoteException e) {
2539 Log.w(TAG, "Failed to install package: " + packageName);
2540 }
2541 }
2542 }
2543
2544 /**
2545 * Called by profile or device owner to re-enable system apps by intent that were disabled
2546 * by default when the managed profile was created. This can only be called from a profile
2547 * or device owner running within a managed profile.
2548 *
2549 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2550 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
2551 * intent will be re-enabled in the current profile.
2552 * @return int The number of activities that matched the intent and were installed.
2553 */
2554 public int enableSystemApp(ComponentName admin, Intent intent) {
2555 if (mService != null) {
2556 try {
2557 return mService.enableSystemAppWithIntent(admin, intent);
2558 } catch (RemoteException e) {
2559 Log.w(TAG, "Failed to install packages matching filter: " + intent);
2560 }
2561 }
2562 return 0;
2563 }
2564
2565 /**
Sander Alewijnse650c3342014-05-08 18:00:50 +01002566 * Called by a profile owner to disable account management for a specific type of account.
2567 *
2568 * <p>The calling device admin must be a profile owner. If it is not, a
2569 * security exception will be thrown.
2570 *
2571 * <p>When account management is disabled for an account type, adding or removing an account
2572 * of that type will not be possible.
2573 *
2574 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2575 * @param accountType For which account management is disabled or enabled.
2576 * @param disabled The boolean indicating that account management will be disabled (true) or
2577 * enabled (false).
2578 */
2579 public void setAccountManagementDisabled(ComponentName admin, String accountType,
2580 boolean disabled) {
2581 if (mService != null) {
2582 try {
2583 mService.setAccountManagementDisabled(admin, accountType, disabled);
2584 } catch (RemoteException e) {
2585 Log.w(TAG, "Failed talking with device policy service", e);
2586 }
2587 }
2588 }
2589
2590 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01002591 * Gets the array of accounts for which account management is disabled by the profile owner.
2592 *
2593 * <p> Account management can be disabled/enabled by calling
2594 * {@link #setAccountManagementDisabled}.
2595 *
2596 * @return a list of account types for which account management has been disabled.
2597 *
2598 * @see #setAccountManagementDisabled
2599 */
2600 public String[] getAccountTypesWithManagementDisabled() {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01002601 return getAccountTypesWithManagementDisabledAsUser(UserHandle.getCallingUserId());
2602 }
2603
2604 /**
2605 * @see #getAccountTypesWithManagementDisabled()
2606 * @hide
2607 */
2608 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01002609 if (mService != null) {
2610 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01002611 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01002612 } catch (RemoteException e) {
2613 Log.w(TAG, "Failed talking with device policy service", e);
2614 }
2615 }
2616
2617 return null;
2618 }
justinzhang511e0d82014-03-24 16:09:24 -04002619
2620 /**
Jason Monkd7b86212014-06-16 13:15:38 -04002621 * Sets which packages may enter lock task mode.
2622 *
2623 * <p>Any packages that shares uid with an allowed package will also be allowed
2624 * to activate lock task.
justinzhang511e0d82014-03-24 16:09:24 -04002625 *
Jason Monkc5185f22014-06-24 11:12:42 -04002626 * This function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04002627 * @param packages The list of packages allowed to enter lock task mode
2628 *
2629 * @see Activity#startLockTask()
Jason Monk1c7c3192014-06-26 12:52:18 -04002630 * @see DeviceAdminReceiver#onLockTaskModeChanged(Context, Intent, boolean, String)
2631 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04002632 */
Jason Monkd7b86212014-06-16 13:15:38 -04002633 public void setLockTaskPackages(String[] packages) throws SecurityException {
justinzhang511e0d82014-03-24 16:09:24 -04002634 if (mService != null) {
2635 try {
Jason Monkd7b86212014-06-16 13:15:38 -04002636 mService.setLockTaskPackages(packages);
justinzhang511e0d82014-03-24 16:09:24 -04002637 } catch (RemoteException e) {
2638 Log.w(TAG, "Failed talking with device policy service", e);
2639 }
2640 }
2641 }
2642
2643 /**
Jason Monkd7b86212014-06-16 13:15:38 -04002644 * This function returns the list of packages allowed to start the lock task mode.
justinzhang511e0d82014-03-24 16:09:24 -04002645 * @hide
2646 */
Jason Monkd7b86212014-06-16 13:15:38 -04002647 public String[] getLockTaskPackages() {
justinzhang511e0d82014-03-24 16:09:24 -04002648 if (mService != null) {
2649 try {
Jason Monkd7b86212014-06-16 13:15:38 -04002650 return mService.getLockTaskPackages();
justinzhang511e0d82014-03-24 16:09:24 -04002651 } catch (RemoteException e) {
2652 Log.w(TAG, "Failed talking with device policy service", e);
2653 }
2654 }
2655 return null;
2656 }
2657
2658 /**
2659 * This function lets the caller know whether the given component is allowed to start the
2660 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04002661 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04002662 */
Jason Monkd7b86212014-06-16 13:15:38 -04002663 public boolean isLockTaskPermitted(String pkg) {
justinzhang511e0d82014-03-24 16:09:24 -04002664 if (mService != null) {
2665 try {
Jason Monkd7b86212014-06-16 13:15:38 -04002666 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04002667 } catch (RemoteException e) {
2668 Log.w(TAG, "Failed talking with device policy service", e);
2669 }
2670 }
2671 return false;
2672 }
Julia Reynoldsda551652014-05-14 17:15:16 -04002673
2674 /**
2675 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
2676 * of the setting is in the correct form for the setting type should be performed by the caller.
2677 *
2678 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2679 * @param setting The name of the setting to update.
2680 * @param value The value to update the setting to.
2681 */
2682 public void setGlobalSetting(ComponentName admin, String setting, String value) {
2683 if (mService != null) {
2684 try {
2685 mService.setGlobalSetting(admin, setting, value);
2686 } catch (RemoteException e) {
2687 Log.w(TAG, "Failed talking with device policy service", e);
2688 }
2689 }
2690 }
2691
2692 /**
2693 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
2694 * that the value of the setting is in the correct form for the setting type should be performed
2695 * by the caller.
2696 *
2697 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2698 * @param setting The name of the setting to update.
2699 * @param value The value to update the setting to.
2700 */
2701 public void setSecureSetting(ComponentName admin, String setting, String value) {
2702 if (mService != null) {
2703 try {
2704 mService.setSecureSetting(admin, setting, value);
2705 } catch (RemoteException e) {
2706 Log.w(TAG, "Failed talking with device policy service", e);
2707 }
2708 }
2709 }
2710
Amith Yamasanif20d6402014-05-24 15:34:37 -07002711 /**
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07002712 * Designates a specific service component as the provider for
Amith Yamasanif20d6402014-05-24 15:34:37 -07002713 * making permission requests of a local or remote administrator of the user.
2714 * <p/>
2715 * Only a profile owner can designate the restrictions provider.
2716 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07002717 * @param provider The component name of the service that implements
2718 * {@link AbstractRestrictionsProvider}. If this param is null,
Amith Yamasanif20d6402014-05-24 15:34:37 -07002719 * it removes the restrictions provider previously assigned.
2720 */
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07002721 public void setRestrictionsProvider(ComponentName admin, ComponentName provider) {
Amith Yamasanif20d6402014-05-24 15:34:37 -07002722 if (mService != null) {
2723 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07002724 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07002725 } catch (RemoteException re) {
2726 Log.w(TAG, "Failed to set permission provider on device policy service");
2727 }
2728 }
2729 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04002730
2731 /**
2732 * Called by profile or device owners to set the master volume mute on or off.
2733 *
2734 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2735 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
2736 */
2737 public void setMasterVolumeMuted(ComponentName admin, boolean on) {
2738 if (mService != null) {
2739 try {
2740 mService.setMasterVolumeMuted(admin, on);
2741 } catch (RemoteException re) {
2742 Log.w(TAG, "Failed to setMasterMute on device policy service");
2743 }
2744 }
2745 }
2746
2747 /**
2748 * Called by profile or device owners to check whether the master volume mute is on or off.
2749 *
2750 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2751 * @return {@code true} if master volume is muted, {@code false} if it's not.
2752 */
2753 public boolean isMasterVolumeMuted(ComponentName admin) {
2754 if (mService != null) {
2755 try {
2756 return mService.isMasterVolumeMuted(admin);
2757 } catch (RemoteException re) {
2758 Log.w(TAG, "Failed to get isMasterMute on device policy service");
2759 }
2760 }
2761 return false;
2762 }
Kenny Guyc13053b2014-05-29 14:17:17 +01002763
2764 /**
2765 * Called by profile or device owners to change whether a user can uninstall
2766 * a package.
2767 *
2768 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2769 * @param packageName package to change.
2770 * @param blockUninstall true if the user shouldn't be able to uninstall the package.
2771 */
2772 public void setBlockUninstall(ComponentName admin, String packageName, boolean blockUninstall) {
2773 if (mService != null) {
2774 try {
2775 mService.setBlockUninstall(admin, packageName, blockUninstall);
2776 } catch (RemoteException re) {
2777 Log.w(TAG, "Failed to call block uninstall on device policy service");
2778 }
2779 }
2780 }
2781
2782 /**
2783 * Called by profile or device owners to check whether a user has been blocked from
2784 * uninstalling a package.
2785 *
2786 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2787 * @param packageName package to check.
2788 * @return true if the user shouldn't be able to uninstall the package.
2789 */
2790 public boolean getBlockUninstall(ComponentName admin, String packageName) {
2791 if (mService != null) {
2792 try {
2793 return mService.getBlockUninstall(admin, packageName);
2794 } catch (RemoteException re) {
2795 Log.w(TAG, "Failed to call block uninstall on device policy service");
2796 }
2797 }
2798 return false;
2799 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08002800}