blob: c79c4072e745257d28553137616fa3adacdc857d [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
Alan Treadwayafad8782016-01-19 15:15:08 +000019import android.annotation.IntDef;
Robin Lee25e26452015-06-02 09:56:29 -070020import android.annotation.NonNull;
21import android.annotation.Nullable;
Dianne Hackbornd6847842010-01-12 18:14:19 -080022import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
Justin Moreyb5deda72014-07-24 10:53:40 -050024import android.annotation.SystemApi;
Jason Monkd7b86212014-06-16 13:15:38 -040025import android.app.Activity;
Dianne Hackbornd6847842010-01-12 18:14:19 -080026import android.content.ComponentName;
27import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010028import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000029import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080030import android.content.pm.ActivityInfo;
31import android.content.pm.PackageManager;
32import android.content.pm.ResolveInfo;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000033import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050034import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040035import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000036import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010037import android.os.Bundle;
Jim Millere303bf42014-08-26 17:12:29 -070038import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000039import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080040import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080041import android.os.RemoteException;
42import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070043import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040044import android.os.UserManager;
Ricky Wai494b95d2015-11-20 16:07:15 +000045import android.provider.ContactsContract.Directory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000046import android.provider.Settings;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010047import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070048import android.service.restrictions.RestrictionsReceiver;
Dianne Hackbornd6847842010-01-12 18:14:19 -080049import android.util.Log;
50
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070051import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040052import com.android.org.conscrypt.TrustedCertificateStore;
53
Jessica Hummel91da58d2014-04-10 17:39:43 +010054import org.xmlpull.v1.XmlPullParserException;
55
Maggie Benthallda51e682013-08-08 22:35:44 -040056import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080057import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070060import java.net.InetSocketAddress;
61import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010062import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000063import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010064import java.security.PrivateKey;
65import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040066import java.security.cert.CertificateException;
67import java.security.cert.CertificateFactory;
68import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010069import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000070import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070071import java.util.ArrayList;
Svetoslav976e8bd2014-07-16 15:12:03 -070072import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080073import java.util.List;
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +010074import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080075
76/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000077 * Public interface for managing policies enforced on a device. Most clients of this class must be
78 * registered with the system as a
Benjamin Franz6cdb27e2015-02-26 12:26:53 +000079 * <a href="{@docRoot}guide/topics/admin/device-admin.html">device administrator</a>. Additionally,
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000080 * a device administrator may be registered as either a profile or device owner. A given method is
81 * accessible to all device administrators unless the documentation for that method specifies that
82 * it is restricted to either device or profile owners.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080083 *
84 * <div class="special reference">
85 * <h3>Developer Guides</h3>
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000086 * <p>For more information about managing policies for device administration, read the
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080087 * <a href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a>
Robin Lee25e26452015-06-02 09:56:29 -070088 * developer guide.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080089 * </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080090 */
91public class DevicePolicyManager {
92 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -080093
94 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -080095 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +000096 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -070097
Makoto Onukic8a5a552015-11-19 14:29:12 -080098 private static final String REMOTE_EXCEPTION_MESSAGE =
99 "Failed to talk with device policy manager service";
100
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000101 private DevicePolicyManager(Context context, boolean parentInstance) {
Esteban Talavera62399912016-01-11 15:37:55 +0000102 this(context,
103 IDevicePolicyManager.Stub.asInterface(
104 ServiceManager.getService(Context.DEVICE_POLICY_SERVICE)),
105 parentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800106 }
107
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800108 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700109 @VisibleForTesting
Esteban Talavera62399912016-01-11 15:37:55 +0000110 protected DevicePolicyManager(
111 Context context, IDevicePolicyManager service, boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700112 mContext = context;
113 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000114 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700115 }
116
117 /** @hide */
118 public static DevicePolicyManager create(Context context) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000119 DevicePolicyManager me = new DevicePolicyManager(context, false);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800120 return me.mService != null ? me : null;
121 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700122
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700123 /** @hide test will override it. */
124 @VisibleForTesting
125 protected int myUserId() {
126 return UserHandle.myUserId();
127 }
128
Dianne Hackbornd6847842010-01-12 18:14:19 -0800129 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000130 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000131 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100132 * <p>A managed profile allows data separation for example for the usage of a
133 * device as a personal and corporate device. The user which provisioning is started from and
134 * the managed profile share a launcher.
135 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800136 * <p>This intent will typically be sent by a mobile device management application (MDM).
137 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
138 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100139 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000140 * <p>It is possible to check if provisioning is allowed or not by querying the method
141 * {@link #isProvisioningAllowed(String)}.
142 *
143 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000144 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700145 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000146 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
147 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000148 *
149 * <p> The intent may also contain the following extras:
150 * <ul>
151 * <li> {@link #EXTRA_PROVISIONING_LOGO_URI}, optional </li>
152 * <li> {@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional </li>
153 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000154 *
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000155 * <p> When managed provisioning has completed, broadcasts are sent to the application specified
156 * in the provisioning intent. The
157 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
158 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
159 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100160 *
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100161 * <p> If provisioning fails, the managedProfile is removed so the device returns to its
162 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100163 *
164 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
165 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
166 * the provisioning flow was successful, although this doesn't guarantee the full flow will
167 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
168 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000169 */
170 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
171 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100172 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000173
174 /**
Mahaver Chopra5e732562015-11-05 11:55:12 +0000175 * @hide
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000176 * Activity action: Starts the provisioning flow which sets up a managed user.
177 *
178 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800179 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000180 * owner who has full control over the user. Provisioning can only happen before user setup has
181 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
182 * allowed.
183 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000184 * <p>This intent should contain the extra
185 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000186 *
187 * <p> If provisioning fails, the device returns to its previous state.
188 *
189 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
190 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
191 * the provisioning flow was successful, although this doesn't guarantee the full flow will
192 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
193 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Mahaver Chopra5e732562015-11-05 11:55:12 +0000194 */
195 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
196 public static final String ACTION_PROVISION_MANAGED_USER
197 = "android.app.action.PROVISION_MANAGED_USER";
198
199 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100200 * Activity action: Starts the provisioning flow which sets up a managed device.
201 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
202 *
203 * <p> During device owner provisioning a device admin app is set as the owner of the device.
204 * A device owner has full control over the device. The device owner can not be modified by the
205 * user.
206 *
207 * <p> A typical use case would be a device that is owned by a company, but used by either an
208 * employee or client.
209 *
210 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000211 * It is possible to check if provisioning is allowed or not by querying the method
212 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100213 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000214 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100215 * <ul>
216 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
217 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
218 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100219 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000220 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000221 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100222 * </ul>
223 *
224 * <p> When device owner provisioning has completed, an intent of the type
225 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
226 * device owner.
227 *
228 * <p> If provisioning fails, the device is factory reset.
229 *
Alan Treadway4582f812015-07-28 11:49:35 +0100230 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
231 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
232 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
233 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100234 */
235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
236 public static final String ACTION_PROVISION_MANAGED_DEVICE
237 = "android.app.action.PROVISION_MANAGED_DEVICE";
238
239 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000240 * Activity action: Starts the provisioning flow which sets up a managed device.
241 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
242 *
243 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
244 * management state that is distinct from that reached by
245 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
246 * user, and only has control over device-wide policies, not individual users and their data.
247 * The primary benefit is that multiple non-system users are supported when provisioning using
248 * this form of device management.
249 *
250 * <p> During device owner provisioning a device admin app is set as the owner of the device.
251 * A device owner has full control over the device. The device owner can not be modified by the
252 * user.
253 *
254 * <p> A typical use case would be a device that is owned by a company, but used by either an
255 * employee or client.
256 *
257 * <p> An intent with this action can be sent only on an unprovisioned device.
258 * It is possible to check if provisioning is allowed or not by querying the method
259 * {@link #isProvisioningAllowed(String)}.
260 *
261 * <p>The intent contains the following extras:
262 * <ul>
263 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
264 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
265 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
266 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
267 * </ul>
268 *
269 * <p> When device owner provisioning has completed, an intent of the type
270 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
271 * device owner.
272 *
273 * <p> If provisioning fails, the device is factory reset.
274 *
275 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
276 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
277 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
278 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
279 *
280 * @hide
281 */
282 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
283 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
284 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
285
286 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000287 * Activity action: Finalizes management provisioning, should be used after user-setup
288 * has been completed and {@link #getUserProvisioningState()} returns one of:
289 * <ul>
290 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
291 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
292 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
293 * </ul>
294 *
295 * @hide
296 */
297 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
298 public static final String ACTION_PROVISION_FINALIZATION
299 = "android.app.action.PROVISION_FINALIZATION";
300
301 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100302 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100303 * allows a mobile device management application or NFC programmer application which starts
304 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100305 * <p>
306 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
307 * sends the intent to pass data to itself on the newly created profile.
308 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
309 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100310 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
311 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
312 * message should contain a stringified {@link java.util.Properties} instance, whose string
313 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
314 * management application after provisioning.
315 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100316 * <p>
317 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700318 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
319 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100320 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100321 */
322 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100323 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100324
325 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100326 * A String extra holding the package name of the mobile device management application that
327 * will be set as the profile owner or device owner.
328 *
329 * <p>If an application starts provisioning directly via an intent with action
330 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
331 * application that started provisioning. The package will be set as profile owner in that case.
332 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000333 * <p>This package is set as device owner when device owner provisioning is started by an NFC
334 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000335 *
336 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700337 * This receiver will be set as the profile or device owner and active admin.
Nicolas Prevot18440252015-03-09 14:07:17 +0000338
339 * @see DeviceAdminReceiver
340 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100341 * supported, but only if there is only one device admin receiver in the package that requires
342 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000343 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000344 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000345 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100346 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000347
348 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000349 * A ComponentName extra indicating the device admin receiver of the mobile device management
350 * application that will be set as the profile owner or device owner and active admin.
351 *
352 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100353 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
354 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
355 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000356 *
357 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100358 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
359 * message containing an NFC record with MIME type
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400360 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name should be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000361 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000362 *
363 * @see DeviceAdminReceiver
364 */
365 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
366 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
367
368 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000369 * An {@link android.accounts.Account} extra holding the account to migrate during managed
370 * profile provisioning. If the account supplied is present in the primary user, it will be
371 * copied, along with its credentials to the managed profile and removed from the primary user.
372 *
373 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
374 */
375
376 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
377 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
378
379 /**
Jessica Hummele3da7902014-08-20 15:20:11 +0100380 * A String extra that, holds the email address of the account which a managed profile is
381 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
382 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100383 *
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100384 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
385 *
Jessica Hummele3da7902014-08-20 15:20:11 +0100386 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
387 * contains this extra, it is forwarded in the
388 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
389 * device management application that was set as the profile owner during provisioning.
390 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100391 */
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100392 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
393 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100394
395 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000396 * A integer extra indicating the predominant color to show during the provisioning.
397 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000398 *
399 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
400 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
401 */
402 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
403 "android.app.extra.PROVISIONING_MAIN_COLOR";
404
405 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000406 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700407 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000408 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100409 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
410 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000411 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000412 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
413 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000414
415 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100416 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
417 * will be set to.
418 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000419 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
420 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100421 */
422 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100423 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100424
425 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100426 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
427 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100428 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000429 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
430 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100431 */
432 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100433 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100434
435 /**
436 * A String extra holding the {@link java.util.Locale} that the device will be set to.
437 * Format: xx_yy, where xx is the language code, and yy the country code.
438 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000439 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
440 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100441 */
442 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100443 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100444
445 /**
446 * A String extra holding the ssid of the wifi network that should be used during nfc device
447 * owner provisioning for downloading the mobile device management application.
448 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000449 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
450 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100451 */
452 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100453 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100454
455 /**
456 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
457 * is hidden or not.
458 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000459 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
460 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100461 */
462 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100463 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100464
465 /**
466 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100467 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
468 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100469 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000470 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
471 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100472 */
473 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100474 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100475
476 /**
477 * A String extra holding the password of the wifi network in
478 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
479 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000480 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
481 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100482 */
483 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100484 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100485
486 /**
487 * A String extra holding the proxy host for the wifi network in
488 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
489 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000490 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
491 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100492 */
493 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100494 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100495
496 /**
497 * An int extra holding the proxy port for the wifi network in
498 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
499 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000500 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
501 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100502 */
503 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100504 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100505
506 /**
507 * A String extra holding the proxy bypass for the wifi network in
508 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
509 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000510 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
511 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100512 */
513 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100514 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100515
516 /**
517 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
518 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
519 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000520 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
521 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100522 */
523 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100524 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100525
526 /**
527 * A String extra holding a url that specifies the download location of the device admin
528 * package. When not provided it is assumed that the device admin package is already installed.
529 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000530 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
531 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100532 */
533 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100534 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100535
536 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400537 * An int extra holding a minimum required version code for the device admin package. If the
538 * device admin is already installed on the device, it will only be re-downloaded from
539 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
540 * installed package is less than this version code.
541 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400542 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400543 * provisioning via an NFC bump.
544 */
545 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
546 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
547
548 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100549 * A String extra holding a http cookie header which should be used in the http request to the
550 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
551 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000552 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
553 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100554 */
555 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100556 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100557
558 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100559 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
560 * the file at download location specified in
561 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100562 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100563 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} should be
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100564 * present. The provided checksum should match the checksum of the file at the download
565 * location. If the checksum doesn't match an error will be shown to the user and the user will
566 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100567 *
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.
Rubin Xud92e7572015-05-18 17:01:13 +0100570 *
571 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
572 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700573 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100574 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100575 */
576 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100577 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100578
579 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100580 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100581 * android package archive at the download location specified in {@link
582 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
583 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100584 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100585 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
586 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
587 *
588 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} should be
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100589 * present. The provided checksum should match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100590 * the download location. If the checksum does not match an error will be shown to the user and
591 * the user will be asked to factory reset the device.
592 *
593 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
594 * provisioning via an NFC bump.
595 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100596 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
597 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100598
599 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000600 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
601 * has completed successfully.
602 *
603 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700604 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000605 *
Ying Wang7f38aab2015-02-20 11:50:09 -0800606 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000607 * corresponds to the account requested to be migrated at provisioning time, if any.
608 */
609 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
610 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
611 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
612
613 /**
Julia Reynolds2f46d942015-05-05 11:44:20 -0400614 * A boolean extra indicating whether device encryption can be skipped as part of Device Owner
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500615 * provisioning.
616 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400617 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100618 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500619 */
620 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
621 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
622
623 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000624 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
625 * provisioning. If this extra is not passed, a default image will be shown.
626 * <h5>The following URI schemes are accepted:</h5>
627 * <ul>
628 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
629 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
630 * </ul>
631 *
632 * <p> It is the responsability of the caller to provide an image with a reasonable
633 * pixed density for the device.
634 *
635 * <p> If a content: URI is passed, the intent should have the flag
636 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
637 * {@link android.content.ClipData} of the intent too.
638 *
639 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
640 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
641 */
642 public static final String EXTRA_PROVISIONING_LOGO_URI =
643 "android.app.extra.PROVISIONING_LOGO_URI";
644
645 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000646 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
647 * during setup-wizard.
648 *
649 * <p>If unspecified, defaults to {@code true} to match the behavior in
650 * {@link android.os.Build.VERSION_CODES#M} and earlier.
651 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000652 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
653 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000654 *
655 * @hide
656 */
657 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
658 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
659
660 /**
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400661 * This MIME type is used for starting the Device Owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100662 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400663 * <p>During device owner provisioning a device admin app is set as the owner of the device.
664 * A device owner has full control over the device. The device owner can not be modified by the
665 * user and the only way of resetting the device is if the device owner app calls a factory
666 * reset.
667 *
668 * <p> A typical use case would be a device that is owned by a company, but used by either an
669 * employee or client.
670 *
671 * <p> The NFC message should be send to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100672 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000673 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100674 * contains the following properties:
675 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400676 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
677 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100678 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400679 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100680 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
681 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
682 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
683 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
684 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
685 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
686 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
687 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
688 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
689 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100690 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
691 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
692 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100693 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000694 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700695 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400696 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
697 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
698 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400699 */
700 public static final String MIME_TYPE_PROVISIONING_NFC
701 = "application/com.android.managedprovisioning";
702
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100703 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800704 * Activity action: ask the user to add a new device administrator to the system.
705 * The desired policy is the ComponentName of the policy in the
706 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
707 * bring the user through adding the device administrator to the system (or
708 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700709 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800710 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
711 * field to provide the user with additional explanation (in addition
712 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800713 *
714 * <p>If your administrator is already active, this will ordinarily return immediately (without
715 * user intervention). However, if your administrator has been updated and is requesting
716 * additional uses-policy flags, the user will be presented with the new list. New policies
717 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800718 */
719 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
720 public static final String ACTION_ADD_DEVICE_ADMIN
721 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700722
Dianne Hackbornd6847842010-01-12 18:14:19 -0800723 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700724 * @hide
725 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -0700726 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700727 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700728 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
729 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700730 * to remotely control restrictions on the user.
731 *
Makoto Onukic8a5a552015-11-19 14:29:12 -0800732 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700733 * result of whether or not the user approved the action. If approved, the result will
734 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
735 * as a profile owner.
736 *
737 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
738 * field to provide the user with additional explanation (in addition
739 * to your component's description) about what is being added.
740 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700741 * <p>If there is already a profile owner active or the caller is not a system app, the
742 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700743 */
744 @SystemApi
745 public static final String ACTION_SET_PROFILE_OWNER
746 = "android.app.action.SET_PROFILE_OWNER";
747
748 /**
749 * @hide
750 * Name of the profile owner admin that controls the user.
751 */
752 @SystemApi
753 public static final String EXTRA_PROFILE_OWNER_NAME
754 = "android.app.extra.PROFILE_OWNER_NAME";
755
756 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100757 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -0700758 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700759 *
Jim Miller284b62e2010-06-08 14:27:42 -0700760 * @hide
761 */
762 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
763 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
764
765 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100766 * Broadcast action: sent when the device owner is set or changed.
767 *
768 * This broadcast is sent only to the primary user.
769 * @see #ACTION_PROVISION_MANAGED_DEVICE
770 */
771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
772 public static final String ACTION_DEVICE_OWNER_CHANGED
773 = "android.app.action.DEVICE_OWNER_CHANGED";
774
775 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800776 * The ComponentName of the administrator component.
777 *
778 * @see #ACTION_ADD_DEVICE_ADMIN
779 */
780 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700781
Dianne Hackbornd6847842010-01-12 18:14:19 -0800782 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800783 * An optional CharSequence providing additional explanation for why the
784 * admin is being added.
785 *
786 * @see #ACTION_ADD_DEVICE_ADMIN
787 */
788 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700789
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800790 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700791 * Activity action: have the user enter a new password. This activity should
792 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
793 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
794 * enter a new password that meets the current requirements. You can use
795 * {@link #isActivePasswordSufficient()} to determine whether you need to
796 * have the user select a new password in order to meet the current
797 * constraints. Upon being resumed from this activity, you can check the new
798 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +0000799 *
800 * If the intent is launched from within a managed profile with a profile
801 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
802 * this will trigger entering a new password for the parent of the profile.
803 * For all other cases it will trigger entering a new password for the user
804 * or profile it is launched from.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800805 */
806 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
807 public static final String ACTION_SET_NEW_PASSWORD
808 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700809
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000810 /**
Benjamin Franzc9921092016-01-08 17:17:44 +0000811 * Activity action: have the user enter a new password for the parent profile.
812 * If the intent is launched from within a managed profile, this will trigger
813 * entering a new password for the parent of the profile. In all other cases
814 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
815 */
816 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
817 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
818 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
819
820 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000821 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
822 * the parent profile to access intents sent from the managed profile.
823 * That is, when an app in the managed profile calls
824 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
825 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000826 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100827 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000828
829 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000830 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
831 * the managed profile to access intents sent from the parent profile.
832 * That is, when an app in the parent profile calls
833 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
834 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000835 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100836 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700837
Dianne Hackbornd6847842010-01-12 18:14:19 -0800838 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +0100839 * Broadcast action: notify that a new local system update policy has been set by the device
840 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +0000841 */
842 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +0100843 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
844 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +0000845
Amith Yamasanid49489b2015-04-28 14:00:26 -0700846 /**
847 * Permission policy to prompt user for new permission requests for runtime permissions.
848 * Already granted or denied permissions are not affected by this.
849 */
850 public static final int PERMISSION_POLICY_PROMPT = 0;
851
852 /**
853 * Permission policy to always grant new permission requests for runtime permissions.
854 * Already granted or denied permissions are not affected by this.
855 */
856 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
857
858 /**
859 * Permission policy to always deny new permission requests for runtime permissions.
860 * Already granted or denied permissions are not affected by this.
861 */
862 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
863
Svet Ganovd8ecc5a2015-05-20 10:45:43 -0700864 /**
865 * Runtime permission state: The user can manage the permission
866 * through the UI.
867 */
868 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
869
870 /**
871 * Runtime permission state: The permission is granted to the app
872 * and the user cannot manage the permission through the UI.
873 */
874 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
875
876 /**
877 * Runtime permission state: The permission is denied to the app
878 * and the user cannot manage the permission through the UI.
879 */
880 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +0000881
882 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000883 * No management for current user in-effect. This is the default.
884 * @hide
885 */
886 public static final int STATE_USER_UNMANAGED = 0;
887
888 /**
889 * Management partially setup, user setup needs to be completed.
890 * @hide
891 */
892 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
893
894 /**
895 * Management partially setup, user setup completed.
896 * @hide
897 */
898 public static final int STATE_USER_SETUP_COMPLETE = 2;
899
900 /**
901 * Management setup and active on current user.
902 * @hide
903 */
904 public static final int STATE_USER_SETUP_FINALIZED = 3;
905
906 /**
907 * Management partially setup on a managed profile.
908 * @hide
909 */
910 public static final int STATE_USER_PROFILE_COMPLETE = 4;
911
912 /**
913 * @hide
914 */
915 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
916 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
917 @Retention(RetentionPolicy.SOURCE)
918 public @interface UserProvisioningState {}
919
920 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800921 * Return true if the given administrator component is currently
922 * active (enabled) in the system.
923 */
Robin Lee25e26452015-06-02 09:56:29 -0700924 public boolean isAdminActive(@NonNull ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700925 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +0100926 }
927
928 /**
929 * @see #isAdminActive(ComponentName)
930 * @hide
931 */
Robin Lee25e26452015-06-02 09:56:29 -0700932 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -0800933 if (mService != null) {
934 try {
Robin Lee25e26452015-06-02 09:56:29 -0700935 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800936 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -0800937 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800938 }
939 }
940 return false;
941 }
Fyodor Kupolov96fb9322014-12-01 15:08:09 -0800942 /**
943 * Return true if the given administrator component is currently being removed
944 * for the user.
945 * @hide
946 */
Robin Lee25e26452015-06-02 09:56:29 -0700947 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -0800948 if (mService != null) {
949 try {
Robin Lee25e26452015-06-02 09:56:29 -0700950 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -0800951 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -0800952 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -0800953 }
954 }
955 return false;
956 }
957
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700958
Dianne Hackbornd6847842010-01-12 18:14:19 -0800959 /**
Robin Lee25e26452015-06-02 09:56:29 -0700960 * Return a list of all currently active device administrators' component
961 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800962 * returned.
963 */
964 public List<ComponentName> getActiveAdmins() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700965 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +0100966 }
967
968 /**
969 * @see #getActiveAdmins()
970 * @hide
971 */
972 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800973 if (mService != null) {
974 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +0100975 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800976 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -0800977 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800978 }
979 }
980 return null;
981 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700982
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -0800983 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -0700984 * Used by package administration code to determine if a package can be stopped
985 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800986 * @hide
987 */
988 public boolean packageHasActiveAdmins(String packageName) {
989 if (mService != null) {
990 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700991 return mService.packageHasActiveAdmins(packageName, myUserId());
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800992 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -0800993 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800994 }
995 }
996 return false;
997 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700998
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800999 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001000 * Remove a current administration component. This can only be called
1001 * by the application that owns the administration component; if you
1002 * try to remove someone else's component, a security exception will be
1003 * thrown.
1004 */
Robin Lee25e26452015-06-02 09:56:29 -07001005 public void removeActiveAdmin(@NonNull ComponentName admin) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001006 if (mService != null) {
1007 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001008 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001009 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001010 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001011 }
1012 }
1013 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001014
Dianne Hackbornd6847842010-01-12 18:14:19 -08001015 /**
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001016 * Returns true if an administrator has been granted a particular device policy. This can
Robin Lee25e26452015-06-02 09:56:29 -07001017 * be used to check whether the administrator was activated under an earlier set of policies,
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001018 * but requires additional policies after an upgrade.
1019 *
1020 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be
1021 * an active administrator, or an exception will be thrown.
1022 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
1023 */
Robin Lee25e26452015-06-02 09:56:29 -07001024 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001025 if (mService != null) {
1026 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001027 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001028 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001029 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001030 }
1031 }
1032 return false;
1033 }
1034
1035 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001036 * Returns true if the Profile Challenge is available to use for the given profile user.
1037 *
1038 * @hide
1039 */
1040 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1041 if (mService != null) {
1042 try {
1043 return mService.isSeparateProfileChallengeAllowed(userHandle);
1044 } catch (RemoteException e) {
1045 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
1046 }
1047 }
1048 return false;
1049 }
1050
1051 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001052 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1053 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001054 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001055 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001056 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001057
Dianne Hackbornd6847842010-01-12 18:14:19 -08001058 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001059 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1060 * recognition technology. This implies technologies that can recognize the identity of
1061 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1062 * Note that quality constants are ordered so that higher values are more restrictive.
1063 */
1064 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1065
1066 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001067 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001068 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001069 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001070 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001071 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001072
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001073 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001074 * Constant for {@link #setPasswordQuality}: the user must have entered a
1075 * password containing at least numeric characters. Note that quality
1076 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001077 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001078 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001079
Dianne Hackbornd6847842010-01-12 18:14:19 -08001080 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001081 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001082 * password containing at least numeric characters with no repeating (4444)
1083 * or ordered (1234, 4321, 2468) sequences. Note that quality
1084 * constants are ordered so that higher values are more restrictive.
1085 */
1086 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1087
1088 /**
1089 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001090 * password containing at least alphabetic (or other symbol) characters.
1091 * Note that quality constants are ordered so that higher values are more
1092 * restrictive.
1093 */
1094 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001095
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001096 /**
1097 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001098 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001099 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001100 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001101 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001102 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001103
Dianne Hackbornd6847842010-01-12 18:14:19 -08001104 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001105 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001106 * password containing at least a letter, a numerical digit and a special
1107 * symbol, by default. With this password quality, passwords can be
1108 * restricted to contain various sets of characters, like at least an
1109 * uppercase letter, etc. These are specified using various methods,
1110 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1111 * that quality constants are ordered so that higher values are more
1112 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001113 */
1114 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1115
1116 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001117 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1118 * modify password. In case this password quality is set, the password is
1119 * managed by a profile owner. The profile owner can set any password,
1120 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1121 * that quality constants are ordered so that higher values are more
1122 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1123 * the highest.
1124 * @hide
1125 */
1126 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1127
1128 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001129 * Called by an application that is administering the device to set the
1130 * password restrictions it is imposing. After setting this, the user
1131 * will not be able to enter a new password that is not at least as
1132 * restrictive as what has been set. Note that the current password
1133 * will remain until the user has set a new one, so the change does not
1134 * take place immediately. To prompt the user for a new password, use
1135 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001136 *
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001137 * <p>Quality constants are ordered so that higher values are more restrictive;
1138 * thus the highest requested quality constant (between the policy set here,
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001139 * the user's preference, and any other considerations) is the one that
1140 * is in effect.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001141 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001142 * <p>The calling device admin must have requested
1143 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1144 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001145 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001146 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001147 * @param quality The new desired quality. One of
1148 * {@link #PASSWORD_QUALITY_UNSPECIFIED}, {@link #PASSWORD_QUALITY_SOMETHING},
Jim Miller85516d02014-01-31 17:08:37 -08001149 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
1150 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC}
1151 * or {@link #PASSWORD_QUALITY_COMPLEX}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001152 */
Robin Lee25e26452015-06-02 09:56:29 -07001153 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001154 if (mService != null) {
1155 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001156 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001157 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001158 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001159 }
1160 }
1161 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001162
Dianne Hackbornd6847842010-01-12 18:14:19 -08001163 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +01001164 * Retrieve the current minimum password quality for all admins of this user
1165 * and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001166 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001167 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001168 */
Robin Lee25e26452015-06-02 09:56:29 -07001169 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001170 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001171 }
1172
1173 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001174 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001175 if (mService != null) {
1176 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001177 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001178 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001179 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001180 }
1181 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001182 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001183 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001184
Dianne Hackbornd6847842010-01-12 18:14:19 -08001185 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001186 * Called by an application that is administering the device to set the
1187 * minimum allowed password length. After setting this, the user
1188 * will not be able to enter a new password that is not at least as
1189 * restrictive as what has been set. Note that the current password
1190 * will remain until the user has set a new one, so the change does not
1191 * take place immediately. To prompt the user for a new password, use
1192 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
1193 * constraint is only imposed if the administrator has also requested either
Jim Miller85516d02014-01-31 17:08:37 -08001194 * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
1195 * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC},
1196 * or {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001197 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001198 * <p>The calling device admin must have requested
1199 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1200 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001201 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001202 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001203 * @param length The new desired minimum password length. A value of 0
1204 * means there is no restriction.
1205 */
Robin Lee25e26452015-06-02 09:56:29 -07001206 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001207 if (mService != null) {
1208 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001209 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001210 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001211 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001212 }
1213 }
1214 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001215
Dianne Hackbornd6847842010-01-12 18:14:19 -08001216 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +01001217 * Retrieve the current minimum password length for all admins of this
1218 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001219 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001220 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001221 */
Robin Lee25e26452015-06-02 09:56:29 -07001222 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001223 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001224 }
1225
1226 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001227 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001228 if (mService != null) {
1229 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001230 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001231 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001232 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001233 }
1234 }
1235 return 0;
1236 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001237
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001238 /**
1239 * Called by an application that is administering the device to set the
1240 * minimum number of upper case letters required in the password. After
1241 * setting this, the user will not be able to enter a new password that is
1242 * not at least as restrictive as what has been set. Note that the current
1243 * password will remain until the user has set a new one, so the change does
1244 * not take place immediately. To prompt the user for a new password, use
1245 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
1246 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001247 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1248 * default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001249 * <p>
1250 * The calling device admin must have requested
1251 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1252 * this method; if it has not, a security exception will be thrown.
1253 *
1254 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1255 * with.
1256 * @param length The new desired minimum number of upper case letters
1257 * required in the password. A value of 0 means there is no
1258 * restriction.
1259 */
Robin Lee25e26452015-06-02 09:56:29 -07001260 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001261 if (mService != null) {
1262 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001263 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001264 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001265 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001266 }
1267 }
1268 }
1269
1270 /**
1271 * Retrieve the current number of upper case letters required in the
Jessica Hummel91da58d2014-04-10 17:39:43 +01001272 * password for all admins of this user and its profiles or a particular one.
1273 * This is the same value as set by
1274 * {#link {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001275 * and only applies when the password quality is
1276 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001277 *
Robin Lee25e26452015-06-02 09:56:29 -07001278 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001279 * aggregate all admins.
1280 * @return The minimum number of upper case letters required in the
1281 * password.
1282 */
Robin Lee25e26452015-06-02 09:56:29 -07001283 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001284 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001285 }
1286
1287 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001288 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001289 if (mService != null) {
1290 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001291 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001292 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001293 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001294 }
1295 }
1296 return 0;
1297 }
1298
1299 /**
1300 * Called by an application that is administering the device to set the
1301 * minimum number of lower case letters required in the password. After
1302 * setting this, the user will not be able to enter a new password that is
1303 * not at least as restrictive as what has been set. Note that the current
1304 * password will remain until the user has set a new one, so the change does
1305 * not take place immediately. To prompt the user for a new password, use
1306 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
1307 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001308 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1309 * default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001310 * <p>
1311 * The calling device admin must have requested
1312 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1313 * this method; if it has not, a security exception will be thrown.
1314 *
1315 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1316 * with.
1317 * @param length The new desired minimum number of lower case letters
1318 * required in the password. A value of 0 means there is no
1319 * restriction.
1320 */
Robin Lee25e26452015-06-02 09:56:29 -07001321 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001322 if (mService != null) {
1323 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001324 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001325 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001326 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001327 }
1328 }
1329 }
1330
1331 /**
1332 * Retrieve the current number of lower case letters required in the
Jessica Hummel91da58d2014-04-10 17:39:43 +01001333 * password for all admins of this user and its profiles or a particular one.
1334 * This is the same value as set by
1335 * {#link {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001336 * and only applies when the password quality is
1337 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001338 *
Robin Lee25e26452015-06-02 09:56:29 -07001339 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001340 * aggregate all admins.
1341 * @return The minimum number of lower case letters required in the
1342 * password.
1343 */
Robin Lee25e26452015-06-02 09:56:29 -07001344 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001345 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001346 }
1347
1348 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001349 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001350 if (mService != null) {
1351 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001352 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001353 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001354 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001355 }
1356 }
1357 return 0;
1358 }
1359
1360 /**
1361 * Called by an application that is administering the device to set the
1362 * minimum number of letters required in the password. After setting this,
1363 * the user will not be able to enter a new password that is not at least as
1364 * restrictive as what has been set. Note that the current password will
1365 * remain until the user has set a new one, so the change does not take
1366 * place immediately. To prompt the user for a new password, use
1367 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
1368 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001369 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1370 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001371 * <p>
1372 * The calling device admin must have requested
1373 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1374 * this method; if it has not, a security exception will be thrown.
1375 *
1376 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1377 * with.
1378 * @param length The new desired minimum number of letters required in the
1379 * password. A value of 0 means there is no restriction.
1380 */
Robin Lee25e26452015-06-02 09:56:29 -07001381 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001382 if (mService != null) {
1383 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001384 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001385 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001386 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001387 }
1388 }
1389 }
1390
1391 /**
1392 * Retrieve the current number of letters required in the password for all
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001393 * admins or a particular one. This is the same value as
1394 * set by {#link {@link #setPasswordMinimumLetters(ComponentName, int)}
1395 * and only applies when the password quality is
1396 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001397 *
Robin Lee25e26452015-06-02 09:56:29 -07001398 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001399 * aggregate all admins.
1400 * @return The minimum number of letters required in the password.
1401 */
Robin Lee25e26452015-06-02 09:56:29 -07001402 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001403 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001404 }
1405
1406 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001407 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001408 if (mService != null) {
1409 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001410 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001411 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001412 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001413 }
1414 }
1415 return 0;
1416 }
1417
1418 /**
1419 * Called by an application that is administering the device to set the
1420 * minimum number of numerical digits required in the password. After
1421 * setting this, the user will not be able to enter a new password that is
1422 * not at least as restrictive as what has been set. Note that the current
1423 * password will remain until the user has set a new one, so the change does
1424 * not take place immediately. To prompt the user for a new password, use
1425 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
1426 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001427 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1428 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001429 * <p>
1430 * The calling device admin must have requested
1431 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1432 * this method; if it has not, a security exception will be thrown.
1433 *
1434 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1435 * with.
1436 * @param length The new desired minimum number of numerical digits required
1437 * in the password. A value of 0 means there is no restriction.
1438 */
Robin Lee25e26452015-06-02 09:56:29 -07001439 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001440 if (mService != null) {
1441 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001442 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001443 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001444 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001445 }
1446 }
1447 }
1448
1449 /**
1450 * Retrieve the current number of numerical digits required in the password
Jessica Hummel91da58d2014-04-10 17:39:43 +01001451 * for all admins of this user and its profiles or a particular one.
1452 * This is the same value as set by
1453 * {#link {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001454 * and only applies when the password quality is
1455 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001456 *
Robin Lee25e26452015-06-02 09:56:29 -07001457 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001458 * aggregate all admins.
1459 * @return The minimum number of numerical digits required in the password.
1460 */
Robin Lee25e26452015-06-02 09:56:29 -07001461 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001462 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001463 }
1464
1465 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001466 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001467 if (mService != null) {
1468 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001469 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001470 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001471 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001472 }
1473 }
1474 return 0;
1475 }
1476
1477 /**
1478 * Called by an application that is administering the device to set the
1479 * minimum number of symbols required in the password. After setting this,
1480 * the user will not be able to enter a new password that is not at least as
1481 * restrictive as what has been set. Note that the current password will
1482 * remain until the user has set a new one, so the change does not take
1483 * place immediately. To prompt the user for a new password, use
1484 * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
1485 * constraint is only imposed if the administrator has also requested
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001486 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1487 * default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001488 * <p>
1489 * The calling device admin must have requested
1490 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1491 * this method; if it has not, a security exception will be thrown.
1492 *
1493 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1494 * with.
1495 * @param length The new desired minimum number of symbols 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 setPasswordMinimumSymbols(@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.setPasswordMinimumSymbols(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 /**
1509 * Retrieve the current number of symbols required in the password for all
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001510 * admins or a particular one. This is the same value as
1511 * set by {#link {@link #setPasswordMinimumSymbols(ComponentName, int)}
1512 * and only applies when the password quality is
1513 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001514 *
Robin Lee25e26452015-06-02 09:56:29 -07001515 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001516 * aggregate all admins.
1517 * @return The minimum number of symbols required in the password.
1518 */
Robin Lee25e26452015-06-02 09:56:29 -07001519 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001520 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001521 }
1522
1523 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001524 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001525 if (mService != null) {
1526 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001527 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001528 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001529 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001530 }
1531 }
1532 return 0;
1533 }
1534
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001535 /**
1536 * Called by an application that is administering the device to set the
1537 * minimum number of non-letter characters (numerical digits or symbols)
1538 * required in the password. After setting this, the user will not be able
1539 * to enter a new password that is not at least as restrictive as what has
1540 * been set. Note that the current password will remain until the user has
1541 * set a new one, so the change does not take place immediately. To prompt
1542 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} after
1543 * setting this value. This constraint is only imposed if the administrator
1544 * has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1545 * {@link #setPasswordQuality}. The default value is 0.
1546 * <p>
1547 * The calling device admin must have requested
1548 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1549 * this method; if it has not, a security exception will be thrown.
1550 *
1551 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1552 * with.
1553 * @param length The new desired minimum number of letters required in the
1554 * password. A value of 0 means there is no restriction.
1555 */
Robin Lee25e26452015-06-02 09:56:29 -07001556 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001557 if (mService != null) {
1558 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001559 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001560 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001561 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001562 }
1563 }
1564 }
1565
1566 /**
1567 * Retrieve the current number of non-letter characters required in the
Jessica Hummel91da58d2014-04-10 17:39:43 +01001568 * password for all admins of this user and its profiles or a particular one.
1569 * This is the same value as set by
1570 * {#link {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001571 * and only applies when the password quality is
1572 * {@link #PASSWORD_QUALITY_COMPLEX}.
1573 *
Robin Lee25e26452015-06-02 09:56:29 -07001574 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001575 * aggregate all admins.
1576 * @return The minimum number of letters required in the password.
1577 */
Robin Lee25e26452015-06-02 09:56:29 -07001578 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001579 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001580 }
1581
1582 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001583 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001584 if (mService != null) {
1585 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001586 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001587 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001588 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001589 }
1590 }
1591 return 0;
1592 }
1593
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001594 /**
1595 * Called by an application that is administering the device to set the length
1596 * of the password history. After setting this, the user will not be able to
1597 * enter a new password that is the same as any password in the history. Note
1598 * that the current password will remain until the user has set a new one, so
1599 * the change does not take place immediately. To prompt the user for a new
1600 * password, use {@link #ACTION_SET_NEW_PASSWORD} after setting this value.
1601 * This constraint is only imposed if the administrator has also requested
Jim Miller85516d02014-01-31 17:08:37 -08001602 * either {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}
1603 * {@link #PASSWORD_QUALITY_ALPHABETIC}, or {@link #PASSWORD_QUALITY_ALPHANUMERIC}
1604 * with {@link #setPasswordQuality}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001605 *
1606 * <p>
1607 * The calling device admin must have requested
1608 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this
1609 * method; if it has not, a security exception will be thrown.
1610 *
1611 * @param admin Which {@link DeviceAdminReceiver} this request is associated
1612 * with.
1613 * @param length The new desired length of password history. A value of 0
1614 * means there is no restriction.
1615 */
Robin Lee25e26452015-06-02 09:56:29 -07001616 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001617 if (mService != null) {
1618 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001619 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001620 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001621 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001622 }
1623 }
1624 }
1625
1626 /**
Jim Millera4e28d12010-11-08 16:15:47 -08001627 * Called by a device admin to set the password expiration timeout. Calling this method
1628 * will restart the countdown for password expiration for the given admin, as will changing
1629 * the device password (for all admins).
1630 *
1631 * <p>The provided timeout is the time delta in ms and will be added to the current time.
1632 * For example, to have the password expire 5 days from now, timeout would be
1633 * 5 * 86400 * 1000 = 432000000 ms for timeout.
1634 *
1635 * <p>To disable password expiration, a value of 0 may be used for timeout.
1636 *
Jim Millera4e28d12010-11-08 16:15:47 -08001637 * <p>The calling device admin must have requested
1638 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this
1639 * method; if it has not, a security exception will be thrown.
1640 *
Jessica Hummel9da60392014-05-21 12:32:57 +01001641 * <p> Note that setting the password will automatically reset the expiration time for all
1642 * active admins. Active admins do not need to explicitly call this method in that case.
1643 *
Jim Millera4e28d12010-11-08 16:15:47 -08001644 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1645 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0
1646 * means there is no restriction (unlimited).
1647 */
Robin Lee25e26452015-06-02 09:56:29 -07001648 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001649 if (mService != null) {
1650 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001651 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001652 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001653 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millera4e28d12010-11-08 16:15:47 -08001654 }
1655 }
1656 }
1657
1658 /**
Jim Miller6b857682011-02-16 16:27:41 -08001659 * Get the password expiration timeout for the given admin. The expiration timeout is the
1660 * recurring expiration timeout provided in the call to
1661 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Robin Lee25e26452015-06-02 09:56:29 -07001662 * aggregate of all policy administrators if {@code admin} is null.
Jim Millera4e28d12010-11-08 16:15:47 -08001663 *
Robin Lee25e26452015-06-02 09:56:29 -07001664 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001665 * @return The timeout for the given admin or the minimum of all timeouts
1666 */
Robin Lee25e26452015-06-02 09:56:29 -07001667 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001668 if (mService != null) {
1669 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001670 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001671 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001672 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millera4e28d12010-11-08 16:15:47 -08001673 }
1674 }
1675 return 0;
1676 }
1677
1678 /**
1679 * Get the current password expiration time for the given admin or an aggregate of
Jessica Hummel91da58d2014-04-10 17:39:43 +01001680 * all admins of this user and its profiles if admin is null. If the password is
1681 * expired, this will return the time since the password expired as a negative number.
1682 * If admin is null, then a composite of all expiration timeouts is returned
1683 * - which will be the minimum of all timeouts.
Jim Millera4e28d12010-11-08 16:15:47 -08001684 *
Robin Lee25e26452015-06-02 09:56:29 -07001685 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001686 * @return The password expiration time, in ms.
1687 */
Robin Lee25e26452015-06-02 09:56:29 -07001688 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001689 if (mService != null) {
1690 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001691 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001692 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001693 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millera4e28d12010-11-08 16:15:47 -08001694 }
1695 }
1696 return 0;
1697 }
1698
1699 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +01001700 * Retrieve the current password history length for all admins of this
1701 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001702 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001703 * all admins.
1704 * @return The length of the password history
1705 */
Robin Lee25e26452015-06-02 09:56:29 -07001706 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001707 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001708 }
1709
1710 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001711 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001712 if (mService != null) {
1713 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001714 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001715 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001716 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001717 }
1718 }
1719 return 0;
1720 }
1721
Dianne Hackbornd6847842010-01-12 18:14:19 -08001722 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001723 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001724 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001725 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001726 * @return Returns the maximum length that the user can enter.
1727 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001728 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001729 // Kind-of arbitrary.
1730 return 16;
1731 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001732
Dianne Hackborn254cb442010-01-27 19:23:59 -08001733 /**
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001734 * Determine whether the current password the user has set is sufficient
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001735 * to meet the policy requirements (quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00001736 * requested by the admins of this user and its profiles that don't have a separate challenge.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001737 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001738 * <p>The calling device admin must have requested
1739 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1740 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001741 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001742 * @return Returns true if the password meets the current requirements, else false.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001743 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001744 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001745 if (mService != null) {
1746 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001747 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001748 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001749 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001750 }
1751 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001752 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001753 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001754
Dianne Hackbornd6847842010-01-12 18:14:19 -08001755 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00001756 * Determine whether the current profile password the user has set is sufficient
1757 * to meet the policy requirements (quality, minimum length) that have been
1758 * requested by the admins of the parent user and its profiles.
1759 *
1760 * @param userHandle the userId of the profile to check the password for.
1761 * @return Returns true if the password would meet the current requirements, else false.
1762 * @hide
1763 */
1764 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
1765 if (mService != null) {
1766 try {
1767 return mService.isProfileActivePasswordSufficientForParent(userHandle);
1768 } catch (RemoteException e) {
1769 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
1770 }
1771 }
1772 return false;
1773 }
1774
1775 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001776 * Retrieve the number of times the user has failed at entering a
1777 * password since that last successful password entry.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001778 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001779 * <p>The calling device admin must have requested
1780 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call
1781 * this method; if it has not, a security exception will be thrown.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001782 */
1783 public int getCurrentFailedPasswordAttempts() {
1784 if (mService != null) {
1785 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001786 return mService.getCurrentFailedPasswordAttempts(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001787 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001788 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001789 }
1790 }
1791 return -1;
1792 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001793
1794 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04001795 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04001796 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04001797 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04001798 * @hide
1799 */
1800 public boolean getDoNotAskCredentialsOnBoot() {
1801 if (mService != null) {
1802 try {
1803 return mService.getDoNotAskCredentialsOnBoot();
1804 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001805 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04001806 }
1807 }
1808 return false;
1809 }
1810
1811 /**
Andrew Stadler88209d12010-02-08 22:59:36 -08001812 * Setting this to a value greater than zero enables a built-in policy
1813 * that will perform a device wipe after too many incorrect
1814 * device-unlock passwords have been entered. This built-in policy combines
1815 * watching for failed passwords and wiping the device, and requires
1816 * that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001817 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001818 *
Andrew Stadler88209d12010-02-08 22:59:36 -08001819 * <p>To implement any other policy (e.g. wiping data for a particular
1820 * application only, erasing or revoking credentials, or reporting the
1821 * failure to a server), you should implement
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001822 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)}
Andrew Stadler88209d12010-02-08 22:59:36 -08001823 * instead. Do not use this API, because if the maximum count is reached,
1824 * the device will be wiped immediately, and your callback will not be invoked.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001825 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001826 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001827 * @param num The number of failed password attempts at which point the
1828 * device will wipe its data.
1829 */
Robin Lee25e26452015-06-02 09:56:29 -07001830 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001831 if (mService != null) {
1832 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001833 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001834 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001835 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001836 }
1837 }
1838 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001839
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001840 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001841 * Retrieve the current maximum number of login attempts that are allowed
Jessica Hummel91da58d2014-04-10 17:39:43 +01001842 * before the device wipes itself, for all admins of this user and its profiles
Dianne Hackborn254cb442010-01-27 19:23:59 -08001843 * or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001844 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001845 * all admins.
1846 */
Robin Lee25e26452015-06-02 09:56:29 -07001847 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001848 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001849 }
1850
1851 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001852 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001853 if (mService != null) {
1854 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001855 return mService.getMaximumFailedPasswordsForWipe(
1856 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08001857 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001858 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborn254cb442010-01-27 19:23:59 -08001859 }
1860 }
1861 return 0;
1862 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001863
Dianne Hackborn254cb442010-01-27 19:23:59 -08001864 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07001865 * Returns the profile with the smallest maximum failed passwords for wipe,
1866 * for the given user. So for primary user, it might return the primary or
1867 * a managed profile. For a secondary user, it would be the same as the
1868 * user passed in.
1869 * @hide Used only by Keyguard
1870 */
1871 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
1872 if (mService != null) {
1873 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001874 return mService.getProfileWithMinimumFailedPasswordsForWipe(
1875 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07001876 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001877 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07001878 }
1879 }
1880 return UserHandle.USER_NULL;
1881 }
1882
1883 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001884 * Flag for {@link #resetPassword}: don't allow other admins to change
1885 * the password again until the user has entered it.
1886 */
1887 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001888
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001889 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04001890 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
1891 * If the flag is set, the device can be booted without asking for user password.
1892 * The absence of this flag does not change the current boot requirements. This flag
1893 * can be set by the device owner only. If the app is not the device owner, the flag
1894 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
1895 * device to factory defaults.
1896 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04001897 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04001898
1899 /**
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001900 * Force a new device unlock password (the password needed to access the
1901 * entire device, not for individual accounts) on the user. This takes
1902 * effect immediately.
Makoto Onuki70f929e2015-11-11 12:40:15 -08001903 *
1904 * <p>Calling this from a managed profile that shares the password with the owner profile
1905 * will throw a security exception.
1906 *
1907 * <p><em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
1908 * device admins that are not device owner and not profile owner.
1909 * The password can now only be changed if there is currently no password set. Device owner
1910 * and profile owner can still do this.</em>
1911 *
1912 * <p>The given password must be sufficient for the
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001913 * current password quality and length constraints as returned by
1914 * {@link #getPasswordQuality(ComponentName)} and
1915 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet
1916 * these constraints, then it will be rejected and false returned. Note
1917 * that the password may be a stronger quality (containing alphanumeric
1918 * characters when the requested quality is only numeric), in which case
1919 * the currently active quality will be increased to match.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001920 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01001921 * <p>Calling with a null or empty password will clear any existing PIN,
Makoto Onuki70f929e2015-11-11 12:40:15 -08001922 * pattern or password if the current password constraints allow it. <em>Note: This will not
1923 * work in {@link android.os.Build.VERSION_CODES#N} and later for device admins that are not
1924 * device owner and not profile owner. Once set, the password cannot be changed to null or
1925 * empty, except by device owner or profile owner.</em>
Adrian Roosf8f56bc2014-11-20 23:55:34 +01001926 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001927 * <p>The calling device admin must have requested
1928 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call
1929 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001930 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01001931 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04001932 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Craig Lafayette4e401fa2015-05-07 10:24:02 -04001933 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001934 * @return Returns true if the password was applied, or false if it is
Makoto Onuki70f929e2015-11-11 12:40:15 -08001935 * not acceptable for the current constraints or if the user has not been decrypted yet.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001936 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001937 public boolean resetPassword(String password, int flags) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001938 if (mParentInstance) {
1939 throw new SecurityException("Reset password does not work across profiles.");
1940 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001941 if (mService != null) {
1942 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08001943 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001944 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001945 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001946 }
1947 }
1948 return false;
1949 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001950
Dianne Hackbornd6847842010-01-12 18:14:19 -08001951 /**
1952 * Called by an application that is administering the device to set the
1953 * maximum time for user activity until the device will lock. This limits
1954 * the length that the user can set. It takes effect immediately.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001955 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001956 * <p>The calling device admin must have requested
Dianne Hackborn315ada72010-02-11 12:14:08 -08001957 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08001958 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001959 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001960 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001961 * @param timeMs The new desired maximum time to lock in milliseconds.
1962 * A value of 0 means there is no restriction.
1963 */
Robin Lee25e26452015-06-02 09:56:29 -07001964 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001965 if (mService != null) {
1966 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001967 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001968 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001969 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001970 }
1971 }
1972 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001973
Dianne Hackbornd6847842010-01-12 18:14:19 -08001974 /**
Jessica Hummel91da58d2014-04-10 17:39:43 +01001975 * Retrieve the current maximum time to unlock for all admins of this user
1976 * and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001977 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001978 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07001979 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07001980 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001981 */
Robin Lee25e26452015-06-02 09:56:29 -07001982 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001983 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001984 }
1985
1986 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001987 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001988 if (mService != null) {
1989 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001990 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001991 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08001992 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001993 }
1994 }
1995 return 0;
1996 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001997
Dianne Hackbornd6847842010-01-12 18:14:19 -08001998 /**
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001999 * Make the device lock immediately, as if the lock screen timeout has
2000 * expired at the point of this call.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002001 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08002002 * <p>The calling device admin must have requested
2003 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
2004 * this method; if it has not, a security exception will be thrown.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002005 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002006 public void lockNow() {
2007 if (mService != null) {
2008 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002009 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002010 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002011 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002012 }
2013 }
2014 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002015
Dianne Hackbornd6847842010-01-12 18:14:19 -08002016 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002017 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002018 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002019 */
2020 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2021
2022 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002023 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2024 * data.
2025 *
Paul Crowley2934b262014-12-02 11:21:13 +00002026 * <p>This flag may only be set by device owner admins; if it is set by
2027 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002028 */
2029 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2030
2031 /**
Robin Lee85bd63f2015-02-10 11:51:00 +00002032 * Ask the user data be wiped. Wiping the primary user will cause the
2033 * device to reboot, erasing all user data while next booting up.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002034 *
Dianne Hackborn8aa2e892010-01-22 11:31:30 -08002035 * <p>The calling device admin must have requested
2036 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to be able to call
2037 * this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002038 *
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002039 * @param flags Bit mask of additional options: currently supported flags
2040 * are {@link #WIPE_EXTERNAL_STORAGE} and
2041 * {@link #WIPE_RESET_PROTECTION_DATA}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002042 */
2043 public void wipeData(int flags) {
2044 if (mService != null) {
2045 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002046 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002047 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002048 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002049 }
2050 }
2051 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002052
Dianne Hackbornd6847842010-01-12 18:14:19 -08002053 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002054 * Called by an application that is administering the device to set the
2055 * global proxy and exclusion list.
2056 * <p>
2057 * The calling device admin must have requested
2058 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2059 * this method; if it has not, a security exception will be thrown.
2060 * Only the first device admin can set the proxy. If a second admin attempts
2061 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002062 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002063 * be returned.
2064 * The method can be called repeatedly by the device admin alrady setting the
2065 * proxy to update the proxy and exclusion list.
2066 *
Robin Lee25e26452015-06-02 09:56:29 -07002067 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002068 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2069 * Pass Proxy.NO_PROXY to reset the proxy.
2070 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002071 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2072 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002073 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002074 */
Robin Lee25e26452015-06-02 09:56:29 -07002075 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002076 List<String> exclusionList ) {
2077 if (proxySpec == null) {
2078 throw new NullPointerException();
2079 }
2080 if (mService != null) {
2081 try {
2082 String hostSpec;
2083 String exclSpec;
2084 if (proxySpec.equals(Proxy.NO_PROXY)) {
2085 hostSpec = null;
2086 exclSpec = null;
2087 } else {
2088 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2089 throw new IllegalArgumentException();
2090 }
2091 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2092 String hostName = sa.getHostName();
2093 int port = sa.getPort();
2094 StringBuilder hostBuilder = new StringBuilder();
2095 hostSpec = hostBuilder.append(hostName)
2096 .append(":").append(Integer.toString(port)).toString();
2097 if (exclusionList == null) {
2098 exclSpec = "";
2099 } else {
2100 StringBuilder listBuilder = new StringBuilder();
2101 boolean firstDomain = true;
2102 for (String exclDomain : exclusionList) {
2103 if (!firstDomain) {
2104 listBuilder = listBuilder.append(",");
2105 } else {
2106 firstDomain = false;
2107 }
2108 listBuilder = listBuilder.append(exclDomain.trim());
2109 }
2110 exclSpec = listBuilder.toString();
2111 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002112 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2113 != android.net.Proxy.PROXY_VALID)
2114 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002115 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002116 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002117 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002118 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002119 }
2120 }
2121 return null;
2122 }
2123
2124 /**
Jason Monk03bc9912014-05-13 09:44:57 -04002125 * Set a network-independent global HTTP proxy. This is not normally what you want
2126 * for typical HTTP proxies - they are generally network dependent. However if you're
2127 * doing something unusual like general internal filtering this may be useful. On
2128 * a private network where the proxy is not accessible, you may break HTTP using this.
2129 *
2130 * <p>This method requires the caller to be the device owner.
2131 *
2132 * <p>This proxy is only a recommendation and it is possible that some apps will ignore it.
2133 * @see ProxyInfo
2134 *
2135 * @param admin Which {@link DeviceAdminReceiver} this request is associated
2136 * with.
2137 * @param proxyInfo The a {@link ProxyInfo} object defining the new global
2138 * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
2139 */
Robin Lee25e26452015-06-02 09:56:29 -07002140 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2141 proxyInfo) {
Jason Monk03bc9912014-05-13 09:44:57 -04002142 if (mService != null) {
2143 try {
2144 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2145 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002146 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jason Monk03bc9912014-05-13 09:44:57 -04002147 }
2148 }
2149 }
2150
2151 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002152 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002153 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2154 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002155 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002156 */
2157 public ComponentName getGlobalProxyAdmin() {
2158 if (mService != null) {
2159 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002160 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002161 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002162 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002163 }
2164 }
2165 return null;
2166 }
2167
2168 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002169 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002170 * indicating that encryption is not supported.
2171 */
2172 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2173
2174 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002175 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002176 * indicating that encryption is supported, but is not currently active.
2177 */
2178 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2179
2180 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002181 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002182 * indicating that encryption is not currently active, but is currently
2183 * being activated. This is only reported by devices that support
2184 * encryption of data and only when the storage is currently
2185 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2186 * to become encrypted will never return this value.
2187 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002188 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002189
2190 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002191 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002192 * indicating that encryption is active.
2193 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002194 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002195
2196 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002197 * Result code for {@link #getStorageEncryptionStatus}:
2198 * indicating that encryption is active, but an encryption key has not
2199 * been set by the user.
2200 */
2201 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2202
2203 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002204 * Activity action: begin the process of encrypting data on the device. This activity should
2205 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2206 * After resuming from this activity, use {@link #getStorageEncryption}
2207 * to check encryption status. However, on some devices this activity may never return, as
2208 * it may trigger a reboot and in some cases a complete data wipe of the device.
2209 */
2210 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2211 public static final String ACTION_START_ENCRYPTION
2212 = "android.app.action.START_ENCRYPTION";
2213
2214 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002215 * Widgets are enabled in keyguard
2216 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002217 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002218
2219 /**
Jim Miller50e62182014-04-23 17:25:00 -07002220 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002221 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002222 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2223
2224 /**
2225 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2226 */
2227 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2228
2229 /**
Jim Miller50e62182014-04-23 17:25:00 -07002230 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2231 */
2232 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2233
2234 /**
2235 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2236 */
2237 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2238
2239 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002240 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002241 * (e.g. PIN/Pattern/Password).
2242 */
2243 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2244
2245 /**
Jim Miller06e34502014-07-17 14:46:05 -07002246 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2247 */
2248 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2249
2250 /**
Jim Miller35207742012-11-02 15:33:20 -07002251 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002252 */
2253 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002254
2255 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002256 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002257 * request that the storage system be encrypted.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002258 *
2259 * <p>When multiple device administrators attempt to control device
2260 * encryption, the most secure, supported setting will always be
2261 * used. If any device administrator requests device encryption,
2262 * it will be enabled; Conversely, if a device administrator
2263 * attempts to disable device encryption while another
2264 * device administrator has enabled it, the call to disable will
2265 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
2266 *
2267 * <p>This policy controls encryption of the secure (application data) storage area. Data
Andy Stadler50c294f2011-03-07 19:13:42 -08002268 * written to other storage areas may or may not be encrypted, and this policy does not require
2269 * or control the encryption of any other storage areas.
2270 * There is one exception: If {@link android.os.Environment#isExternalStorageEmulated()} is
2271 * {@code true}, then the directory returned by
2272 * {@link android.os.Environment#getExternalStorageDirectory()} must be written to disk
2273 * within the encrypted storage area.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002274 *
2275 * <p>Important Note: On some devices, it is possible to encrypt storage without requiring
2276 * the user to create a device PIN or Password. In this case, the storage is encrypted, but
2277 * the encryption key may not be fully secured. For maximum security, the administrator should
2278 * also require (and check for) a pattern, PIN, or password.
2279 *
2280 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2281 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002282 * @return the new request status (for all active admins) - will be one of
2283 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2284 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2285 * {@link #getStorageEncryptionStatus()} to query the actual device state.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002286 */
Robin Lee25e26452015-06-02 09:56:29 -07002287 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002288 if (mService != null) {
2289 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002290 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002291 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002292 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002293 }
2294 }
2295 return ENCRYPTION_STATUS_UNSUPPORTED;
2296 }
2297
2298 /**
2299 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002300 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002301 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002302 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2303 * this will return the requested encryption setting as an aggregate of all active
2304 * administrators.
2305 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002306 */
Robin Lee25e26452015-06-02 09:56:29 -07002307 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002308 if (mService != null) {
2309 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002310 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002311 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002312 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002313 }
2314 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002315 return false;
2316 }
2317
2318 /**
2319 * Called by an application that is administering the device to
2320 * determine the current encryption status of the device.
2321 *
2322 * Depending on the returned status code, the caller may proceed in different
2323 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2324 * storage system does not support encryption. If the
2325 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2326 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002327 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2328 * storage system has enabled encryption but no password is set so further action
2329 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or
Andy Stadler22dbfda2011-01-17 12:47:31 -08002330 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required.
2331 *
Robin Lee7e678712014-07-24 16:41:31 +01002332 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002333 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002334 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
2335 * or {@link #ENCRYPTION_STATUS_ACTIVE}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002336 */
2337 public int getStorageEncryptionStatus() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002338 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002339 }
2340
2341 /** @hide per-user version */
2342 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002343 if (mService != null) {
2344 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002345 return mService.getStorageEncryptionStatus(userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002346 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002347 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002348 }
2349 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002350 return ENCRYPTION_STATUS_UNSUPPORTED;
2351 }
2352
2353 /**
Robin Lee7e678712014-07-24 16:41:31 +01002354 * Installs the given certificate as a user CA.
2355 *
Robin Lee25e26452015-06-02 09:56:29 -07002356 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2357 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002358 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002359 *
2360 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002361 * interrupted, true otherwise.
Maggie Benthallda51e682013-08-08 22:35:44 -04002362 */
Robin Lee25e26452015-06-02 09:56:29 -07002363 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04002364 if (mService != null) {
2365 try {
Robin Lee7e678712014-07-24 16:41:31 +01002366 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002367 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002368 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002369 }
2370 }
2371 return false;
2372 }
2373
2374 /**
Robin Lee7e678712014-07-24 16:41:31 +01002375 * Uninstalls the given certificate from trusted user CAs, if present.
2376 *
Robin Lee25e26452015-06-02 09:56:29 -07002377 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2378 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002379 * @param certBuffer encoded form of the certificate to remove.
Maggie Benthallda51e682013-08-08 22:35:44 -04002380 */
Robin Lee25e26452015-06-02 09:56:29 -07002381 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04002382 if (mService != null) {
2383 try {
Robin Lee306fe082014-06-19 14:04:24 +00002384 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002385 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002386 } catch (CertificateException e) {
2387 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002388 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002389 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002390 }
2391 }
2392 }
2393
2394 /**
Robin Lee7e678712014-07-24 16:41:31 +01002395 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2396 * If a user has installed any certificates by other means than device policy these will be
2397 * included too.
2398 *
Robin Lee25e26452015-06-02 09:56:29 -07002399 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2400 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002401 * @return a List of byte[] arrays, each encoding one user CA certificate.
Maggie Benthallda51e682013-08-08 22:35:44 -04002402 */
Robin Lee25e26452015-06-02 09:56:29 -07002403 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002404 List<byte[]> certs = new ArrayList<byte[]>();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002405 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002406 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002407 mService.enforceCanManageCaCerts(admin);
2408 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2409 for (String alias : certStore.userAliases()) {
2410 try {
2411 certs.add(certStore.getCertificate(alias).getEncoded());
2412 } catch (CertificateException ce) {
2413 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2414 }
2415 }
2416 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002417 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Robin Lee7e678712014-07-24 16:41:31 +01002418 }
2419 }
2420 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002421 }
2422
2423 /**
Robin Lee7e678712014-07-24 16:41:31 +01002424 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2425 * means other than device policy will also be removed, except for system CA certificates.
2426 *
Robin Lee25e26452015-06-02 09:56:29 -07002427 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2428 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002429 */
Robin Lee25e26452015-06-02 09:56:29 -07002430 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002431 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002432 try {
2433 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2434 .toArray(new String[0]));
2435 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002436 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Robin Lee7e678712014-07-24 16:41:31 +01002437 }
2438 }
2439 }
2440
2441 /**
2442 * Returns whether this certificate is installed as a trusted CA.
2443 *
Robin Lee25e26452015-06-02 09:56:29 -07002444 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2445 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002446 * @param certBuffer encoded form of the certificate to look up.
Maggie Benthallda51e682013-08-08 22:35:44 -04002447 */
Robin Lee25e26452015-06-02 09:56:29 -07002448 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002449 if (mService != null) {
2450 try {
2451 mService.enforceCanManageCaCerts(admin);
2452 return getCaCertAlias(certBuffer) != null;
2453 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002454 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002455 } catch (CertificateException ce) {
2456 Log.w(TAG, "Could not parse certificate", ce);
2457 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002458 }
2459 return false;
2460 }
2461
2462 /**
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002463 * Called by a device or profile owner to install a certificate and private key pair. The
2464 * keypair will be visible to all apps within the profile.
2465 *
Robin Lee25e26452015-06-02 09:56:29 -07002466 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2467 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002468 * @param privKey The private key to install.
2469 * @param cert The certificate to install.
2470 * @param alias The private key alias under which to install the certificate. If a certificate
2471 * with that alias already exists, it will be overwritten.
2472 * @return {@code true} if the keys were installed, {@code false} otherwise.
2473 */
Robin Leefbc65642015-08-03 16:21:22 +01002474 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2475 @NonNull Certificate cert, @NonNull String alias) {
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002476 try {
2477 final byte[] pemCert = Credentials.convertToPem(cert);
Robin Lee0d5ccb72014-09-12 17:41:44 +01002478 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2479 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Robin Lee25e26452015-06-02 09:56:29 -07002480 return mService.installKeyPair(admin, pkcs8Key, pemCert, alias);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002481 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002482 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Robin Lee0d5ccb72014-09-12 17:41:44 +01002483 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2484 Log.w(TAG, "Failed to obtain private key material", e);
2485 } catch (CertificateException | IOException e) {
2486 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002487 }
2488 return false;
2489 }
2490
2491 /**
Robin Leefbc65642015-08-03 16:21:22 +01002492 * Called by a device or profile owner to remove all user credentials installed under a given
2493 * alias.
2494 *
2495 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2496 * {@code null} if calling from a delegated certificate installer.
2497 * @param alias The private key alias under which the certificate is installed.
2498 * @return {@code true} if the keys were both removed, {@code false} otherwise.
2499 */
2500 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
2501 try {
2502 return mService.removeKeyPair(admin, alias);
2503 } catch (RemoteException e) {
2504 Log.w(TAG, "Failed talking with device policy service", e);
2505 }
2506 return false;
2507 }
2508
2509 /**
Robin Lee25e26452015-06-02 09:56:29 -07002510 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00002511 * doesn't exist.
2512 */
2513 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2514 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2515 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2516 new ByteArrayInputStream(certBuffer));
2517 return new TrustedCertificateStore().getCertificateAlias(cert);
2518 }
2519
2520 /**
Rubin Xuec32b562015-03-03 17:34:05 +00002521 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01002522 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00002523 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01002524 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00002525 * <p>
2526 * Delegated certificate installer is a per-user state. The delegated access is persistent until
2527 * it is later cleared by calling this method with a null value or uninstallling the certificate
2528 * installer.
2529 *
Robin Lee25e26452015-06-02 09:56:29 -07002530 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00002531 * @param installerPackage The package name of the certificate installer which will be given
Robin Lee25e26452015-06-02 09:56:29 -07002532 * access. If {@code null} is given the current package will be cleared.
Rubin Xuec32b562015-03-03 17:34:05 +00002533 */
Robin Lee25e26452015-06-02 09:56:29 -07002534 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
2535 installerPackage) throws SecurityException {
Rubin Xuec32b562015-03-03 17:34:05 +00002536 if (mService != null) {
2537 try {
Robin Lee25e26452015-06-02 09:56:29 -07002538 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00002539 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002540 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Rubin Xuec32b562015-03-03 17:34:05 +00002541 }
2542 }
2543 }
2544
2545 /**
2546 * Called by a profile owner or device owner to retrieve the certificate installer for the
Makoto Onuki32b30572015-12-11 14:29:51 -08002547 * user. null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00002548 *
Robin Lee25e26452015-06-02 09:56:29 -07002549 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2550 * @return The package name of the current delegated certificate installer, or {@code null}
Rubin Xuec32b562015-03-03 17:34:05 +00002551 * if none is set.
2552 */
Robin Lee25e26452015-06-02 09:56:29 -07002553 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Rubin Xuec32b562015-03-03 17:34:05 +00002554 if (mService != null) {
2555 try {
Robin Lee25e26452015-06-02 09:56:29 -07002556 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00002557 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002558 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Rubin Xuec32b562015-03-03 17:34:05 +00002559 }
2560 }
2561 return null;
2562 }
2563
2564 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00002565 * Called by a device or profile owner to configure an always-on VPN connection through a
2566 * specific application for the current user.
2567 * This connection is automatically granted and persisted after a reboot.
2568 *
2569 * <p>The designated package should declare a {@link android.net.VpnService} in its
2570 * manifest guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE},
2571 * otherwise the call will fail.
2572 *
2573 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null}
2574 * to remove an existing always-on VPN configuration.
2575 *
2576 * @return {@code true} if the package is set as always-on VPN controller;
2577 * {@code false} otherwise.
2578 */
2579 public boolean setAlwaysOnVpnPackage(@NonNull ComponentName admin,
2580 @Nullable String vpnPackage) {
2581 if (mService != null) {
2582 try {
2583 return mService.setAlwaysOnVpnPackage(admin, vpnPackage);
2584 } catch (RemoteException e) {
2585 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
2586 }
2587 }
2588 return false;
2589 }
2590
2591 /**
2592 * Called by a device or profile owner to read the name of the package administering an
2593 * always-on VPN connection for the current user.
2594 * If there is no such package, or the always-on VPN is provided by the system instead
2595 * of by an application, {@code null} will be returned.
2596 *
2597 * @return Package name of VPN controller responsible for always-on VPN,
2598 * or {@code null} if none is set.
2599 */
2600 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
2601 if (mService != null) {
2602 try {
2603 return mService.getAlwaysOnVpnPackage(admin);
2604 } catch (RemoteException e) {
2605 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
2606 }
2607 }
2608 return null;
2609 }
2610
2611 /**
Ben Komalo2447edd2011-05-09 16:05:33 -07002612 * Called by an application that is administering the device to disable all cameras
Amith Yamasani242f4b12014-10-14 16:06:13 -07002613 * on the device, for this user. After setting this, no applications running as this user
2614 * will be able to access any cameras on the device.
Ben Komalo2447edd2011-05-09 16:05:33 -07002615 *
Makoto Onuki759a7632015-10-28 16:43:10 -07002616 * <p>If the caller is device owner, then the restriction will be applied to all users.
2617 *
Ben Komalo2447edd2011-05-09 16:05:33 -07002618 * <p>The calling device admin must have requested
2619 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call
2620 * this method; if it has not, a security exception will be thrown.
2621 *
2622 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2623 * @param disabled Whether or not the camera should be disabled.
2624 */
Robin Lee25e26452015-06-02 09:56:29 -07002625 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Ben Komalo2447edd2011-05-09 16:05:33 -07002626 if (mService != null) {
2627 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002628 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07002629 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002630 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ben Komalo2447edd2011-05-09 16:05:33 -07002631 }
2632 }
2633 }
2634
2635 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07002636 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08002637 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07002638 * @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 -07002639 * have disabled the camera
2640 */
Robin Lee25e26452015-06-02 09:56:29 -07002641 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002642 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002643 }
2644
2645 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002646 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07002647 if (mService != null) {
2648 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002649 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07002650 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002651 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ben Komalo2447edd2011-05-09 16:05:33 -07002652 }
2653 }
2654 return false;
2655 }
2656
2657 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00002658 * Called by a device owner to request a bugreport.
2659 *
2660 * <p>There must be only one user on the device, managed by the device owner.
2661 * Otherwise a security exception will be thrown.
2662 *
2663 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2664 * @return {@code true} if the bugreport collection started successfully, or {@code false}
2665 * if it wasn't triggered because a previous bugreport operation is still active
2666 * (either the bugreport is still running or waiting for the user to share or decline)
2667 */
2668 public boolean requestBugreport(@NonNull ComponentName admin) {
2669 if (mService != null) {
2670 try {
2671 return mService.requestBugreport(admin);
2672 } catch (RemoteException e) {
2673 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
2674 }
2675 }
2676 return false;
2677 }
2678
2679 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07002680 * Determine whether or not creating a guest user has been disabled for the device
2681 *
2682 * @hide
2683 */
2684 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
2685 // Currently guest users can always be created if multi-user is enabled
2686 // TODO introduce a policy for guest user creation
2687 return false;
2688 }
2689
2690 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01002691 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
2692 * screen capture also prevents the content from being shown on display devices that do not have
2693 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
2694 * secure surfaces and secure displays.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002695 *
2696 * <p>The calling device admin must be a device or profile owner. If it is not, a
2697 * security exception will be thrown.
2698 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07002699 * <p>From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also
Benjamin Franzc200f442015-06-25 18:20:04 +01002700 * blocks assist requests for all activities of the relevant user.
2701 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002702 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01002703 * @param disabled Whether screen capture is disabled or not.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002704 */
Robin Lee25e26452015-06-02 09:56:29 -07002705 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002706 if (mService != null) {
2707 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002708 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002709 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002710 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002711 }
2712 }
2713 }
2714
2715 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08002716 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002717 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07002718 * @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 +01002719 * have disabled screen capture.
2720 */
Robin Lee25e26452015-06-02 09:56:29 -07002721 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002722 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002723 }
2724
2725 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002726 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002727 if (mService != null) {
2728 try {
2729 return mService.getScreenCaptureDisabled(admin, userHandle);
2730 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002731 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01002732 }
2733 }
2734 return false;
2735 }
2736
2737 /**
Sander Alewijnse0ced6272014-08-26 11:18:26 +01002738 * Called by a device owner to set whether auto time is required. If auto time is
2739 * required the user cannot set the date and time, but has to use network date and time.
2740 *
2741 * <p>Note: if auto time is required the user can still manually set the time zone.
2742 *
2743 * <p>The calling device admin must be a device owner. If it is not, a security exception will
2744 * be thrown.
2745 *
2746 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2747 * @param required Whether auto time is set required or not.
2748 */
Robin Lee25e26452015-06-02 09:56:29 -07002749 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Sander Alewijnse0ced6272014-08-26 11:18:26 +01002750 if (mService != null) {
2751 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002752 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01002753 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002754 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01002755 }
2756 }
2757 }
2758
2759 /**
2760 * @return true if auto time is required.
2761 */
2762 public boolean getAutoTimeRequired() {
2763 if (mService != null) {
2764 try {
2765 return mService.getAutoTimeRequired();
2766 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002767 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01002768 }
2769 }
2770 return false;
2771 }
2772
2773 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01002774 * Called by a device owner to set whether all users created on the device should be ephemeral.
2775 *
2776 * <p>The system user is exempt from this policy - it is never ephemeral.
2777 *
2778 * <p>The calling device admin must be the device owner. If it is not, a security exception will
2779 * be thrown.
2780 *
2781 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2782 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
2783 * subsequently created users will be ephemeral.
2784 * @hide
2785 */
2786 public void setForceEphemeralUsers(
2787 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
2788 if (mService != null) {
2789 try {
2790 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
2791 } catch (RemoteException e) {
2792 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
2793 }
2794 }
2795 }
2796
2797 /**
2798 * @return true if all users are created ephemeral.
2799 * @hide
2800 */
2801 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
2802 if (mService != null) {
2803 try {
2804 return mService.getForceEphemeralUsers(admin);
2805 } catch (RemoteException e) {
2806 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
2807 }
2808 }
2809 return false;
2810 }
2811
2812 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07002813 * Called by an application that is administering the device to disable keyguard customizations,
2814 * such as widgets. After setting this, keyguard features will be disabled according to the
2815 * provided feature list.
Jim Millerb8ec4702012-08-31 17:19:10 -07002816 *
2817 * <p>The calling device admin must have requested
Jim Miller48b9b0d2012-09-19 23:16:50 -07002818 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call
Jim Millerb8ec4702012-08-31 17:19:10 -07002819 * this method; if it has not, a security exception will be thrown.
2820 *
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00002821 * <p>Calling this from a managed profile before version
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07002822 * {@link android.os.Build.VERSION_CODES#M} will throw a security exception.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00002823 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07002824 * <p>From version {@link android.os.Build.VERSION_CODES#M} a profile owner can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00002825 * <ul>
2826 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, {@link #KEYGUARD_DISABLE_FINGERPRINT}
2827 * these will affect the profile's parent user.
2828 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} this will affect notifications
2829 * generated by applications in the managed profile.
2830 * </ul>
2831 * <p>Requests to disable other features on a managed profile will be ignored. The admin
2832 * can check which features have been disabled by calling
2833 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07002834 *
Jim Millerb8ec4702012-08-31 17:19:10 -07002835 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07002836 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
2837 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
Jim Miller50e62182014-04-23 17:25:00 -07002838 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00002839 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_FINGERPRINT},
2840 * {@link #KEYGUARD_DISABLE_FEATURES_ALL}
Jim Millerb8ec4702012-08-31 17:19:10 -07002841 */
Robin Lee25e26452015-06-02 09:56:29 -07002842 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07002843 if (mService != null) {
2844 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002845 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07002846 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002847 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millerb8ec4702012-08-31 17:19:10 -07002848 }
2849 }
2850 }
2851
2852 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08002853 * Determine whether or not features have been disabled in keyguard either by the calling
Jim Millerb8ec4702012-08-31 17:19:10 -07002854 * admin, if specified, or all admins.
Esteban Talavera62399912016-01-11 15:37:55 +00002855 * @param admin The name of the admin component to check, or {@code null} to check whether any
2856 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07002857 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
2858 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07002859 */
Robin Lee25e26452015-06-02 09:56:29 -07002860 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002861 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002862 }
2863
2864 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002865 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07002866 if (mService != null) {
2867 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002868 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07002869 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002870 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Millerb8ec4702012-08-31 17:19:10 -07002871 }
2872 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07002873 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07002874 }
2875
2876 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08002877 * @hide
2878 */
Robin Lee25e26452015-06-02 09:56:29 -07002879 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
2880 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002881 if (mService != null) {
2882 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01002883 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002884 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002885 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002886 }
2887 }
2888 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002889
Dianne Hackbornd6847842010-01-12 18:14:19 -08002890 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01002891 * @hide
2892 */
Robin Lee25e26452015-06-02 09:56:29 -07002893 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002894 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01002895 }
2896
2897 /**
Robin Lee25e26452015-06-02 09:56:29 -07002898 * Returns the DeviceAdminInfo as defined by the administrator's package info &amp; meta-data
Dianne Hackbornd6847842010-01-12 18:14:19 -08002899 * @hide
2900 */
Robin Lee25e26452015-06-02 09:56:29 -07002901 public DeviceAdminInfo getAdminInfo(@NonNull ComponentName cn) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002902 ActivityInfo ai;
2903 try {
2904 ai = mContext.getPackageManager().getReceiverInfo(cn,
2905 PackageManager.GET_META_DATA);
2906 } catch (PackageManager.NameNotFoundException e) {
2907 Log.w(TAG, "Unable to retrieve device policy " + cn, e);
2908 return null;
2909 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002910
Dianne Hackbornd6847842010-01-12 18:14:19 -08002911 ResolveInfo ri = new ResolveInfo();
2912 ri.activityInfo = ai;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002913
Dianne Hackbornd6847842010-01-12 18:14:19 -08002914 try {
2915 return new DeviceAdminInfo(mContext, ri);
Makoto Onuki55c46f22015-11-25 14:56:23 -08002916 } catch (XmlPullParserException | IOException e) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002917 Log.w(TAG, "Unable to parse device policy " + cn, e);
2918 return null;
2919 }
2920 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002921
Dianne Hackbornd6847842010-01-12 18:14:19 -08002922 /**
2923 * @hide
2924 */
Robin Lee25e26452015-06-02 09:56:29 -07002925 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002926 if (mService != null) {
2927 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002928 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002929 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002930 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002931 }
2932 }
2933 }
2934
2935 /**
2936 * @hide
2937 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002938 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002939 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002940 if (mService != null) {
2941 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002942 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002943 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002944 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002945 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002946 }
2947 }
2948 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002949
Dianne Hackbornd6847842010-01-12 18:14:19 -08002950 /**
2951 * @hide
2952 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002953 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002954 if (mService != null) {
2955 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002956 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002957 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002958 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002959 }
2960 }
2961 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002962
Dianne Hackbornd6847842010-01-12 18:14:19 -08002963 /**
2964 * @hide
2965 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002966 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002967 if (mService != null) {
2968 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002969 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002970 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08002971 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002972 }
2973 }
2974 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07002975
2976 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00002977 * Should be called when keyguard has been dismissed.
2978 * @hide
2979 */
2980 public void reportKeyguardDismissed() {
2981 if (mService != null) {
2982 try {
2983 mService.reportKeyguardDismissed();
2984 } catch (RemoteException e) {
2985 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
2986 }
2987 }
2988 }
2989
2990 /**
2991 * Should be called when keyguard view has been shown to the user.
2992 * @hide
2993 */
2994 public void reportKeyguardSecured() {
2995 if (mService != null) {
2996 try {
2997 mService.reportKeyguardSecured();
2998 } catch (RemoteException e) {
2999 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3000 }
3001 }
3002 }
3003
3004 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003005 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003006 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003007 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3008 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003009 * @return whether the package was successfully registered as the device owner.
3010 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003011 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003012 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003013 public boolean setDeviceOwner(ComponentName who) {
3014 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003015 }
3016
3017 /**
3018 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003019 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003020 public boolean setDeviceOwner(ComponentName who, int userId) {
3021 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003022 }
3023
3024 /**
3025 * @hide
3026 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003027 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3028 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003029 }
3030
3031 /**
3032 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003033 * Sets the given package as the device owner. The package must already be installed. There
3034 * must not already be a device owner.
3035 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3036 * this method.
3037 * Calling this after the setup phase of the primary user has completed is allowed only if
3038 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003039 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003040 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003041 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003042 * @return whether the package was successfully registered as the device owner.
3043 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003044 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003045 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003046 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003047 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003048 if (mService != null) {
3049 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003050 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003051 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003052 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003053 }
3054 }
3055 return false;
3056 }
3057
3058 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003059 * Used to determine if a particular package has been registered as a Device Owner app.
3060 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003061 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003062 * package is currently registered as the device owner app, pass in the package name from
3063 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003064 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003065 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3066 * the setup process.
3067 * @param packageName the package name of the app, to compare with the registered device owner
3068 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003069 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003070 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003071 public boolean isDeviceOwnerApp(String packageName) {
Makoto Onukic8a5a552015-11-19 14:29:12 -08003072 return isDeviceOwnerAppOnCallingUser(packageName);
3073 }
3074
3075 /**
3076 * @return true if a package is registered as device owner, only when it's running on the
3077 * calling user.
3078 *
3079 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3080 * @hide
3081 */
3082 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3083 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3084 }
3085
3086 /**
3087 * @return true if a package is registered as device owner, even if it's running on a different
3088 * user.
3089 *
3090 * <p>Requires the MANAGE_USERS permission.
3091 *
3092 * @hide
3093 */
3094 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3095 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3096 }
3097
3098 /**
3099 * @return device owner component name, only when it's running on the calling user.
3100 *
3101 * @hide
3102 */
3103 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3104 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3105 }
3106
3107 /**
3108 * @return device owner component name, even if it's running on a different user.
3109 *
3110 * <p>Requires the MANAGE_USERS permission.
3111 *
3112 * @hide
3113 */
3114 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3115 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3116 }
3117
3118 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003119 if (packageName == null) {
3120 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003121 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003122 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003123 if (deviceOwner == null) {
3124 return false;
3125 }
3126 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003127 }
3128
Makoto Onukic8a5a552015-11-19 14:29:12 -08003129 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3130 if (mService != null) {
3131 try {
3132 return mService.getDeviceOwnerComponent(callingUserOnly);
3133 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003134 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Makoto Onukic8a5a552015-11-19 14:29:12 -08003135 }
3136 }
3137 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003138 }
3139
Jason Monkb0dced82014-06-06 14:36:20 -04003140 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003141 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3142 * no device owner.
3143 *
3144 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003145 *
3146 * @hide
3147 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003148 public int getDeviceOwnerUserId() {
3149 if (mService != null) {
3150 try {
3151 return mService.getDeviceOwnerUserId();
3152 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003153 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Makoto Onukic8a5a552015-11-19 14:29:12 -08003154 }
3155 }
3156 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003157 }
3158
3159 /**
Jason Monkb0dced82014-06-06 14:36:20 -04003160 * Clears the current device owner. The caller must be the device owner.
3161 *
3162 * This function should be used cautiously as once it is called it cannot
3163 * be undone. The device owner can only be set as a part of device setup
3164 * before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003165 *
3166 * @param packageName The package name of the device owner.
Jason Monkb0dced82014-06-06 14:36:20 -04003167 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003168 public void clearDeviceOwnerApp(String packageName) {
Jason Monkb0dced82014-06-06 14:36:20 -04003169 if (mService != null) {
3170 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003171 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003172 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003173 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Jason Monkb0dced82014-06-06 14:36:20 -04003174 }
3175 }
3176 }
3177
Makoto Onukia52562c2015-10-01 16:12:31 -07003178 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003179 * Returns the device owner package name, only if it's running on the calling user.
3180 *
3181 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003182 *
3183 * @hide
3184 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003185 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003186 public String getDeviceOwner() {
Makoto Onukic8a5a552015-11-19 14:29:12 -08003187 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3188 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003189 }
3190
3191 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003192 * @return true if the device is managed by any device owner.
3193 *
3194 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003195 *
3196 * @hide
3197 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003198 public boolean isDeviceManaged() {
3199 return getDeviceOwnerComponentOnAnyUser() != null;
3200 }
3201
3202 /**
3203 * Returns the device owner name. Note this method *will* return the device owner
3204 * name when it's running on a different user.
3205 *
3206 * <p>Requires the MANAGE_USERS permission.
3207 *
3208 * @hide
3209 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003210 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003211 public String getDeviceOwnerNameOnAnyUser() {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003212 if (mService != null) {
3213 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003214 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003215 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003216 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003217 }
3218 }
3219 return null;
3220 }
Adam Connors776c5552014-01-09 10:42:56 +00003221
3222 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003223 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003224 * @deprecated Do not use
3225 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003226 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003227 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003228 @SystemApi
3229 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003230 return null;
3231 }
3232
3233 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003234 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003235 * @deprecated Do not use
3236 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003237 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003238 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003239 @SystemApi
3240 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003241 return null;
3242 }
3243
Julia Reynolds20118f12015-02-11 12:34:08 -05003244 /**
Adam Connors776c5552014-01-09 10:42:56 +00003245 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003246 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303247 * Sets the given component as an active admin and registers the package as the profile
3248 * owner for this user. The package must already be installed and there shouldn't be
3249 * an existing profile owner registered for this user. Also, this method must be called
3250 * before the user setup has been completed.
3251 * <p>
3252 * This method can only be called by system apps that hold MANAGE_USERS permission and
3253 * MANAGE_DEVICE_ADMINS permission.
3254 * @param admin The component to register as an active admin and profile owner.
3255 * @param ownerName The user-visible name of the entity that is managing this user.
3256 * @return whether the admin was successfully registered as the profile owner.
3257 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3258 * the user has already been set up.
3259 */
Justin Morey80440cc2014-07-24 09:16:35 -05003260 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003261 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303262 throws IllegalArgumentException {
3263 if (mService != null) {
3264 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003265 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303266 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003267 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303268 } catch (RemoteException re) {
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303269 throw new IllegalArgumentException("Couldn't set profile owner.", re);
3270 }
3271 }
3272 return false;
3273 }
3274
3275 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003276 * Clears the active profile owner and removes all user restrictions. The caller must
3277 * be from the same package as the active profile owner for this user, otherwise a
3278 * SecurityException will be thrown.
3279 *
Makoto Onuki5bf68022016-01-27 13:49:19 -08003280 * <p>This doesn't work for managed profile owners.
3281 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003282 * @param admin The component to remove as the profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003283 */
Robin Lee25e26452015-06-02 09:56:29 -07003284 public void clearProfileOwner(@NonNull ComponentName admin) {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003285 if (mService != null) {
3286 try {
3287 mService.clearProfileOwner(admin);
3288 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003289 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003290 }
3291 }
3292 }
3293
3294 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003295 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003296 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003297 */
3298 public boolean hasUserSetupCompleted() {
3299 if (mService != null) {
3300 try {
3301 return mService.hasUserSetupCompleted();
3302 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003303 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003304 }
3305 }
3306 return true;
3307 }
3308
3309 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003310 * @hide
3311 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003312 * already be installed. There must not already be a profile owner for this user.
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 specified user has completed is allowed only if:
3316 * - the caller is SYSTEM_UID.
3317 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003318 * @param admin the component name to be registered as profile owner.
3319 * @param ownerName the human readable name of the organisation associated with this DPM.
3320 * @param userHandle the userId to set the profile owner for.
3321 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003322 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3323 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003324 */
Robin Lee25e26452015-06-02 09:56:29 -07003325 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003326 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003327 if (mService != null) {
3328 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003329 if (ownerName == null) {
3330 ownerName = "";
3331 }
3332 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003333 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003334 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Adam Connors776c5552014-01-09 10:42:56 +00003335 throw new IllegalArgumentException("Couldn't set profile owner.", re);
3336 }
3337 }
3338 return false;
3339 }
3340
3341 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003342 * Sets the device owner information to be shown on the lock screen.
3343 *
3344 * <p>If the device owner information is {@code null} or empty then the device owner info is
3345 * cleared and the user owner info is shown on the lock screen if it is set.
Andrei Stingaceanucc5061f2016-01-07 17:55:57 +00003346 * <p>If the device owner information contains only whitespaces then the message on the lock
3347 * screen will be blank and the user will not be allowed to change it.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003348 *
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003349 * <p>If the device owner information needs to be localized, it is the responsibility of the
3350 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3351 * and set a new version of this string accordingly.
3352 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003353 * @param admin The name of the admin component to check.
3354 * @param info Device owner information which will be displayed instead of the user
3355 * owner info.
3356 * @return Whether the device owner information has been set.
3357 */
3358 public boolean setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, String info) {
3359 if (mService != null) {
3360 try {
3361 return mService.setDeviceOwnerLockScreenInfo(admin, info);
3362 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003363 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003364 }
3365 }
3366 return false;
3367 }
3368
3369 /**
3370 * @return The device owner information. If it is not set returns {@code null}.
3371 */
3372 public String getDeviceOwnerLockScreenInfo() {
3373 if (mService != null) {
3374 try {
3375 return mService.getDeviceOwnerLockScreenInfo();
3376 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003377 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003378 }
3379 }
3380 return null;
3381 }
3382
3383 /**
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003384 * Called by device or profile owners for setting the package suspended for this user.
3385 * A suspended package will not be started by the package manager, its notifications will
3386 * be hidden and it will not show up in recents. The package must already be installed.
3387 *
3388 * @param admin The name of the admin component to check.
3389 * @param packageName The package name of the app to suspend or unsuspend.
3390 * @param suspended If set to {@code true} than the package will be suspended, if set to
3391 * {@code false} the package will be unsuspended.
3392 * @return boolean {@code true} if the operation was successfully performed, {@code false}
3393 * otherwise.
3394 */
3395 public boolean setPackageSuspended(@NonNull ComponentName admin, String packageName,
3396 boolean suspended) {
3397 if (mService != null) {
3398 try {
3399 return mService.setPackageSuspended(admin, packageName, suspended);
3400 } catch (RemoteException re) {
3401 Log.w(TAG, "Failed talking with device policy service", re);
3402 }
3403 }
3404 return false;
3405 }
3406
3407 /**
3408 * Called by device or profile owners to determine if a package is suspended.
3409 *
3410 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3411 * @param packageName The name of the package to retrieve the suspended status of.
3412 * @return boolean {@code true} if the package is suspended, {@code false} otherwise.
3413 */
3414 public boolean getPackageSuspended(@NonNull ComponentName admin, String packageName) {
3415 if (mService != null) {
3416 try {
3417 return mService.getPackageSuspended(admin, packageName);
3418 } catch (RemoteException e) {
3419 Log.w(TAG, "Failed talking with device policy service", e);
3420 }
3421 }
3422 return false;
3423 }
3424
3425 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003426 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3427 * be used. Only the profile owner can call this.
3428 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01003429 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003430 *
3431 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3432 */
Robin Lee25e26452015-06-02 09:56:29 -07003433 public void setProfileEnabled(@NonNull ComponentName admin) {
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003434 if (mService != null) {
3435 try {
3436 mService.setProfileEnabled(admin);
3437 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003438 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003439 }
3440 }
3441 }
3442
3443 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003444 * Sets the name of the profile. In the device owner case it sets the name of the user
3445 * 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 +01003446 * never called by the profile or device owner, the name will be set to default values.
3447 *
3448 * @see #isProfileOwnerApp
3449 * @see #isDeviceOwnerApp
3450 *
Robin Lee25e26452015-06-02 09:56:29 -07003451 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003452 * @param profileName The name of the profile.
3453 */
Robin Lee25e26452015-06-02 09:56:29 -07003454 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Jessica Hummel1333ea12014-06-23 11:20:10 +01003455 if (mService != null) {
3456 try {
Robin Lee25e26452015-06-02 09:56:29 -07003457 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003458 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003459 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003460 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003461 }
3462 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003463
3464 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003465 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08003466 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003467 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00003468 *
3469 * @param packageName The package name of the app to compare with the registered profile owner.
3470 * @return Whether or not the package is registered as the profile owner.
3471 */
3472 public boolean isProfileOwnerApp(String packageName) {
3473 if (mService != null) {
3474 try {
Nicolas Prevot90af6d72014-07-30 14:19:12 +01003475 ComponentName profileOwner = mService.getProfileOwner(
3476 Process.myUserHandle().getIdentifier());
3477 return profileOwner != null
3478 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00003479 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003480 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Adam Connors776c5552014-01-09 10:42:56 +00003481 }
3482 }
3483 return false;
3484 }
3485
3486 /**
3487 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003488 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00003489 * owner has been set for that user.
3490 * @throws IllegalArgumentException if the userId is invalid.
3491 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003492 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003493 public ComponentName getProfileOwner() throws IllegalArgumentException {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01003494 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
3495 }
3496
3497 /**
3498 * @see #getProfileOwner()
3499 * @hide
3500 */
3501 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003502 if (mService != null) {
3503 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01003504 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00003505 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003506 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Adam Connors776c5552014-01-09 10:42:56 +00003507 throw new IllegalArgumentException(
3508 "Requested profile owner for invalid userId", re);
3509 }
3510 }
3511 return null;
3512 }
3513
3514 /**
3515 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003516 * @return the human readable name of the organisation associated with this DPM or {@code null}
3517 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00003518 * @throws IllegalArgumentException if the userId is invalid.
3519 */
3520 public String getProfileOwnerName() throws IllegalArgumentException {
3521 if (mService != null) {
3522 try {
3523 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
3524 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003525 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Adam Connors776c5552014-01-09 10:42:56 +00003526 throw new IllegalArgumentException(
3527 "Requested profile owner for invalid userId", re);
3528 }
3529 }
3530 return null;
3531 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003532
3533 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07003534 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08003535 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07003536 * @return the human readable name of the organisation associated with this profile owner or
3537 * null if one is not set.
3538 * @throws IllegalArgumentException if the userId is invalid.
3539 */
3540 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02003541 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Amith Yamasani38f836b2014-08-20 14:51:15 -07003542 if (mService != null) {
3543 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02003544 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07003545 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003546 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasani38f836b2014-08-20 14:51:15 -07003547 throw new IllegalArgumentException(
3548 "Requested profile owner for invalid userId", re);
3549 }
3550 }
3551 return null;
3552 }
3553
3554 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003555 * Called by a profile owner or device owner to add a default intent handler activity for
3556 * intents that match a certain intent filter. This activity will remain the default intent
3557 * handler even if the set of potential event handlers for the intent filter changes and if
3558 * the intent preferences are reset.
3559 *
3560 * <p>The default disambiguation mechanism takes over if the activity is not installed
3561 * (anymore). When the activity is (re)installed, it is automatically reset as default
3562 * intent handler for the filter.
3563 *
3564 * <p>The calling device admin must be a profile owner or device owner. If it is not, a
3565 * security exception will be thrown.
3566 *
3567 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3568 * @param filter The IntentFilter for which a default handler is added.
3569 * @param activity The Activity that is added as default intent handler.
3570 */
Robin Lee25e26452015-06-02 09:56:29 -07003571 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
3572 @NonNull ComponentName activity) {
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003573 if (mService != null) {
3574 try {
3575 mService.addPersistentPreferredActivity(admin, filter, activity);
3576 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003577 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003578 }
3579 }
3580 }
3581
3582 /**
3583 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00003584 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003585 *
3586 * <p>The calling device admin must be a profile owner. If it is not, a security
3587 * exception will be thrown.
3588 *
3589 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3590 * @param packageName The name of the package for which preferences are removed.
3591 */
Robin Lee25e26452015-06-02 09:56:29 -07003592 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003593 String packageName) {
3594 if (mService != null) {
3595 try {
3596 mService.clearPackagePersistentPreferredActivities(admin, packageName);
3597 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003598 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003599 }
3600 }
3601 }
Robin Lee66e5d962014-04-09 16:44:21 +01003602
3603 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00003604 * Called by a profile owner or device owner to grant permission to a package to manage
3605 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
3606 * {@link #getApplicationRestrictions}.
3607 * <p>
3608 * This permission is persistent until it is later cleared by calling this method with a
3609 * {@code null} value or uninstalling the managing package.
3610 *
3611 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3612 * @param packageName The package name which will be given access to application restrictions
3613 * APIs. If {@code null} is given the current package will be cleared.
3614 */
3615 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
3616 @Nullable String packageName) {
3617 if (mService != null) {
3618 try {
3619 mService.setApplicationRestrictionsManagingPackage(admin, packageName);
3620 } catch (RemoteException e) {
3621 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3622 }
3623 }
3624 }
3625
3626 /**
3627 * Called by a profile owner or device owner to retrieve the application restrictions managing
3628 * package for the current user, or {@code null} if none is set.
3629 *
3630 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3631 * @return The package name allowed to manage application restrictions on the current user, or
3632 * {@code null} if none is set.
3633 */
3634 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
3635 if (mService != null) {
3636 try {
3637 return mService.getApplicationRestrictionsManagingPackage(admin);
3638 } catch (RemoteException e) {
3639 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3640 }
3641 }
3642 return null;
3643 }
3644
3645 /**
3646 * Returns {@code true} if the calling package has been granted permission via
3647 * {@link #setApplicationRestrictionsManagingPackage} to manage application
3648 * restrictions for the calling user.
3649 */
3650 public boolean isCallerApplicationRestrictionsManagingPackage() {
3651 if (mService != null) {
3652 try {
3653 return mService.isCallerApplicationRestrictionsManagingPackage();
3654 } catch (RemoteException e) {
3655 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3656 }
3657 }
3658 return false;
3659 }
3660
3661 /**
3662 * Sets the application restrictions for a given target application running in the calling user.
3663 *
3664 * <p>The caller must be a profile or device owner on that user, or the package allowed to
3665 * manage application restrictions via {@link #setApplicationRestrictionsManagingPackage};
3666 * otherwise a security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01003667 *
Esteban Talavera6b8e0642015-08-10 17:26:04 +01003668 * <p>The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
3669 * <ul>
3670 * <li>{@code boolean}
3671 * <li>{@code int}
3672 * <li>{@code String} or {@code String[]}
3673 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
3674 * </ul>
Robin Lee66e5d962014-04-09 16:44:21 +01003675 *
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00003676 * <p>If the restrictions are not available yet, but may be applied in the near future,
Esteban Talaverabf60f722015-12-10 16:26:44 +00003677 * the caller can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00003678 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
3679 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00003680 * <p>The application restrictions are only made visible to the target application via
3681 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or
3682 * device owner, and the application restrictions managing package via
3683 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01003684 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00003685 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3686 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01003687 * @param packageName The name of the package to update restricted settings for.
3688 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
3689 * set of active restrictions.
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00003690 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00003691 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00003692 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01003693 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00003694 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01003695 Bundle settings) {
3696 if (mService != null) {
3697 try {
3698 mService.setApplicationRestrictions(admin, packageName, settings);
3699 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003700 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Robin Lee66e5d962014-04-09 16:44:21 +01003701 }
3702 }
3703 }
3704
3705 /**
Jim Millere303bf42014-08-26 17:12:29 -07003706 * Sets a list of configuration features to enable for a TrustAgent component. This is meant
3707 * to be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all
3708 * trust agents but those enabled by this function call. If flag
3709 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Jim Miller604e7552014-07-18 19:00:02 -07003710 *
3711 * <p>The calling device admin must have requested
3712 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call
Jim Millere303bf42014-08-26 17:12:29 -07003713 * this method; if not, a security exception will be thrown.
Jim Miller604e7552014-07-18 19:00:02 -07003714 *
3715 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07003716 * @param target Component name of the agent to be enabled.
Jim Millerb5db57a2015-01-14 18:17:19 -08003717 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent
Jim Millere303bf42014-08-26 17:12:29 -07003718 * will be strictly disabled according to the state of the
3719 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
3720 * <p>If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all admins,
3721 * then it's up to the TrustAgent itself to aggregate the values from all device admins.
3722 * <p>Consult documentation for the specific TrustAgent to determine legal options parameters.
Jim Miller604e7552014-07-18 19:00:02 -07003723 */
Robin Lee25e26452015-06-02 09:56:29 -07003724 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
3725 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07003726 if (mService != null) {
3727 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003728 mService.setTrustAgentConfiguration(admin, target, configuration);
Jim Miller604e7552014-07-18 19:00:02 -07003729 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003730 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Miller604e7552014-07-18 19:00:02 -07003731 }
3732 }
3733 }
3734
3735 /**
Jim Millere303bf42014-08-26 17:12:29 -07003736 * Gets configuration for the given trust agent based on aggregating all calls to
3737 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
3738 * all device admins.
Jim Miller604e7552014-07-18 19:00:02 -07003739 *
Jim Millerb5db57a2015-01-14 18:17:19 -08003740 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
3741 * this function returns a list of configurations for all admins that declare
3742 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
3743 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
3744 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
3745 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07003746 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07003747 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07003748 */
Robin Lee25e26452015-06-02 09:56:29 -07003749 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
3750 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003751 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07003752 }
3753
3754 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003755 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
3756 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07003757 if (mService != null) {
3758 try {
Jim Millere303bf42014-08-26 17:12:29 -07003759 return mService.getTrustAgentConfiguration(admin, agent, userHandle);
Jim Miller604e7552014-07-18 19:00:02 -07003760 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003761 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Jim Miller604e7552014-07-18 19:00:02 -07003762 }
3763 }
Jim Millere303bf42014-08-26 17:12:29 -07003764 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07003765 }
3766
3767 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003768 * Called by a profile owner of a managed profile to set whether caller-Id information from
3769 * the managed profile will be shown in the parent profile, for incoming calls.
Adam Connors210fe212014-07-17 15:41:43 +01003770 *
3771 * <p>The calling device admin must be a profile owner. If it is not, a
3772 * security exception will be thrown.
3773 *
Robin Lee25e26452015-06-02 09:56:29 -07003774 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01003775 * @param disabled If true caller-Id information in the managed profile is not displayed.
3776 */
Robin Lee25e26452015-06-02 09:56:29 -07003777 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Adam Connors210fe212014-07-17 15:41:43 +01003778 if (mService != null) {
3779 try {
Robin Lee25e26452015-06-02 09:56:29 -07003780 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01003781 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003782 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Adam Connors210fe212014-07-17 15:41:43 +01003783 }
3784 }
3785 }
3786
3787 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003788 * Called by a profile owner of a managed profile to determine whether or not caller-Id
3789 * information has been disabled.
Adam Connors210fe212014-07-17 15:41:43 +01003790 *
3791 * <p>The calling device admin must be a profile owner. If it is not, a
3792 * security exception will be thrown.
3793 *
Robin Lee25e26452015-06-02 09:56:29 -07003794 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01003795 */
Robin Lee25e26452015-06-02 09:56:29 -07003796 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Adam Connors210fe212014-07-17 15:41:43 +01003797 if (mService != null) {
3798 try {
Robin Lee25e26452015-06-02 09:56:29 -07003799 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01003800 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003801 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Adam Connors210fe212014-07-17 15:41:43 +01003802 }
3803 }
3804 return false;
3805 }
3806
3807 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07003808 * Determine whether or not caller-Id information has been disabled.
3809 *
3810 * @param userHandle The user for whom to check the caller-id permission
3811 * @hide
3812 */
3813 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
3814 if (mService != null) {
3815 try {
3816 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
3817 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003818 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Amith Yamasani570002f2014-07-18 15:48:54 -07003819 }
3820 }
3821 return false;
3822 }
3823
3824 /**
Victor Chang1060c6182016-01-04 20:16:23 +00003825 * Called by a profile owner of a managed profile to set whether contacts search from
3826 * the managed profile will be shown in the parent profile, for incoming calls.
3827 *
3828 * <p>The calling device admin must be a profile owner. If it is not, a
3829 * security exception will be thrown.
3830 *
3831 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3832 * @param disabled If true contacts search in the managed profile is not displayed.
3833 */
3834 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
3835 boolean disabled) {
3836 if (mService != null) {
3837 try {
3838 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
3839 } catch (RemoteException e) {
3840 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3841 }
3842 }
3843 }
3844
3845 /**
3846 * Called by a profile owner of a managed profile to determine whether or not contacts search
3847 * has been disabled.
3848 *
3849 * <p>The calling device admin must be a profile owner. If it is not, a
3850 * security exception will be thrown.
3851 *
3852 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3853 */
3854 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
3855 if (mService != null) {
3856 try {
3857 return mService.getCrossProfileContactsSearchDisabled(admin);
3858 } catch (RemoteException e) {
3859 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3860 }
3861 }
3862 return false;
3863 }
3864
3865
3866 /**
3867 * Determine whether or not contacts search has been disabled.
3868 *
3869 * @param userHandle The user for whom to check the contacts search permission
3870 * @hide
3871 */
3872 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
3873 if (mService != null) {
3874 try {
3875 return mService
3876 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
3877 } catch (RemoteException e) {
3878 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
3879 }
3880 }
3881 return false;
3882 }
3883
3884 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003885 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00003886 *
Makoto Onuki1040da12015-03-19 11:24:00 -07003887 * @hide
3888 */
3889 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00003890 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07003891 if (mService != null) {
3892 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00003893 mService.startManagedQuickContact(actualLookupKey, actualContactId,
3894 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07003895 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003896 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Makoto Onuki1040da12015-03-19 11:24:00 -07003897 }
3898 }
3899 }
3900
3901 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003902 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00003903 * @hide
3904 */
3905 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
3906 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00003907 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00003908 originalIntent);
3909 }
3910
3911 /**
Ricky Wai778ba132015-03-31 14:21:22 +01003912 * Called by a profile owner of a managed profile to set whether bluetooth
3913 * devices can access enterprise contacts.
3914 * <p>
3915 * The calling device admin must be a profile owner. If it is not, a
3916 * security exception will be thrown.
3917 * <p>
3918 * This API works on managed profile only.
3919 *
Robin Lee25e26452015-06-02 09:56:29 -07003920 * @param admin Which {@link DeviceAdminReceiver} this request is associated
Ricky Wai778ba132015-03-31 14:21:22 +01003921 * with.
3922 * @param disabled If true, bluetooth devices cannot access enterprise
3923 * contacts.
3924 */
Robin Lee25e26452015-06-02 09:56:29 -07003925 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Ricky Wai778ba132015-03-31 14:21:22 +01003926 if (mService != null) {
3927 try {
Robin Lee25e26452015-06-02 09:56:29 -07003928 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01003929 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003930 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ricky Wai778ba132015-03-31 14:21:22 +01003931 }
3932 }
3933 }
3934
3935 /**
3936 * Called by a profile owner of a managed profile to determine whether or
3937 * not Bluetooth devices cannot access enterprise contacts.
3938 * <p>
3939 * The calling device admin must be a profile owner. If it is not, a
3940 * security exception will be thrown.
3941 * <p>
3942 * This API works on managed profile only.
3943 *
Robin Lee25e26452015-06-02 09:56:29 -07003944 * @param admin Which {@link DeviceAdminReceiver} this request is associated
Ricky Wai778ba132015-03-31 14:21:22 +01003945 * with.
3946 */
Robin Lee25e26452015-06-02 09:56:29 -07003947 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Ricky Wai778ba132015-03-31 14:21:22 +01003948 if (mService != null) {
3949 try {
Robin Lee25e26452015-06-02 09:56:29 -07003950 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01003951 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003952 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ricky Wai778ba132015-03-31 14:21:22 +01003953 }
3954 }
3955 return true;
3956 }
3957
3958 /**
3959 * Determine whether or not Bluetooth devices cannot access contacts.
3960 * <p>
3961 * This API works on managed profile UserHandle only.
3962 *
3963 * @param userHandle The user for whom to check the caller-id permission
3964 * @hide
3965 */
3966 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
3967 if (mService != null) {
3968 try {
3969 return mService.getBluetoothContactSharingDisabledForUser(userHandle
3970 .getIdentifier());
3971 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003972 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Ricky Wai778ba132015-03-31 14:21:22 +01003973 }
3974 }
3975 return true;
3976 }
3977
3978 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003979 * Called by the profile owner of a managed profile so that some intents sent in the managed
3980 * profile can also be resolved in the parent, or vice versa.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00003981 * Only activity intents are supported.
3982 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00003983 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01003984 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
3985 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01003986 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
3987 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00003988 */
Robin Lee25e26452015-06-02 09:56:29 -07003989 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00003990 if (mService != null) {
3991 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01003992 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00003993 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08003994 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00003995 }
3996 }
3997 }
3998
3999 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004000 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4001 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004002 * Only removes those that have been set by the profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004003 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4004 */
Robin Lee25e26452015-06-02 09:56:29 -07004005 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004006 if (mService != null) {
4007 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004008 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004009 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004010 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004011 }
4012 }
4013 }
4014
4015 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004016 * Called by a profile or device owner to set the permitted accessibility services. When
4017 * set by a device owner or profile owner the restriction applies to all profiles of the
4018 * user the device owner or profile owner is an admin for.
Jim Millerb1474f42014-08-26 18:42:58 -07004019 *
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004020 * By default the user can use any accessiblity service. When zero or more packages have
4021 * been added, accessiblity services that are not in the list and not part of the system
Jim Millerb1474f42014-08-26 18:42:58 -07004022 * can not be enabled by the user.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004023 *
4024 * <p> Calling with a null value for the list disables the restriction so that all services
4025 * can be used, calling with an empty list only allows the builtin system's services.
4026 *
4027 * <p> System accesibility services are always available to the user the list can't modify
4028 * this.
4029 *
4030 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4031 * @param packageNames List of accessibility service package names.
4032 *
4033 * @return true if setting the restriction succeeded. It fail if there is
4034 * one or more non-system accessibility services enabled, that are not in the list.
4035 */
Robin Lee25e26452015-06-02 09:56:29 -07004036 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004037 List<String> packageNames) {
4038 if (mService != null) {
4039 try {
4040 return mService.setPermittedAccessibilityServices(admin, packageNames);
4041 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004042 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004043 }
4044 }
4045 return false;
4046 }
4047
4048 /**
4049 * Returns the list of permitted accessibility services set by this device or profile owner.
4050 *
4051 * <p>An empty list means no accessibility services except system services are allowed.
4052 * Null means all accessibility services are allowed.
4053 *
4054 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4055 * @return List of accessiblity service package names.
4056 */
Robin Lee25e26452015-06-02 09:56:29 -07004057 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004058 if (mService != null) {
4059 try {
4060 return mService.getPermittedAccessibilityServices(admin);
4061 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004062 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004063 }
4064 }
4065 return null;
4066 }
4067
4068 /**
4069 * Returns the list of accessibility services permitted by the device or profiles
4070 * owners of this user.
4071 *
4072 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4073 * it will contain the intersection of the permitted lists for any device or profile
4074 * owners that apply to this user. It will also include any system accessibility services.
4075 *
4076 * @param userId which user to check for.
4077 * @return List of accessiblity service package names.
4078 * @hide
4079 */
4080 @SystemApi
4081 public List<String> getPermittedAccessibilityServices(int userId) {
4082 if (mService != null) {
4083 try {
4084 return mService.getPermittedAccessibilityServicesForUser(userId);
4085 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004086 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004087 }
4088 }
4089 return null;
4090 }
4091
4092 /**
4093 * Called by a profile or device owner to set the permitted input methods services. When
4094 * set by a device owner or profile owner the restriction applies to all profiles of the
4095 * user the device owner or profile owner is an admin for.
4096 *
4097 * By default the user can use any input method. When zero or more packages have
4098 * been added, input method that are not in the list and not part of the system
4099 * can not be enabled by the user.
4100 *
4101 * This method will fail if it is called for a admin that is not for the foreground user
4102 * or a profile of the foreground user.
4103 *
4104 * <p> Calling with a null value for the list disables the restriction so that all input methods
4105 * can be used, calling with an empty list disables all but the system's own input methods.
4106 *
4107 * <p> System input methods are always available to the user this method can't modify this.
4108 *
4109 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4110 * @param packageNames List of input method package names.
Kenny Guy74a70242015-02-05 19:48:38 +00004111 * @return true if setting the restriction succeeded. It will fail if there are
4112 * one or more non-system input methods currently enabled that are not in
4113 * the packageNames list.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004114 */
Robin Lee25e26452015-06-02 09:56:29 -07004115 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004116 if (mService != null) {
4117 try {
4118 return mService.setPermittedInputMethods(admin, packageNames);
4119 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004120 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004121 }
4122 }
4123 return false;
4124 }
4125
4126
4127 /**
4128 * Returns the list of permitted input methods set by this device or profile owner.
4129 *
4130 * <p>An empty list means no input methods except system input methods are allowed.
4131 * Null means all input methods are allowed.
4132 *
4133 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4134 * @return List of input method package names.
4135 */
Robin Lee25e26452015-06-02 09:56:29 -07004136 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004137 if (mService != null) {
4138 try {
4139 return mService.getPermittedInputMethods(admin);
4140 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004141 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004142 }
4143 }
4144 return null;
4145 }
4146
4147 /**
4148 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004149 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004150 *
4151 * <p>Null means all input methods are allowed, if a non-null list is returned
4152 * it will contain the intersection of the permitted lists for any device or profile
4153 * owners that apply to this user. It will also include any system input methods.
4154 *
4155 * @return List of input method package names.
4156 * @hide
4157 */
4158 @SystemApi
4159 public List<String> getPermittedInputMethodsForCurrentUser() {
4160 if (mService != null) {
4161 try {
4162 return mService.getPermittedInputMethodsForCurrentUser();
4163 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004164 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004165 }
4166 }
4167 return null;
4168 }
4169
4170 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004171 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4172 * currently installed it.
4173 *
4174 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4175 *
4176 * @return List of package names to keep cached.
4177 * @hide
4178 */
4179 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
4180 if (mService != null) {
4181 try {
4182 return mService.getKeepUninstalledPackages(admin);
4183 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004184 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004185 }
4186 }
4187 return null;
4188 }
4189
4190 /**
4191 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4192 * currently installed it.
4193 *
4194 * <p>Please note that setting this policy does not imply that specified apps will be
4195 * automatically pre-cached.</p>
4196 *
4197 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4198 * @param packageNames List of package names to keep cached.
4199 * @hide
4200 */
4201 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4202 @NonNull List<String> packageNames) {
4203 if (mService != null) {
4204 try {
4205 mService.setKeepUninstalledPackages(admin, packageNames);
4206 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004207 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004208 }
4209 }
4210 }
4211
4212 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004213 * Called by a device owner to create a user with the specified name. The UserHandle returned
4214 * by this method should not be persisted as user handles are recycled as users are removed and
4215 * created. If you need to persist an identifier for this user, use
4216 * {@link UserManager#getSerialNumberForUser}.
4217 *
4218 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4219 * @param name the user's name
4220 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004221 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4222 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004223 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004224 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
Julia Reynolds1e958392014-05-16 14:25:21 -04004225 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004226 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004227 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004228 try {
4229 return mService.createUser(admin, name);
4230 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004231 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Julia Reynolds1e958392014-05-16 14:25:21 -04004232 }
4233 return null;
4234 }
4235
4236 /**
Jason Monk03978a42014-06-10 15:05:30 -04004237 * Called by a device owner to create a user with the specified name. The UserHandle returned
4238 * by this method should not be persisted as user handles are recycled as users are removed and
4239 * created. If you need to persist an identifier for this user, use
4240 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4241 * immediately.
4242 *
4243 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4244 * as registered as an active admin on the new user. The profile owner package will be
4245 * installed on the new user if it already is installed on the device.
4246 *
4247 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4248 * profileOwnerComponent when onEnable is called.
4249 *
4250 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4251 * @param name the user's name
4252 * @param ownerName the human readable name of the organisation associated with this DPM.
4253 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4254 * the user.
4255 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4256 * on the new user.
4257 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004258 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4259 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004260 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004261 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
Jason Monk03978a42014-06-10 15:05:30 -04004262 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004263 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004264 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4265 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004266 try {
4267 return mService.createAndInitializeUser(admin, name, ownerName, profileOwnerComponent,
4268 adminExtras);
4269 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004270 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Jason Monk03978a42014-06-10 15:05:30 -04004271 }
4272 return null;
4273 }
4274
4275 /**
phweissa92e1212016-01-25 17:14:10 +01004276 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01004277 */
4278 public static final int SKIP_SETUP_WIZARD = 0x0001;
4279
4280 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01004281 * Flag used by {@link #createAndManageUser} to specify that the user should be created
4282 * ephemeral.
4283 * @hide
4284 */
4285 public static final int MAKE_USER_EPHEMERAL = 0x0002;
4286
4287 /**
phweissa92e1212016-01-25 17:14:10 +01004288 * Called by a device owner to create a user with the specified name and a given component of
4289 * the calling package as profile owner. The UserHandle returned by this method should not be
4290 * persisted as user handles are recycled as users are removed and created. If you need to
4291 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4292 * user will not be started in the background.
phweiss343fb332016-01-25 14:48:59 +01004293 *
phweissa92e1212016-01-25 17:14:10 +01004294 * <p>admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also
4295 * a DeviceAdminReceiver in the same package as admin, and will become the profile owner and
4296 * will be registered as an active admin on the new user. The profile owner package will be
4297 * installed on the new user.
phweiss343fb332016-01-25 14:48:59 +01004298 *
4299 * <p>If the adminExtras are not null, they will be stored on the device until the user is
4300 * started for the first time. Then the extras will be passed to the admin when
4301 * onEnable is called.
4302 *
4303 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4304 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01004305 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
4306 * same package as admin, otherwise no user is created and an IllegalArgumentException is
4307 * thrown.
phweiss343fb332016-01-25 14:48:59 +01004308 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
4309 * user.
phweissa92e1212016-01-25 17:14:10 +01004310 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01004311 * @see UserHandle
4312 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4313 * user could not be created.
phweiss343fb332016-01-25 14:48:59 +01004314 */
4315 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01004316 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4317 int flags) {
phweiss343fb332016-01-25 14:48:59 +01004318 try {
phweissa92e1212016-01-25 17:14:10 +01004319 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01004320 } catch (RemoteException re) {
4321 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
4322 }
4323 return null;
4324 }
4325
4326 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004327 * Called by a device owner to remove a user and all associated data. The primary user can
4328 * not be removed.
4329 *
4330 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4331 * @param userHandle the user to remove.
4332 * @return {@code true} if the user was removed, {@code false} otherwise.
4333 */
Robin Lee25e26452015-06-02 09:56:29 -07004334 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004335 try {
4336 return mService.removeUser(admin, userHandle);
4337 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004338 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Julia Reynolds1e958392014-05-16 14:25:21 -04004339 return false;
4340 }
4341 }
4342
4343 /**
Jason Monk582d9112014-07-09 19:57:08 -04004344 * Called by a device owner to switch the specified user to the foreground.
4345 *
4346 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4347 * @param userHandle the user to switch to; null will switch to primary.
4348 * @return {@code true} if the switch was successful, {@code false} otherwise.
4349 *
4350 * @see Intent#ACTION_USER_FOREGROUND
4351 */
Robin Lee25e26452015-06-02 09:56:29 -07004352 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Jason Monk582d9112014-07-09 19:57:08 -04004353 try {
4354 return mService.switchUser(admin, userHandle);
4355 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004356 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Jason Monk582d9112014-07-09 19:57:08 -04004357 return false;
4358 }
4359 }
4360
4361 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004362 * Retrieves the application restrictions for a given target application running in the calling
4363 * user.
Robin Lee66e5d962014-04-09 16:44:21 +01004364 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004365 * <p>The caller must be a profile or device owner on that user, or the package allowed to
4366 * manage application restrictions via {@link #setApplicationRestrictionsManagingPackage};
4367 * otherwise a security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01004368 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004369 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
4370 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004371 * @param packageName The name of the package to fetch restricted settings of.
4372 * @return {@link Bundle} of settings corresponding to what was set last time
4373 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty {@link Bundle}
4374 * if no restrictions have been set.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004375 *
4376 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01004377 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004378 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Robin Lee66e5d962014-04-09 16:44:21 +01004379 if (mService != null) {
4380 try {
4381 return mService.getApplicationRestrictions(admin, packageName);
4382 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004383 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Robin Lee66e5d962014-04-09 16:44:21 +01004384 }
4385 }
4386 return null;
4387 }
Amith Yamasanibe465322014-04-24 13:45:17 -07004388
4389 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004390 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07004391 * <p>
4392 * The calling device admin must be a profile or device owner; if it is not,
4393 * a security exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07004394 *
Amith Yamasanibe465322014-04-24 13:45:17 -07004395 * @param admin Which {@link DeviceAdminReceiver} this request is associated
4396 * with.
4397 * @param key The key of the restriction. See the constants in
4398 * {@link android.os.UserManager} for the list of keys.
4399 */
Robin Lee25e26452015-06-02 09:56:29 -07004400 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Amith Yamasanibe465322014-04-24 13:45:17 -07004401 if (mService != null) {
4402 try {
4403 mService.setUserRestriction(admin, key, true);
4404 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004405 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Amith Yamasanibe465322014-04-24 13:45:17 -07004406 }
4407 }
4408 }
4409
4410 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004411 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07004412 * <p>
4413 * The calling device admin must be a profile or device owner; if it is not,
4414 * a security exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07004415 *
Amith Yamasanibe465322014-04-24 13:45:17 -07004416 * @param admin Which {@link DeviceAdminReceiver} this request is associated
4417 * with.
4418 * @param key The key of the restriction. See the constants in
4419 * {@link android.os.UserManager} for the list of keys.
4420 */
Robin Lee25e26452015-06-02 09:56:29 -07004421 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Amith Yamasanibe465322014-04-24 13:45:17 -07004422 if (mService != null) {
4423 try {
4424 mService.setUserRestriction(admin, key, false);
4425 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004426 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Amith Yamasanibe465322014-04-24 13:45:17 -07004427 }
4428 }
4429 }
Adam Connors010cfd42014-04-16 12:48:13 +01004430
4431 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004432 * Called by a profile or device owner to get user restrictions set with
4433 * {@link #addUserRestriction(ComponentName, String)}.
4434 * <p>
4435 * The target user may have more restrictions set by the system or other device owner / profile
4436 * owner. To get all the user restrictions currently set, use
4437 * {@link UserManager#getUserRestrictions()}.
4438 *
4439 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka1c277a52015-11-11 21:58:24 +00004440 * @throws SecurityException if the {@code admin} is not an active admin.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004441 */
4442 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
Sudheer Shanka1c277a52015-11-11 21:58:24 +00004443 return getUserRestrictions(admin, myUserId());
4444 }
4445
4446 /** @hide per-user version */
4447 public Bundle getUserRestrictions(@NonNull ComponentName admin, int userHandle) {
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004448 Bundle ret = null;
4449 if (mService != null) {
4450 try {
Sudheer Shanka1c277a52015-11-11 21:58:24 +00004451 ret = mService.getUserRestrictions(admin, userHandle);
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004452 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004453 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004454 }
4455 }
4456 return ret == null ? new Bundle() : ret;
4457 }
4458
4459 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004460 * Called by profile or device owners to hide or unhide packages. When a package is hidden it
Julia Reynolds966881e2014-05-14 12:23:08 -04004461 * is unavailable for use, but the data and actual package file remain.
4462 *
4463 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004464 * @param packageName The name of the package to hide or unhide.
4465 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
4466 * unhidden.
4467 * @return boolean Whether the hidden setting of the package was successfully updated.
Julia Reynolds966881e2014-05-14 12:23:08 -04004468 */
Robin Lee25e26452015-06-02 09:56:29 -07004469 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004470 boolean hidden) {
Julia Reynolds966881e2014-05-14 12:23:08 -04004471 if (mService != null) {
4472 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004473 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04004474 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004475 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Julia Reynolds966881e2014-05-14 12:23:08 -04004476 }
4477 }
4478 return false;
4479 }
4480
4481 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004482 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04004483 *
4484 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004485 * @param packageName The name of the package to retrieve the hidden status of.
4486 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Julia Reynolds966881e2014-05-14 12:23:08 -04004487 */
Robin Lee25e26452015-06-02 09:56:29 -07004488 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Julia Reynolds966881e2014-05-14 12:23:08 -04004489 if (mService != null) {
4490 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004491 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04004492 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004493 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Julia Reynolds966881e2014-05-14 12:23:08 -04004494 }
4495 }
4496 return false;
4497 }
4498
4499 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004500 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004501 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00004502 *
4503 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08004504 * @param packageName The package to be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00004505 */
Robin Lee25e26452015-06-02 09:56:29 -07004506 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Adam Connors655be2a2014-07-14 09:01:25 +00004507 if (mService != null) {
4508 try {
4509 mService.enableSystemApp(admin, packageName);
4510 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004511 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Adam Connors655be2a2014-07-14 09:01:25 +00004512 }
4513 }
4514 }
4515
4516 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004517 * Called by profile or device owners to re-enable system apps by intent that were disabled
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004518 * by default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00004519 *
4520 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4521 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Makoto Onuki32b30572015-12-11 14:29:51 -08004522 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00004523 * @return int The number of activities that matched the intent and were installed.
4524 */
Robin Lee25e26452015-06-02 09:56:29 -07004525 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Adam Connors655be2a2014-07-14 09:01:25 +00004526 if (mService != null) {
4527 try {
4528 return mService.enableSystemAppWithIntent(admin, intent);
4529 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004530 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Adam Connors655be2a2014-07-14 09:01:25 +00004531 }
4532 }
4533 return 0;
4534 }
4535
4536 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00004537 * Called by a device owner or profile owner to disable account management for a specific type
4538 * of account.
Sander Alewijnse650c3342014-05-08 18:00:50 +01004539 *
Sander Alewijnse112e0532014-10-29 13:28:49 +00004540 * <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 +01004541 * security exception will be thrown.
4542 *
4543 * <p>When account management is disabled for an account type, adding or removing an account
4544 * of that type will not be possible.
4545 *
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00004546 * <p>From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
4547 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
4548 * management for a specific type is disabled.
4549 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01004550 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4551 * @param accountType For which account management is disabled or enabled.
4552 * @param disabled The boolean indicating that account management will be disabled (true) or
4553 * enabled (false).
4554 */
Robin Lee25e26452015-06-02 09:56:29 -07004555 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01004556 boolean disabled) {
4557 if (mService != null) {
4558 try {
4559 mService.setAccountManagementDisabled(admin, accountType, disabled);
4560 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004561 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnse650c3342014-05-08 18:00:50 +01004562 }
4563 }
4564 }
4565
4566 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01004567 * Gets the array of accounts for which account management is disabled by the profile owner.
4568 *
4569 * <p> Account management can be disabled/enabled by calling
4570 * {@link #setAccountManagementDisabled}.
4571 *
4572 * @return a list of account types for which account management has been disabled.
4573 *
4574 * @see #setAccountManagementDisabled
4575 */
4576 public String[] getAccountTypesWithManagementDisabled() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004577 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01004578 }
4579
4580 /**
4581 * @see #getAccountTypesWithManagementDisabled()
4582 * @hide
4583 */
4584 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01004585 if (mService != null) {
4586 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01004587 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01004588 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004589 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01004590 }
4591 }
4592
4593 return null;
4594 }
justinzhang511e0d82014-03-24 16:09:24 -04004595
4596 /**
Jason Monkd7b86212014-06-16 13:15:38 -04004597 * Sets which packages may enter lock task mode.
4598 *
4599 * <p>Any packages that shares uid with an allowed package will also be allowed
4600 * to activate lock task.
justinzhang511e0d82014-03-24 16:09:24 -04004601 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004602 * From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
Benjamin Franz469dd582015-06-09 14:24:36 +01004603 * package list results in locked tasks belonging to those packages to be finished.
4604 *
Jason Monkc5185f22014-06-24 11:12:42 -04004605 * This function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04004606 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04004607 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jason Monkd7b86212014-06-16 13:15:38 -04004608 *
4609 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00004610 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
4611 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04004612 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04004613 */
Robin Lee25e26452015-06-02 09:56:29 -07004614 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04004615 throws SecurityException {
justinzhang511e0d82014-03-24 16:09:24 -04004616 if (mService != null) {
4617 try {
Jason Monk48aacba2014-08-13 16:29:08 -04004618 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04004619 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004620 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
justinzhang511e0d82014-03-24 16:09:24 -04004621 }
4622 }
4623 }
4624
4625 /**
Jason Monkd7b86212014-06-16 13:15:38 -04004626 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04004627 *
4628 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04004629 * @hide
4630 */
Robin Lee25e26452015-06-02 09:56:29 -07004631 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
justinzhang511e0d82014-03-24 16:09:24 -04004632 if (mService != null) {
4633 try {
Jason Monk48aacba2014-08-13 16:29:08 -04004634 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04004635 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004636 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
justinzhang511e0d82014-03-24 16:09:24 -04004637 }
4638 }
4639 return null;
4640 }
4641
4642 /**
4643 * This function lets the caller know whether the given component is allowed to start the
4644 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04004645 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04004646 */
Jason Monkd7b86212014-06-16 13:15:38 -04004647 public boolean isLockTaskPermitted(String pkg) {
justinzhang511e0d82014-03-24 16:09:24 -04004648 if (mService != null) {
4649 try {
Jason Monkd7b86212014-06-16 13:15:38 -04004650 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04004651 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004652 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
justinzhang511e0d82014-03-24 16:09:24 -04004653 }
4654 }
4655 return false;
4656 }
Julia Reynoldsda551652014-05-14 17:15:16 -04004657
4658 /**
4659 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
4660 * 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 -04004661 * <p>The settings that can be updated with this method are:
4662 * <ul>
4663 * <li>{@link Settings.Global#ADB_ENABLED}</li>
4664 * <li>{@link Settings.Global#AUTO_TIME}</li>
4665 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004666 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004667 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004668 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Benjamin Franz68cc4202015-03-11 15:43:06 +00004669 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN}
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004670 * This setting is only available from {@link android.os.Build.VERSION_CODES#M} onwards
Esteban Talavera656fa7f2015-06-29 17:41:39 +01004671 * and can only be set if {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
Zoltan Szatmary-Ban4045d242015-05-27 12:42:39 +01004672 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004673 * This setting is only available from {@link android.os.Build.VERSION_CODES#M} onwards.
Zoltan Szatmary-Ban3c430952015-07-03 14:04:09 +01004674 * </li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004675 * </ul>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01004676 * <p>Changing the following settings has no effect as of
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004677 * {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01004678 * <ul>
4679 * <li>{@link Settings.Global#BLUETOOTH_ON}.
4680 * Use {@link android.bluetooth.BluetoothAdapter#enable()} and
4681 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
4682 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
4683 * <li>{@link Settings.Global#MODE_RINGER}.
4684 * Use {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
4685 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
4686 * <li>{@link Settings.Global#WIFI_ON}.
4687 * Use {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
4688 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04004689 *
4690 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4691 * @param setting The name of the setting to update.
4692 * @param value The value to update the setting to.
4693 */
Robin Lee25e26452015-06-02 09:56:29 -07004694 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Julia Reynoldsda551652014-05-14 17:15:16 -04004695 if (mService != null) {
4696 try {
4697 mService.setGlobalSetting(admin, setting, value);
4698 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004699 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Julia Reynoldsda551652014-05-14 17:15:16 -04004700 }
4701 }
4702 }
4703
4704 /**
4705 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
4706 * that the value of the setting is in the correct form for the setting type should be performed
4707 * by the caller.
Julia Reynolds82735bc2014-09-04 16:43:30 -04004708 * <p>The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004709 * <ul>
4710 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07004711 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04004712 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
4713 * </ul>
Julia Reynolds82735bc2014-09-04 16:43:30 -04004714 * <p>A device owner can additionally update the following settings:
4715 * <ul>
4716 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
4717 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04004718 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4719 * @param setting The name of the setting to update.
4720 * @param value The value to update the setting to.
4721 */
Robin Lee25e26452015-06-02 09:56:29 -07004722 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Julia Reynoldsda551652014-05-14 17:15:16 -04004723 if (mService != null) {
4724 try {
4725 mService.setSecureSetting(admin, setting, value);
4726 } catch (RemoteException e) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004727 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
Julia Reynoldsda551652014-05-14 17:15:16 -04004728 }
4729 }
4730 }
4731
Amith Yamasanif20d6402014-05-24 15:34:37 -07004732 /**
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07004733 * Designates a specific service component as the provider for
Amith Yamasanif20d6402014-05-24 15:34:37 -07004734 * making permission requests of a local or remote administrator of the user.
4735 * <p/>
4736 * Only a profile owner can designate the restrictions provider.
4737 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07004738 * @param provider The component name of the service that implements
Amith Yamasanid1d7c022014-08-19 17:03:41 -07004739 * {@link RestrictionsReceiver}. If this param is null,
Amith Yamasanif20d6402014-05-24 15:34:37 -07004740 * it removes the restrictions provider previously assigned.
4741 */
Robin Lee25e26452015-06-02 09:56:29 -07004742 public void setRestrictionsProvider(@NonNull ComponentName admin,
4743 @Nullable ComponentName provider) {
Amith Yamasanif20d6402014-05-24 15:34:37 -07004744 if (mService != null) {
4745 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07004746 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07004747 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004748 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanif20d6402014-05-24 15:34:37 -07004749 }
4750 }
4751 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04004752
4753 /**
4754 * Called by profile or device owners to set the master volume mute on or off.
4755 *
4756 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4757 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
4758 */
Robin Lee25e26452015-06-02 09:56:29 -07004759 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Julia Reynolds4a21b252014-06-04 11:11:43 -04004760 if (mService != null) {
4761 try {
4762 mService.setMasterVolumeMuted(admin, on);
4763 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004764 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Julia Reynolds4a21b252014-06-04 11:11:43 -04004765 }
4766 }
4767 }
4768
4769 /**
4770 * Called by profile or device owners to check whether the master volume mute is on or off.
4771 *
4772 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4773 * @return {@code true} if master volume is muted, {@code false} if it's not.
4774 */
Robin Lee25e26452015-06-02 09:56:29 -07004775 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Julia Reynolds4a21b252014-06-04 11:11:43 -04004776 if (mService != null) {
4777 try {
4778 return mService.isMasterVolumeMuted(admin);
4779 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004780 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Julia Reynolds4a21b252014-06-04 11:11:43 -04004781 }
4782 }
4783 return false;
4784 }
Kenny Guyc13053b2014-05-29 14:17:17 +01004785
4786 /**
4787 * Called by profile or device owners to change whether a user can uninstall
4788 * a package.
4789 *
4790 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4791 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01004792 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Kenny Guyc13053b2014-05-29 14:17:17 +01004793 */
Robin Lee25e26452015-06-02 09:56:29 -07004794 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01004795 boolean uninstallBlocked) {
Kenny Guyc13053b2014-05-29 14:17:17 +01004796 if (mService != null) {
4797 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01004798 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01004799 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004800 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Kenny Guyc13053b2014-05-29 14:17:17 +01004801 }
4802 }
4803 }
4804
4805 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004806 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00004807 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00004808 * <p>
4809 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Robin Lee25e26452015-06-02 09:56:29 -07004810 * behavior of this API is changed such that passing {@code null} as the {@code admin}
Rubin Xue1e6faa2015-03-10 10:51:59 +00004811 * parameter will return if any admin has blocked the uninstallation. Before L MR1, passing
Robin Lee25e26452015-06-02 09:56:29 -07004812 * {@code null} will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01004813 *
Robin Lee25e26452015-06-02 09:56:29 -07004814 * @param admin The name of the admin component whose blocking policy will be checked, or
4815 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01004816 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00004817 * @return true if uninstallation is blocked.
Kenny Guyc13053b2014-05-29 14:17:17 +01004818 */
Robin Lee25e26452015-06-02 09:56:29 -07004819 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Kenny Guyc13053b2014-05-29 14:17:17 +01004820 if (mService != null) {
4821 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01004822 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01004823 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004824 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Kenny Guyc13053b2014-05-29 14:17:17 +01004825 }
4826 }
4827 return false;
4828 }
Svetoslav976e8bd2014-07-16 15:12:03 -07004829
4830 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004831 * Called by the profile owner of a managed profile to enable widget providers from a
4832 * given package to be available in the parent profile. As a result the user will be able to
Svetoslav976e8bd2014-07-16 15:12:03 -07004833 * add widgets from the white-listed package running under the profile to a widget
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004834 * host which runs under the parent profile, for example the home screen. Note that
Svetoslav976e8bd2014-07-16 15:12:03 -07004835 * a package may have zero or more provider components, where each component
4836 * provides a different widget type.
4837 * <p>
4838 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07004839 *
4840 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4841 * @param packageName The package from which widget providers are white-listed.
4842 * @return Whether the package was added.
4843 *
4844 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
4845 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
4846 */
Robin Lee25e26452015-06-02 09:56:29 -07004847 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Svetoslav976e8bd2014-07-16 15:12:03 -07004848 if (mService != null) {
4849 try {
4850 return mService.addCrossProfileWidgetProvider(admin, packageName);
4851 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004852 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Svetoslav976e8bd2014-07-16 15:12:03 -07004853 }
4854 }
4855 return false;
4856 }
4857
4858 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004859 * Called by the profile owner of a managed profile to disable widget providers from a given
4860 * package to be available in the parent profile. For this method to take effect the
Svetoslav976e8bd2014-07-16 15:12:03 -07004861 * package should have been added via {@link #addCrossProfileWidgetProvider(
4862 * android.content.ComponentName, String)}.
4863 * <p>
4864 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07004865 *
4866 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4867 * @param packageName The package from which widget providers are no longer
4868 * white-listed.
4869 * @return Whether the package was removed.
4870 *
4871 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
4872 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
4873 */
Esteban Talavera62399912016-01-11 15:37:55 +00004874 public boolean removeCrossProfileWidgetProvider(
4875 @NonNull ComponentName admin, String packageName) {
Svetoslav976e8bd2014-07-16 15:12:03 -07004876 if (mService != null) {
4877 try {
4878 return mService.removeCrossProfileWidgetProvider(admin, packageName);
4879 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004880 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Svetoslav976e8bd2014-07-16 15:12:03 -07004881 }
4882 }
4883 return false;
4884 }
4885
4886 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004887 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07004888 * available in the parent profile.
4889 *
4890 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4891 * @return The white-listed package list.
4892 *
4893 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
4894 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
4895 */
Robin Lee25e26452015-06-02 09:56:29 -07004896 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Svetoslav976e8bd2014-07-16 15:12:03 -07004897 if (mService != null) {
4898 try {
4899 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
4900 if (providers != null) {
4901 return providers;
4902 }
4903 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004904 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Svetoslav976e8bd2014-07-16 15:12:03 -07004905 }
4906 }
4907 return Collections.emptyList();
4908 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05004909
4910 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004911 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05004912 *
4913 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4914 * @param icon the bitmap to set as the photo.
4915 */
Robin Lee25e26452015-06-02 09:56:29 -07004916 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05004917 try {
4918 mService.setUserIcon(admin, icon);
4919 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004920 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05004921 }
4922 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04004923
4924 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01004925 * Called by device owners to set a local system update policy. When a new policy is set,
4926 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00004927 *
Robin Lee25e26452015-06-02 09:56:29 -07004928 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
4929 * components in the device owner package can set system update policies and the
4930 * most recent policy takes
Rubin Xu5faad8e2015-04-20 17:43:48 +01004931 * effect.
Robin Lee25e26452015-06-02 09:56:29 -07004932 * @param policy the new policy, or {@code null} to clear the current policy.
Rubin Xu5faad8e2015-04-20 17:43:48 +01004933 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00004934 */
Robin Lee25e26452015-06-02 09:56:29 -07004935 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Rubin Xu8027a4f2015-03-10 17:52:37 +00004936 if (mService != null) {
4937 try {
Robin Lee25e26452015-06-02 09:56:29 -07004938 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00004939 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004940 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Rubin Xu8027a4f2015-03-10 17:52:37 +00004941 }
4942 }
4943 }
4944
4945 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01004946 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00004947 *
Robin Lee25e26452015-06-02 09:56:29 -07004948 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00004949 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01004950 public SystemUpdatePolicy getSystemUpdatePolicy() {
Rubin Xu8027a4f2015-03-10 17:52:37 +00004951 if (mService != null) {
4952 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01004953 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00004954 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004955 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Rubin Xu8027a4f2015-03-10 17:52:37 +00004956 }
4957 }
4958 return null;
4959 }
Benjamin Franze36087e2015-04-07 16:40:34 +01004960
4961 /**
4962 * Called by a device owner to disable the keyguard altogether.
4963 *
4964 * <p>Setting the keyguard to disabled has the same effect as choosing "None" as the screen
4965 * lock type. However, this call has no effect if a password, pin or pattern is currently set.
4966 * If a password, pin or pattern is set after the keyguard was disabled, the keyguard stops
4967 * being disabled.
4968 *
4969 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01004970 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01004971 *
4972 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Benjamin Franzbece8062015-05-06 12:14:31 +01004973 * place. {@code true} otherwise.
Benjamin Franze36087e2015-04-07 16:40:34 +01004974 */
Robin Lee25e26452015-06-02 09:56:29 -07004975 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franze36087e2015-04-07 16:40:34 +01004976 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01004977 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01004978 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004979 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Benjamin Franze36087e2015-04-07 16:40:34 +01004980 return false;
4981 }
4982 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00004983
4984 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01004985 * Called by device owner to disable the status bar. Disabling the status bar blocks
4986 * notifications, quick settings and other screen overlays that allow escaping from
Benjamin Franzea2ec972015-03-16 17:18:09 +00004987 * a single use device.
4988 *
4989 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01004990 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
4991 *
4992 * @return {@code false} if attempting to disable the status bar failed.
4993 * {@code true} otherwise.
Benjamin Franzea2ec972015-03-16 17:18:09 +00004994 */
Robin Lee25e26452015-06-02 09:56:29 -07004995 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzea2ec972015-03-16 17:18:09 +00004996 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01004997 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00004998 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08004999 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Benjamin Franzbece8062015-05-06 12:14:31 +01005000 return false;
Benjamin Franzea2ec972015-03-16 17:18:09 +00005001 }
5002 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005003
5004 /**
5005 * Callable by the system update service to notify device owners about pending updates.
5006 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5007 * permission.
5008 *
5009 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5010 * when the current pending update was first available. -1 if no update is available.
5011 * @hide
5012 */
5013 @SystemApi
5014 public void notifyPendingSystemUpdate(long updateReceivedTime) {
5015 if (mService != null) {
5016 try {
5017 mService.notifyPendingSystemUpdate(updateReceivedTime);
5018 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005019 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Rubin Xudc105cc2015-04-14 23:38:01 +01005020 }
5021 }
5022 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005023
5024 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005025 * Called by profile or device owners to set the default response for future runtime permission
5026 * requests by applications. The policy can allow for normal operation which prompts the
5027 * user to grant a permission, or can allow automatic granting or denying of runtime
5028 * permission requests by an application. This also applies to new permissions declared by app
Benjamin Franz45dd6662015-07-08 14:24:14 +01005029 * updates. When a permission is denied or granted this way, the effect is equivalent to setting
5030 * the permission grant state via {@link #setPermissionGrantState}.
5031 *
5032 * <p/>As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005033 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005034 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005035 * @param admin Which profile or device owner this request is associated with.
5036 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
5037 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005038 *
5039 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005040 */
Robin Lee25e26452015-06-02 09:56:29 -07005041 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005042 try {
5043 mService.setPermissionPolicy(admin, policy);
5044 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005045 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005046 }
5047 }
5048
5049 /**
5050 * Returns the current runtime permission policy set by the device or profile owner. The
5051 * default is {@link #PERMISSION_POLICY_PROMPT}.
5052 * @param admin Which profile or device owner this request is associated with.
5053 * @return the current policy for future permission requests.
5054 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005055 public int getPermissionPolicy(ComponentName admin) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005056 try {
5057 return mService.getPermissionPolicy(admin);
5058 } catch (RemoteException re) {
5059 return PERMISSION_POLICY_PROMPT;
5060 }
5061 }
5062
5063 /**
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005064 * Sets the grant state of a runtime permission for a specific application. The state
5065 * can be {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it
5066 * through the UI, {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission
5067 * is denied and the user cannot manage it through the UI, and {@link
5068 * #PERMISSION_GRANT_STATE_GRANTED granted} in which the permission is granted and the
5069 * user cannot manage it through the UI. This might affect all permissions in a
5070 * group that the runtime permission belongs to. This method can only be called
5071 * by a profile or device owner.
5072 *
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005073 * <p/>Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not
5074 * revoke the permission. It retains the previous grant, if any.
5075 *
5076 * <p/>Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005077 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005078 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005079 * @param admin Which profile or device owner this request is associated with.
5080 * @param packageName The application to grant or revoke a permission to.
5081 * @param permission The permission to grant or revoke.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005082 * @param grantState The permission grant state which is one of {@link
5083 * #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5084 * {@link #PERMISSION_GRANT_STATE_GRANTED},
5085 * @return whether the permission was successfully granted or revoked.
5086 *
5087 * @see #PERMISSION_GRANT_STATE_DENIED
5088 * @see #PERMISSION_GRANT_STATE_DEFAULT
5089 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005090 */
Robin Lee25e26452015-06-02 09:56:29 -07005091 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005092 String permission, int grantState) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005093 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005094 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005095 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005096 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005097 return false;
5098 }
5099 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005100
5101 /**
5102 * Returns the current grant state of a runtime permission for a specific application.
5103 *
5104 * @param admin Which profile or device owner this request is associated with.
5105 * @param packageName The application to check the grant state for.
5106 * @param permission The permission to check for.
5107 * @return the current grant state specified by device policy. If the profile or device owner
5108 * has not set a grant state, the return value is {@link #PERMISSION_GRANT_STATE_DEFAULT}.
5109 * This does not indicate whether or not the permission is currently granted for the package.
5110 *
5111 * <p/>If a grant state was set by the profile or device owner, then the return value will
5112 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or {@link #PERMISSION_GRANT_STATE_GRANTED},
5113 * which indicates if the permission is currently denied or granted.
5114 *
5115 * @see #setPermissionGrantState(ComponentName, String, String, int)
5116 * @see PackageManager#checkPermission(String, String)
5117 */
Robin Lee25e26452015-06-02 09:56:29 -07005118 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005119 String permission) {
5120 try {
5121 return mService.getPermissionGrantState(admin, packageName, permission);
5122 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005123 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Amith Yamasani184b3752015-05-22 13:00:51 -07005124 return PERMISSION_GRANT_STATE_DEFAULT;
5125 }
5126 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005127
5128 /**
5129 * Returns if provisioning a managed profile or device is possible or not.
5130 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5131 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
5132 * Note that even if this method returns true, there is a slight possibility that the
5133 * provisioning will not be allowed when it is actually initiated because some event has
5134 * happened in between.
5135 * @return if provisioning a managed profile or device is possible or not.
5136 * @throws IllegalArgumentException if the supplied action is not valid.
5137 */
5138 public boolean isProvisioningAllowed(String action) {
5139 try {
5140 return mService.isProvisioningAllowed(action);
5141 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005142 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005143 return false;
5144 }
5145 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005146
5147 /**
5148 * @hide
5149 * Return if this user is a managed profile of another user. An admin can become the profile
5150 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
5151 * user with {@link #ACTION_PROVISION_MANAGED_USER}.
5152 * @param admin Which profile owner this request is associated with.
5153 * @return if this user is a managed profile of another user.
5154 */
5155 public boolean isManagedProfile(@NonNull ComponentName admin) {
5156 try {
5157 return mService.isManagedProfile(admin);
5158 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005159 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005160 return false;
5161 }
5162 }
5163
5164 /**
5165 * @hide
5166 * Return if this user is a system-only user. An admin can manage a device from a system only
5167 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5168 * @param admin Which device owner this request is associated with.
5169 * @return if this user is a system-only user.
5170 */
5171 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5172 try {
5173 return mService.isSystemOnlyUser(admin);
5174 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005175 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005176 return false;
5177 }
5178 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005179
5180 /**
5181 * Called by device owner to get the MAC address of the Wi-Fi device.
5182 *
5183 * @return the MAC address of the Wi-Fi device, or null when the information is not
5184 * available. (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5185 *
5186 * <p>The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5187 */
5188 public String getWifiMacAddress() {
5189 try {
5190 return mService.getWifiMacAddress();
5191 } catch (RemoteException re) {
Makoto Onuki55c46f22015-11-25 14:56:23 -08005192 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005193 return null;
5194 }
5195 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005196
5197 /**
5198 * Called by device owner to reboot the device.
5199 */
5200 public void reboot(@NonNull ComponentName admin) {
5201 try {
5202 mService.reboot(admin);
5203 } catch (RemoteException re) {
5204 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5205 }
5206 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005207
5208 /**
5209 * Called by a device admin to set the short support message. This will
5210 * be displayed to the user in settings screens where funtionality has
5211 * been disabled by the admin.
5212 *
5213 * The message should be limited to a short statement such as
5214 * "This setting is disabled by your administrator. Contact someone@example.com
5215 * for support."
5216 * If the message is longer than 200 characters it may be truncated.
5217 *
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005218 * <p>If the short support message needs to be localized, it is the responsibility of the
5219 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5220 * and set a new version of this string accordingly.
5221 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005222 * @see #setLongSupportMessage
5223 *
5224 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5225 * @param message Short message to be displayed to the user in settings or null to
5226 * clear the existing message.
5227 */
5228 public void setShortSupportMessage(@NonNull ComponentName admin,
5229 @Nullable String message) {
5230 if (mService != null) {
5231 try {
5232 mService.setShortSupportMessage(admin, message);
5233 } catch (RemoteException e) {
5234 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5235 }
5236 }
5237 }
5238
5239 /**
5240 * Called by a device admin to get the short support message.
5241 *
5242 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5243 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)}
5244 * or null if no message has been set.
5245 */
5246 public String getShortSupportMessage(@NonNull ComponentName admin) {
5247 if (mService != null) {
5248 try {
5249 return mService.getShortSupportMessage(admin);
5250 } catch (RemoteException e) {
5251 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5252 }
5253 }
5254 return null;
5255 }
5256
5257 /**
5258 * Called by a device admin to set the long support message. This will
5259 * be displayed to the user in the device administators settings screen.
5260 *
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005261 * <p>If the long support message needs to be localized, it is the responsibility of the
5262 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5263 * and set a new version of this string accordingly.
5264 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005265 * @see #setShortSupportMessage
5266 *
5267 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5268 * @param message Long message to be displayed to the user in settings or null to
5269 * clear the existing message.
5270 */
5271 public void setLongSupportMessage(@NonNull ComponentName admin,
5272 @Nullable String message) {
5273 if (mService != null) {
5274 try {
5275 mService.setLongSupportMessage(admin, message);
5276 } catch (RemoteException e) {
5277 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5278 }
5279 }
5280 }
5281
5282 /**
5283 * Called by a device admin to get the long support message.
5284 *
5285 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5286 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)}
5287 * or null if no message has been set.
5288 */
5289 public String getLongSupportMessage(@NonNull ComponentName admin) {
5290 if (mService != null) {
5291 try {
5292 return mService.getLongSupportMessage(admin);
5293 } catch (RemoteException e) {
5294 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5295 }
5296 }
5297 return null;
5298 }
5299
5300 /**
5301 * Called by the system to get the short support message.
5302 *
5303 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5304 * @param userHandle user id the admin is running as.
5305 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)}
5306 *
5307 * @hide
5308 */
5309 public String getShortSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
5310 if (mService != null) {
5311 try {
5312 return mService.getShortSupportMessageForUser(admin, userHandle);
5313 } catch (RemoteException e) {
5314 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5315 }
5316 }
5317 return null;
5318 }
5319
5320
5321 /**
5322 * Called by the system to get the long support message.
5323 *
5324 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5325 * @param userHandle user id the admin is running as.
5326 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)}
5327 *
5328 * @hide
5329 */
5330 public String getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
5331 if (mService != null) {
5332 try {
5333 return mService.getLongSupportMessageForUser(admin, userHandle);
5334 } catch (RemoteException e) {
5335 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5336 }
5337 }
5338 return null;
5339 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005340
5341 /**
Esteban Talavera62399912016-01-11 15:37:55 +00005342 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
5343 * whose calls act on the parent profile.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005344 *
5345 * <p> Note only some methods will work on the parent Manager.
5346 *
5347 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
5348 */
5349 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
5350 try {
5351 if (!mService.isManagedProfile(admin)) {
5352 throw new SecurityException("The current user does not have a parent profile.");
5353 }
5354 return new DevicePolicyManager(mContext, true);
5355 } catch (RemoteException re) {
5356 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5357 return null;
5358 }
5359 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00005360
5361 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00005362 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
5363 * profile.
5364 *
5365 * @hide
5366 */
5367 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
5368 mContext.checkSelfPermission(
5369 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
5370 if (!uInfo.isManagedProfile()) {
5371 throw new SecurityException("The user " + uInfo.id
5372 + " does not have a parent profile.");
5373 }
5374 return new DevicePolicyManager(mContext, true);
5375 }
5376
5377 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00005378 * Called by a profile owner of a managed profile to set the color used for customization.
5379 * This color is used as background color of the confirm credentials screen for that user.
5380 * The default color is {@link android.graphics.Color#GRAY}.
5381 *
5382 * <p>The confirm credentials screen can be created using
5383 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
5384 *
5385 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5386 * @param color The 32bit representation of the color to be used.
5387 */
5388 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
5389 try {
5390 mService.setOrganizationColor(admin, color);
5391 } catch (RemoteException re) {
5392 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5393 }
5394 }
5395
5396 /**
5397 * Called by a profile owner of a managed profile to retrieve the color used for customization.
5398 * This color is used as background color of the confirm credentials screen for that user.
5399 *
5400 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5401 * @return The 32bit representation of the color to be used.
5402 */
5403 public int getOrganizationColor(@NonNull ComponentName admin) {
5404 try {
5405 return mService.getOrganizationColor(admin);
5406 } catch (RemoteException re) {
5407 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5408 return 0;
5409 }
5410 }
5411
5412 /**
5413 * @hide
5414 * Retrieve the customization color for a given user.
5415 *
5416 * @param userHandle The user id of the user we're interested in.
5417 * @return The 32bit representation of the color to be used.
5418 */
5419 public int getOrganizationColorForUser(int userHandle) {
5420 try {
5421 return mService.getOrganizationColorForUser(userHandle);
5422 } catch (RemoteException re) {
5423 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);
5424 return 0;
5425 }
5426 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01005427
5428 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005429 * Called by a profile owner of a managed profile to set the name of the organization under
5430 * management.
5431 *
5432 * <p>If the organization name needs to be localized, it is the responsibility of the
5433 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5434 * and set a new version of this string accordingly.
5435 *
5436 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5437 * @param title The organization name or {@code null} to clear a previously set name.
5438 */
5439 public void setOrganizationName(@NonNull ComponentName admin, @Nullable String title) {
5440 try {
5441 mService.setOrganizationName(admin, title);
5442 } catch (RemoteException re) {
5443 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE);
5444 }
5445 }
5446
5447 /**
5448 * Called by a profile owner of a managed profile to retrieve the name of the organization
5449 * under management.
5450 *
5451 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5452 * @return The organization name or {@code null} if none is set.
5453 */
5454 public String getOrganizationName(@NonNull ComponentName admin) {
5455 try {
5456 return mService.getOrganizationName(admin);
5457 } catch (RemoteException re) {
5458 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE);
5459 return null;
5460 }
5461 }
5462
5463 /**
5464 * Retrieve the default title message used in the confirm credentials screen for a given user.
5465 *
5466 * @param userHandle The user id of the user we're interested in.
5467 * @return The organization name or {@code null} if none is set.
5468 *
5469 * @hide
5470 */
5471 public String getOrganizationNameForUser(int userHandle) {
5472 try {
5473 return mService.getOrganizationNameForUser(userHandle);
5474 } catch (RemoteException re) {
5475 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE);
5476 return null;
5477 }
5478 }
5479
5480 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00005481 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
5482 * return {@link #STATE_USER_UNMANAGED}
5483 * @hide
5484 */
5485 @UserProvisioningState
5486 public int getUserProvisioningState() {
5487 if (mService != null) {
5488 try {
5489 return mService.getUserProvisioningState();
5490 } catch (RemoteException e) {
5491 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5492 }
5493 }
5494 return STATE_USER_UNMANAGED;
5495 }
5496
5497 /**
5498 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
5499 *
5500 * @param state to store
5501 * @param userHandle for user
5502 * @hide
5503 */
5504 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
5505 if (mService != null) {
5506 try {
5507 mService.setUserProvisioningState(state, userHandle);
5508 } catch (RemoteException e) {
5509 Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);
5510 }
5511 }
5512 }
5513
5514 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01005515 * @hide
5516 * Indicates the entity that controls the device or profile owner. A user/profile is considered
5517 * affiliated if it is managed by the same entity as the device.
5518 *
5519 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
5520 * user/profile is considered affiliated if the following conditions are both met:
5521 * <ul>
5522 * <li>The device owner and the user's/profile's profile owner have called this method,
5523 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
5524 * and a profile owner intersect, they must have come from the same source, which means that
5525 * the device owner and profile owner are controlled by the same entity.</li>
5526 * <li>The device owner's and profile owner's package names are the same.</li>
5527 * </ul>
5528 *
5529 * @param admin Which profile or device owner this request is associated with.
5530 * @param ids A set of opaque affiliation ids.
5531 */
5532 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
5533 try {
5534 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
5535 } catch (RemoteException e) {
5536 Log.w(TAG, "Failed talking with device policy service", e);
5537 }
5538 }
5539
5540 /**
5541 * @hide
5542 * Returns whether this user/profile is affiliated with the device. See
5543 * {@link #setAffiliationIds} for the definition of affiliation.
5544 *
5545 * @return whether this user/profile is affiliated with the device.
5546 */
5547 public boolean isAffiliatedUser() {
5548 try {
5549 return mService != null && mService.isAffiliatedUser();
5550 } catch (RemoteException e) {
5551 Log.w(TAG, "Failed talking with device policy service", e);
5552 return false;
5553 }
5554 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08005555}