blob: 74fe13ac19613392e93d765bdb9ed526c27c5093 [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
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000019import android.annotation.ColorInt;
Alan Treadwayafad8782016-01-19 15:15:08 +000020import android.annotation.IntDef;
Robin Lee25e26452015-06-02 09:56:29 -070021import android.annotation.NonNull;
22import android.annotation.Nullable;
Dianne Hackbornd6847842010-01-12 18:14:19 -080023import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
Justin Moreyb5deda72014-07-24 10:53:40 -050025import android.annotation.SystemApi;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000026import android.annotation.UserIdInt;
Jason Monkd7b86212014-06-16 13:15:38 -040027import android.app.Activity;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000028import android.auditing.SecurityLog;
29import android.auditing.SecurityLog.SecurityEvent;
Dianne Hackbornd6847842010-01-12 18:14:19 -080030import android.content.ComponentName;
31import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010032import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000033import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080034import android.content.pm.ActivityInfo;
35import android.content.pm.PackageManager;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000036import android.content.pm.ParceledListSlice;
Dianne Hackbornd6847842010-01-12 18:14:19 -080037import android.content.pm.ResolveInfo;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000038import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050039import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040040import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000041import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010042import android.os.Bundle;
Jim Millere303bf42014-08-26 17:12:29 -070043import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000044import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080045import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080046import android.os.RemoteException;
47import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070048import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040049import android.os.UserManager;
Ricky Wai494b95d2015-11-20 16:07:15 +000050import android.provider.ContactsContract.Directory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000051import android.provider.Settings;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010052import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070053import android.service.restrictions.RestrictionsReceiver;
Dianne Hackbornd6847842010-01-12 18:14:19 -080054import android.util.Log;
55
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070056import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040057import com.android.org.conscrypt.TrustedCertificateStore;
58
Jessica Hummel91da58d2014-04-10 17:39:43 +010059import org.xmlpull.v1.XmlPullParserException;
60
Maggie Benthallda51e682013-08-08 22:35:44 -040061import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080062import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000063import java.lang.annotation.Retention;
64import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070065import java.net.InetSocketAddress;
66import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010067import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000068import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010069import java.security.PrivateKey;
70import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040071import java.security.cert.CertificateException;
72import java.security.cert.CertificateFactory;
73import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010074import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000075import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070076import java.util.ArrayList;
Svetoslav976e8bd2014-07-16 15:12:03 -070077import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080078import java.util.List;
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +010079import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080080
81/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000082 * Public interface for managing policies enforced on a device. Most clients of this class must be
83 * registered with the system as a
Benjamin Franz6cdb27e2015-02-26 12:26:53 +000084 * <a href="{@docRoot}guide/topics/admin/device-admin.html">device administrator</a>. Additionally,
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000085 * a device administrator may be registered as either a profile or device owner. A given method is
86 * accessible to all device administrators unless the documentation for that method specifies that
87 * it is restricted to either device or profile owners.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080088 *
89 * <div class="special reference">
90 * <h3>Developer Guides</h3>
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000091 * <p>For more information about managing policies for device administration, read the
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080092 * <a href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a>
Robin Lee25e26452015-06-02 09:56:29 -070093 * developer guide.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080094 * </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080095 */
96public class DevicePolicyManager {
97 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -080098
99 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -0800100 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +0000101 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700102
Makoto Onukic8a5a552015-11-19 14:29:12 -0800103 private static final String REMOTE_EXCEPTION_MESSAGE =
104 "Failed to talk with device policy manager service";
105
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000106 private DevicePolicyManager(Context context, boolean parentInstance) {
Esteban Talavera62399912016-01-11 15:37:55 +0000107 this(context,
108 IDevicePolicyManager.Stub.asInterface(
109 ServiceManager.getService(Context.DEVICE_POLICY_SERVICE)),
110 parentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800111 }
112
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800113 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700114 @VisibleForTesting
Esteban Talavera62399912016-01-11 15:37:55 +0000115 protected DevicePolicyManager(
116 Context context, IDevicePolicyManager service, boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700117 mContext = context;
118 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000119 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700120 }
121
122 /** @hide */
123 public static DevicePolicyManager create(Context context) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000124 DevicePolicyManager me = new DevicePolicyManager(context, false);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800125 return me.mService != null ? me : null;
126 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700127
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700128 /** @hide test will override it. */
129 @VisibleForTesting
130 protected int myUserId() {
131 return UserHandle.myUserId();
132 }
133
Dianne Hackbornd6847842010-01-12 18:14:19 -0800134 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000135 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000136 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100137 * <p>A managed profile allows data separation for example for the usage of a
138 * device as a personal and corporate device. The user which provisioning is started from and
139 * the managed profile share a launcher.
140 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800141 * <p>This intent will typically be sent by a mobile device management application (MDM).
142 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
143 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100144 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000145 * <p>It is possible to check if provisioning is allowed or not by querying the method
146 * {@link #isProvisioningAllowed(String)}.
147 *
148 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000149 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700150 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000151 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
152 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000153 *
154 * <p> The intent may also contain the following extras:
155 * <ul>
156 * <li> {@link #EXTRA_PROVISIONING_LOGO_URI}, optional </li>
157 * <li> {@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional </li>
158 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000159 *
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000160 * <p> When managed provisioning has completed, broadcasts are sent to the application specified
161 * in the provisioning intent. The
162 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
163 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
164 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100165 *
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100166 * <p> If provisioning fails, the managedProfile is removed so the device returns to its
167 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100168 *
169 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
170 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
171 * the provisioning flow was successful, although this doesn't guarantee the full flow will
172 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
173 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000174 */
175 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
176 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100177 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000178
179 /**
Mahaver Chopra5e732562015-11-05 11:55:12 +0000180 * @hide
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000181 * Activity action: Starts the provisioning flow which sets up a managed user.
182 *
183 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800184 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000185 * owner who has full control over the user. Provisioning can only happen before user setup has
186 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
187 * allowed.
188 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000189 * <p>This intent should contain the extra
190 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000191 *
192 * <p> If provisioning fails, the device returns to its previous state.
193 *
194 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
195 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
196 * the provisioning flow was successful, although this doesn't guarantee the full flow will
197 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
198 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Mahaver Chopra5e732562015-11-05 11:55:12 +0000199 */
200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
201 public static final String ACTION_PROVISION_MANAGED_USER
202 = "android.app.action.PROVISION_MANAGED_USER";
203
204 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100205 * Activity action: Starts the provisioning flow which sets up a managed device.
206 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
207 *
208 * <p> During device owner provisioning a device admin app is set as the owner of the device.
209 * A device owner has full control over the device. The device owner can not be modified by the
210 * user.
211 *
212 * <p> A typical use case would be a device that is owned by a company, but used by either an
213 * employee or client.
214 *
215 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000216 * It is possible to check if provisioning is allowed or not by querying the method
217 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100218 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000219 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100220 * <ul>
221 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
222 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
223 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100224 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000225 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000226 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100227 * </ul>
228 *
229 * <p> When device owner provisioning has completed, an intent of the type
230 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
231 * device owner.
232 *
233 * <p> If provisioning fails, the device is factory reset.
234 *
Alan Treadway4582f812015-07-28 11:49:35 +0100235 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
236 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
237 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
238 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100239 */
240 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
241 public static final String ACTION_PROVISION_MANAGED_DEVICE
242 = "android.app.action.PROVISION_MANAGED_DEVICE";
243
244 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000245 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000246 *
247 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
248 * the device. A device owner has full control over the device. The device owner can not be
249 * modified by the user and the only way of resetting the device is via factory reset.
250 *
251 * <p>A typical use case would be a device that is owned by a company, but used by either an
252 * employee or client.
253 *
254 * <p>The provisioning message should be sent to an unprovisioned device.
255 *
256 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
257 * by a privileged app with the permission
258 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
259 *
260 * <p>The provisioning intent contains the following properties:
261 * <ul>
262 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
263 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
264 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
265 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
266 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
267 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
268 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
269 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
270 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
271 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
272 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
273 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
274 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
275 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
276 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
277 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
278 *
279 * @hide
280 */
281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
282 @SystemApi
283 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
284 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
285
286 /**
287 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000288 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
289 *
290 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
291 * management state that is distinct from that reached by
292 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
293 * user, and only has control over device-wide policies, not individual users and their data.
294 * The primary benefit is that multiple non-system users are supported when provisioning using
295 * this form of device management.
296 *
297 * <p> During device owner provisioning a device admin app is set as the owner of the device.
298 * A device owner has full control over the device. The device owner can not be modified by the
299 * user.
300 *
301 * <p> A typical use case would be a device that is owned by a company, but used by either an
302 * employee or client.
303 *
304 * <p> An intent with this action can be sent only on an unprovisioned device.
305 * It is possible to check if provisioning is allowed or not by querying the method
306 * {@link #isProvisioningAllowed(String)}.
307 *
308 * <p>The intent contains the following extras:
309 * <ul>
310 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
311 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
312 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
313 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
314 * </ul>
315 *
316 * <p> When device owner provisioning has completed, an intent of the type
317 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
318 * device owner.
319 *
320 * <p> If provisioning fails, the device is factory reset.
321 *
322 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
323 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
324 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
325 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
326 *
327 * @hide
328 */
329 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
330 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
331 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
332
333 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000334 * Activity action: Finalizes management provisioning, should be used after user-setup
335 * has been completed and {@link #getUserProvisioningState()} returns one of:
336 * <ul>
337 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
338 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
339 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
340 * </ul>
341 *
342 * @hide
343 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000344 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000345 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
346 public static final String ACTION_PROVISION_FINALIZATION
347 = "android.app.action.PROVISION_FINALIZATION";
348
349 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100350 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100351 * allows a mobile device management application or NFC programmer application which starts
352 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100353 * <p>
354 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
355 * sends the intent to pass data to itself on the newly created profile.
356 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
357 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100358 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
359 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
360 * message should contain a stringified {@link java.util.Properties} instance, whose string
361 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
362 * management application after provisioning.
363 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100364 * <p>
365 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700366 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
367 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100368 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100369 */
370 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100371 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100372
373 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100374 * A String extra holding the package name of the mobile device management application that
375 * will be set as the profile owner or device owner.
376 *
377 * <p>If an application starts provisioning directly via an intent with action
378 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
379 * application that started provisioning. The package will be set as profile owner in that case.
380 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000381 * <p>This package is set as device owner when device owner provisioning is started by an NFC
382 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000383 *
384 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700385 * This receiver will be set as the profile or device owner and active admin.
Nicolas Prevot18440252015-03-09 14:07:17 +0000386
387 * @see DeviceAdminReceiver
388 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100389 * supported, but only if there is only one device admin receiver in the package that requires
390 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000391 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000392 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000393 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100394 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000395
396 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000397 * A ComponentName extra indicating the device admin receiver of the mobile device management
398 * application that will be set as the profile owner or device owner and active admin.
399 *
400 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100401 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
402 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
403 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000404 *
405 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100406 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
407 * message containing an NFC record with MIME type
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400408 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name should be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000409 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000410 *
411 * @see DeviceAdminReceiver
412 */
413 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
414 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
415
416 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000417 * An {@link android.accounts.Account} extra holding the account to migrate during managed
418 * profile provisioning. If the account supplied is present in the primary user, it will be
419 * copied, along with its credentials to the managed profile and removed from the primary user.
420 *
421 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
422 */
423
424 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
425 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
426
427 /**
Jessica Hummele3da7902014-08-20 15:20:11 +0100428 * A String extra that, holds the email address of the account which a managed profile is
429 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
430 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100431 *
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100432 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
433 *
Jessica Hummele3da7902014-08-20 15:20:11 +0100434 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
435 * contains this extra, it is forwarded in the
436 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
437 * device management application that was set as the profile owner during provisioning.
438 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100439 */
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100440 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
441 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100442
443 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000444 * A integer extra indicating the predominant color to show during the provisioning.
445 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000446 *
447 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
448 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
449 */
450 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
451 "android.app.extra.PROVISIONING_MAIN_COLOR";
452
453 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000454 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700455 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000456 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100457 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
458 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000459 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000460 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
461 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000462
463 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100464 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
465 * will be set to.
466 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000467 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
468 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100469 */
470 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100471 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100472
473 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100474 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
475 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100476 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000477 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
478 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100479 */
480 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100481 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100482
483 /**
484 * A String extra holding the {@link java.util.Locale} that the device will be set to.
485 * Format: xx_yy, where xx is the language code, and yy the country code.
486 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000487 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
488 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100489 */
490 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100491 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100492
493 /**
494 * A String extra holding the ssid of the wifi network that should be used during nfc device
495 * owner provisioning for downloading the mobile device management application.
496 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000497 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
498 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100499 */
500 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100501 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100502
503 /**
504 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
505 * is hidden or not.
506 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000507 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
508 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100509 */
510 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100511 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100512
513 /**
514 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100515 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
516 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100517 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000518 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
519 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100520 */
521 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100522 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100523
524 /**
525 * A String extra holding the password of the wifi network in
526 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
527 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000528 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
529 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100530 */
531 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100532 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100533
534 /**
535 * A String extra holding the proxy host for the wifi network in
536 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
537 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000538 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
539 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100540 */
541 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100542 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100543
544 /**
545 * An int extra holding the proxy port for the wifi network in
546 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
547 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000548 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
549 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100550 */
551 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100552 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100553
554 /**
555 * A String extra holding the proxy bypass for the wifi network in
556 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
557 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000558 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
559 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100560 */
561 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100562 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100563
564 /**
565 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
566 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
567 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000568 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
569 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100570 */
571 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100572 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100573
574 /**
575 * A String extra holding a url that specifies the download location of the device admin
576 * package. When not provided it is assumed that the device admin package is already installed.
577 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000578 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
579 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100580 */
581 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100582 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100583
584 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400585 * An int extra holding a minimum required version code for the device admin package. If the
586 * device admin is already installed on the device, it will only be re-downloaded from
587 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
588 * installed package is less than this version code.
589 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400590 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400591 * provisioning via an NFC bump.
592 */
593 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
594 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
595
596 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100597 * A String extra holding a http cookie header which should be used in the http request to the
598 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
599 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000600 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
601 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100602 */
603 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100604 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100605
606 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100607 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
608 * the file at download location specified in
609 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100610 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100611 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} should be
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100612 * present. The provided checksum should match the checksum of the file at the download
613 * location. If the checksum doesn't match an error will be shown to the user and the user will
614 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100615 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000616 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
617 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100618 *
619 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
620 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700621 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100622 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100623 */
624 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100625 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100626
627 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100628 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100629 * android package archive at the download location specified in {@link
630 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
631 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100632 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100633 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
634 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
635 *
636 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} should be
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100637 * present. The provided checksum should match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100638 * the download location. If the checksum does not match an error will be shown to the user and
639 * the user will be asked to factory reset the device.
640 *
641 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
642 * provisioning via an NFC bump.
643 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100644 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
645 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100646
647 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000648 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
649 * has completed successfully.
650 *
651 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700652 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000653 *
Ying Wang7f38aab2015-02-20 11:50:09 -0800654 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000655 * corresponds to the account requested to be migrated at provisioning time, if any.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
659 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
660
661 /**
Julia Reynolds2f46d942015-05-05 11:44:20 -0400662 * A boolean extra indicating whether device encryption can be skipped as part of Device Owner
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500663 * provisioning.
664 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400665 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100666 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500667 */
668 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
669 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
670
671 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000672 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
673 * provisioning. If this extra is not passed, a default image will be shown.
674 * <h5>The following URI schemes are accepted:</h5>
675 * <ul>
676 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
677 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
678 * </ul>
679 *
680 * <p> It is the responsability of the caller to provide an image with a reasonable
681 * pixed density for the device.
682 *
683 * <p> If a content: URI is passed, the intent should have the flag
684 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
685 * {@link android.content.ClipData} of the intent too.
686 *
687 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
688 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
689 */
690 public static final String EXTRA_PROVISIONING_LOGO_URI =
691 "android.app.extra.PROVISIONING_LOGO_URI";
692
693 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000694 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
695 * during setup-wizard.
696 *
697 * <p>If unspecified, defaults to {@code true} to match the behavior in
698 * {@link android.os.Build.VERSION_CODES#M} and earlier.
699 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000700 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
701 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000702 *
703 * @hide
704 */
705 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
706 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
707
708 /**
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400709 * This MIME type is used for starting the Device Owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100710 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400711 * <p>During device owner provisioning a device admin app is set as the owner of the device.
712 * A device owner has full control over the device. The device owner can not be modified by the
713 * user and the only way of resetting the device is if the device owner app calls a factory
714 * reset.
715 *
716 * <p> A typical use case would be a device that is owned by a company, but used by either an
717 * employee or client.
718 *
719 * <p> The NFC message should be send to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100720 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000721 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100722 * contains the following properties:
723 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400724 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
725 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100726 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400727 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100728 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
729 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
730 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
731 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
732 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
733 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
734 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
735 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
736 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
737 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100738 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
739 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
740 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100741 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000742 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700743 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400744 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
745 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
746 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400747 */
748 public static final String MIME_TYPE_PROVISIONING_NFC
749 = "application/com.android.managedprovisioning";
750
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100751 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800752 * Activity action: ask the user to add a new device administrator to the system.
753 * The desired policy is the ComponentName of the policy in the
754 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
755 * bring the user through adding the device administrator to the system (or
756 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700757 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800758 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
759 * field to provide the user with additional explanation (in addition
760 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800761 *
762 * <p>If your administrator is already active, this will ordinarily return immediately (without
763 * user intervention). However, if your administrator has been updated and is requesting
764 * additional uses-policy flags, the user will be presented with the new list. New policies
765 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800766 */
767 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
768 public static final String ACTION_ADD_DEVICE_ADMIN
769 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700770
Dianne Hackbornd6847842010-01-12 18:14:19 -0800771 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700772 * @hide
773 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -0700774 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700775 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700776 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
777 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700778 * to remotely control restrictions on the user.
779 *
Makoto Onukic8a5a552015-11-19 14:29:12 -0800780 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700781 * result of whether or not the user approved the action. If approved, the result will
782 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
783 * as a profile owner.
784 *
785 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
786 * field to provide the user with additional explanation (in addition
787 * to your component's description) about what is being added.
788 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700789 * <p>If there is already a profile owner active or the caller is not a system app, the
790 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700791 */
792 @SystemApi
793 public static final String ACTION_SET_PROFILE_OWNER
794 = "android.app.action.SET_PROFILE_OWNER";
795
796 /**
797 * @hide
798 * Name of the profile owner admin that controls the user.
799 */
800 @SystemApi
801 public static final String EXTRA_PROFILE_OWNER_NAME
802 = "android.app.extra.PROFILE_OWNER_NAME";
803
804 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100805 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -0700806 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700807 *
Jim Miller284b62e2010-06-08 14:27:42 -0700808 * @hide
809 */
810 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
811 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
812
813 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100814 * Broadcast action: sent when the device owner is set or changed.
815 *
816 * This broadcast is sent only to the primary user.
817 * @see #ACTION_PROVISION_MANAGED_DEVICE
818 */
819 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
820 public static final String ACTION_DEVICE_OWNER_CHANGED
821 = "android.app.action.DEVICE_OWNER_CHANGED";
822
823 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800824 * The ComponentName of the administrator component.
825 *
826 * @see #ACTION_ADD_DEVICE_ADMIN
827 */
828 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700829
Dianne Hackbornd6847842010-01-12 18:14:19 -0800830 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800831 * An optional CharSequence providing additional explanation for why the
832 * admin is being added.
833 *
834 * @see #ACTION_ADD_DEVICE_ADMIN
835 */
836 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700837
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800838 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700839 * Activity action: have the user enter a new password. This activity should
840 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
841 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
842 * enter a new password that meets the current requirements. You can use
843 * {@link #isActivePasswordSufficient()} to determine whether you need to
844 * have the user select a new password in order to meet the current
845 * constraints. Upon being resumed from this activity, you can check the new
846 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +0000847 *
848 * If the intent is launched from within a managed profile with a profile
849 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
850 * this will trigger entering a new password for the parent of the profile.
851 * For all other cases it will trigger entering a new password for the user
852 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +0000853 *
854 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -0800855 */
856 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
857 public static final String ACTION_SET_NEW_PASSWORD
858 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700859
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000860 /**
Benjamin Franzc9921092016-01-08 17:17:44 +0000861 * Activity action: have the user enter a new password for the parent profile.
862 * If the intent is launched from within a managed profile, this will trigger
863 * entering a new password for the parent of the profile. In all other cases
864 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
865 */
866 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
867 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
868 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
869
870 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000871 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
872 * the parent profile to access intents sent from the managed profile.
873 * That is, when an app in the managed profile calls
874 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
875 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000876 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100877 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000878
879 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000880 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
881 * the managed profile to access intents sent from the parent profile.
882 * That is, when an app in the parent profile calls
883 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
884 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000885 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100886 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700887
Dianne Hackbornd6847842010-01-12 18:14:19 -0800888 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +0100889 * Broadcast action: notify that a new local system update policy has been set by the device
890 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +0000891 */
892 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +0100893 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
894 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +0000895
Amith Yamasanid49489b2015-04-28 14:00:26 -0700896 /**
897 * Permission policy to prompt user for new permission requests for runtime permissions.
898 * Already granted or denied permissions are not affected by this.
899 */
900 public static final int PERMISSION_POLICY_PROMPT = 0;
901
902 /**
903 * Permission policy to always grant new permission requests for runtime permissions.
904 * Already granted or denied permissions are not affected by this.
905 */
906 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
907
908 /**
909 * Permission policy to always deny new permission requests for runtime permissions.
910 * Already granted or denied permissions are not affected by this.
911 */
912 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
913
Svet Ganovd8ecc5a2015-05-20 10:45:43 -0700914 /**
915 * Runtime permission state: The user can manage the permission
916 * through the UI.
917 */
918 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
919
920 /**
921 * Runtime permission state: The permission is granted to the app
922 * and the user cannot manage the permission through the UI.
923 */
924 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
925
926 /**
927 * Runtime permission state: The permission is denied to the app
928 * and the user cannot manage the permission through the UI.
929 */
930 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +0000931
932 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000933 * No management for current user in-effect. This is the default.
934 * @hide
935 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000936 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000937 public static final int STATE_USER_UNMANAGED = 0;
938
939 /**
940 * Management partially setup, user setup needs to be completed.
941 * @hide
942 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000943 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000944 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
945
946 /**
947 * Management partially setup, user setup completed.
948 * @hide
949 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000950 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000951 public static final int STATE_USER_SETUP_COMPLETE = 2;
952
953 /**
954 * Management setup and active on current user.
955 * @hide
956 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000957 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000958 public static final int STATE_USER_SETUP_FINALIZED = 3;
959
960 /**
961 * Management partially setup on a managed profile.
962 * @hide
963 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000964 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000965 public static final int STATE_USER_PROFILE_COMPLETE = 4;
966
967 /**
968 * @hide
969 */
970 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
971 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
972 @Retention(RetentionPolicy.SOURCE)
973 public @interface UserProvisioningState {}
974
975 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800976 * Return true if the given administrator component is currently
977 * active (enabled) in the system.
978 */
Robin Lee25e26452015-06-02 09:56:29 -0700979 public boolean isAdminActive(@NonNull ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700980 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +0100981 }
982
983 /**
984 * @see #isAdminActive(ComponentName)
985 * @hide
986 */
Robin Lee25e26452015-06-02 09:56:29 -0700987 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800988 if (mService != null) {
989 try {
Robin Lee25e26452015-06-02 09:56:29 -0700990 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800991 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -0800992 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800993 }
994 }
995 return false;
996 }
Fyodor Kupolov96fb9322014-12-01 15:08:09 -0800997 /**
998 * Return true if the given administrator component is currently being removed
999 * for the user.
1000 * @hide
1001 */
Robin Lee25e26452015-06-02 09:56:29 -07001002 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001003 if (mService != null) {
1004 try {
Robin Lee25e26452015-06-02 09:56:29 -07001005 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001006 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001007 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001008 }
1009 }
1010 return false;
1011 }
1012
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001013
Dianne Hackbornd6847842010-01-12 18:14:19 -08001014 /**
Robin Lee25e26452015-06-02 09:56:29 -07001015 * Return a list of all currently active device administrators' component
1016 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001017 * returned.
1018 */
1019 public List<ComponentName> getActiveAdmins() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001020 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001021 }
1022
1023 /**
1024 * @see #getActiveAdmins()
1025 * @hide
1026 */
1027 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001028 if (mService != null) {
1029 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001030 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001031 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001032 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001033 }
1034 }
1035 return null;
1036 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001037
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001038 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001039 * Used by package administration code to determine if a package can be stopped
1040 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001041 * @hide
1042 */
1043 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001044 return packageHasActiveAdmins(packageName, myUserId());
1045 }
1046
1047 /**
1048 * Used by package administration code to determine if a package can be stopped
1049 * or uninstalled.
1050 * @hide
1051 */
1052 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001053 if (mService != null) {
1054 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001055 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001056 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001057 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001058 }
1059 }
1060 return false;
1061 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001062
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001063 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001064 * Remove a current administration component. This can only be called
1065 * by the application that owns the administration component; if you
1066 * try to remove someone else's component, a security exception will be
1067 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001068 *
1069 * <p>Note that the operation is not synchronous and the admin might still be active (as
1070 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001071 */
Robin Lee25e26452015-06-02 09:56:29 -07001072 public void removeActiveAdmin(@NonNull ComponentName admin) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001073 if (mService != null) {
1074 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001075 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001076 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001077 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001078 }
1079 }
1080 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001081
Dianne Hackbornd6847842010-01-12 18:14:19 -08001082 /**
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001083 * Returns true if an administrator has been granted a particular device policy. This can
Robin Lee25e26452015-06-02 09:56:29 -07001084 * be used to check whether the administrator was activated under an earlier set of policies,
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001085 * but requires additional policies after an upgrade.
1086 *
1087 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be
1088 * an active administrator, or an exception will be thrown.
1089 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
1090 */
Robin Lee25e26452015-06-02 09:56:29 -07001091 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001092 if (mService != null) {
1093 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001094 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001095 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001096 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001097 }
1098 }
1099 return false;
1100 }
1101
1102 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001103 * Returns true if the Profile Challenge is available to use for the given profile user.
1104 *
1105 * @hide
1106 */
1107 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1108 if (mService != null) {
1109 try {
1110 return mService.isSeparateProfileChallengeAllowed(userHandle);
1111 } catch (RemoteException e) {
1112 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
1113 }
1114 }
1115 return false;
1116 }
1117
1118 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001119 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1120 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001121 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001122 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001123 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001124
Dianne Hackbornd6847842010-01-12 18:14:19 -08001125 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001126 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1127 * recognition technology. This implies technologies that can recognize the identity of
1128 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1129 * Note that quality constants are ordered so that higher values are more restrictive.
1130 */
1131 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1132
1133 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001134 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001135 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001136 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001137 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001138 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001139
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001140 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001141 * Constant for {@link #setPasswordQuality}: the user must have entered a
1142 * password containing at least numeric characters. Note that quality
1143 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001144 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001145 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001146
Dianne Hackbornd6847842010-01-12 18:14:19 -08001147 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001148 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001149 * password containing at least numeric characters with no repeating (4444)
1150 * or ordered (1234, 4321, 2468) sequences. Note that quality
1151 * constants are ordered so that higher values are more restrictive.
1152 */
1153 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1154
1155 /**
1156 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001157 * password containing at least alphabetic (or other symbol) characters.
1158 * Note that quality constants are ordered so that higher values are more
1159 * restrictive.
1160 */
1161 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001162
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001163 /**
1164 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001165 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001166 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001167 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001168 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001169 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001170
Dianne Hackbornd6847842010-01-12 18:14:19 -08001171 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001172 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001173 * password containing at least a letter, a numerical digit and a special
1174 * symbol, by default. With this password quality, passwords can be
1175 * restricted to contain various sets of characters, like at least an
1176 * uppercase letter, etc. These are specified using various methods,
1177 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1178 * that quality constants are ordered so that higher values are more
1179 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001180 */
1181 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1182
1183 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001184 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1185 * modify password. In case this password quality is set, the password is
1186 * managed by a profile owner. The profile owner can set any password,
1187 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1188 * that quality constants are ordered so that higher values are more
1189 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1190 * the highest.
1191 * @hide
1192 */
1193 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1194
1195 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001196 * Called by an application that is administering the device to set the
1197 * password restrictions it is imposing. After setting this, the user
1198 * will not be able to enter a new password that is not at least as
1199 * restrictive as what has been set. Note that the current password
1200 * will remain until the user has set a new one, so the change does not
1201 * take place immediately. To prompt the user for a new password, use
Esteban Talaverac1c83592016-02-17 17:56:15 +00001202 * {@link #ACTION_SET_NEW_PASSWORD} or
1203 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001204 *
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001205 * <p>Quality constants are ordered so that higher values are more restrictive;
1206 * thus the highest requested quality constant (between the policy set here,
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001207 * the user's preference, and any other considerations) is the one that
1208 * is in effect.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001209 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001210 * <p>The calling device admin must have requested
1211 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1212 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001213 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001214 * <p>This method can be called on the {@link DevicePolicyManager} instance
1215 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1216 * restrictions on the parent profile.
1217 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001218 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001219 * @param quality The new desired quality. One of
1220 * {@link #PASSWORD_QUALITY_UNSPECIFIED}, {@link #PASSWORD_QUALITY_SOMETHING},
Jim Miller85516d02014-01-31 17:08:37 -08001221 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
1222 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC}
1223 * or {@link #PASSWORD_QUALITY_COMPLEX}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001224 */
Robin Lee25e26452015-06-02 09:56:29 -07001225 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001226 if (mService != null) {
1227 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001228 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001229 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001230 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001231 }
1232 }
1233 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001234
Dianne Hackbornd6847842010-01-12 18:14:19 -08001235 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001236 * Retrieve the current minimum password quality for a particular admin or all admins that set
1237 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1238 * a separate challenge are not taken into account.
1239 *
1240 * <p>This method can be called on the {@link DevicePolicyManager} instance
1241 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1242 * restrictions on the parent profile.
1243 *
Robin Lee25e26452015-06-02 09:56:29 -07001244 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001245 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001246 */
Robin Lee25e26452015-06-02 09:56:29 -07001247 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001248 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001249 }
1250
1251 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001252 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001253 if (mService != null) {
1254 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001255 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001256 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001257 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001258 }
1259 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001260 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001261 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001262
Dianne Hackbornd6847842010-01-12 18:14:19 -08001263 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001264 * Called by an application that is administering the device to set the
1265 * minimum allowed password length. After setting this, the user
1266 * will not be able to enter a new password that is not at least as
1267 * restrictive as what has been set. Note that the current password
1268 * will remain until the user has set a new one, so the change does not
1269 * take place immediately. To prompt the user for a new password, use
Esteban Talaverac1c83592016-02-17 17:56:15 +00001270 * {@link #ACTION_SET_NEW_PASSWORD} or
1271 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This
Dianne Hackbornd6847842010-01-12 18:14:19 -08001272 * constraint is only imposed if the administrator has also requested either
Jim Miller85516d02014-01-31 17:08:37 -08001273 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
1274 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC},
1275 * or {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001276 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001277 * <p>The calling device admin must have requested
1278 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1279 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001280 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001281 * <p>This method can be called on the {@link DevicePolicyManager} instance
1282 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1283 * restrictions on the parent profile.
1284 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001285 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001286 * @param length The new desired minimum password length. A value of 0
1287 * means there is no restriction.
1288 */
Robin Lee25e26452015-06-02 09:56:29 -07001289 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001290 if (mService != null) {
1291 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001292 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001293 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001294 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001295 }
1296 }
1297 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001298
Dianne Hackbornd6847842010-01-12 18:14:19 -08001299 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001300 * Retrieve the current minimum password length for a particular admin or all admins that set
1301 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1302 * a separate challenge are not taken into account.
1303 *
1304 * <p>This method can be called on the {@link DevicePolicyManager} instance
1305 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1306 * restrictions on the parent profile.
1307 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001308 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001309 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001310 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001311 */
Robin Lee25e26452015-06-02 09:56:29 -07001312 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001313 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001314 }
1315
1316 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001317 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001318 if (mService != null) {
1319 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001320 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001321 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001322 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001323 }
1324 }
1325 return 0;
1326 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001327
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001328 /**
1329 * Called by an application that is administering the device to set the
1330 * minimum number of upper case letters required in the password. After
1331 * setting this, the user will not be able to enter a new password that is
1332 * not at least as restrictive as what has been set. Note that the current
1333 * password will remain until the user has set a new one, so the change does
1334 * not take place immediately. To prompt the user for a new password, use
Esteban Talaverac1c83592016-02-17 17:56:15 +00001335 * {@link #ACTION_SET_NEW_PASSWORD} or
1336 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001337 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001338 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1339 * default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001340 * <p>
1341 * The calling device admin must have requested
1342 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1343 * this method; if it has not, a security exception will be thrown.
1344 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001345 * <p>This method can be called on the {@link DevicePolicyManager} instance
1346 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1347 * restrictions on the parent profile.
1348 *
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001349 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1350 * with.
1351 * @param length The new desired minimum number of upper case letters
1352 * required in the password. A value of 0 means there is no
1353 * restriction.
1354 */
Robin Lee25e26452015-06-02 09:56:29 -07001355 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001356 if (mService != null) {
1357 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001358 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001359 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001360 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001361 }
1362 }
1363 }
1364
1365 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001366 * Retrieve the current number of upper case letters required in the password
1367 * for a particular admin or all admins that set retrictions on this user and
1368 * its participating profiles. Restrictions on profiles that have a separate challenge
1369 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001370 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001371 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001372 * and only applies when the password quality is
1373 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001374 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001375 * <p>This method can be called on the {@link DevicePolicyManager} instance
1376 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1377 * restrictions on the parent profile.
1378 *
Robin Lee25e26452015-06-02 09:56:29 -07001379 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001380 * aggregate all admins.
1381 * @return The minimum number of upper case letters required in the
1382 * password.
1383 */
Robin Lee25e26452015-06-02 09:56:29 -07001384 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001385 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001386 }
1387
1388 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001389 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001390 if (mService != null) {
1391 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001392 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001393 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001394 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001395 }
1396 }
1397 return 0;
1398 }
1399
1400 /**
1401 * Called by an application that is administering the device to set the
1402 * minimum number of lower case letters required in the password. After
1403 * setting this, the user will not be able to enter a new password that is
1404 * not at least as restrictive as what has been set. Note that the current
1405 * password will remain until the user has set a new one, so the change does
1406 * not take place immediately. To prompt the user for a new password, use
Esteban Talaverac1c83592016-02-17 17:56:15 +00001407 * {@link #ACTION_SET_NEW_PASSWORD} or
1408 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001409 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001410 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1411 * default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001412 * <p>
1413 * The calling device admin must have requested
1414 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1415 * this method; if it has not, a security exception will be thrown.
1416 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001417 * <p>This method can be called on the {@link DevicePolicyManager} instance
1418 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1419 * restrictions on the parent profile.
1420 *
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001421 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1422 * with.
1423 * @param length The new desired minimum number of lower case letters
1424 * required in the password. A value of 0 means there is no
1425 * restriction.
1426 */
Robin Lee25e26452015-06-02 09:56:29 -07001427 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001428 if (mService != null) {
1429 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001430 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001431 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001432 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001433 }
1434 }
1435 }
1436
1437 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001438 * Retrieve the current number of lower case letters required in the password
1439 * for a particular admin or all admins that set retrictions on this user
1440 * and its participating profiles. Restrictions on profiles that have
1441 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001442 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001443 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001444 * and only applies when the password quality is
1445 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001446 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001447 * <p>This method can be called on the {@link DevicePolicyManager} instance
1448 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1449 * restrictions on the parent profile.
1450 *
Robin Lee25e26452015-06-02 09:56:29 -07001451 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001452 * aggregate all admins.
1453 * @return The minimum number of lower case letters required in the
1454 * password.
1455 */
Robin Lee25e26452015-06-02 09:56:29 -07001456 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001457 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001458 }
1459
1460 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001461 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001462 if (mService != null) {
1463 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001464 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001465 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001466 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001467 }
1468 }
1469 return 0;
1470 }
1471
1472 /**
1473 * Called by an application that is administering the device to set the
1474 * minimum number of letters required in the password. After setting this,
1475 * the user will not be able to enter a new password that is not at least as
1476 * restrictive as what has been set. Note that the current password will
1477 * remain until the user has set a new one, so the change does not take
1478 * place immediately. To prompt the user for a new password, use
Esteban Talaverac1c83592016-02-17 17:56:15 +00001479 * {@link #ACTION_SET_NEW_PASSWORD} or
1480 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001481 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001482 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1483 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001484 * <p>
1485 * The calling device admin must have requested
1486 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1487 * this method; if it has not, a security exception will be thrown.
1488 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001489 * <p>This method can be called on the {@link DevicePolicyManager} instance
1490 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1491 * restrictions on the parent profile.
1492 *
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001493 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1494 * with.
1495 * @param length The new desired minimum number of letters required in the
1496 * password. A value of 0 means there is no restriction.
1497 */
Robin Lee25e26452015-06-02 09:56:29 -07001498 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001499 if (mService != null) {
1500 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001501 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001502 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001503 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001504 }
1505 }
1506 }
1507
1508 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001509 * Retrieve the current number of letters required in the password
1510 * for a particular admin or all admins that set retrictions on this user
1511 * and its participating profiles. Restrictions on profiles that have
1512 * a separate challenge are not taken into account.
1513 * This is the same value as set by
1514 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001515 * and only applies when the password quality is
1516 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001517 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001518 * <p>This method can be called on the {@link DevicePolicyManager} instance
1519 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1520 * restrictions on the parent profile.
1521 *
Robin Lee25e26452015-06-02 09:56:29 -07001522 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001523 * aggregate all admins.
1524 * @return The minimum number of letters required in the password.
1525 */
Robin Lee25e26452015-06-02 09:56:29 -07001526 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001527 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001528 }
1529
1530 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001531 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001532 if (mService != null) {
1533 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001534 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001535 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001536 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001537 }
1538 }
1539 return 0;
1540 }
1541
1542 /**
1543 * Called by an application that is administering the device to set the
1544 * minimum number of numerical digits required in the password. After
1545 * setting this, the user will not be able to enter a new password that is
1546 * not at least as restrictive as what has been set. Note that the current
1547 * password will remain until the user has set a new one, so the change does
1548 * not take place immediately. To prompt the user for a new password, use
Esteban Talaverac1c83592016-02-17 17:56:15 +00001549 * {@link #ACTION_SET_NEW_PASSWORD} or
1550 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001551 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001552 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1553 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001554 * <p>
1555 * The calling device admin must have requested
1556 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1557 * this method; if it has not, a security exception will be thrown.
1558 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001559 * <p>This method can be called on the {@link DevicePolicyManager} instance
1560 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1561 * restrictions on the parent profile.
1562 *
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001563 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1564 * with.
1565 * @param length The new desired minimum number of numerical digits required
1566 * in the password. A value of 0 means there is no restriction.
1567 */
Robin Lee25e26452015-06-02 09:56:29 -07001568 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001569 if (mService != null) {
1570 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001571 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001572 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001573 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001574 }
1575 }
1576 }
1577
1578 /**
1579 * Retrieve the current number of numerical digits required in the password
Esteban Talaverac1c83592016-02-17 17:56:15 +00001580 * for a particular admin or all admins that set retrictions on this user
1581 * and its participating profiles. Restrictions on profiles that have
1582 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001583 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001584 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001585 * and only applies when the password quality is
1586 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001587 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001588 * <p>This method can be called on the {@link DevicePolicyManager} instance
1589 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1590 * restrictions on the parent profile.
1591 *
Robin Lee25e26452015-06-02 09:56:29 -07001592 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001593 * aggregate all admins.
1594 * @return The minimum number of numerical digits required in the password.
1595 */
Robin Lee25e26452015-06-02 09:56:29 -07001596 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001597 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001598 }
1599
1600 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001601 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001602 if (mService != null) {
1603 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001604 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001605 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001606 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001607 }
1608 }
1609 return 0;
1610 }
1611
1612 /**
1613 * Called by an application that is administering the device to set the
1614 * minimum number of symbols required in the password. After setting this,
1615 * the user will not be able to enter a new password that is not at least as
1616 * restrictive as what has been set. Note that the current password will
1617 * remain until the user has set a new one, so the change does not take
1618 * place immediately. To prompt the user for a new password, use
Esteban Talaverac1c83592016-02-17 17:56:15 +00001619 * {@link #ACTION_SET_NEW_PASSWORD} or
1620 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001621 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001622 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1623 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001624 * <p>
1625 * The calling device admin must have requested
1626 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1627 * this method; if it has not, a security exception will be thrown.
1628 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001629 * <p>This method can be called on the {@link DevicePolicyManager} instance
1630 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1631 * restrictions on the parent profile.
1632 *
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001633 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1634 * with.
1635 * @param length The new desired minimum number of symbols required in the
1636 * password. A value of 0 means there is no restriction.
1637 */
Robin Lee25e26452015-06-02 09:56:29 -07001638 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001639 if (mService != null) {
1640 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001641 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001642 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001643 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001644 }
1645 }
1646 }
1647
1648 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001649 * Retrieve the current number of symbols required in the password
1650 * for a particular admin or all admins that set retrictions on this user
1651 * and its participating profiles. Restrictions on profiles that have
1652 * a separate challenge are not taken into account. This is the same value as
1653 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001654 * and only applies when the password quality is
1655 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001656 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001657 * <p>This method can be called on the {@link DevicePolicyManager} instance
1658 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1659 * restrictions on the parent profile.
1660 *
Robin Lee25e26452015-06-02 09:56:29 -07001661 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001662 * aggregate all admins.
1663 * @return The minimum number of symbols required in the password.
1664 */
Robin Lee25e26452015-06-02 09:56:29 -07001665 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001666 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001667 }
1668
1669 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001670 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001671 if (mService != null) {
1672 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001673 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001674 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001675 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001676 }
1677 }
1678 return 0;
1679 }
1680
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001681 /**
1682 * Called by an application that is administering the device to set the
1683 * minimum number of non-letter characters (numerical digits or symbols)
1684 * required in the password. After setting this, the user will not be able
1685 * to enter a new password that is not at least as restrictive as what has
1686 * been set. Note that the current password will remain until the user has
1687 * set a new one, so the change does not take place immediately. To prompt
Esteban Talaverac1c83592016-02-17 17:56:15 +00001688 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1689 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001690 * setting this value. This constraint is only imposed if the administrator
1691 * has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1692 * {@link #setPasswordQuality}. The default value is 0.
1693 * <p>
1694 * The calling device admin must have requested
1695 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1696 * this method; if it has not, a security exception will be thrown.
1697 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001698 * <p>This method can be called on the {@link DevicePolicyManager} instance
1699 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1700 * restrictions on the parent profile.
1701 *
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001702 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1703 * with.
1704 * @param length The new desired minimum number of letters required in the
1705 * password. A value of 0 means there is no restriction.
1706 */
Robin Lee25e26452015-06-02 09:56:29 -07001707 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001708 if (mService != null) {
1709 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001710 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001711 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001712 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001713 }
1714 }
1715 }
1716
1717 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001718 * Retrieve the current number of non-letter characters required in the password
1719 * for a particular admin or all admins that set retrictions on this user
1720 * and its participating profiles. Restrictions on profiles that have
1721 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001722 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001723 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001724 * and only applies when the password quality is
1725 * {@link #PASSWORD_QUALITY_COMPLEX}.
1726 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001727 * <p>This method can be called on the {@link DevicePolicyManager} instance
1728 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1729 * restrictions on the parent profile.
1730 *
Robin Lee25e26452015-06-02 09:56:29 -07001731 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001732 * aggregate all admins.
1733 * @return The minimum number of letters required in the password.
1734 */
Robin Lee25e26452015-06-02 09:56:29 -07001735 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001736 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001737 }
1738
1739 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001740 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001741 if (mService != null) {
1742 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001743 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001744 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001745 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001746 }
1747 }
1748 return 0;
1749 }
1750
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001751 /**
1752 * Called by an application that is administering the device to set the length
1753 * of the password history. After setting this, the user will not be able to
1754 * enter a new password that is the same as any password in the history. Note
1755 * that the current password will remain until the user has set a new one, so
1756 * the change does not take place immediately. To prompt the user for a new
Esteban Talaverac1c83592016-02-17 17:56:15 +00001757 * password, use {@link #ACTION_SET_NEW_PASSWORD} or
1758 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001759 * This constraint is only imposed if the administrator has also requested
Jim Miller85516d02014-01-31 17:08:37 -08001760 * either {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}
1761 * {@link #PASSWORD_QUALITY_ALPHABETIC}, or {@link #PASSWORD_QUALITY_ALPHANUMERIC}
1762 * with {@link #setPasswordQuality}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001763 *
1764 * <p>
1765 * The calling device admin must have requested
1766 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this
1767 * method; if it has not, a security exception will be thrown.
1768 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001769 * <p>This method can be called on the {@link DevicePolicyManager} instance
1770 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1771 * restrictions on the parent profile.
1772 *
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001773 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1774 * with.
1775 * @param length The new desired length of password history. A value of 0
1776 * means there is no restriction.
1777 */
Robin Lee25e26452015-06-02 09:56:29 -07001778 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001779 if (mService != null) {
1780 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001781 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001782 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001783 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001784 }
1785 }
1786 }
1787
1788 /**
Jim Millera4e28d12010-11-08 16:15:47 -08001789 * Called by a device admin to set the password expiration timeout. Calling this method
1790 * will restart the countdown for password expiration for the given admin, as will changing
1791 * the device password (for all admins).
1792 *
1793 * <p>The provided timeout is the time delta in ms and will be added to the current time.
1794 * For example, to have the password expire 5 days from now, timeout would be
1795 * 5 * 86400 * 1000 = 432000000 ms for timeout.
1796 *
1797 * <p>To disable password expiration, a value of 0 may be used for timeout.
1798 *
Jim Millera4e28d12010-11-08 16:15:47 -08001799 * <p>The calling device admin must have requested
1800 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this
1801 * method; if it has not, a security exception will be thrown.
1802 *
Jessica Hummel9da60392014-05-21 12:32:57 +01001803 * <p> Note that setting the password will automatically reset the expiration time for all
1804 * active admins. Active admins do not need to explicitly call this method in that case.
1805 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001806 * <p>This method can be called on the {@link DevicePolicyManager} instance
1807 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
1808 * restrictions on the parent profile.
1809 *
Jim Millera4e28d12010-11-08 16:15:47 -08001810 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1811 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0
1812 * means there is no restriction (unlimited).
1813 */
Robin Lee25e26452015-06-02 09:56:29 -07001814 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001815 if (mService != null) {
1816 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001817 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001818 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001819 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millera4e28d12010-11-08 16:15:47 -08001820 }
1821 }
1822 }
1823
1824 /**
Jim Miller6b857682011-02-16 16:27:41 -08001825 * Get the password expiration timeout for the given admin. The expiration timeout is the
1826 * recurring expiration timeout provided in the call to
1827 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001828 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1829 * have set restrictions on profiles that have a separate challenge are not taken into account.
1830 *
1831 * <p>This method can be called on the {@link DevicePolicyManager} instance
1832 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1833 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001834 *
Robin Lee25e26452015-06-02 09:56:29 -07001835 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001836 * @return The timeout for the given admin or the minimum of all timeouts
1837 */
Robin Lee25e26452015-06-02 09:56:29 -07001838 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001839 if (mService != null) {
1840 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001841 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001842 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001843 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millera4e28d12010-11-08 16:15:47 -08001844 }
1845 }
1846 return 0;
1847 }
1848
1849 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001850 * Get the current password expiration time for a particular admin or all admins that set
1851 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1852 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1853 * of all expiration times is returned - which will be the minimum of all of them.
1854 *
1855 * <p>This method can be called on the {@link DevicePolicyManager} instance
1856 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1857 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001858 *
Robin Lee25e26452015-06-02 09:56:29 -07001859 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001860 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001861 */
Robin Lee25e26452015-06-02 09:56:29 -07001862 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001863 if (mService != null) {
1864 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001865 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001866 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001867 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millera4e28d12010-11-08 16:15:47 -08001868 }
1869 }
1870 return 0;
1871 }
1872
1873 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001874 * Retrieve the current password history length for a particular admin or all admins that
1875 * set retrictions on this user and its participating profiles. Restrictions on profiles that
1876 * have a separate challenge are not taken into account.
1877 *
1878 * <p>This method can be called on the {@link DevicePolicyManager} instance
1879 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1880 * restrictions on the parent profile.
1881 *
Robin Lee25e26452015-06-02 09:56:29 -07001882 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001883 * all admins.
1884 * @return The length of the password history
1885 */
Robin Lee25e26452015-06-02 09:56:29 -07001886 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001887 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001888 }
1889
1890 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001891 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001892 if (mService != null) {
1893 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001894 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001895 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001896 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001897 }
1898 }
1899 return 0;
1900 }
1901
Dianne Hackbornd6847842010-01-12 18:14:19 -08001902 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001903 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001904 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001905 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001906 * @return Returns the maximum length that the user can enter.
1907 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001908 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001909 // Kind-of arbitrary.
1910 return 16;
1911 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001912
Dianne Hackborn254cb442010-01-27 19:23:59 -08001913 /**
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001914 * Determine whether the current password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00001915 * to meet the policy requirements (e.g. quality, minimum length) that have been
1916 * requested by the admins of this user and its participating profiles.
1917 * Restrictions on profiles that have a separate challenge are not taken into account.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001918 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001919 * <p>The calling device admin must have requested
1920 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1921 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001922 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001923 * <p>This method can be called on the {@link DevicePolicyManager} instance
1924 * returned by {@link #getParentProfileInstance(ComponentName)} in order to determine
1925 * if the password set on the parent profile is sufficient.
1926 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001927 * @return Returns true if the password meets the current requirements, else false.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001928 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001929 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001930 if (mService != null) {
1931 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001932 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001933 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001934 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001935 }
1936 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001937 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001938 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001939
Dianne Hackbornd6847842010-01-12 18:14:19 -08001940 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00001941 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00001942 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00001943 * requested by the admins of the parent user and its profiles.
1944 *
1945 * @param userHandle the userId of the profile to check the password for.
1946 * @return Returns true if the password would meet the current requirements, else false.
1947 * @hide
1948 */
1949 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
1950 if (mService != null) {
1951 try {
1952 return mService.isProfileActivePasswordSufficientForParent(userHandle);
1953 } catch (RemoteException e) {
1954 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
1955 }
1956 }
1957 return false;
1958 }
1959
1960 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001961 * Retrieve the number of times the user has failed at entering a
1962 * password since that last successful password entry.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001963 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001964 * <p>This method can be called on the {@link DevicePolicyManager} instance
1965 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1966 * the number of failed password attemts for the parent user.
1967 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001968 * <p>The calling device admin must have requested
1969 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call
1970 * this method; if it has not, a security exception will be thrown.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001971 */
1972 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00001973 return getCurrentFailedPasswordAttempts(myUserId());
1974 }
1975
1976 /**
1977 * Retrieve the number of times the given user has failed at entering a
1978 * password since that last successful password entry.
1979 *
1980 * <p>The calling device admin must have requested
1981 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
1982 * not and it is not the system uid, a security exception will be thrown.
1983 *
1984 * @hide
1985 */
1986 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001987 if (mService != null) {
1988 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00001989 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001990 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001991 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001992 }
1993 }
1994 return -1;
1995 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001996
1997 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04001998 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04001999 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002000 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002001 * @hide
2002 */
2003 public boolean getDoNotAskCredentialsOnBoot() {
2004 if (mService != null) {
2005 try {
2006 return mService.getDoNotAskCredentialsOnBoot();
2007 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002008 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002009 }
2010 }
2011 return false;
2012 }
2013
2014 /**
Andrew Stadler88209d12010-02-08 22:59:36 -08002015 * Setting this to a value greater than zero enables a built-in policy
Esteban Talaverac1c83592016-02-17 17:56:15 +00002016 * that will perform a device or profile wipe after too many incorrect
Andrew Stadler88209d12010-02-08 22:59:36 -08002017 * device-unlock passwords have been entered. This built-in policy combines
2018 * watching for failed passwords and wiping the device, and requires
2019 * that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002020 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002021 *
Andrew Stadler88209d12010-02-08 22:59:36 -08002022 * <p>To implement any other policy (e.g. wiping data for a particular
2023 * application only, erasing or revoking credentials, or reporting the
2024 * failure to a server), you should implement
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002025 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)}
Andrew Stadler88209d12010-02-08 22:59:36 -08002026 * instead. Do not use this API, because if the maximum count is reached,
Esteban Talaverac1c83592016-02-17 17:56:15 +00002027 * the device or profile will be wiped immediately, and your callback will not be invoked.
2028 *
2029 * <p>This method can be called on the {@link DevicePolicyManager} instance
2030 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
2031 * a value on the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002032 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002033 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002034 * @param num The number of failed password attempts at which point the
Esteban Talaverac1c83592016-02-17 17:56:15 +00002035 * device or profile will be wiped.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002036 */
Robin Lee25e26452015-06-02 09:56:29 -07002037 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002038 if (mService != null) {
2039 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002040 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002041 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002042 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002043 }
2044 }
2045 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002046
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002047 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002048 * Retrieve the current maximum number of login attempts that are allowed before the device
2049 * or profile is wiped, for a particular admin or all admins that set retrictions on this user
2050 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2051 * not taken into account.
2052 *
2053 * <p>This method can be called on the {@link DevicePolicyManager} instance
2054 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2055 * the value for the parent profile.
2056 *
Robin Lee25e26452015-06-02 09:56:29 -07002057 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002058 * all admins.
2059 */
Robin Lee25e26452015-06-02 09:56:29 -07002060 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002061 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002062 }
2063
2064 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002065 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002066 if (mService != null) {
2067 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002068 return mService.getMaximumFailedPasswordsForWipe(
2069 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002070 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002071 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002072 }
2073 }
2074 return 0;
2075 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002076
Dianne Hackborn254cb442010-01-27 19:23:59 -08002077 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002078 * Returns the profile with the smallest maximum failed passwords for wipe,
2079 * for the given user. So for primary user, it might return the primary or
2080 * a managed profile. For a secondary user, it would be the same as the
2081 * user passed in.
2082 * @hide Used only by Keyguard
2083 */
2084 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2085 if (mService != null) {
2086 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002087 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2088 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002089 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002090 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002091 }
2092 }
2093 return UserHandle.USER_NULL;
2094 }
2095
2096 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002097 * Flag for {@link #resetPassword}: don't allow other admins to change
2098 * the password again until the user has entered it.
2099 */
2100 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002101
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002102 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002103 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2104 * If the flag is set, the device can be booted without asking for user password.
2105 * The absence of this flag does not change the current boot requirements. This flag
2106 * can be set by the device owner only. If the app is not the device owner, the flag
2107 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2108 * device to factory defaults.
2109 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002110 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002111
2112 /**
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002113 * Force a new device unlock password (the password needed to access the
2114 * entire device, not for individual accounts) on the user. This takes
2115 * effect immediately.
Makoto Onuki70f929e2015-11-11 12:40:15 -08002116 *
2117 * <p>Calling this from a managed profile that shares the password with the owner profile
2118 * will throw a security exception.
2119 *
2120 * <p><em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
2121 * device admins that are not device owner and not profile owner.
2122 * The password can now only be changed if there is currently no password set. Device owner
2123 * and profile owner can still do this.</em>
2124 *
2125 * <p>The given password must be sufficient for the
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002126 * current password quality and length constraints as returned by
2127 * {@link #getPasswordQuality(ComponentName)} and
2128 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet
2129 * these constraints, then it will be rejected and false returned. Note
2130 * that the password may be a stronger quality (containing alphanumeric
2131 * characters when the requested quality is only numeric), in which case
2132 * the currently active quality will be increased to match.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002133 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002134 * <p>Calling with a null or empty password will clear any existing PIN,
Makoto Onuki70f929e2015-11-11 12:40:15 -08002135 * pattern or password if the current password constraints allow it. <em>Note: This will not
2136 * work in {@link android.os.Build.VERSION_CODES#N} and later for device admins that are not
2137 * device owner and not profile owner. Once set, the password cannot be changed to null or
2138 * empty, except by device owner or profile owner.</em>
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002139 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08002140 * <p>The calling device admin must have requested
2141 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call
2142 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002143 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002144 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002145 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002146 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002147 * @return Returns true if the password was applied, or false if it is
Makoto Onuki70f929e2015-11-11 12:40:15 -08002148 * not acceptable for the current constraints or if the user has not been decrypted yet.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002149 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002150 public boolean resetPassword(String password, int flags) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002151 if (mParentInstance) {
2152 throw new SecurityException("Reset password does not work across profiles.");
2153 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002154 if (mService != null) {
2155 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002156 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002157 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002158 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002159 }
2160 }
2161 return false;
2162 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002163
Dianne Hackbornd6847842010-01-12 18:14:19 -08002164 /**
2165 * Called by an application that is administering the device to set the
2166 * maximum time for user activity until the device will lock. This limits
2167 * the length that the user can set. It takes effect immediately.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002168 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08002169 * <p>The calling device admin must have requested
Dianne Hackborn315ada72010-02-11 12:14:08 -08002170 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08002171 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002172 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002173 * <p>This method can be called on the {@link DevicePolicyManager} instance
2174 * returned by {@link #getParentProfileInstance(ComponentName)} in order to set
2175 * restrictions on the parent profile.
2176 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002177 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002178 * @param timeMs The new desired maximum time to lock in milliseconds.
2179 * A value of 0 means there is no restriction.
2180 */
Robin Lee25e26452015-06-02 09:56:29 -07002181 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002182 if (mService != null) {
2183 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002184 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002185 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002186 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002187 }
2188 }
2189 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002190
Dianne Hackbornd6847842010-01-12 18:14:19 -08002191 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002192 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
2193 * retrictions on this user and its participating profiles. Restrictions on profiles that have
2194 * a separate challenge are not taken into account.
2195 *
2196 * <p>This method can be called on the {@link DevicePolicyManager} instance
2197 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2198 * restrictions on the parent profile.
2199 *
Robin Lee25e26452015-06-02 09:56:29 -07002200 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002201 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002202 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002203 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002204 */
Robin Lee25e26452015-06-02 09:56:29 -07002205 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002206 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002207 }
2208
2209 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002210 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002211 if (mService != null) {
2212 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002213 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002214 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002215 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002216 }
2217 }
2218 return 0;
2219 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002220
Dianne Hackbornd6847842010-01-12 18:14:19 -08002221 /**
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002222 * Make the device lock immediately, as if the lock screen timeout has
2223 * expired at the point of this call.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002224 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08002225 * <p>The calling device admin must have requested
2226 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
2227 * this method; if it has not, a security exception will be thrown.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002228 *
2229 * <p>This method can be called on the {@link DevicePolicyManager} instance
2230 * returned by {@link #getParentProfileInstance(ComponentName)} in order to lock
2231 * the parent profile.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002232 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002233 public void lockNow() {
2234 if (mService != null) {
2235 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002236 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002237 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002238 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002239 }
2240 }
2241 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002242
Dianne Hackbornd6847842010-01-12 18:14:19 -08002243 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002244 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002245 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002246 */
2247 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2248
2249 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002250 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2251 * data.
2252 *
Paul Crowley2934b262014-12-02 11:21:13 +00002253 * <p>This flag may only be set by device owner admins; if it is set by
2254 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002255 */
2256 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2257
2258 /**
Robin Lee85bd63f2015-02-10 11:51:00 +00002259 * Ask the user data be wiped. Wiping the primary user will cause the
2260 * device to reboot, erasing all user data while next booting up.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002261 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08002262 * <p>The calling device admin must have requested
2263 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to be able to call
2264 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002265 *
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002266 * @param flags Bit mask of additional options: currently supported flags
2267 * are {@link #WIPE_EXTERNAL_STORAGE} and
2268 * {@link #WIPE_RESET_PROTECTION_DATA}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002269 */
2270 public void wipeData(int flags) {
2271 if (mService != null) {
2272 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002273 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002274 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002275 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002276 }
2277 }
2278 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002279
Dianne Hackbornd6847842010-01-12 18:14:19 -08002280 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002281 * Called by an application that is administering the device to set the
2282 * global proxy and exclusion list.
2283 * <p>
2284 * The calling device admin must have requested
2285 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2286 * this method; if it has not, a security exception will be thrown.
2287 * Only the first device admin can set the proxy. If a second admin attempts
2288 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002289 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002290 * be returned.
2291 * The method can be called repeatedly by the device admin alrady setting the
2292 * proxy to update the proxy and exclusion list.
2293 *
Robin Lee25e26452015-06-02 09:56:29 -07002294 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002295 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2296 * Pass Proxy.NO_PROXY to reset the proxy.
2297 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002298 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2299 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002300 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002301 */
Robin Lee25e26452015-06-02 09:56:29 -07002302 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002303 List<String> exclusionList ) {
2304 if (proxySpec == null) {
2305 throw new NullPointerException();
2306 }
2307 if (mService != null) {
2308 try {
2309 String hostSpec;
2310 String exclSpec;
2311 if (proxySpec.equals(Proxy.NO_PROXY)) {
2312 hostSpec = null;
2313 exclSpec = null;
2314 } else {
2315 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2316 throw new IllegalArgumentException();
2317 }
2318 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2319 String hostName = sa.getHostName();
2320 int port = sa.getPort();
2321 StringBuilder hostBuilder = new StringBuilder();
2322 hostSpec = hostBuilder.append(hostName)
2323 .append(":").append(Integer.toString(port)).toString();
2324 if (exclusionList == null) {
2325 exclSpec = "";
2326 } else {
2327 StringBuilder listBuilder = new StringBuilder();
2328 boolean firstDomain = true;
2329 for (String exclDomain : exclusionList) {
2330 if (!firstDomain) {
2331 listBuilder = listBuilder.append(",");
2332 } else {
2333 firstDomain = false;
2334 }
2335 listBuilder = listBuilder.append(exclDomain.trim());
2336 }
2337 exclSpec = listBuilder.toString();
2338 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002339 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2340 != android.net.Proxy.PROXY_VALID)
2341 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002342 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002343 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002344 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002345 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002346 }
2347 }
2348 return null;
2349 }
2350
2351 /**
Jason Monk03bc9912014-05-13 09:44:57 -04002352 * Set a network-independent global HTTP proxy. This is not normally what you want
2353 * for typical HTTP proxies - they are generally network dependent. However if you're
2354 * doing something unusual like general internal filtering this may be useful. On
2355 * a private network where the proxy is not accessible, you may break HTTP using this.
2356 *
2357 * <p>This method requires the caller to be the device owner.
2358 *
2359 * <p>This proxy is only a recommendation and it is possible that some apps will ignore it.
2360 * @see ProxyInfo
2361 *
2362 * @param admin Which {@link DeviceAdminReceiver} this request is associated
2363 * with.
2364 * @param proxyInfo The a {@link ProxyInfo} object defining the new global
2365 * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
2366 */
Robin Lee25e26452015-06-02 09:56:29 -07002367 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2368 proxyInfo) {
Jason Monk03bc9912014-05-13 09:44:57 -04002369 if (mService != null) {
2370 try {
2371 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2372 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002373 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jason Monk03bc9912014-05-13 09:44:57 -04002374 }
2375 }
2376 }
2377
2378 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002379 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002380 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2381 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002382 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002383 */
2384 public ComponentName getGlobalProxyAdmin() {
2385 if (mService != null) {
2386 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002387 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002388 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002389 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002390 }
2391 }
2392 return null;
2393 }
2394
2395 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002396 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002397 * indicating that encryption is not supported.
2398 */
2399 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2400
2401 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002402 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002403 * indicating that encryption is supported, but is not currently active.
2404 */
2405 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2406
2407 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002408 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002409 * indicating that encryption is not currently active, but is currently
2410 * being activated. This is only reported by devices that support
2411 * encryption of data and only when the storage is currently
2412 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2413 * to become encrypted will never return this value.
2414 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002415 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002416
2417 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002418 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002419 * indicating that encryption is active.
2420 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002421 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002422
2423 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002424 * Result code for {@link #getStorageEncryptionStatus}:
2425 * indicating that encryption is active, but an encryption key has not
2426 * been set by the user.
2427 */
2428 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2429
2430 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002431 * Activity action: begin the process of encrypting data on the device. This activity should
2432 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2433 * After resuming from this activity, use {@link #getStorageEncryption}
2434 * to check encryption status. However, on some devices this activity may never return, as
2435 * it may trigger a reboot and in some cases a complete data wipe of the device.
2436 */
2437 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2438 public static final String ACTION_START_ENCRYPTION
2439 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002440 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002441 * Widgets are enabled in keyguard
2442 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002443 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002444
2445 /**
Jim Miller50e62182014-04-23 17:25:00 -07002446 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002447 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002448 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2449
2450 /**
2451 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2452 */
2453 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2454
2455 /**
Jim Miller50e62182014-04-23 17:25:00 -07002456 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2457 */
2458 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2459
2460 /**
2461 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2462 */
2463 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2464
2465 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002466 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002467 * (e.g. PIN/Pattern/Password).
2468 */
2469 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2470
2471 /**
Jim Miller06e34502014-07-17 14:46:05 -07002472 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2473 */
2474 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2475
2476 /**
Jim Miller35207742012-11-02 15:33:20 -07002477 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002478 */
2479 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002480
2481 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002482 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002483 * request that the storage system be encrypted.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002484 *
2485 * <p>When multiple device administrators attempt to control device
2486 * encryption, the most secure, supported setting will always be
2487 * used. If any device administrator requests device encryption,
2488 * it will be enabled; Conversely, if a device administrator
2489 * attempts to disable device encryption while another
2490 * device administrator has enabled it, the call to disable will
2491 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
2492 *
2493 * <p>This policy controls encryption of the secure (application data) storage area. Data
Andy Stadler50c294f2011-03-07 19:13:42 -08002494 * written to other storage areas may or may not be encrypted, and this policy does not require
2495 * or control the encryption of any other storage areas.
2496 * There is one exception: If {@link android.os.Environment#isExternalStorageEmulated()} is
2497 * {@code true}, then the directory returned by
2498 * {@link android.os.Environment#getExternalStorageDirectory()} must be written to disk
2499 * within the encrypted storage area.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002500 *
2501 * <p>Important Note: On some devices, it is possible to encrypt storage without requiring
2502 * the user to create a device PIN or Password. In this case, the storage is encrypted, but
2503 * the encryption key may not be fully secured. For maximum security, the administrator should
2504 * also require (and check for) a pattern, PIN, or password.
2505 *
2506 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2507 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002508 * @return the new request status (for all active admins) - will be one of
2509 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2510 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2511 * {@link #getStorageEncryptionStatus()} to query the actual device state.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002512 */
Robin Lee25e26452015-06-02 09:56:29 -07002513 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002514 if (mService != null) {
2515 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002516 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002517 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002518 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002519 }
2520 }
2521 return ENCRYPTION_STATUS_UNSUPPORTED;
2522 }
2523
2524 /**
2525 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002526 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002527 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002528 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2529 * this will return the requested encryption setting as an aggregate of all active
2530 * administrators.
2531 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002532 */
Robin Lee25e26452015-06-02 09:56:29 -07002533 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002534 if (mService != null) {
2535 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002536 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002537 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002538 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002539 }
2540 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002541 return false;
2542 }
2543
2544 /**
2545 * Called by an application that is administering the device to
2546 * determine the current encryption status of the device.
2547 *
2548 * Depending on the returned status code, the caller may proceed in different
2549 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2550 * storage system does not support encryption. If the
2551 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2552 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002553 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2554 * storage system has enabled encryption but no password is set so further action
2555 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or
Andy Stadler22dbfda2011-01-17 12:47:31 -08002556 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required.
2557 *
Robin Lee7e678712014-07-24 16:41:31 +01002558 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002559 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002560 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
2561 * or {@link #ENCRYPTION_STATUS_ACTIVE}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002562 */
2563 public int getStorageEncryptionStatus() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002564 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002565 }
2566
2567 /** @hide per-user version */
2568 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002569 if (mService != null) {
2570 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002571 return mService.getStorageEncryptionStatus(userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002572 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002573 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002574 }
2575 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002576 return ENCRYPTION_STATUS_UNSUPPORTED;
2577 }
2578
2579 /**
Robin Lee7e678712014-07-24 16:41:31 +01002580 * Installs the given certificate as a user CA.
2581 *
Robin Lee25e26452015-06-02 09:56:29 -07002582 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2583 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002584 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002585 *
2586 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002587 * interrupted, true otherwise.
Maggie Benthallda51e682013-08-08 22:35:44 -04002588 */
Robin Lee25e26452015-06-02 09:56:29 -07002589 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04002590 if (mService != null) {
2591 try {
Robin Lee7e678712014-07-24 16:41:31 +01002592 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002593 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002594 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002595 }
2596 }
2597 return false;
2598 }
2599
2600 /**
Robin Lee7e678712014-07-24 16:41:31 +01002601 * Uninstalls the given certificate from trusted user CAs, if present.
2602 *
Robin Lee25e26452015-06-02 09:56:29 -07002603 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2604 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002605 * @param certBuffer encoded form of the certificate to remove.
Maggie Benthallda51e682013-08-08 22:35:44 -04002606 */
Robin Lee25e26452015-06-02 09:56:29 -07002607 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04002608 if (mService != null) {
2609 try {
Robin Lee306fe082014-06-19 14:04:24 +00002610 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002611 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002612 } catch (CertificateException e) {
2613 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002614 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002615 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002616 }
2617 }
2618 }
2619
2620 /**
Robin Lee7e678712014-07-24 16:41:31 +01002621 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2622 * If a user has installed any certificates by other means than device policy these will be
2623 * included too.
2624 *
Robin Lee25e26452015-06-02 09:56:29 -07002625 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2626 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002627 * @return a List of byte[] arrays, each encoding one user CA certificate.
Maggie Benthallda51e682013-08-08 22:35:44 -04002628 */
Robin Lee25e26452015-06-02 09:56:29 -07002629 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002630 List<byte[]> certs = new ArrayList<byte[]>();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002631 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002632 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002633 mService.enforceCanManageCaCerts(admin);
2634 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2635 for (String alias : certStore.userAliases()) {
2636 try {
2637 certs.add(certStore.getCertificate(alias).getEncoded());
2638 } catch (CertificateException ce) {
2639 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2640 }
2641 }
2642 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002643 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Robin Lee7e678712014-07-24 16:41:31 +01002644 }
2645 }
2646 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002647 }
2648
2649 /**
Robin Lee7e678712014-07-24 16:41:31 +01002650 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2651 * means other than device policy will also be removed, except for system CA certificates.
2652 *
Robin Lee25e26452015-06-02 09:56:29 -07002653 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2654 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002655 */
Robin Lee25e26452015-06-02 09:56:29 -07002656 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002657 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002658 try {
2659 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2660 .toArray(new String[0]));
2661 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002662 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Robin Lee7e678712014-07-24 16:41:31 +01002663 }
2664 }
2665 }
2666
2667 /**
2668 * Returns whether this certificate is installed as a trusted CA.
2669 *
Robin Lee25e26452015-06-02 09:56:29 -07002670 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2671 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002672 * @param certBuffer encoded form of the certificate to look up.
Maggie Benthallda51e682013-08-08 22:35:44 -04002673 */
Robin Lee25e26452015-06-02 09:56:29 -07002674 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002675 if (mService != null) {
2676 try {
2677 mService.enforceCanManageCaCerts(admin);
2678 return getCaCertAlias(certBuffer) != null;
2679 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002680 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002681 } catch (CertificateException ce) {
2682 Log.w(TAG, "Could not parse certificate", ce);
2683 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002684 }
2685 return false;
2686 }
2687
2688 /**
Robin Leece3399f2016-02-24 12:08:32 +00002689 * Called by a device or profile owner, or delegated certificate installer, to install a
2690 * certificate and corresponding private key. All apps within the profile will be able to access
2691 * the certificate and use the private key, given direct user approval.
2692 *
2693 * <p>Access to the installed credentials will not be granted to the caller of this API without
2694 * direct user approval. This is for security - should a certificate installer become
2695 * compromised, certificates it had already installed will be protected.
2696 *
2697 * <p>If the installer must have access to the credentials, call
2698 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate, String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002699 *
Robin Lee25e26452015-06-02 09:56:29 -07002700 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2701 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002702 * @param privKey The private key to install.
2703 * @param cert The certificate to install.
2704 * @param alias The private key alias under which to install the certificate. If a certificate
2705 * with that alias already exists, it will be overwritten.
2706 * @return {@code true} if the keys were installed, {@code false} otherwise.
2707 */
Robin Leefbc65642015-08-03 16:21:22 +01002708 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2709 @NonNull Certificate cert, @NonNull String alias) {
Robin Leece3399f2016-02-24 12:08:32 +00002710 return installKeyPair(admin, privKey, cert, alias, false);
2711 }
2712
2713 /**
2714 * Called by a device or profile owner, or delegated certificate installer, to install a
2715 * certificate and corresponding private key. All apps within the profile will be able to access
2716 * the certificate and use the private key, given direct user approval.
2717 *
2718 * <p>The caller of this API may grant itself access to the credential immediately, without user
2719 * approval. It is a best practice not to request this unless strictly necessary since it opens
2720 * up additional security vulnerabilities.
2721 *
2722 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2723 * {@code null} if calling from a delegated certificate installer.
2724 * @param privKey The private key to install.
2725 * @param cert The certificate to install.
2726 * @param alias The private key alias under which to install the certificate. If a certificate
2727 * with that alias already exists, it will be overwritten.
2728 * @param requestAccess {@code true} to request that the calling app be granted access to the
2729 * credentials immediately. Otherwise, access to the credentials will be gated by user approval.
2730 * @return {@code true} if the keys were installed, {@code false} otherwise.
2731 */
2732 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2733 @NonNull Certificate cert, @NonNull String alias, boolean requestAccess) {
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002734 try {
2735 final byte[] pemCert = Credentials.convertToPem(cert);
Robin Lee0d5ccb72014-09-12 17:41:44 +01002736 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2737 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Robin Leece3399f2016-02-24 12:08:32 +00002738 return mService.installKeyPair(admin, pkcs8Key, pemCert, alias, requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002739 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002740 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Robin Lee0d5ccb72014-09-12 17:41:44 +01002741 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2742 Log.w(TAG, "Failed to obtain private key material", e);
2743 } catch (CertificateException | IOException e) {
2744 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002745 }
2746 return false;
2747 }
2748
2749 /**
Robin Leece3399f2016-02-24 12:08:32 +00002750 * Called by a device or profile owner, or delegated certificate installer, to remove all user
2751 * credentials installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01002752 *
2753 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2754 * {@code null} if calling from a delegated certificate installer.
2755 * @param alias The private key alias under which the certificate is installed.
2756 * @return {@code true} if the keys were both removed, {@code false} otherwise.
2757 */
2758 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
2759 try {
2760 return mService.removeKeyPair(admin, alias);
2761 } catch (RemoteException e) {
Esteban Talaverac1c83592016-02-17 17:56:15 +00002762 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Robin Leefbc65642015-08-03 16:21:22 +01002763 }
2764 return false;
2765 }
2766
2767 /**
Robin Lee25e26452015-06-02 09:56:29 -07002768 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00002769 * doesn't exist.
2770 */
2771 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2772 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2773 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2774 new ByteArrayInputStream(certBuffer));
2775 return new TrustedCertificateStore().getCertificateAlias(cert);
2776 }
2777
2778 /**
Rubin Xuec32b562015-03-03 17:34:05 +00002779 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01002780 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00002781 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01002782 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00002783 * <p>
2784 * Delegated certificate installer is a per-user state. The delegated access is persistent until
2785 * it is later cleared by calling this method with a null value or uninstallling the certificate
2786 * installer.
Rubin Xuf03d0a62016-02-10 14:54:15 +00002787 *<p>
2788 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
2789 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
2790 * supplied certificate installer package must be installed when calling this API,
2791 * otherwise an {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00002792 *
Robin Lee25e26452015-06-02 09:56:29 -07002793 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00002794 * @param installerPackage The package name of the certificate installer which will be given
Robin Lee25e26452015-06-02 09:56:29 -07002795 * access. If {@code null} is given the current package will be cleared.
Rubin Xuec32b562015-03-03 17:34:05 +00002796 */
Robin Lee25e26452015-06-02 09:56:29 -07002797 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
2798 installerPackage) throws SecurityException {
Rubin Xuec32b562015-03-03 17:34:05 +00002799 if (mService != null) {
2800 try {
Robin Lee25e26452015-06-02 09:56:29 -07002801 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00002802 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002803 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Rubin Xuec32b562015-03-03 17:34:05 +00002804 }
2805 }
2806 }
2807
2808 /**
2809 * Called by a profile owner or device owner to retrieve the certificate installer for the
Makoto Onuki32b30572015-12-11 14:29:51 -08002810 * user. null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00002811 *
Robin Lee25e26452015-06-02 09:56:29 -07002812 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2813 * @return The package name of the current delegated certificate installer, or {@code null}
Rubin Xuec32b562015-03-03 17:34:05 +00002814 * if none is set.
2815 */
Robin Lee25e26452015-06-02 09:56:29 -07002816 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Rubin Xuec32b562015-03-03 17:34:05 +00002817 if (mService != null) {
2818 try {
Robin Lee25e26452015-06-02 09:56:29 -07002819 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00002820 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002821 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Rubin Xuec32b562015-03-03 17:34:05 +00002822 }
2823 }
2824 return null;
2825 }
2826
2827 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00002828 * Called by a device or profile owner to configure an always-on VPN connection through a
2829 * specific application for the current user.
2830 * This connection is automatically granted and persisted after a reboot.
2831 *
2832 * <p>The designated package should declare a {@link android.net.VpnService} in its
2833 * manifest guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE},
2834 * otherwise the call will fail.
2835 *
2836 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null}
2837 * to remove an existing always-on VPN configuration.
2838 *
2839 * @return {@code true} if the package is set as always-on VPN controller;
2840 * {@code false} otherwise.
2841 */
2842 public boolean setAlwaysOnVpnPackage(@NonNull ComponentName admin,
2843 @Nullable String vpnPackage) {
2844 if (mService != null) {
2845 try {
2846 return mService.setAlwaysOnVpnPackage(admin, vpnPackage);
2847 } catch (RemoteException e) {
2848 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
2849 }
2850 }
2851 return false;
2852 }
2853
2854 /**
2855 * Called by a device or profile owner to read the name of the package administering an
2856 * always-on VPN connection for the current user.
2857 * If there is no such package, or the always-on VPN is provided by the system instead
2858 * of by an application, {@code null} will be returned.
2859 *
2860 * @return Package name of VPN controller responsible for always-on VPN,
2861 * or {@code null} if none is set.
2862 */
2863 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
2864 if (mService != null) {
2865 try {
2866 return mService.getAlwaysOnVpnPackage(admin);
2867 } catch (RemoteException e) {
2868 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
2869 }
2870 }
2871 return null;
2872 }
2873
2874 /**
Ben Komalo2447edd2011-05-09 16:05:33 -07002875 * Called by an application that is administering the device to disable all cameras
Amith Yamasani242f4b12014-10-14 16:06:13 -07002876 * on the device, for this user. After setting this, no applications running as this user
2877 * will be able to access any cameras on the device.
Ben Komalo2447edd2011-05-09 16:05:33 -07002878 *
Makoto Onuki759a7632015-10-28 16:43:10 -07002879 * <p>If the caller is device owner, then the restriction will be applied to all users.
2880 *
Ben Komalo2447edd2011-05-09 16:05:33 -07002881 * <p>The calling device admin must have requested
2882 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call
2883 * this method; if it has not, a security exception will be thrown.
2884 *
2885 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2886 * @param disabled Whether or not the camera should be disabled.
2887 */
Robin Lee25e26452015-06-02 09:56:29 -07002888 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Ben Komalo2447edd2011-05-09 16:05:33 -07002889 if (mService != null) {
2890 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002891 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07002892 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002893 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ben Komalo2447edd2011-05-09 16:05:33 -07002894 }
2895 }
2896 }
2897
2898 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07002899 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08002900 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07002901 * @param admin The name of the admin component to check, or {@code null} to check whether any admins
Ben Komalo2447edd2011-05-09 16:05:33 -07002902 * have disabled the camera
2903 */
Robin Lee25e26452015-06-02 09:56:29 -07002904 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002905 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002906 }
2907
2908 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002909 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07002910 if (mService != null) {
2911 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002912 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07002913 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002914 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ben Komalo2447edd2011-05-09 16:05:33 -07002915 }
2916 }
2917 return false;
2918 }
2919
2920 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00002921 * Called by a device owner to request a bugreport.
2922 *
2923 * <p>There must be only one user on the device, managed by the device owner.
2924 * Otherwise a security exception will be thrown.
2925 *
2926 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2927 * @return {@code true} if the bugreport collection started successfully, or {@code false}
2928 * if it wasn't triggered because a previous bugreport operation is still active
2929 * (either the bugreport is still running or waiting for the user to share or decline)
2930 */
2931 public boolean requestBugreport(@NonNull ComponentName admin) {
2932 if (mService != null) {
2933 try {
2934 return mService.requestBugreport(admin);
2935 } catch (RemoteException e) {
2936 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
2937 }
2938 }
2939 return false;
2940 }
2941
2942 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07002943 * Determine whether or not creating a guest user has been disabled for the device
2944 *
2945 * @hide
2946 */
2947 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
2948 // Currently guest users can always be created if multi-user is enabled
2949 // TODO introduce a policy for guest user creation
2950 return false;
2951 }
2952
2953 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01002954 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
2955 * screen capture also prevents the content from being shown on display devices that do not have
2956 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
2957 * secure surfaces and secure displays.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002958 *
2959 * <p>The calling device admin must be a device or profile owner. If it is not, a
2960 * security exception will be thrown.
2961 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07002962 * <p>From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also
Benjamin Franzc200f442015-06-25 18:20:04 +01002963 * blocks assist requests for all activities of the relevant user.
2964 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002965 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01002966 * @param disabled Whether screen capture is disabled or not.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002967 */
Robin Lee25e26452015-06-02 09:56:29 -07002968 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002969 if (mService != null) {
2970 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002971 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002972 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002973 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002974 }
2975 }
2976 }
2977
2978 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08002979 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002980 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07002981 * @param admin The name of the admin component to check, or {@code null} to check whether any admins
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002982 * have disabled screen capture.
2983 */
Robin Lee25e26452015-06-02 09:56:29 -07002984 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002985 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002986 }
2987
2988 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002989 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002990 if (mService != null) {
2991 try {
2992 return mService.getScreenCaptureDisabled(admin, userHandle);
2993 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002994 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002995 }
2996 }
2997 return false;
2998 }
2999
3000 /**
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003001 * Called by a device owner to set whether auto time is required. If auto time is
3002 * required the user cannot set the date and time, but has to use network date and time.
3003 *
3004 * <p>Note: if auto time is required the user can still manually set the time zone.
3005 *
3006 * <p>The calling device admin must be a device owner. If it is not, a security exception will
3007 * be thrown.
3008 *
3009 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3010 * @param required Whether auto time is set required or not.
3011 */
Robin Lee25e26452015-06-02 09:56:29 -07003012 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003013 if (mService != null) {
3014 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003015 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003016 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003017 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003018 }
3019 }
3020 }
3021
3022 /**
3023 * @return true if auto time is required.
3024 */
3025 public boolean getAutoTimeRequired() {
3026 if (mService != null) {
3027 try {
3028 return mService.getAutoTimeRequired();
3029 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003030 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003031 }
3032 }
3033 return false;
3034 }
3035
3036 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003037 * Called by a device owner to set whether all users created on the device should be ephemeral.
3038 *
3039 * <p>The system user is exempt from this policy - it is never ephemeral.
3040 *
3041 * <p>The calling device admin must be the device owner. If it is not, a security exception will
3042 * be thrown.
3043 *
3044 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3045 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
3046 * subsequently created users will be ephemeral.
3047 * @hide
3048 */
3049 public void setForceEphemeralUsers(
3050 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
3051 if (mService != null) {
3052 try {
3053 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3054 } catch (RemoteException e) {
3055 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3056 }
3057 }
3058 }
3059
3060 /**
3061 * @return true if all users are created ephemeral.
3062 * @hide
3063 */
3064 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
3065 if (mService != null) {
3066 try {
3067 return mService.getForceEphemeralUsers(admin);
3068 } catch (RemoteException e) {
3069 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3070 }
3071 }
3072 return false;
3073 }
3074
3075 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003076 * Called by an application that is administering the device to disable keyguard customizations,
3077 * such as widgets. After setting this, keyguard features will be disabled according to the
3078 * provided feature list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003079 *
3080 * <p>The calling device admin must have requested
Jim Miller48b9b0d2012-09-19 23:16:50 -07003081 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call
Jim Millerb8ec4702012-08-31 17:19:10 -07003082 * this method; if it has not, a security exception will be thrown.
3083 *
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003084 * <p>Calling this from a managed profile before version
Esteban Talaverac1c83592016-02-17 17:56:15 +00003085 * {@link android.os.Build.VERSION_CODES#M} will throw a security exception. From version
3086 * {@link android.os.Build.VERSION_CODES#M} the profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003087 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003088 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
3089 * is no separate challenge set on the managed profile.
3090 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
3091 * there is one, or the parent user otherwise.
3092 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications
3093 * generated by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003094 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003095 *
3096 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3097 * set on the {@link DevicePolicyManager} instance returned by
3098 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the
3099 * parent profile.
3100 *
3101 * <p>Requests to disable other features on a managed profile will be ignored.
3102 *
3103 * <p>The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003104 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003105 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003106 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003107 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
3108 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
Jim Miller50e62182014-04-23 17:25:00 -07003109 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003110 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_FINGERPRINT},
3111 * {@link #KEYGUARD_DISABLE_FEATURES_ALL}
Jim Millerb8ec4702012-08-31 17:19:10 -07003112 */
Robin Lee25e26452015-06-02 09:56:29 -07003113 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003114 if (mService != null) {
3115 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003116 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003117 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003118 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millerb8ec4702012-08-31 17:19:10 -07003119 }
3120 }
3121 }
3122
3123 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003124 * Determine whether or not features have been disabled in keyguard either by the calling
Esteban Talaverac1c83592016-02-17 17:56:15 +00003125 * admin, if specified, or all admins that set retrictions on this user and its participating
3126 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3127 *
3128 * <p>This method can be called on the {@link DevicePolicyManager} instance
3129 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3130 * restrictions on the parent profile.
3131 *
Esteban Talavera62399912016-01-11 15:37:55 +00003132 * @param admin The name of the admin component to check, or {@code null} to check whether any
3133 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003134 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3135 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003136 */
Robin Lee25e26452015-06-02 09:56:29 -07003137 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003138 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003139 }
3140
3141 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003142 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003143 if (mService != null) {
3144 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003145 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003146 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003147 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millerb8ec4702012-08-31 17:19:10 -07003148 }
3149 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003150 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003151 }
3152
3153 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003154 * @hide
3155 */
Robin Lee25e26452015-06-02 09:56:29 -07003156 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3157 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003158 if (mService != null) {
3159 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003160 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003161 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003162 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003163 }
3164 }
3165 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003166
Dianne Hackbornd6847842010-01-12 18:14:19 -08003167 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003168 * @hide
3169 */
Robin Lee25e26452015-06-02 09:56:29 -07003170 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003171 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003172 }
3173
3174 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003175 * @hide
3176 */
Robin Lee25e26452015-06-02 09:56:29 -07003177 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003178 if (mService != null) {
3179 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003180 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003181 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003182 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003183 }
3184 }
3185 }
3186
3187 /**
3188 * @hide
3189 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003190 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003191 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003192 if (mService != null) {
3193 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003194 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003195 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003196 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003197 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003198 }
3199 }
3200 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003201
Dianne Hackbornd6847842010-01-12 18:14:19 -08003202 /**
3203 * @hide
3204 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003205 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003206 if (mService != null) {
3207 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003208 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003209 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003210 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003211 }
3212 }
3213 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003214
Dianne Hackbornd6847842010-01-12 18:14:19 -08003215 /**
3216 * @hide
3217 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003218 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003219 if (mService != null) {
3220 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003221 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003222 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003223 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003224 }
3225 }
3226 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003227
3228 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003229 * @hide
3230 */
3231 public void reportFailedFingerprintAttempt(int userHandle) {
3232 if (mService != null) {
3233 try {
3234 mService.reportFailedFingerprintAttempt(userHandle);
3235 } catch (RemoteException e) {
3236 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3237 }
3238 }
3239 }
3240
3241 /**
3242 * @hide
3243 */
3244 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3245 if (mService != null) {
3246 try {
3247 mService.reportSuccessfulFingerprintAttempt(userHandle);
3248 } catch (RemoteException e) {
3249 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3250 }
3251 }
3252 }
3253
3254 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003255 * Should be called when keyguard has been dismissed.
3256 * @hide
3257 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003258 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003259 if (mService != null) {
3260 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003261 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003262 } catch (RemoteException e) {
3263 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3264 }
3265 }
3266 }
3267
3268 /**
3269 * Should be called when keyguard view has been shown to the user.
3270 * @hide
3271 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003272 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003273 if (mService != null) {
3274 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003275 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003276 } catch (RemoteException e) {
3277 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3278 }
3279 }
3280 }
3281
3282 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003283 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003284 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003285 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3286 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003287 * @return whether the package was successfully registered as the device owner.
3288 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003289 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003290 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003291 public boolean setDeviceOwner(ComponentName who) {
3292 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003293 }
3294
3295 /**
3296 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003297 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003298 public boolean setDeviceOwner(ComponentName who, int userId) {
3299 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003300 }
3301
3302 /**
3303 * @hide
3304 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003305 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3306 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003307 }
3308
3309 /**
3310 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003311 * Sets the given package as the device owner. The package must already be installed. There
3312 * must not already be a device owner.
3313 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3314 * this method.
3315 * Calling this after the setup phase of the primary user has completed is allowed only if
3316 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003317 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003318 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003319 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003320 * @return whether the package was successfully registered as the device owner.
3321 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003322 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003323 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003324 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003325 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003326 if (mService != null) {
3327 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003328 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003329 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003330 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003331 }
3332 }
3333 return false;
3334 }
3335
3336 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003337 * Used to determine if a particular package has been registered as a Device Owner app.
3338 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003339 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003340 * package is currently registered as the device owner app, pass in the package name from
3341 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003342 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003343 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3344 * the setup process.
3345 * @param packageName the package name of the app, to compare with the registered device owner
3346 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003347 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003348 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003349 public boolean isDeviceOwnerApp(String packageName) {
Makoto Onukic8a5a552015-11-19 14:29:12 -08003350 return isDeviceOwnerAppOnCallingUser(packageName);
3351 }
3352
3353 /**
3354 * @return true if a package is registered as device owner, only when it's running on the
3355 * calling user.
3356 *
3357 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3358 * @hide
3359 */
3360 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3361 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3362 }
3363
3364 /**
3365 * @return true if a package is registered as device owner, even if it's running on a different
3366 * user.
3367 *
3368 * <p>Requires the MANAGE_USERS permission.
3369 *
3370 * @hide
3371 */
3372 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3373 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3374 }
3375
3376 /**
3377 * @return device owner component name, only when it's running on the calling user.
3378 *
3379 * @hide
3380 */
3381 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3382 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3383 }
3384
3385 /**
3386 * @return device owner component name, even if it's running on a different user.
3387 *
3388 * <p>Requires the MANAGE_USERS permission.
3389 *
3390 * @hide
3391 */
3392 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3393 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3394 }
3395
3396 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003397 if (packageName == null) {
3398 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003399 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003400 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003401 if (deviceOwner == null) {
3402 return false;
3403 }
3404 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003405 }
3406
Makoto Onukic8a5a552015-11-19 14:29:12 -08003407 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3408 if (mService != null) {
3409 try {
3410 return mService.getDeviceOwnerComponent(callingUserOnly);
3411 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003412 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Makoto Onukic8a5a552015-11-19 14:29:12 -08003413 }
3414 }
3415 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003416 }
3417
Jason Monkb0dced82014-06-06 14:36:20 -04003418 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003419 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3420 * no device owner.
3421 *
3422 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003423 *
3424 * @hide
3425 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003426 public int getDeviceOwnerUserId() {
3427 if (mService != null) {
3428 try {
3429 return mService.getDeviceOwnerUserId();
3430 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003431 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Makoto Onukic8a5a552015-11-19 14:29:12 -08003432 }
3433 }
3434 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003435 }
3436
3437 /**
Jason Monkb0dced82014-06-06 14:36:20 -04003438 * Clears the current device owner. The caller must be the device owner.
3439 *
3440 * This function should be used cautiously as once it is called it cannot
3441 * be undone. The device owner can only be set as a part of device setup
3442 * before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003443 *
3444 * @param packageName The package name of the device owner.
Jason Monkb0dced82014-06-06 14:36:20 -04003445 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003446 public void clearDeviceOwnerApp(String packageName) {
Jason Monkb0dced82014-06-06 14:36:20 -04003447 if (mService != null) {
3448 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003449 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003450 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003451 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Jason Monkb0dced82014-06-06 14:36:20 -04003452 }
3453 }
3454 }
3455
Makoto Onukia52562c2015-10-01 16:12:31 -07003456 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003457 * Returns the device owner package name, only if it's running on the calling user.
3458 *
3459 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003460 *
3461 * @hide
3462 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003463 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003464 public String getDeviceOwner() {
Makoto Onukic8a5a552015-11-19 14:29:12 -08003465 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3466 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003467 }
3468
3469 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003470 * @return true if the device is managed by any device owner.
3471 *
3472 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003473 *
3474 * @hide
3475 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003476 public boolean isDeviceManaged() {
3477 return getDeviceOwnerComponentOnAnyUser() != null;
3478 }
3479
3480 /**
3481 * Returns the device owner name. Note this method *will* return the device owner
3482 * name when it's running on a different user.
3483 *
3484 * <p>Requires the MANAGE_USERS permission.
3485 *
3486 * @hide
3487 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003488 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003489 public String getDeviceOwnerNameOnAnyUser() {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003490 if (mService != null) {
3491 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003492 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003493 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003494 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003495 }
3496 }
3497 return null;
3498 }
Adam Connors776c5552014-01-09 10:42:56 +00003499
3500 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003501 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003502 * @deprecated Do not use
3503 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003504 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003505 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003506 @SystemApi
3507 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003508 return null;
3509 }
3510
3511 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003512 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003513 * @deprecated Do not use
3514 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003515 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003516 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003517 @SystemApi
3518 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003519 return null;
3520 }
3521
Julia Reynolds20118f12015-02-11 12:34:08 -05003522 /**
Adam Connors776c5552014-01-09 10:42:56 +00003523 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003524 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303525 * Sets the given component as an active admin and registers the package as the profile
3526 * owner for this user. The package must already be installed and there shouldn't be
3527 * an existing profile owner registered for this user. Also, this method must be called
3528 * before the user setup has been completed.
3529 * <p>
3530 * This method can only be called by system apps that hold MANAGE_USERS permission and
3531 * MANAGE_DEVICE_ADMINS permission.
3532 * @param admin The component to register as an active admin and profile owner.
3533 * @param ownerName The user-visible name of the entity that is managing this user.
3534 * @return whether the admin was successfully registered as the profile owner.
3535 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3536 * the user has already been set up.
3537 */
Justin Morey80440cc2014-07-24 09:16:35 -05003538 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003539 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303540 throws IllegalArgumentException {
3541 if (mService != null) {
3542 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003543 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303544 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003545 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303546 } catch (RemoteException re) {
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303547 throw new IllegalArgumentException("Couldn't set profile owner.", re);
3548 }
3549 }
3550 return false;
3551 }
3552
3553 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003554 * Clears the active profile owner and removes all user restrictions. The caller must
3555 * be from the same package as the active profile owner for this user, otherwise a
3556 * SecurityException will be thrown.
3557 *
Makoto Onuki5bf68022016-01-27 13:49:19 -08003558 * <p>This doesn't work for managed profile owners.
3559 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003560 * @param admin The component to remove as the profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003561 */
Robin Lee25e26452015-06-02 09:56:29 -07003562 public void clearProfileOwner(@NonNull ComponentName admin) {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003563 if (mService != null) {
3564 try {
3565 mService.clearProfileOwner(admin);
3566 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003567 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003568 }
3569 }
3570 }
3571
3572 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003573 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003574 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003575 */
3576 public boolean hasUserSetupCompleted() {
3577 if (mService != null) {
3578 try {
3579 return mService.hasUserSetupCompleted();
3580 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003581 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003582 }
3583 }
3584 return true;
3585 }
3586
3587 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003588 * @hide
3589 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003590 * already be installed. There must not already be a profile owner for this user.
3591 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3592 * this method.
3593 * Calling this after the setup phase of the specified user has completed is allowed only if:
3594 * - the caller is SYSTEM_UID.
3595 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003596 * @param admin the component name to be registered as profile owner.
3597 * @param ownerName the human readable name of the organisation associated with this DPM.
3598 * @param userHandle the userId to set the profile owner for.
3599 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003600 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3601 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003602 */
Robin Lee25e26452015-06-02 09:56:29 -07003603 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003604 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003605 if (mService != null) {
3606 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003607 if (ownerName == null) {
3608 ownerName = "";
3609 }
3610 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003611 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003612 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Adam Connors776c5552014-01-09 10:42:56 +00003613 throw new IllegalArgumentException("Couldn't set profile owner.", re);
3614 }
3615 }
3616 return false;
3617 }
3618
3619 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003620 * Sets the device owner information to be shown on the lock screen.
3621 *
3622 * <p>If the device owner information is {@code null} or empty then the device owner info is
3623 * cleared and the user owner info is shown on the lock screen if it is set.
Andrei Stingaceanucc5061f2016-01-07 17:55:57 +00003624 * <p>If the device owner information contains only whitespaces then the message on the lock
3625 * screen will be blank and the user will not be allowed to change it.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003626 *
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003627 * <p>If the device owner information needs to be localized, it is the responsibility of the
3628 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3629 * and set a new version of this string accordingly.
3630 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003631 * @param admin The name of the admin component to check.
3632 * @param info Device owner information which will be displayed instead of the user
3633 * owner info.
3634 * @return Whether the device owner information has been set.
3635 */
3636 public boolean setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, String info) {
3637 if (mService != null) {
3638 try {
3639 return mService.setDeviceOwnerLockScreenInfo(admin, info);
3640 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003641 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003642 }
3643 }
3644 return false;
3645 }
3646
3647 /**
3648 * @return The device owner information. If it is not set returns {@code null}.
3649 */
3650 public String getDeviceOwnerLockScreenInfo() {
3651 if (mService != null) {
3652 try {
3653 return mService.getDeviceOwnerLockScreenInfo();
3654 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003655 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003656 }
3657 }
3658 return null;
3659 }
3660
3661 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003662 * Called by device or profile owners to suspend packages for this user.
3663 *
3664 * <p>A suspended package will not be able to start activities. Its notifications will
3665 * be hidden, it will not show up in recents, will not be able to show toasts or dialogs
3666 * or ring the device.
3667 *
3668 * <p>The package must already be installed.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003669 *
3670 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003671 * @param packageNames The package names to suspend or unsuspend.
3672 * @param suspended If set to {@code true} than the packages will be suspended, if set to
3673 * {@code false} the packages will be unsuspended.
3674 * @return an array of package names for which the suspended status is not set as requested in
3675 * this method.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003676 */
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003677 public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003678 boolean suspended) {
3679 if (mService != null) {
3680 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003681 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003682 } catch (RemoteException re) {
Esteban Talaverac1c83592016-02-17 17:56:15 +00003683 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003684 }
3685 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003686 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003687 }
3688
3689 /**
3690 * Called by device or profile owners to determine if a package is suspended.
3691 *
3692 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3693 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00003694 * @return {@code true} if the package is suspended or {@code false} if the package is not
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003695 * suspended, could not be found or an error occurred.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003696 */
3697 public boolean getPackageSuspended(@NonNull ComponentName admin, String packageName) {
3698 if (mService != null) {
3699 try {
3700 return mService.getPackageSuspended(admin, packageName);
3701 } catch (RemoteException e) {
Esteban Talaverac1c83592016-02-17 17:56:15 +00003702 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003703 }
3704 }
3705 return false;
3706 }
3707
3708 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003709 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3710 * be used. Only the profile owner can call this.
3711 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01003712 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003713 *
3714 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3715 */
Robin Lee25e26452015-06-02 09:56:29 -07003716 public void setProfileEnabled(@NonNull ComponentName admin) {
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003717 if (mService != null) {
3718 try {
3719 mService.setProfileEnabled(admin);
3720 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003721 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003722 }
3723 }
3724 }
3725
3726 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003727 * Sets the name of the profile. In the device owner case it sets the name of the user
3728 * which it is called from. Only a profile owner or device owner can call this. If this is
Jessica Hummel1333ea12014-06-23 11:20:10 +01003729 * never called by the profile or device owner, the name will be set to default values.
3730 *
3731 * @see #isProfileOwnerApp
3732 * @see #isDeviceOwnerApp
3733 *
Robin Lee25e26452015-06-02 09:56:29 -07003734 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003735 * @param profileName The name of the profile.
3736 */
Robin Lee25e26452015-06-02 09:56:29 -07003737 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Jessica Hummel1333ea12014-06-23 11:20:10 +01003738 if (mService != null) {
3739 try {
Robin Lee25e26452015-06-02 09:56:29 -07003740 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003741 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003742 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003743 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003744 }
3745 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003746
3747 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003748 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08003749 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003750 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00003751 *
3752 * @param packageName The package name of the app to compare with the registered profile owner.
3753 * @return Whether or not the package is registered as the profile owner.
3754 */
3755 public boolean isProfileOwnerApp(String packageName) {
3756 if (mService != null) {
3757 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08003758 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01003759 return profileOwner != null
3760 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00003761 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003762 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Adam Connors776c5552014-01-09 10:42:56 +00003763 }
3764 }
3765 return false;
3766 }
3767
3768 /**
3769 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003770 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00003771 * owner has been set for that user.
3772 * @throws IllegalArgumentException if the userId is invalid.
3773 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003774 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003775 public ComponentName getProfileOwner() throws IllegalArgumentException {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01003776 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
3777 }
3778
3779 /**
3780 * @see #getProfileOwner()
3781 * @hide
3782 */
3783 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003784 if (mService != null) {
3785 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01003786 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00003787 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003788 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Adam Connors776c5552014-01-09 10:42:56 +00003789 throw new IllegalArgumentException(
3790 "Requested profile owner for invalid userId", re);
3791 }
3792 }
3793 return null;
3794 }
3795
3796 /**
3797 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003798 * @return the human readable name of the organisation associated with this DPM or {@code null}
3799 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00003800 * @throws IllegalArgumentException if the userId is invalid.
3801 */
3802 public String getProfileOwnerName() throws IllegalArgumentException {
3803 if (mService != null) {
3804 try {
3805 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
3806 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003807 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Adam Connors776c5552014-01-09 10:42:56 +00003808 throw new IllegalArgumentException(
3809 "Requested profile owner for invalid userId", re);
3810 }
3811 }
3812 return null;
3813 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003814
3815 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07003816 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08003817 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07003818 * @return the human readable name of the organisation associated with this profile owner or
3819 * null if one is not set.
3820 * @throws IllegalArgumentException if the userId is invalid.
3821 */
3822 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02003823 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Amith Yamasani38f836b2014-08-20 14:51:15 -07003824 if (mService != null) {
3825 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02003826 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07003827 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003828 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasani38f836b2014-08-20 14:51:15 -07003829 throw new IllegalArgumentException(
3830 "Requested profile owner for invalid userId", re);
3831 }
3832 }
3833 return null;
3834 }
3835
3836 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003837 * Called by a profile owner or device owner to add a default intent handler activity for
3838 * intents that match a certain intent filter. This activity will remain the default intent
3839 * handler even if the set of potential event handlers for the intent filter changes and if
3840 * the intent preferences are reset.
3841 *
3842 * <p>The default disambiguation mechanism takes over if the activity is not installed
3843 * (anymore). When the activity is (re)installed, it is automatically reset as default
3844 * intent handler for the filter.
3845 *
3846 * <p>The calling device admin must be a profile owner or device owner. If it is not, a
3847 * security exception will be thrown.
3848 *
3849 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3850 * @param filter The IntentFilter for which a default handler is added.
3851 * @param activity The Activity that is added as default intent handler.
3852 */
Robin Lee25e26452015-06-02 09:56:29 -07003853 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
3854 @NonNull ComponentName activity) {
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003855 if (mService != null) {
3856 try {
3857 mService.addPersistentPreferredActivity(admin, filter, activity);
3858 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003859 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003860 }
3861 }
3862 }
3863
3864 /**
3865 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00003866 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003867 *
3868 * <p>The calling device admin must be a profile owner. If it is not, a security
3869 * exception will be thrown.
3870 *
3871 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3872 * @param packageName The name of the package for which preferences are removed.
3873 */
Robin Lee25e26452015-06-02 09:56:29 -07003874 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003875 String packageName) {
3876 if (mService != null) {
3877 try {
3878 mService.clearPackagePersistentPreferredActivities(admin, packageName);
3879 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003880 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003881 }
3882 }
3883 }
Robin Lee66e5d962014-04-09 16:44:21 +01003884
3885 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00003886 * Called by a profile owner or device owner to grant permission to a package to manage
3887 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
3888 * {@link #getApplicationRestrictions}.
3889 * <p>
3890 * This permission is persistent until it is later cleared by calling this method with a
3891 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00003892 * <p>
3893 * The supplied application restriction managing package must be installed when calling this
3894 * API, otherwise an {@link IllegalArgumentException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00003895 *
3896 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3897 * @param packageName The package name which will be given access to application restrictions
3898 * APIs. If {@code null} is given the current package will be cleared.
3899 */
3900 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
3901 @Nullable String packageName) {
3902 if (mService != null) {
3903 try {
3904 mService.setApplicationRestrictionsManagingPackage(admin, packageName);
3905 } catch (RemoteException e) {
3906 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3907 }
3908 }
3909 }
3910
3911 /**
3912 * Called by a profile owner or device owner to retrieve the application restrictions managing
3913 * package for the current user, or {@code null} if none is set.
3914 *
3915 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3916 * @return The package name allowed to manage application restrictions on the current user, or
3917 * {@code null} if none is set.
3918 */
3919 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
3920 if (mService != null) {
3921 try {
3922 return mService.getApplicationRestrictionsManagingPackage(admin);
3923 } catch (RemoteException e) {
3924 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3925 }
3926 }
3927 return null;
3928 }
3929
3930 /**
3931 * Returns {@code true} if the calling package has been granted permission via
3932 * {@link #setApplicationRestrictionsManagingPackage} to manage application
3933 * restrictions for the calling user.
3934 */
3935 public boolean isCallerApplicationRestrictionsManagingPackage() {
3936 if (mService != null) {
3937 try {
3938 return mService.isCallerApplicationRestrictionsManagingPackage();
3939 } catch (RemoteException e) {
3940 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3941 }
3942 }
3943 return false;
3944 }
3945
3946 /**
3947 * Sets the application restrictions for a given target application running in the calling user.
3948 *
3949 * <p>The caller must be a profile or device owner on that user, or the package allowed to
3950 * manage application restrictions via {@link #setApplicationRestrictionsManagingPackage};
3951 * otherwise a security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01003952 *
Esteban Talavera6b8e0642015-08-10 17:26:04 +01003953 * <p>The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
3954 * <ul>
3955 * <li>{@code boolean}
3956 * <li>{@code int}
3957 * <li>{@code String} or {@code String[]}
3958 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
3959 * </ul>
Robin Lee66e5d962014-04-09 16:44:21 +01003960 *
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00003961 * <p>If the restrictions are not available yet, but may be applied in the near future,
Esteban Talaverabf60f722015-12-10 16:26:44 +00003962 * the caller can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00003963 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
3964 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00003965 * <p>The application restrictions are only made visible to the target application via
3966 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or
3967 * device owner, and the application restrictions managing package via
3968 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01003969 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00003970 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3971 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01003972 * @param packageName The name of the package to update restricted settings for.
3973 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
3974 * set of active restrictions.
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00003975 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00003976 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00003977 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01003978 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00003979 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01003980 Bundle settings) {
3981 if (mService != null) {
3982 try {
3983 mService.setApplicationRestrictions(admin, packageName, settings);
3984 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003985 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Robin Lee66e5d962014-04-09 16:44:21 +01003986 }
3987 }
3988 }
3989
3990 /**
Jim Millere303bf42014-08-26 17:12:29 -07003991 * Sets a list of configuration features to enable for a TrustAgent component. This is meant
3992 * to be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all
3993 * trust agents but those enabled by this function call. If flag
3994 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Jim Miller604e7552014-07-18 19:00:02 -07003995 *
3996 * <p>The calling device admin must have requested
3997 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call
Jim Millere303bf42014-08-26 17:12:29 -07003998 * this method; if not, a security exception will be thrown.
Jim Miller604e7552014-07-18 19:00:02 -07003999 *
4000 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004001 * @param target Component name of the agent to be enabled.
Jim Millerb5db57a2015-01-14 18:17:19 -08004002 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent
Jim Millere303bf42014-08-26 17:12:29 -07004003 * will be strictly disabled according to the state of the
4004 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4005 * <p>If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all admins,
4006 * then it's up to the TrustAgent itself to aggregate the values from all device admins.
4007 * <p>Consult documentation for the specific TrustAgent to determine legal options parameters.
Jim Miller604e7552014-07-18 19:00:02 -07004008 */
Robin Lee25e26452015-06-02 09:56:29 -07004009 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4010 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004011 if (mService != null) {
4012 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08004013 mService.setTrustAgentConfiguration(admin, target, configuration);
Jim Miller604e7552014-07-18 19:00:02 -07004014 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004015 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Miller604e7552014-07-18 19:00:02 -07004016 }
4017 }
4018 }
4019
4020 /**
Jim Millere303bf42014-08-26 17:12:29 -07004021 * Gets configuration for the given trust agent based on aggregating all calls to
4022 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4023 * all device admins.
Jim Miller604e7552014-07-18 19:00:02 -07004024 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004025 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4026 * this function returns a list of configurations for all admins that declare
4027 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4028 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4029 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4030 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004031 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004032 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004033 */
Robin Lee25e26452015-06-02 09:56:29 -07004034 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4035 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004036 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004037 }
4038
4039 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004040 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4041 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004042 if (mService != null) {
4043 try {
Jim Millere303bf42014-08-26 17:12:29 -07004044 return mService.getTrustAgentConfiguration(admin, agent, userHandle);
Jim Miller604e7552014-07-18 19:00:02 -07004045 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004046 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Miller604e7552014-07-18 19:00:02 -07004047 }
4048 }
Jim Millere303bf42014-08-26 17:12:29 -07004049 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004050 }
4051
4052 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004053 * Called by a profile owner of a managed profile to set whether caller-Id information from
4054 * the managed profile will be shown in the parent profile, for incoming calls.
Adam Connors210fe212014-07-17 15:41:43 +01004055 *
4056 * <p>The calling device admin must be a profile owner. If it is not, a
4057 * security exception will be thrown.
4058 *
Robin Lee25e26452015-06-02 09:56:29 -07004059 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004060 * @param disabled If true caller-Id information in the managed profile is not displayed.
4061 */
Robin Lee25e26452015-06-02 09:56:29 -07004062 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Adam Connors210fe212014-07-17 15:41:43 +01004063 if (mService != null) {
4064 try {
Robin Lee25e26452015-06-02 09:56:29 -07004065 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004066 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004067 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Adam Connors210fe212014-07-17 15:41:43 +01004068 }
4069 }
4070 }
4071
4072 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004073 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4074 * information has been disabled.
Adam Connors210fe212014-07-17 15:41:43 +01004075 *
4076 * <p>The calling device admin must be a profile owner. If it is not, a
4077 * security exception will be thrown.
4078 *
Robin Lee25e26452015-06-02 09:56:29 -07004079 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004080 */
Robin Lee25e26452015-06-02 09:56:29 -07004081 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Adam Connors210fe212014-07-17 15:41:43 +01004082 if (mService != null) {
4083 try {
Robin Lee25e26452015-06-02 09:56:29 -07004084 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004085 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004086 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Adam Connors210fe212014-07-17 15:41:43 +01004087 }
4088 }
4089 return false;
4090 }
4091
4092 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004093 * Determine whether or not caller-Id information has been disabled.
4094 *
4095 * @param userHandle The user for whom to check the caller-id permission
4096 * @hide
4097 */
4098 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4099 if (mService != null) {
4100 try {
4101 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4102 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004103 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Amith Yamasani570002f2014-07-18 15:48:54 -07004104 }
4105 }
4106 return false;
4107 }
4108
4109 /**
Victor Chang1060c6182016-01-04 20:16:23 +00004110 * Called by a profile owner of a managed profile to set whether contacts search from
4111 * the managed profile will be shown in the parent profile, for incoming calls.
4112 *
4113 * <p>The calling device admin must be a profile owner. If it is not, a
4114 * security exception will be thrown.
4115 *
4116 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4117 * @param disabled If true contacts search in the managed profile is not displayed.
4118 */
4119 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4120 boolean disabled) {
4121 if (mService != null) {
4122 try {
4123 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4124 } catch (RemoteException e) {
4125 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
4126 }
4127 }
4128 }
4129
4130 /**
4131 * Called by a profile owner of a managed profile to determine whether or not contacts search
4132 * has been disabled.
4133 *
4134 * <p>The calling device admin must be a profile owner. If it is not, a
4135 * security exception will be thrown.
4136 *
4137 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4138 */
4139 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
4140 if (mService != null) {
4141 try {
4142 return mService.getCrossProfileContactsSearchDisabled(admin);
4143 } catch (RemoteException e) {
4144 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
4145 }
4146 }
4147 return false;
4148 }
4149
4150
4151 /**
4152 * Determine whether or not contacts search has been disabled.
4153 *
4154 * @param userHandle The user for whom to check the contacts search permission
4155 * @hide
4156 */
4157 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4158 if (mService != null) {
4159 try {
4160 return mService
4161 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4162 } catch (RemoteException e) {
4163 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
4164 }
4165 }
4166 return false;
4167 }
4168
4169 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004170 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004171 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004172 * @hide
4173 */
4174 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004175 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004176 if (mService != null) {
4177 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004178 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4179 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004180 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004181 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Makoto Onuki1040da12015-03-19 11:24:00 -07004182 }
4183 }
4184 }
4185
4186 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004187 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004188 * @hide
4189 */
4190 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4191 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004192 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004193 originalIntent);
4194 }
4195
4196 /**
Ricky Wai778ba132015-03-31 14:21:22 +01004197 * Called by a profile owner of a managed profile to set whether bluetooth
4198 * devices can access enterprise contacts.
4199 * <p>
4200 * The calling device admin must be a profile owner. If it is not, a
4201 * security exception will be thrown.
4202 * <p>
4203 * This API works on managed profile only.
4204 *
Robin Lee25e26452015-06-02 09:56:29 -07004205 * @param admin Which {@link DeviceAdminReceiver} this request is associated
Ricky Wai778ba132015-03-31 14:21:22 +01004206 * with.
4207 * @param disabled If true, bluetooth devices cannot access enterprise
4208 * contacts.
4209 */
Robin Lee25e26452015-06-02 09:56:29 -07004210 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Ricky Wai778ba132015-03-31 14:21:22 +01004211 if (mService != null) {
4212 try {
Robin Lee25e26452015-06-02 09:56:29 -07004213 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004214 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004215 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ricky Wai778ba132015-03-31 14:21:22 +01004216 }
4217 }
4218 }
4219
4220 /**
4221 * Called by a profile owner of a managed profile to determine whether or
4222 * not Bluetooth devices cannot access enterprise contacts.
4223 * <p>
4224 * The calling device admin must be a profile owner. If it is not, a
4225 * security exception will be thrown.
4226 * <p>
4227 * This API works on managed profile only.
4228 *
Robin Lee25e26452015-06-02 09:56:29 -07004229 * @param admin Which {@link DeviceAdminReceiver} this request is associated
Ricky Wai778ba132015-03-31 14:21:22 +01004230 * with.
4231 */
Robin Lee25e26452015-06-02 09:56:29 -07004232 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Ricky Wai778ba132015-03-31 14:21:22 +01004233 if (mService != null) {
4234 try {
Robin Lee25e26452015-06-02 09:56:29 -07004235 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004236 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004237 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ricky Wai778ba132015-03-31 14:21:22 +01004238 }
4239 }
4240 return true;
4241 }
4242
4243 /**
4244 * Determine whether or not Bluetooth devices cannot access contacts.
4245 * <p>
4246 * This API works on managed profile UserHandle only.
4247 *
4248 * @param userHandle The user for whom to check the caller-id permission
4249 * @hide
4250 */
4251 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4252 if (mService != null) {
4253 try {
4254 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4255 .getIdentifier());
4256 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004257 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ricky Wai778ba132015-03-31 14:21:22 +01004258 }
4259 }
4260 return true;
4261 }
4262
4263 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004264 * Called by the profile owner of a managed profile so that some intents sent in the managed
4265 * profile can also be resolved in the parent, or vice versa.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004266 * Only activity intents are supported.
4267 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004268 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004269 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
4270 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004271 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
4272 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004273 */
Robin Lee25e26452015-06-02 09:56:29 -07004274 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004275 if (mService != null) {
4276 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004277 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004278 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004279 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004280 }
4281 }
4282 }
4283
4284 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004285 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4286 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004287 * Only removes those that have been set by the profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004288 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4289 */
Robin Lee25e26452015-06-02 09:56:29 -07004290 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004291 if (mService != null) {
4292 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004293 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004294 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004295 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004296 }
4297 }
4298 }
4299
4300 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004301 * Called by a profile or device owner to set the permitted accessibility services. When
4302 * set by a device owner or profile owner the restriction applies to all profiles of the
4303 * user the device owner or profile owner is an admin for.
Jim Millerb1474f42014-08-26 18:42:58 -07004304 *
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004305 * By default the user can use any accessiblity service. When zero or more packages have
4306 * been added, accessiblity services that are not in the list and not part of the system
Jim Millerb1474f42014-08-26 18:42:58 -07004307 * can not be enabled by the user.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004308 *
4309 * <p> Calling with a null value for the list disables the restriction so that all services
4310 * can be used, calling with an empty list only allows the builtin system's services.
4311 *
4312 * <p> System accesibility services are always available to the user the list can't modify
4313 * this.
4314 *
4315 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4316 * @param packageNames List of accessibility service package names.
4317 *
4318 * @return true if setting the restriction succeeded. It fail if there is
4319 * one or more non-system accessibility services enabled, that are not in the list.
4320 */
Robin Lee25e26452015-06-02 09:56:29 -07004321 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004322 List<String> packageNames) {
4323 if (mService != null) {
4324 try {
4325 return mService.setPermittedAccessibilityServices(admin, packageNames);
4326 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004327 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004328 }
4329 }
4330 return false;
4331 }
4332
4333 /**
4334 * Returns the list of permitted accessibility services set by this device or profile owner.
4335 *
4336 * <p>An empty list means no accessibility services except system services are allowed.
4337 * Null means all accessibility services are allowed.
4338 *
4339 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4340 * @return List of accessiblity service package names.
4341 */
Robin Lee25e26452015-06-02 09:56:29 -07004342 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004343 if (mService != null) {
4344 try {
4345 return mService.getPermittedAccessibilityServices(admin);
4346 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004347 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004348 }
4349 }
4350 return null;
4351 }
4352
4353 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004354 * Called by the system to check if a specific accessibility service is disabled by admin.
4355 *
4356 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4357 * @param packageName Accessibility service package name that needs to be checked.
4358 * @param userHandle user id the admin is running as.
4359 * @return true if the accessibility service is permitted, otherwise false.
4360 *
4361 * @hide
4362 */
4363 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4364 @NonNull String packageName, int userHandle) {
4365 if (mService != null) {
4366 try {
4367 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4368 userHandle);
4369 } catch (RemoteException e) {
4370 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
4371 }
4372 }
4373 return false;
4374 }
4375
4376 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004377 * Returns the list of accessibility services permitted by the device or profiles
4378 * owners of this user.
4379 *
4380 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4381 * it will contain the intersection of the permitted lists for any device or profile
4382 * owners that apply to this user. It will also include any system accessibility services.
4383 *
4384 * @param userId which user to check for.
4385 * @return List of accessiblity service package names.
4386 * @hide
4387 */
4388 @SystemApi
4389 public List<String> getPermittedAccessibilityServices(int userId) {
4390 if (mService != null) {
4391 try {
4392 return mService.getPermittedAccessibilityServicesForUser(userId);
4393 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004394 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004395 }
4396 }
4397 return null;
4398 }
4399
4400 /**
4401 * Called by a profile or device owner to set the permitted input methods services. When
4402 * set by a device owner or profile owner the restriction applies to all profiles of the
4403 * user the device owner or profile owner is an admin for.
4404 *
4405 * By default the user can use any input method. When zero or more packages have
4406 * been added, input method that are not in the list and not part of the system
4407 * can not be enabled by the user.
4408 *
4409 * This method will fail if it is called for a admin that is not for the foreground user
4410 * or a profile of the foreground user.
4411 *
4412 * <p> Calling with a null value for the list disables the restriction so that all input methods
4413 * can be used, calling with an empty list disables all but the system's own input methods.
4414 *
4415 * <p> System input methods are always available to the user this method can't modify this.
4416 *
4417 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4418 * @param packageNames List of input method package names.
Kenny Guy74a70242015-02-05 19:48:38 +00004419 * @return true if setting the restriction succeeded. It will fail if there are
4420 * one or more non-system input methods currently enabled that are not in
4421 * the packageNames list.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004422 */
Robin Lee25e26452015-06-02 09:56:29 -07004423 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004424 if (mService != null) {
4425 try {
4426 return mService.setPermittedInputMethods(admin, packageNames);
4427 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004428 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004429 }
4430 }
4431 return false;
4432 }
4433
4434
4435 /**
4436 * Returns the list of permitted input methods set by this device or profile owner.
4437 *
4438 * <p>An empty list means no input methods except system input methods are allowed.
4439 * Null means all input methods are allowed.
4440 *
4441 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4442 * @return List of input method package names.
4443 */
Robin Lee25e26452015-06-02 09:56:29 -07004444 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004445 if (mService != null) {
4446 try {
4447 return mService.getPermittedInputMethods(admin);
4448 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004449 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004450 }
4451 }
4452 return null;
4453 }
4454
4455 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004456 * Called by the system to check if a specific input method is disabled by admin.
4457 *
4458 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4459 * @param packageName Input method package name that needs to be checked.
4460 * @param userHandle user id the admin is running as.
4461 * @return true if the input method is permitted, otherwise false.
4462 *
4463 * @hide
4464 */
4465 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4466 @NonNull String packageName, int userHandle) {
4467 if (mService != null) {
4468 try {
4469 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4470 } catch (RemoteException e) {
4471 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
4472 }
4473 }
4474 return false;
4475 }
4476
4477 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004478 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004479 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004480 *
4481 * <p>Null means all input methods are allowed, if a non-null list is returned
4482 * it will contain the intersection of the permitted lists for any device or profile
4483 * owners that apply to this user. It will also include any system input methods.
4484 *
4485 * @return List of input method package names.
4486 * @hide
4487 */
4488 @SystemApi
4489 public List<String> getPermittedInputMethodsForCurrentUser() {
4490 if (mService != null) {
4491 try {
4492 return mService.getPermittedInputMethodsForCurrentUser();
4493 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004494 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004495 }
4496 }
4497 return null;
4498 }
4499
4500 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004501 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4502 * currently installed it.
4503 *
4504 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4505 *
4506 * @return List of package names to keep cached.
4507 * @hide
4508 */
4509 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
4510 if (mService != null) {
4511 try {
4512 return mService.getKeepUninstalledPackages(admin);
4513 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004514 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004515 }
4516 }
4517 return null;
4518 }
4519
4520 /**
4521 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4522 * currently installed it.
4523 *
4524 * <p>Please note that setting this policy does not imply that specified apps will be
4525 * automatically pre-cached.</p>
4526 *
4527 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4528 * @param packageNames List of package names to keep cached.
4529 * @hide
4530 */
4531 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4532 @NonNull List<String> packageNames) {
4533 if (mService != null) {
4534 try {
4535 mService.setKeepUninstalledPackages(admin, packageNames);
4536 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004537 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004538 }
4539 }
4540 }
4541
4542 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004543 * Called by a device owner to create a user with the specified name. The UserHandle returned
4544 * by this method should not be persisted as user handles are recycled as users are removed and
4545 * created. If you need to persist an identifier for this user, use
4546 * {@link UserManager#getSerialNumberForUser}.
4547 *
4548 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4549 * @param name the user's name
4550 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004551 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4552 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004553 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004554 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004555 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004556 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004557 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004558 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004559 return null;
4560 }
4561
4562 /**
Jason Monk03978a42014-06-10 15:05:30 -04004563 * Called by a device owner to create a user with the specified name. The UserHandle returned
4564 * by this method should not be persisted as user handles are recycled as users are removed and
4565 * created. If you need to persist an identifier for this user, use
4566 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4567 * immediately.
4568 *
4569 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4570 * as registered as an active admin on the new user. The profile owner package will be
4571 * installed on the new user if it already is installed on the device.
4572 *
4573 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4574 * profileOwnerComponent when onEnable is called.
4575 *
4576 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4577 * @param name the user's name
4578 * @param ownerName the human readable name of the organisation associated with this DPM.
4579 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4580 * the user.
4581 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4582 * on the new user.
4583 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004584 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4585 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004586 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004587 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004588 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04004589 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004590 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004591 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4592 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004593 return null;
4594 }
4595
4596 /**
phweissa92e1212016-01-25 17:14:10 +01004597 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01004598 */
4599 public static final int SKIP_SETUP_WIZARD = 0x0001;
4600
4601 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01004602 * Flag used by {@link #createAndManageUser} to specify that the user should be created
4603 * ephemeral.
4604 * @hide
4605 */
4606 public static final int MAKE_USER_EPHEMERAL = 0x0002;
4607
4608 /**
phweissa92e1212016-01-25 17:14:10 +01004609 * Called by a device owner to create a user with the specified name and a given component of
4610 * the calling package as profile owner. The UserHandle returned by this method should not be
4611 * persisted as user handles are recycled as users are removed and created. If you need to
4612 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4613 * user will not be started in the background.
phweiss343fb332016-01-25 14:48:59 +01004614 *
phweissa92e1212016-01-25 17:14:10 +01004615 * <p>admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also
4616 * a DeviceAdminReceiver in the same package as admin, and will become the profile owner and
4617 * will be registered as an active admin on the new user. The profile owner package will be
4618 * installed on the new user.
phweiss343fb332016-01-25 14:48:59 +01004619 *
4620 * <p>If the adminExtras are not null, they will be stored on the device until the user is
4621 * started for the first time. Then the extras will be passed to the admin when
4622 * onEnable is called.
4623 *
4624 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4625 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01004626 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
4627 * same package as admin, otherwise no user is created and an IllegalArgumentException is
4628 * thrown.
phweiss343fb332016-01-25 14:48:59 +01004629 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
4630 * user.
phweissa92e1212016-01-25 17:14:10 +01004631 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01004632 * @see UserHandle
4633 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4634 * user could not be created.
phweiss343fb332016-01-25 14:48:59 +01004635 */
4636 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01004637 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4638 int flags) {
phweiss343fb332016-01-25 14:48:59 +01004639 try {
phweissa92e1212016-01-25 17:14:10 +01004640 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01004641 } catch (RemoteException re) {
4642 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
4643 }
4644 return null;
4645 }
4646
4647 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004648 * Called by a device owner to remove a user and all associated data. The primary user can
4649 * not be removed.
4650 *
4651 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4652 * @param userHandle the user to remove.
4653 * @return {@code true} if the user was removed, {@code false} otherwise.
4654 */
Robin Lee25e26452015-06-02 09:56:29 -07004655 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004656 try {
4657 return mService.removeUser(admin, userHandle);
4658 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004659 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Julia Reynolds1e958392014-05-16 14:25:21 -04004660 return false;
4661 }
4662 }
4663
4664 /**
Jason Monk582d9112014-07-09 19:57:08 -04004665 * Called by a device owner to switch the specified user to the foreground.
4666 *
4667 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4668 * @param userHandle the user to switch to; null will switch to primary.
4669 * @return {@code true} if the switch was successful, {@code false} otherwise.
4670 *
4671 * @see Intent#ACTION_USER_FOREGROUND
4672 */
Robin Lee25e26452015-06-02 09:56:29 -07004673 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Jason Monk582d9112014-07-09 19:57:08 -04004674 try {
4675 return mService.switchUser(admin, userHandle);
4676 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004677 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Jason Monk582d9112014-07-09 19:57:08 -04004678 return false;
4679 }
4680 }
4681
4682 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004683 * Retrieves the application restrictions for a given target application running in the calling
4684 * user.
Robin Lee66e5d962014-04-09 16:44:21 +01004685 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004686 * <p>The caller must be a profile or device owner on that user, or the package allowed to
4687 * manage application restrictions via {@link #setApplicationRestrictionsManagingPackage};
4688 * otherwise a security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01004689 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004690 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
4691 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004692 * @param packageName The name of the package to fetch restricted settings of.
4693 * @return {@link Bundle} of settings corresponding to what was set last time
4694 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty {@link Bundle}
4695 * if no restrictions have been set.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004696 *
4697 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01004698 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004699 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Robin Lee66e5d962014-04-09 16:44:21 +01004700 if (mService != null) {
4701 try {
4702 return mService.getApplicationRestrictions(admin, packageName);
4703 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004704 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Robin Lee66e5d962014-04-09 16:44:21 +01004705 }
4706 }
4707 return null;
4708 }
Amith Yamasanibe465322014-04-24 13:45:17 -07004709
4710 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004711 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07004712 * <p>
4713 * The calling device admin must be a profile or device owner; if it is not,
4714 * a security exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07004715 *
Amith Yamasanibe465322014-04-24 13:45:17 -07004716 * @param admin Which {@link DeviceAdminReceiver} this request is associated
4717 * with.
4718 * @param key The key of the restriction. See the constants in
4719 * {@link android.os.UserManager} for the list of keys.
4720 */
Robin Lee25e26452015-06-02 09:56:29 -07004721 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Amith Yamasanibe465322014-04-24 13:45:17 -07004722 if (mService != null) {
4723 try {
4724 mService.setUserRestriction(admin, key, true);
4725 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004726 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Amith Yamasanibe465322014-04-24 13:45:17 -07004727 }
4728 }
4729 }
4730
4731 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004732 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07004733 * <p>
4734 * The calling device admin must be a profile or device owner; if it is not,
4735 * a security exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07004736 *
Amith Yamasanibe465322014-04-24 13:45:17 -07004737 * @param admin Which {@link DeviceAdminReceiver} this request is associated
4738 * with.
4739 * @param key The key of the restriction. See the constants in
4740 * {@link android.os.UserManager} for the list of keys.
4741 */
Robin Lee25e26452015-06-02 09:56:29 -07004742 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Amith Yamasanibe465322014-04-24 13:45:17 -07004743 if (mService != null) {
4744 try {
4745 mService.setUserRestriction(admin, key, false);
4746 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004747 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Amith Yamasanibe465322014-04-24 13:45:17 -07004748 }
4749 }
4750 }
Adam Connors010cfd42014-04-16 12:48:13 +01004751
4752 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004753 * Called by a profile or device owner to get user restrictions set with
4754 * {@link #addUserRestriction(ComponentName, String)}.
4755 * <p>
4756 * The target user may have more restrictions set by the system or other device owner / profile
4757 * owner. To get all the user restrictions currently set, use
4758 * {@link UserManager#getUserRestrictions()}.
4759 *
4760 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka1c277a52015-11-11 21:58:24 +00004761 * @throws SecurityException if the {@code admin} is not an active admin.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004762 */
4763 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
Sudheer Shanka1c277a52015-11-11 21:58:24 +00004764 return getUserRestrictions(admin, myUserId());
4765 }
4766
4767 /** @hide per-user version */
4768 public Bundle getUserRestrictions(@NonNull ComponentName admin, int userHandle) {
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004769 Bundle ret = null;
4770 if (mService != null) {
4771 try {
Sudheer Shanka1c277a52015-11-11 21:58:24 +00004772 ret = mService.getUserRestrictions(admin, userHandle);
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004773 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004774 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004775 }
4776 }
4777 return ret == null ? new Bundle() : ret;
4778 }
4779
4780 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004781 * Called by profile or device owners to hide or unhide packages. When a package is hidden it
Julia Reynolds966881e2014-05-14 12:23:08 -04004782 * is unavailable for use, but the data and actual package file remain.
4783 *
4784 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004785 * @param packageName The name of the package to hide or unhide.
4786 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
4787 * unhidden.
4788 * @return boolean Whether the hidden setting of the package was successfully updated.
Julia Reynolds966881e2014-05-14 12:23:08 -04004789 */
Robin Lee25e26452015-06-02 09:56:29 -07004790 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004791 boolean hidden) {
Julia Reynolds966881e2014-05-14 12:23:08 -04004792 if (mService != null) {
4793 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004794 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04004795 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004796 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Julia Reynolds966881e2014-05-14 12:23:08 -04004797 }
4798 }
4799 return false;
4800 }
4801
4802 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004803 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04004804 *
4805 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004806 * @param packageName The name of the package to retrieve the hidden status of.
4807 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Julia Reynolds966881e2014-05-14 12:23:08 -04004808 */
Robin Lee25e26452015-06-02 09:56:29 -07004809 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Julia Reynolds966881e2014-05-14 12:23:08 -04004810 if (mService != null) {
4811 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004812 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04004813 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004814 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Julia Reynolds966881e2014-05-14 12:23:08 -04004815 }
4816 }
4817 return false;
4818 }
4819
4820 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004821 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004822 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00004823 *
4824 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08004825 * @param packageName The package to be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00004826 */
Robin Lee25e26452015-06-02 09:56:29 -07004827 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Adam Connors655be2a2014-07-14 09:01:25 +00004828 if (mService != null) {
4829 try {
4830 mService.enableSystemApp(admin, packageName);
4831 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004832 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Adam Connors655be2a2014-07-14 09:01:25 +00004833 }
4834 }
4835 }
4836
4837 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004838 * Called by profile or device owners to re-enable system apps by intent that were disabled
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004839 * by default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00004840 *
4841 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4842 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Makoto Onuki32b30572015-12-11 14:29:51 -08004843 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00004844 * @return int The number of activities that matched the intent and were installed.
4845 */
Robin Lee25e26452015-06-02 09:56:29 -07004846 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Adam Connors655be2a2014-07-14 09:01:25 +00004847 if (mService != null) {
4848 try {
4849 return mService.enableSystemAppWithIntent(admin, intent);
4850 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004851 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Adam Connors655be2a2014-07-14 09:01:25 +00004852 }
4853 }
4854 return 0;
4855 }
4856
4857 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00004858 * Called by a device owner or profile owner to disable account management for a specific type
4859 * of account.
Sander Alewijnse650c3342014-05-08 18:00:50 +01004860 *
Sander Alewijnse112e0532014-10-29 13:28:49 +00004861 * <p>The calling device admin must be a device owner or profile owner. If it is not, a
Sander Alewijnse650c3342014-05-08 18:00:50 +01004862 * security exception will be thrown.
4863 *
4864 * <p>When account management is disabled for an account type, adding or removing an account
4865 * of that type will not be possible.
4866 *
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00004867 * <p>From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
4868 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
4869 * management for a specific type is disabled.
4870 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01004871 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4872 * @param accountType For which account management is disabled or enabled.
4873 * @param disabled The boolean indicating that account management will be disabled (true) or
4874 * enabled (false).
4875 */
Robin Lee25e26452015-06-02 09:56:29 -07004876 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01004877 boolean disabled) {
4878 if (mService != null) {
4879 try {
4880 mService.setAccountManagementDisabled(admin, accountType, disabled);
4881 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004882 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnse650c3342014-05-08 18:00:50 +01004883 }
4884 }
4885 }
4886
4887 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01004888 * Gets the array of accounts for which account management is disabled by the profile owner.
4889 *
4890 * <p> Account management can be disabled/enabled by calling
4891 * {@link #setAccountManagementDisabled}.
4892 *
4893 * @return a list of account types for which account management has been disabled.
4894 *
4895 * @see #setAccountManagementDisabled
4896 */
4897 public String[] getAccountTypesWithManagementDisabled() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004898 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01004899 }
4900
4901 /**
4902 * @see #getAccountTypesWithManagementDisabled()
4903 * @hide
4904 */
4905 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01004906 if (mService != null) {
4907 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01004908 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01004909 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004910 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01004911 }
4912 }
4913
4914 return null;
4915 }
justinzhang511e0d82014-03-24 16:09:24 -04004916
4917 /**
Jason Monkd7b86212014-06-16 13:15:38 -04004918 * Sets which packages may enter lock task mode.
4919 *
4920 * <p>Any packages that shares uid with an allowed package will also be allowed
4921 * to activate lock task.
justinzhang511e0d82014-03-24 16:09:24 -04004922 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004923 * From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
Benjamin Franz469dd582015-06-09 14:24:36 +01004924 * package list results in locked tasks belonging to those packages to be finished.
4925 *
Jason Monkc5185f22014-06-24 11:12:42 -04004926 * This function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04004927 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04004928 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jason Monkd7b86212014-06-16 13:15:38 -04004929 *
4930 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00004931 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
4932 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04004933 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04004934 */
Robin Lee25e26452015-06-02 09:56:29 -07004935 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04004936 throws SecurityException {
justinzhang511e0d82014-03-24 16:09:24 -04004937 if (mService != null) {
4938 try {
Jason Monk48aacba2014-08-13 16:29:08 -04004939 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04004940 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004941 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
justinzhang511e0d82014-03-24 16:09:24 -04004942 }
4943 }
4944 }
4945
4946 /**
Jason Monkd7b86212014-06-16 13:15:38 -04004947 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04004948 *
4949 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04004950 * @hide
4951 */
Robin Lee25e26452015-06-02 09:56:29 -07004952 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
justinzhang511e0d82014-03-24 16:09:24 -04004953 if (mService != null) {
4954 try {
Jason Monk48aacba2014-08-13 16:29:08 -04004955 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04004956 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004957 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
justinzhang511e0d82014-03-24 16:09:24 -04004958 }
4959 }
4960 return null;
4961 }
4962
4963 /**
4964 * This function lets the caller know whether the given component is allowed to start the
4965 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04004966 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04004967 */
Jason Monkd7b86212014-06-16 13:15:38 -04004968 public boolean isLockTaskPermitted(String pkg) {
justinzhang511e0d82014-03-24 16:09:24 -04004969 if (mService != null) {
4970 try {
Jason Monkd7b86212014-06-16 13:15:38 -04004971 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04004972 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004973 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
justinzhang511e0d82014-03-24 16:09:24 -04004974 }
4975 }
4976 return false;
4977 }
Julia Reynoldsda551652014-05-14 17:15:16 -04004978
4979 /**
4980 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
4981 * of the setting is in the correct form for the setting type should be performed by the caller.
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004982 * <p>The settings that can be updated with this method are:
4983 * <ul>
4984 * <li>{@link Settings.Global#ADB_ENABLED}</li>
4985 * <li>{@link Settings.Global#AUTO_TIME}</li>
4986 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004987 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004988 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004989 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Benjamin Franz68cc4202015-03-11 15:43:06 +00004990 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN}
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004991 * This setting is only available from {@link android.os.Build.VERSION_CODES#M} onwards
Esteban Talavera656fa7f2015-06-29 17:41:39 +01004992 * and can only be set if {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
Zoltan Szatmary-Ban4045d242015-05-27 12:42:39 +01004993 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004994 * This setting is only available from {@link android.os.Build.VERSION_CODES#M} onwards.
Zoltan Szatmary-Ban3c430952015-07-03 14:04:09 +01004995 * </li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004996 * </ul>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01004997 * <p>Changing the following settings has no effect as of
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004998 * {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01004999 * <ul>
5000 * <li>{@link Settings.Global#BLUETOOTH_ON}.
5001 * Use {@link android.bluetooth.BluetoothAdapter#enable()} and
5002 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
5003 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
5004 * <li>{@link Settings.Global#MODE_RINGER}.
5005 * Use {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
5006 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
5007 * <li>{@link Settings.Global#WIFI_ON}.
5008 * Use {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
5009 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005010 *
5011 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5012 * @param setting The name of the setting to update.
5013 * @param value The value to update the setting to.
5014 */
Robin Lee25e26452015-06-02 09:56:29 -07005015 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Julia Reynoldsda551652014-05-14 17:15:16 -04005016 if (mService != null) {
5017 try {
5018 mService.setGlobalSetting(admin, setting, value);
5019 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005020 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Julia Reynoldsda551652014-05-14 17:15:16 -04005021 }
5022 }
5023 }
5024
5025 /**
5026 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5027 * that the value of the setting is in the correct form for the setting type should be performed
5028 * by the caller.
Julia Reynolds82735bc2014-09-04 16:43:30 -04005029 * <p>The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005030 * <ul>
5031 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005032 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005033 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5034 * </ul>
Julia Reynolds82735bc2014-09-04 16:43:30 -04005035 * <p>A device owner can additionally update the following settings:
5036 * <ul>
5037 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5038 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005039 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5040 * @param setting The name of the setting to update.
5041 * @param value The value to update the setting to.
5042 */
Robin Lee25e26452015-06-02 09:56:29 -07005043 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Julia Reynoldsda551652014-05-14 17:15:16 -04005044 if (mService != null) {
5045 try {
5046 mService.setSecureSetting(admin, setting, value);
5047 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005048 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Julia Reynoldsda551652014-05-14 17:15:16 -04005049 }
5050 }
5051 }
5052
Amith Yamasanif20d6402014-05-24 15:34:37 -07005053 /**
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005054 * Designates a specific service component as the provider for
Amith Yamasanif20d6402014-05-24 15:34:37 -07005055 * making permission requests of a local or remote administrator of the user.
5056 * <p/>
5057 * Only a profile owner can designate the restrictions provider.
5058 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005059 * @param provider The component name of the service that implements
Amith Yamasanid1d7c022014-08-19 17:03:41 -07005060 * {@link RestrictionsReceiver}. If this param is null,
Amith Yamasanif20d6402014-05-24 15:34:37 -07005061 * it removes the restrictions provider previously assigned.
5062 */
Robin Lee25e26452015-06-02 09:56:29 -07005063 public void setRestrictionsProvider(@NonNull ComponentName admin,
5064 @Nullable ComponentName provider) {
Amith Yamasanif20d6402014-05-24 15:34:37 -07005065 if (mService != null) {
5066 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005067 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005068 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005069 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005070 }
5071 }
5072 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005073
5074 /**
5075 * Called by profile or device owners to set the master volume mute on or off.
5076 *
5077 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5078 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
5079 */
Robin Lee25e26452015-06-02 09:56:29 -07005080 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Julia Reynolds4a21b252014-06-04 11:11:43 -04005081 if (mService != null) {
5082 try {
5083 mService.setMasterVolumeMuted(admin, on);
5084 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005085 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Julia Reynolds4a21b252014-06-04 11:11:43 -04005086 }
5087 }
5088 }
5089
5090 /**
5091 * Called by profile or device owners to check whether the master volume mute is on or off.
5092 *
5093 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5094 * @return {@code true} if master volume is muted, {@code false} if it's not.
5095 */
Robin Lee25e26452015-06-02 09:56:29 -07005096 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Julia Reynolds4a21b252014-06-04 11:11:43 -04005097 if (mService != null) {
5098 try {
5099 return mService.isMasterVolumeMuted(admin);
5100 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005101 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Julia Reynolds4a21b252014-06-04 11:11:43 -04005102 }
5103 }
5104 return false;
5105 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005106
5107 /**
5108 * Called by profile or device owners to change whether a user can uninstall
5109 * a package.
5110 *
5111 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5112 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005113 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005114 */
Robin Lee25e26452015-06-02 09:56:29 -07005115 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005116 boolean uninstallBlocked) {
Kenny Guyc13053b2014-05-29 14:17:17 +01005117 if (mService != null) {
5118 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005119 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005120 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005121 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Kenny Guyc13053b2014-05-29 14:17:17 +01005122 }
5123 }
5124 }
5125
5126 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005127 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005128 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005129 * <p>
5130 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Robin Lee25e26452015-06-02 09:56:29 -07005131 * behavior of this API is changed such that passing {@code null} as the {@code admin}
Rubin Xue1e6faa2015-03-10 10:51:59 +00005132 * parameter will return if any admin has blocked the uninstallation. Before L MR1, passing
Robin Lee25e26452015-06-02 09:56:29 -07005133 * {@code null} will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005134 *
Robin Lee25e26452015-06-02 09:56:29 -07005135 * @param admin The name of the admin component whose blocking policy will be checked, or
5136 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005137 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005138 * @return true if uninstallation is blocked.
Kenny Guyc13053b2014-05-29 14:17:17 +01005139 */
Robin Lee25e26452015-06-02 09:56:29 -07005140 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Kenny Guyc13053b2014-05-29 14:17:17 +01005141 if (mService != null) {
5142 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005143 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005144 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005145 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Kenny Guyc13053b2014-05-29 14:17:17 +01005146 }
5147 }
5148 return false;
5149 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005150
5151 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005152 * Called by the profile owner of a managed profile to enable widget providers from a
5153 * given package to be available in the parent profile. As a result the user will be able to
Svetoslav976e8bd2014-07-16 15:12:03 -07005154 * add widgets from the white-listed package running under the profile to a widget
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005155 * host which runs under the parent profile, for example the home screen. Note that
Svetoslav976e8bd2014-07-16 15:12:03 -07005156 * a package may have zero or more provider components, where each component
5157 * provides a different widget type.
5158 * <p>
5159 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005160 *
5161 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5162 * @param packageName The package from which widget providers are white-listed.
5163 * @return Whether the package was added.
5164 *
5165 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5166 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5167 */
Robin Lee25e26452015-06-02 09:56:29 -07005168 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Svetoslav976e8bd2014-07-16 15:12:03 -07005169 if (mService != null) {
5170 try {
5171 return mService.addCrossProfileWidgetProvider(admin, packageName);
5172 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005173 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Svetoslav976e8bd2014-07-16 15:12:03 -07005174 }
5175 }
5176 return false;
5177 }
5178
5179 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005180 * Called by the profile owner of a managed profile to disable widget providers from a given
5181 * package to be available in the parent profile. For this method to take effect the
Svetoslav976e8bd2014-07-16 15:12:03 -07005182 * package should have been added via {@link #addCrossProfileWidgetProvider(
5183 * android.content.ComponentName, String)}.
5184 * <p>
5185 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005186 *
5187 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5188 * @param packageName The package from which widget providers are no longer
5189 * white-listed.
5190 * @return Whether the package was removed.
5191 *
5192 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5193 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5194 */
Esteban Talavera62399912016-01-11 15:37:55 +00005195 public boolean removeCrossProfileWidgetProvider(
5196 @NonNull ComponentName admin, String packageName) {
Svetoslav976e8bd2014-07-16 15:12:03 -07005197 if (mService != null) {
5198 try {
5199 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5200 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005201 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Svetoslav976e8bd2014-07-16 15:12:03 -07005202 }
5203 }
5204 return false;
5205 }
5206
5207 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005208 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005209 * available in the parent profile.
5210 *
5211 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5212 * @return The white-listed package list.
5213 *
5214 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5215 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5216 */
Robin Lee25e26452015-06-02 09:56:29 -07005217 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Svetoslav976e8bd2014-07-16 15:12:03 -07005218 if (mService != null) {
5219 try {
5220 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5221 if (providers != null) {
5222 return providers;
5223 }
5224 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005225 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Svetoslav976e8bd2014-07-16 15:12:03 -07005226 }
5227 }
5228 return Collections.emptyList();
5229 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005230
5231 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005232 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005233 *
5234 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5235 * @param icon the bitmap to set as the photo.
5236 */
Robin Lee25e26452015-06-02 09:56:29 -07005237 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005238 try {
5239 mService.setUserIcon(admin, icon);
5240 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005241 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005242 }
5243 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005244
5245 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005246 * Called by device owners to set a local system update policy. When a new policy is set,
5247 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005248 *
Robin Lee25e26452015-06-02 09:56:29 -07005249 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
5250 * components in the device owner package can set system update policies and the
5251 * most recent policy takes
Rubin Xu5faad8e2015-04-20 17:43:48 +01005252 * effect.
Robin Lee25e26452015-06-02 09:56:29 -07005253 * @param policy the new policy, or {@code null} to clear the current policy.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005254 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005255 */
Robin Lee25e26452015-06-02 09:56:29 -07005256 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Rubin Xu8027a4f2015-03-10 17:52:37 +00005257 if (mService != null) {
5258 try {
Robin Lee25e26452015-06-02 09:56:29 -07005259 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005260 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005261 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005262 }
5263 }
5264 }
5265
5266 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005267 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005268 *
Robin Lee25e26452015-06-02 09:56:29 -07005269 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005270 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01005271 public SystemUpdatePolicy getSystemUpdatePolicy() {
Rubin Xu8027a4f2015-03-10 17:52:37 +00005272 if (mService != null) {
5273 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005274 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005275 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005276 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005277 }
5278 }
5279 return null;
5280 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005281
5282 /**
5283 * Called by a device owner to disable the keyguard altogether.
5284 *
5285 * <p>Setting the keyguard to disabled has the same effect as choosing "None" as the screen
5286 * lock type. However, this call has no effect if a password, pin or pattern is currently set.
5287 * If a password, pin or pattern is set after the keyguard was disabled, the keyguard stops
5288 * being disabled.
5289 *
5290 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005291 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005292 *
5293 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Benjamin Franzbece8062015-05-06 12:14:31 +01005294 * place. {@code true} otherwise.
Benjamin Franze36087e2015-04-07 16:40:34 +01005295 */
Robin Lee25e26452015-06-02 09:56:29 -07005296 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franze36087e2015-04-07 16:40:34 +01005297 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005298 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005299 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005300 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Benjamin Franze36087e2015-04-07 16:40:34 +01005301 return false;
5302 }
5303 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005304
5305 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005306 * Called by device owner to disable the status bar. Disabling the status bar blocks
5307 * notifications, quick settings and other screen overlays that allow escaping from
Benjamin Franzea2ec972015-03-16 17:18:09 +00005308 * a single use device.
5309 *
5310 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005311 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
5312 *
5313 * @return {@code false} if attempting to disable the status bar failed.
5314 * {@code true} otherwise.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005315 */
Robin Lee25e26452015-06-02 09:56:29 -07005316 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzea2ec972015-03-16 17:18:09 +00005317 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005318 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005319 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005320 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Benjamin Franzbece8062015-05-06 12:14:31 +01005321 return false;
Benjamin Franzea2ec972015-03-16 17:18:09 +00005322 }
5323 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005324
5325 /**
5326 * Callable by the system update service to notify device owners about pending updates.
5327 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5328 * permission.
5329 *
5330 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5331 * when the current pending update was first available. -1 if no update is available.
5332 * @hide
5333 */
5334 @SystemApi
5335 public void notifyPendingSystemUpdate(long updateReceivedTime) {
5336 if (mService != null) {
5337 try {
5338 mService.notifyPendingSystemUpdate(updateReceivedTime);
5339 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005340 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Rubin Xudc105cc2015-04-14 23:38:01 +01005341 }
5342 }
5343 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005344
5345 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005346 * Called by profile or device owners to set the default response for future runtime permission
5347 * requests by applications. The policy can allow for normal operation which prompts the
5348 * user to grant a permission, or can allow automatic granting or denying of runtime
5349 * permission requests by an application. This also applies to new permissions declared by app
Benjamin Franz45dd6662015-07-08 14:24:14 +01005350 * updates. When a permission is denied or granted this way, the effect is equivalent to setting
5351 * the permission grant state via {@link #setPermissionGrantState}.
5352 *
5353 * <p/>As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005354 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005355 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005356 * @param admin Which profile or device owner this request is associated with.
5357 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
5358 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005359 *
5360 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005361 */
Robin Lee25e26452015-06-02 09:56:29 -07005362 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005363 try {
5364 mService.setPermissionPolicy(admin, policy);
5365 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005366 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005367 }
5368 }
5369
5370 /**
5371 * Returns the current runtime permission policy set by the device or profile owner. The
5372 * default is {@link #PERMISSION_POLICY_PROMPT}.
5373 * @param admin Which profile or device owner this request is associated with.
5374 * @return the current policy for future permission requests.
5375 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005376 public int getPermissionPolicy(ComponentName admin) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005377 try {
5378 return mService.getPermissionPolicy(admin);
5379 } catch (RemoteException re) {
5380 return PERMISSION_POLICY_PROMPT;
5381 }
5382 }
5383
5384 /**
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005385 * Sets the grant state of a runtime permission for a specific application. The state
5386 * can be {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it
5387 * through the UI, {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission
5388 * is denied and the user cannot manage it through the UI, and {@link
5389 * #PERMISSION_GRANT_STATE_GRANTED granted} in which the permission is granted and the
5390 * user cannot manage it through the UI. This might affect all permissions in a
5391 * group that the runtime permission belongs to. This method can only be called
5392 * by a profile or device owner.
5393 *
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005394 * <p/>Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not
5395 * revoke the permission. It retains the previous grant, if any.
5396 *
5397 * <p/>Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005398 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005399 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005400 * @param admin Which profile or device owner this request is associated with.
5401 * @param packageName The application to grant or revoke a permission to.
5402 * @param permission The permission to grant or revoke.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005403 * @param grantState The permission grant state which is one of {@link
5404 * #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5405 * {@link #PERMISSION_GRANT_STATE_GRANTED},
5406 * @return whether the permission was successfully granted or revoked.
5407 *
5408 * @see #PERMISSION_GRANT_STATE_DENIED
5409 * @see #PERMISSION_GRANT_STATE_DEFAULT
5410 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005411 */
Robin Lee25e26452015-06-02 09:56:29 -07005412 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005413 String permission, int grantState) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005414 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005415 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005416 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005417 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005418 return false;
5419 }
5420 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005421
5422 /**
5423 * Returns the current grant state of a runtime permission for a specific application.
5424 *
5425 * @param admin Which profile or device owner this request is associated with.
5426 * @param packageName The application to check the grant state for.
5427 * @param permission The permission to check for.
5428 * @return the current grant state specified by device policy. If the profile or device owner
5429 * has not set a grant state, the return value is {@link #PERMISSION_GRANT_STATE_DEFAULT}.
5430 * This does not indicate whether or not the permission is currently granted for the package.
5431 *
5432 * <p/>If a grant state was set by the profile or device owner, then the return value will
5433 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or {@link #PERMISSION_GRANT_STATE_GRANTED},
5434 * which indicates if the permission is currently denied or granted.
5435 *
5436 * @see #setPermissionGrantState(ComponentName, String, String, int)
5437 * @see PackageManager#checkPermission(String, String)
5438 */
Robin Lee25e26452015-06-02 09:56:29 -07005439 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005440 String permission) {
5441 try {
5442 return mService.getPermissionGrantState(admin, packageName, permission);
5443 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005444 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasani184b3752015-05-22 13:00:51 -07005445 return PERMISSION_GRANT_STATE_DEFAULT;
5446 }
5447 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005448
5449 /**
5450 * Returns if provisioning a managed profile or device is possible or not.
5451 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5452 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
5453 * Note that even if this method returns true, there is a slight possibility that the
5454 * provisioning will not be allowed when it is actually initiated because some event has
5455 * happened in between.
5456 * @return if provisioning a managed profile or device is possible or not.
5457 * @throws IllegalArgumentException if the supplied action is not valid.
5458 */
5459 public boolean isProvisioningAllowed(String action) {
5460 try {
5461 return mService.isProvisioningAllowed(action);
5462 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005463 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005464 return false;
5465 }
5466 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005467
5468 /**
5469 * @hide
5470 * Return if this user is a managed profile of another user. An admin can become the profile
5471 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
5472 * user with {@link #ACTION_PROVISION_MANAGED_USER}.
5473 * @param admin Which profile owner this request is associated with.
5474 * @return if this user is a managed profile of another user.
5475 */
5476 public boolean isManagedProfile(@NonNull ComponentName admin) {
5477 try {
5478 return mService.isManagedProfile(admin);
5479 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005480 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005481 return false;
5482 }
5483 }
5484
5485 /**
5486 * @hide
5487 * Return if this user is a system-only user. An admin can manage a device from a system only
5488 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5489 * @param admin Which device owner this request is associated with.
5490 * @return if this user is a system-only user.
5491 */
5492 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5493 try {
5494 return mService.isSystemOnlyUser(admin);
5495 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005496 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005497 return false;
5498 }
5499 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005500
5501 /**
5502 * Called by device owner to get the MAC address of the Wi-Fi device.
5503 *
5504 * @return the MAC address of the Wi-Fi device, or null when the information is not
5505 * available. (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5506 *
5507 * <p>The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5508 */
5509 public String getWifiMacAddress() {
5510 try {
5511 return mService.getWifiMacAddress();
5512 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005513 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005514 return null;
5515 }
5516 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005517
5518 /**
5519 * Called by device owner to reboot the device.
5520 */
5521 public void reboot(@NonNull ComponentName admin) {
5522 try {
5523 mService.reboot(admin);
5524 } catch (RemoteException re) {
5525 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5526 }
5527 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005528
5529 /**
5530 * Called by a device admin to set the short support message. This will
5531 * be displayed to the user in settings screens where funtionality has
5532 * been disabled by the admin.
5533 *
5534 * The message should be limited to a short statement such as
5535 * "This setting is disabled by your administrator. Contact someone@example.com
5536 * for support."
5537 * If the message is longer than 200 characters it may be truncated.
5538 *
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005539 * <p>If the short support message needs to be localized, it is the responsibility of the
5540 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5541 * and set a new version of this string accordingly.
5542 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005543 * @see #setLongSupportMessage
5544 *
5545 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5546 * @param message Short message to be displayed to the user in settings or null to
5547 * clear the existing message.
5548 */
5549 public void setShortSupportMessage(@NonNull ComponentName admin,
5550 @Nullable String message) {
5551 if (mService != null) {
5552 try {
5553 mService.setShortSupportMessage(admin, message);
5554 } catch (RemoteException e) {
5555 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5556 }
5557 }
5558 }
5559
5560 /**
5561 * Called by a device admin to get the short support message.
5562 *
5563 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5564 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)}
5565 * or null if no message has been set.
5566 */
5567 public String getShortSupportMessage(@NonNull ComponentName admin) {
5568 if (mService != null) {
5569 try {
5570 return mService.getShortSupportMessage(admin);
5571 } catch (RemoteException e) {
5572 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5573 }
5574 }
5575 return null;
5576 }
5577
5578 /**
5579 * Called by a device admin to set the long support message. This will
5580 * be displayed to the user in the device administators settings screen.
5581 *
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005582 * <p>If the long support message needs to be localized, it is the responsibility of the
5583 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5584 * and set a new version of this string accordingly.
5585 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005586 * @see #setShortSupportMessage
5587 *
5588 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5589 * @param message Long message to be displayed to the user in settings or null to
5590 * clear the existing message.
5591 */
5592 public void setLongSupportMessage(@NonNull ComponentName admin,
5593 @Nullable String message) {
5594 if (mService != null) {
5595 try {
5596 mService.setLongSupportMessage(admin, message);
5597 } catch (RemoteException e) {
5598 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5599 }
5600 }
5601 }
5602
5603 /**
5604 * Called by a device admin to get the long support message.
5605 *
5606 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5607 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)}
5608 * or null if no message has been set.
5609 */
5610 public String getLongSupportMessage(@NonNull ComponentName admin) {
5611 if (mService != null) {
5612 try {
5613 return mService.getLongSupportMessage(admin);
5614 } catch (RemoteException e) {
5615 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5616 }
5617 }
5618 return null;
5619 }
5620
5621 /**
5622 * Called by the system to get the short support message.
5623 *
5624 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5625 * @param userHandle user id the admin is running as.
5626 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)}
5627 *
5628 * @hide
5629 */
5630 public String getShortSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
5631 if (mService != null) {
5632 try {
5633 return mService.getShortSupportMessageForUser(admin, userHandle);
5634 } catch (RemoteException e) {
5635 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5636 }
5637 }
5638 return null;
5639 }
5640
5641
5642 /**
5643 * Called by the system to get the long support message.
5644 *
5645 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5646 * @param userHandle user id the admin is running as.
5647 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)}
5648 *
5649 * @hide
5650 */
5651 public String getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
5652 if (mService != null) {
5653 try {
5654 return mService.getLongSupportMessageForUser(admin, userHandle);
5655 } catch (RemoteException e) {
5656 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5657 }
5658 }
5659 return null;
5660 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005661
5662 /**
Esteban Talavera62399912016-01-11 15:37:55 +00005663 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
5664 * whose calls act on the parent profile.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005665 *
5666 * <p> Note only some methods will work on the parent Manager.
5667 *
5668 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
5669 */
5670 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
5671 try {
5672 if (!mService.isManagedProfile(admin)) {
5673 throw new SecurityException("The current user does not have a parent profile.");
5674 }
5675 return new DevicePolicyManager(mContext, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005676 } catch (RemoteException e) {
5677 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5678 return null;
5679 }
5680 }
5681
5682 /**
5683 * Called by device owner to control the device logging feature. Logging can only be
5684 * enabled on single user devices where the sole user is managed by the device owner.
5685 *
5686 * <p> Device logs contain various information intended for security auditing purposes.
5687 * See {@link SecurityEvent} for details.
5688 *
5689 * @param admin Which device owner this request is associated with.
5690 * @param enabled whether device logging should be enabled or not.
5691 * @see #retrieveDeviceLogs
5692 */
5693 public void setDeviceLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
5694 try {
5695 mService.setDeviceLoggingEnabled(admin, enabled);
5696 } catch (RemoteException re) {
5697 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5698 }
5699 }
5700
5701 /**
5702 * Return whether device logging is enabled or not by the device owner.
5703 *
5704 * @param admin Which device owner this request is associated with.
5705 * @return {@code true} if device logging is enabled by device owner, {@code false} otherwise.
5706 */
5707 public boolean getDeviceLoggingEnabled(@NonNull ComponentName admin) {
5708 try {
5709 return mService.getDeviceLoggingEnabled(admin);
5710 } catch (RemoteException re) {
5711 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5712 return false;
5713 }
5714 }
5715
5716 /**
5717 * Called by device owner to retrieve all new device logging entries since the last call to
5718 * this API after device boots.
5719 *
5720 * <p> Access to the logs is rate limited and it will only return new logs after the device
5721 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
5722 *
5723 * @param admin Which device owner this request is associated with.
5724 * @return the new batch of device logs which is a list of {@link SecurityEvent},
5725 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
5726 */
5727 public List<SecurityEvent> retrieveDeviceLogs(@NonNull ComponentName admin) {
5728 try {
5729 ParceledListSlice<SecurityEvent> list = mService.retrieveDeviceLogs(admin);
5730 if (list != null) {
5731 return list.getList();
5732 } else {
5733 // Rate limit exceeded.
5734 return null;
5735 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005736 } catch (RemoteException re) {
5737 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5738 return null;
5739 }
5740 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00005741
5742 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00005743 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
5744 * profile.
5745 *
5746 * @hide
5747 */
5748 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
5749 mContext.checkSelfPermission(
5750 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
5751 if (!uInfo.isManagedProfile()) {
5752 throw new SecurityException("The user " + uInfo.id
5753 + " does not have a parent profile.");
5754 }
5755 return new DevicePolicyManager(mContext, true);
5756 }
5757
5758 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005759 * Called by device owners to retrieve device logs from before the device's last reboot.
5760 *
5761 * <p>
5762 * <strong> The device logs are retrieved from a RAM region which is not guaranteed to be
5763 * corruption-free during power cycles, due to hardware variations and limitations. As a
5764 * result, this API is provided as best-effort and the returned logs may contain corrupted data.
5765 * </strong>
5766 *
5767 * @param admin Which device owner this request is associated with.
5768 * @return Device logs from before the latest reboot of the system.
5769 */
5770 public List<SecurityEvent> retrievePreviousDeviceLogs(@NonNull ComponentName admin) {
5771 try {
5772 ParceledListSlice<SecurityEvent> list = mService.retrievePreviousDeviceLogs(admin);
5773 return list.getList();
5774 } catch (RemoteException re) {
5775 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5776 return Collections.<SecurityEvent>emptyList();
5777 }
5778 }
5779
5780 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00005781 * Called by a profile owner of a managed profile to set the color used for customization.
5782 * This color is used as background color of the confirm credentials screen for that user.
5783 * The default color is {@link android.graphics.Color#GRAY}.
5784 *
5785 * <p>The confirm credentials screen can be created using
5786 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
5787 *
5788 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5789 * @param color The 32bit representation of the color to be used.
5790 */
5791 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
5792 try {
5793 mService.setOrganizationColor(admin, color);
5794 } catch (RemoteException re) {
5795 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5796 }
5797 }
5798
5799 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00005800 * @hide
5801 *
5802 * Sets the color used for customization.
5803 *
5804 * @param color The 32bit representation of the color to be used.
5805 * @param userId which user to set the color to.
5806 * @RequiresPermission(allOf = {
5807 * Manifest.permission.MANAGE_USERS,
5808 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
5809 */
5810 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
5811 try {
5812 mService.setOrganizationColorForUser(color, userId);
5813 } catch (RemoteException re) {
5814 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5815 }
5816 }
5817
5818 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00005819 * Called by a profile owner of a managed profile to retrieve the color used for customization.
5820 * This color is used as background color of the confirm credentials screen for that user.
5821 *
5822 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5823 * @return The 32bit representation of the color to be used.
5824 */
5825 public int getOrganizationColor(@NonNull ComponentName admin) {
5826 try {
5827 return mService.getOrganizationColor(admin);
5828 } catch (RemoteException re) {
5829 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5830 return 0;
5831 }
5832 }
5833
5834 /**
5835 * @hide
5836 * Retrieve the customization color for a given user.
5837 *
5838 * @param userHandle The user id of the user we're interested in.
5839 * @return The 32bit representation of the color to be used.
5840 */
5841 public int getOrganizationColorForUser(int userHandle) {
5842 try {
5843 return mService.getOrganizationColorForUser(userHandle);
5844 } catch (RemoteException re) {
5845 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5846 return 0;
5847 }
5848 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01005849
5850 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005851 * Called by a profile owner of a managed profile to set the name of the organization under
5852 * management.
5853 *
5854 * <p>If the organization name needs to be localized, it is the responsibility of the
5855 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5856 * and set a new version of this string accordingly.
5857 *
5858 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5859 * @param title The organization name or {@code null} to clear a previously set name.
5860 */
5861 public void setOrganizationName(@NonNull ComponentName admin, @Nullable String title) {
5862 try {
5863 mService.setOrganizationName(admin, title);
5864 } catch (RemoteException re) {
5865 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE);
5866 }
5867 }
5868
5869 /**
5870 * Called by a profile owner of a managed profile to retrieve the name of the organization
5871 * under management.
5872 *
5873 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5874 * @return The organization name or {@code null} if none is set.
5875 */
5876 public String getOrganizationName(@NonNull ComponentName admin) {
5877 try {
5878 return mService.getOrganizationName(admin);
5879 } catch (RemoteException re) {
5880 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE);
5881 return null;
5882 }
5883 }
5884
5885 /**
5886 * Retrieve the default title message used in the confirm credentials screen for a given user.
5887 *
5888 * @param userHandle The user id of the user we're interested in.
5889 * @return The organization name or {@code null} if none is set.
5890 *
5891 * @hide
5892 */
5893 public String getOrganizationNameForUser(int userHandle) {
5894 try {
5895 return mService.getOrganizationNameForUser(userHandle);
5896 } catch (RemoteException re) {
5897 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE);
5898 return null;
5899 }
5900 }
5901
5902 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00005903 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
5904 * return {@link #STATE_USER_UNMANAGED}
5905 * @hide
5906 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00005907 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00005908 @UserProvisioningState
5909 public int getUserProvisioningState() {
5910 if (mService != null) {
5911 try {
5912 return mService.getUserProvisioningState();
5913 } catch (RemoteException e) {
5914 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5915 }
5916 }
5917 return STATE_USER_UNMANAGED;
5918 }
5919
5920 /**
5921 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
5922 *
5923 * @param state to store
5924 * @param userHandle for user
5925 * @hide
5926 */
5927 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
5928 if (mService != null) {
5929 try {
5930 mService.setUserProvisioningState(state, userHandle);
5931 } catch (RemoteException e) {
5932 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5933 }
5934 }
5935 }
5936
5937 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01005938 * @hide
5939 * Indicates the entity that controls the device or profile owner. A user/profile is considered
5940 * affiliated if it is managed by the same entity as the device.
5941 *
5942 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
5943 * user/profile is considered affiliated if the following conditions are both met:
5944 * <ul>
5945 * <li>The device owner and the user's/profile's profile owner have called this method,
5946 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
5947 * and a profile owner intersect, they must have come from the same source, which means that
5948 * the device owner and profile owner are controlled by the same entity.</li>
5949 * <li>The device owner's and profile owner's package names are the same.</li>
5950 * </ul>
5951 *
5952 * @param admin Which profile or device owner this request is associated with.
5953 * @param ids A set of opaque affiliation ids.
5954 */
5955 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
5956 try {
5957 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
5958 } catch (RemoteException e) {
Esteban Talaverac1c83592016-02-17 17:56:15 +00005959 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01005960 }
5961 }
5962
5963 /**
5964 * @hide
5965 * Returns whether this user/profile is affiliated with the device. See
5966 * {@link #setAffiliationIds} for the definition of affiliation.
5967 *
5968 * @return whether this user/profile is affiliated with the device.
5969 */
5970 public boolean isAffiliatedUser() {
5971 try {
5972 return mService != null && mService.isAffiliatedUser();
5973 } catch (RemoteException e) {
Esteban Talaverac1c83592016-02-17 17:56:15 +00005974 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01005975 return false;
5976 }
5977 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08005978
5979 /**
5980 * @hide
5981 * Returns whether the uninstall for {@code packageName} for the current user is in queue
5982 * to be started
5983 * @param packageName the package to check for
5984 * @return whether the uninstall intent for {@code packageName} is pending
5985 */
5986 public boolean isUninstallInQueue(String packageName) {
5987 try {
5988 return mService.isUninstallInQueue(packageName);
5989 } catch (RemoteException re) {
5990 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5991 return false;
5992 }
5993 }
5994
5995 /**
5996 * @hide
5997 * @param packageName the package containing active DAs to be uninstalled
5998 */
5999 public void uninstallPackageWithActiveAdmins(String packageName) {
6000 try {
6001 mService.uninstallPackageWithActiveAdmins(packageName);
6002 } catch (RemoteException re) {
6003 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
6004 }
6005 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006006}