blob: 692c7fdc520a82a2ba4c8b5941e380eb8a901897 [file] [log] [blame]
Dianne Hackbornd6847842010-01-12 18:14:19 -08001/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Dianne Hackborn87bba1e2010-02-26 17:25:54 -080017package android.app.admin;
Dianne Hackbornd6847842010-01-12 18:14:19 -080018
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000019import android.annotation.ColorInt;
Alan Treadwayafad8782016-01-19 15:15:08 +000020import android.annotation.IntDef;
Robin Lee25e26452015-06-02 09:56:29 -070021import android.annotation.NonNull;
22import android.annotation.Nullable;
Dianne Hackbornd6847842010-01-12 18:14:19 -080023import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
Justin Moreyb5deda72014-07-24 10:53:40 -050025import android.annotation.SystemApi;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000026import android.annotation.UserIdInt;
Fyodor Kupolov4e9af062016-07-18 16:59:11 -070027import android.annotation.WorkerThread;
Jason Monkd7b86212014-06-16 13:15:38 -040028import android.app.Activity;
Michal Karpinski6235a942016-03-15 12:07:23 +000029import android.app.admin.SecurityLog.SecurityEvent;
Dianne Hackbornd6847842010-01-12 18:14:19 -080030import android.content.ComponentName;
31import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010032import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000033import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080034import android.content.pm.PackageManager;
Victor Changcd14c0a2016-03-16 19:10:15 +000035import android.content.pm.PackageManager.NameNotFoundException;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000036import android.content.pm.ParceledListSlice;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000037import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050038import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040039import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000040import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010041import android.os.Bundle;
Jim Millere303bf42014-08-26 17:12:29 -070042import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000043import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080044import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080045import android.os.RemoteException;
46import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070047import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040048import android.os.UserManager;
Jeff Sharkey49ca5292016-05-10 12:54:45 -060049import android.os.ServiceManager.ServiceNotFoundException;
Ricky Wai494b95d2015-11-20 16:07:15 +000050import android.provider.ContactsContract.Directory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000051import android.provider.Settings;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010052import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070053import android.service.restrictions.RestrictionsReceiver;
Mahaver Chopra1216ae52016-03-11 15:39:48 +000054import android.telephony.TelephonyManager;
Dianne Hackbornd6847842010-01-12 18:14:19 -080055import android.util.Log;
56
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070057import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040058import com.android.org.conscrypt.TrustedCertificateStore;
59
60import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080061import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000062import java.lang.annotation.Retention;
63import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070064import java.net.InetSocketAddress;
65import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010066import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000067import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010068import java.security.PrivateKey;
69import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040070import java.security.cert.CertificateException;
71import java.security.cert.CertificateFactory;
72import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010073import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000074import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070075import java.util.ArrayList;
Rubin Xub4365912016-03-23 12:13:22 +000076import java.util.Arrays;
Svetoslav976e8bd2014-07-16 15:12:03 -070077import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080078import java.util.List;
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +010079import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080080
81/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000082 * Public interface for managing policies enforced on a device. Most clients of this class must be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070083 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
84 * administrator</a>. Additionally, a device administrator may be registered as either a profile or
85 * device owner. A given method is accessible to all device administrators unless the documentation
86 * for that method specifies that it is restricted to either device or profile owners. Any
87 * application calling an api may only pass as an argument a device administrator component it
88 * owns. Otherwise, a {@link SecurityException} will be thrown.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080089 * <div class="special reference">
90 * <h3>Developer Guides</h3>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070091 * <p>
92 * For more information about managing policies for device administration, read the <a href=
93 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
94 * guide. </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080095 */
96public class DevicePolicyManager {
97 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -080098
99 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -0800100 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +0000101 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700102
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600103 /** @hide */
104 public DevicePolicyManager(Context context, IDevicePolicyManager service) {
105 this(context, service, false);
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
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600110 protected DevicePolicyManager(Context context, IDevicePolicyManager service,
111 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
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700117 /** @hide test will override it. */
118 @VisibleForTesting
119 protected int myUserId() {
120 return UserHandle.myUserId();
121 }
122
Dianne Hackbornd6847842010-01-12 18:14:19 -0800123 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000124 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000125 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100126 * <p>A managed profile allows data separation for example for the usage of a
127 * device as a personal and corporate device. The user which provisioning is started from and
128 * the managed profile share a launcher.
129 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800130 * <p>This intent will typically be sent by a mobile device management application (MDM).
131 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
132 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100133 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000134 * <p>It is possible to check if provisioning is allowed or not by querying the method
135 * {@link #isProvisioningAllowed(String)}.
136 *
137 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000138 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700139 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000140 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
141 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000142 *
Benjamin Franzea956242016-03-21 15:45:56 +0000143 * <p>The intent may also contain the following extras:
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000144 * <ul>
Benjamin Franzea956242016-03-21 15:45:56 +0000145 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
146 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
147 * {@link android.os.Build.VERSION_CODES#N}</li>
148 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
149 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
150 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000151 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000152 *
Benjamin Franzea956242016-03-21 15:45:56 +0000153 * <p>When managed provisioning has completed, broadcasts are sent to the application specified
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000154 * in the provisioning intent. The
155 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
156 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
157 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100158 *
Benjamin Franzea956242016-03-21 15:45:56 +0000159 * <p>If provisioning fails, the managedProfile is removed so the device returns to its
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100160 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100161 *
162 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
163 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
164 * the provisioning flow was successful, although this doesn't guarantee the full flow will
165 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
166 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000167 */
168 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
169 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100170 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000171
172 /**
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000173 * Activity action: Starts the provisioning flow which sets up a managed user.
174 *
175 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800176 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000177 * owner who has full control over the user. Provisioning can only happen before user setup has
178 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
179 * allowed.
180 *
Benjamin Franzea956242016-03-21 15:45:56 +0000181 * <p>The intent contains the following extras:
182 * <ul>
183 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
184 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
185 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
186 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
187 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
188 * </ul>
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000189 *
Benjamin Franzea956242016-03-21 15:45:56 +0000190 * <p>If provisioning fails, the device returns to its previous state.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000191 *
192 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
193 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
194 * the provisioning flow was successful, although this doesn't guarantee the full flow will
195 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
196 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Benjamin Franzea956242016-03-21 15:45:56 +0000197 *
198 * @hide
Mahaver Chopra5e732562015-11-05 11:55:12 +0000199 */
200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
201 public static final String ACTION_PROVISION_MANAGED_USER
202 = "android.app.action.PROVISION_MANAGED_USER";
203
204 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100205 * Activity action: Starts the provisioning flow which sets up a managed device.
206 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
207 *
208 * <p> During device owner provisioning a device admin app is set as the owner of the device.
209 * A device owner has full control over the device. The device owner can not be modified by the
210 * user.
211 *
212 * <p> A typical use case would be a device that is owned by a company, but used by either an
213 * employee or client.
214 *
215 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000216 * It is possible to check if provisioning is allowed or not by querying the method
217 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100218 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000219 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100220 * <ul>
221 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
222 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
223 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100224 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000225 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000226 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100227 * </ul>
228 *
Benjamin Franzea956242016-03-21 15:45:56 +0000229 * <p>When device owner provisioning has completed, an intent of the type
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100230 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
231 * device owner.
232 *
Benjamin Franzea956242016-03-21 15:45:56 +0000233 * <p>If provisioning fails, the device is factory reset.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100234 *
Alan Treadway4582f812015-07-28 11:49:35 +0100235 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
236 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
237 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
238 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100239 */
240 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
241 public static final String ACTION_PROVISION_MANAGED_DEVICE
242 = "android.app.action.PROVISION_MANAGED_DEVICE";
243
244 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000245 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000246 *
247 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
248 * the device. A device owner has full control over the device. The device owner can not be
249 * modified by the user and the only way of resetting the device is via factory reset.
250 *
251 * <p>A typical use case would be a device that is owned by a company, but used by either an
252 * employee or client.
253 *
254 * <p>The provisioning message should be sent to an unprovisioned device.
255 *
256 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
257 * by a privileged app with the permission
258 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
259 *
260 * <p>The provisioning intent contains the following properties:
261 * <ul>
262 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
263 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
264 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
265 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
266 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
267 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
268 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
269 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
270 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
271 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
272 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
273 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
274 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
275 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
276 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
277 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
278 *
279 * @hide
280 */
281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
282 @SystemApi
283 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
284 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
285
286 /**
287 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000288 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
289 *
290 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
291 * management state that is distinct from that reached by
292 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
293 * user, and only has control over device-wide policies, not individual users and their data.
294 * The primary benefit is that multiple non-system users are supported when provisioning using
295 * this form of device management.
296 *
Benjamin Franzea956242016-03-21 15:45:56 +0000297 * <p>During device owner provisioning a device admin app is set as the owner of the device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000298 * A device owner has full control over the device. The device owner can not be modified by the
299 * user.
300 *
Benjamin Franzea956242016-03-21 15:45:56 +0000301 * <p>A typical use case would be a device that is owned by a company, but used by either an
Alan Treadway46dd4492015-11-09 13:57:19 +0000302 * employee or client.
303 *
Benjamin Franzea956242016-03-21 15:45:56 +0000304 * <p>An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000305 * It is possible to check if provisioning is allowed or not by querying the method
306 * {@link #isProvisioningAllowed(String)}.
307 *
308 * <p>The intent contains the following extras:
309 * <ul>
310 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
311 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
312 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
313 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Benjamin Franzea956242016-03-21 15:45:56 +0000314 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
315 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Alan Treadway46dd4492015-11-09 13:57:19 +0000316 * </ul>
317 *
Benjamin Franzea956242016-03-21 15:45:56 +0000318 * <p>When device owner provisioning has completed, an intent of the type
Alan Treadway46dd4492015-11-09 13:57:19 +0000319 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
320 * device owner.
321 *
Benjamin Franzea956242016-03-21 15:45:56 +0000322 * <p>If provisioning fails, the device is factory reset.
Alan Treadway46dd4492015-11-09 13:57:19 +0000323 *
324 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
325 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
326 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
327 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
328 *
329 * @hide
330 */
331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
332 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
333 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
334
335 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000336 * Activity action: Finalizes management provisioning, should be used after user-setup
337 * has been completed and {@link #getUserProvisioningState()} returns one of:
338 * <ul>
339 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
340 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
341 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
342 * </ul>
343 *
344 * @hide
345 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000346 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000347 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
348 public static final String ACTION_PROVISION_FINALIZATION
349 = "android.app.action.PROVISION_FINALIZATION";
350
351 /**
Michal Karpinskiba244092016-02-25 17:28:24 +0000352 * Action: Bugreport sharing with device owner has been accepted by the user.
353 *
354 * @hide
355 */
356 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
357 "com.android.server.action.BUGREPORT_SHARING_ACCEPTED";
358
359 /**
360 * Action: Bugreport sharing with device owner has been declined by the user.
361 *
362 * @hide
363 */
364 public static final String ACTION_BUGREPORT_SHARING_DECLINED =
365 "com.android.server.action.BUGREPORT_SHARING_DECLINED";
366
367 /**
368 * Action: Bugreport has been collected and is dispatched to {@link DevicePolicyManagerService}.
369 *
370 * @hide
371 */
372 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
373 "android.intent.action.REMOTE_BUGREPORT_DISPATCH";
374
375 /**
376 * Extra for shared bugreport's SHA-256 hash.
377 *
378 * @hide
379 */
380 public static final String EXTRA_REMOTE_BUGREPORT_HASH =
381 "android.intent.extra.REMOTE_BUGREPORT_HASH";
382
383 /**
384 * Extra for remote bugreport notification shown type.
385 *
386 * @hide
387 */
388 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
389 "android.app.extra.bugreport_notification_type";
390
391 /**
392 * Notification type for a started remote bugreport flow.
393 *
394 * @hide
395 */
396 public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
397
398 /**
399 * Notification type for a bugreport that has already been accepted to be shared, but is still
400 * being taken.
401 *
402 * @hide
403 */
404 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
405
406 /**
407 * Notification type for a bugreport that has been taken and can be shared or declined.
408 *
409 * @hide
410 */
411 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
412
413 /**
Michal Karpinski8f010dd2016-06-21 15:05:53 +0100414 * Default and maximum timeout in milliseconds after which unlocking with weak auth times out,
415 * i.e. the user has to use a strong authentication method like password, PIN or pattern.
416 *
417 * @hide
418 */
419 public static final long DEFAULT_STRONG_AUTH_TIMEOUT_MS = 72 * 60 * 60 * 1000; // 72h
420
421 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100422 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100423 * allows a mobile device management application or NFC programmer application which starts
424 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100425 * <p>
426 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
427 * sends the intent to pass data to itself on the newly created profile.
428 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
429 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100430 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
431 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
432 * message should contain a stringified {@link java.util.Properties} instance, whose string
433 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
434 * management application after provisioning.
435 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100436 * <p>
437 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700438 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
439 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100440 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100441 */
442 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100443 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100444
445 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100446 * A String extra holding the package name of the mobile device management application that
447 * will be set as the profile owner or device owner.
448 *
449 * <p>If an application starts provisioning directly via an intent with action
450 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
451 * application that started provisioning. The package will be set as profile owner in that case.
452 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000453 * <p>This package is set as device owner when device owner provisioning is started by an NFC
454 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000455 *
456 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700457 * This receiver will be set as the profile or device owner and active admin.
Benjamin Franzea956242016-03-21 15:45:56 +0000458 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000459 * @see DeviceAdminReceiver
460 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100461 * supported, but only if there is only one device admin receiver in the package that requires
462 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000463 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000464 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000465 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100466 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000467
468 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000469 * A ComponentName extra indicating the device admin receiver of the mobile device management
470 * application that will be set as the profile owner or device owner and active admin.
471 *
472 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100473 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
474 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
475 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000476 *
477 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100478 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
479 * message containing an NFC record with MIME type
Benjamin Franzea956242016-03-21 15:45:56 +0000480 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000481 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000482 *
483 * @see DeviceAdminReceiver
484 */
485 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
486 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
487
488 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000489 * An {@link android.accounts.Account} extra holding the account to migrate during managed
490 * profile provisioning. If the account supplied is present in the primary user, it will be
491 * copied, along with its credentials to the managed profile and removed from the primary user.
492 *
493 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
494 */
495
496 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
497 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
498
499 /**
Jessica Hummele3da7902014-08-20 15:20:11 +0100500 * A String extra that, holds the email address of the account which a managed profile is
501 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
502 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100503 *
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100504 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
505 *
Jessica Hummele3da7902014-08-20 15:20:11 +0100506 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
507 * contains this extra, it is forwarded in the
508 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
509 * device management application that was set as the profile owner during provisioning.
510 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100511 */
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100512 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
513 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100514
515 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000516 * A integer extra indicating the predominant color to show during the provisioning.
517 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000518 *
519 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
520 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
521 */
522 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
523 "android.app.extra.PROVISIONING_MAIN_COLOR";
524
525 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000526 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700527 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000528 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100529 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
530 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000531 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000532 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
533 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000534
535 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100536 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
537 * will be set to.
538 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000539 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
540 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100541 */
542 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100543 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100544
545 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100546 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
547 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100548 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000549 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
550 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100551 */
552 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100553 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100554
555 /**
556 * A String extra holding the {@link java.util.Locale} that the device will be set to.
557 * Format: xx_yy, where xx is the language code, and yy the country code.
558 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000559 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
560 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100561 */
562 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100563 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100564
565 /**
566 * A String extra holding the ssid of the wifi network that should be used during nfc device
567 * owner provisioning for downloading the mobile device management application.
568 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000569 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
570 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100571 */
572 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100573 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100574
575 /**
576 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
577 * is hidden or not.
578 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000579 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
580 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100581 */
582 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100583 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100584
585 /**
586 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100587 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
588 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100589 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000590 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
591 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100592 */
593 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100594 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100595
596 /**
597 * A String extra holding the password of the wifi network in
598 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
599 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000600 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
601 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100602 */
603 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100604 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100605
606 /**
607 * A String extra holding the proxy host for the wifi network in
608 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
609 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000610 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
611 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100612 */
613 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100614 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100615
616 /**
617 * An int extra holding the proxy port for the wifi network in
618 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
619 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000620 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
621 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100622 */
623 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100624 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100625
626 /**
627 * A String extra holding the proxy bypass for the wifi network in
628 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
629 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000630 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
631 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100632 */
633 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100634 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100635
636 /**
637 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
638 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
639 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000640 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
641 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100642 */
643 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100644 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100645
646 /**
647 * A String extra holding a url that specifies the download location of the device admin
648 * package. When not provided it is assumed that the device admin package is already installed.
649 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000650 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
651 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100652 */
653 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100654 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100655
656 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400657 * An int extra holding a minimum required version code for the device admin package. If the
658 * device admin is already installed on the device, it will only be re-downloaded from
659 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
660 * installed package is less than this version code.
661 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400662 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400663 * provisioning via an NFC bump.
664 */
665 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
666 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
667
668 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100669 * A String extra holding a http cookie header which should be used in the http request to the
670 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
671 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000672 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
673 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100674 */
675 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100676 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100677
678 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100679 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
680 * the file at download location specified in
681 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100682 *
Benjamin Franzea956242016-03-21 15:45:56 +0000683 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
684 * present. The provided checksum must match the checksum of the file at the download
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100685 * location. If the checksum doesn't match an error will be shown to the user and the user will
686 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100687 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000688 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
689 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100690 *
691 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
692 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700693 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100694 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100695 */
696 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100697 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100698
699 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100700 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100701 * android package archive at the download location specified in {@link
702 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
703 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100704 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100705 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
706 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
707 *
Benjamin Franzea956242016-03-21 15:45:56 +0000708 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
709 * present. The provided checksum must match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100710 * the download location. If the checksum does not match an error will be shown to the user and
711 * the user will be asked to factory reset the device.
712 *
713 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
714 * provisioning via an NFC bump.
715 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100716 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
717 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100718
719 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000720 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
721 * has completed successfully.
722 *
723 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700724 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000725 *
Ying Wang7f38aab2015-02-20 11:50:09 -0800726 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000727 * corresponds to the account requested to be migrated at provisioning time, if any.
728 */
729 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
730 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
731 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
732
733 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000734 * A boolean extra indicating whether device encryption can be skipped as part of device owner
735 * or managed profile provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500736 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400737 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100738 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Benjamin Franzea956242016-03-21 15:45:56 +0000739 *
740 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
741 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500742 */
743 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
744 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
745
746 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000747 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
748 * provisioning. If this extra is not passed, a default image will be shown.
749 * <h5>The following URI schemes are accepted:</h5>
750 * <ul>
751 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
752 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
753 * </ul>
754 *
755 * <p> It is the responsability of the caller to provide an image with a reasonable
756 * pixed density for the device.
757 *
758 * <p> If a content: URI is passed, the intent should have the flag
759 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
760 * {@link android.content.ClipData} of the intent too.
761 *
762 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
763 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
764 */
765 public static final String EXTRA_PROVISIONING_LOGO_URI =
766 "android.app.extra.PROVISIONING_LOGO_URI";
767
768 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000769 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
770 * during setup-wizard.
771 *
772 * <p>If unspecified, defaults to {@code true} to match the behavior in
773 * {@link android.os.Build.VERSION_CODES#M} and earlier.
774 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000775 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
776 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000777 *
778 * @hide
779 */
780 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
781 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
782
783 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000784 * This MIME type is used for starting the device owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100785 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400786 * <p>During device owner provisioning a device admin app is set as the owner of the device.
787 * A device owner has full control over the device. The device owner can not be modified by the
788 * user and the only way of resetting the device is if the device owner app calls a factory
789 * reset.
790 *
791 * <p> A typical use case would be a device that is owned by a company, but used by either an
792 * employee or client.
793 *
Benjamin Franzea956242016-03-21 15:45:56 +0000794 * <p> The NFC message must be sent to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100795 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000796 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100797 * contains the following properties:
798 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400799 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
800 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100801 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400802 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100803 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
804 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
805 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
806 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
807 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
808 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
809 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
810 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
811 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
812 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100813 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
814 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
815 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100816 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000817 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700818 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400819 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
820 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
821 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400822 */
823 public static final String MIME_TYPE_PROVISIONING_NFC
824 = "application/com.android.managedprovisioning";
825
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100826 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800827 * Activity action: ask the user to add a new device administrator to the system.
828 * The desired policy is the ComponentName of the policy in the
829 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
830 * bring the user through adding the device administrator to the system (or
831 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700832 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800833 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
834 * field to provide the user with additional explanation (in addition
835 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800836 *
837 * <p>If your administrator is already active, this will ordinarily return immediately (without
838 * user intervention). However, if your administrator has been updated and is requesting
839 * additional uses-policy flags, the user will be presented with the new list. New policies
840 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800841 */
842 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
843 public static final String ACTION_ADD_DEVICE_ADMIN
844 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700845
Dianne Hackbornd6847842010-01-12 18:14:19 -0800846 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700847 * @hide
848 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -0700849 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700850 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700851 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
852 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700853 * to remotely control restrictions on the user.
854 *
Makoto Onukic8a5a552015-11-19 14:29:12 -0800855 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700856 * result of whether or not the user approved the action. If approved, the result will
857 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
858 * as a profile owner.
859 *
860 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
861 * field to provide the user with additional explanation (in addition
862 * to your component's description) about what is being added.
863 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700864 * <p>If there is already a profile owner active or the caller is not a system app, the
865 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700866 */
867 @SystemApi
868 public static final String ACTION_SET_PROFILE_OWNER
869 = "android.app.action.SET_PROFILE_OWNER";
870
871 /**
872 * @hide
873 * Name of the profile owner admin that controls the user.
874 */
875 @SystemApi
876 public static final String EXTRA_PROFILE_OWNER_NAME
877 = "android.app.extra.PROFILE_OWNER_NAME";
878
879 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100880 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -0700881 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700882 *
Jim Miller284b62e2010-06-08 14:27:42 -0700883 * @hide
884 */
885 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
886 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
887
888 /**
Tony Mak1970f972016-08-30 17:41:48 +0100889 * Broadcast action: sent when the device owner is set, changed or cleared.
Nicolas Prevot00799002015-07-27 18:15:20 +0100890 *
891 * This broadcast is sent only to the primary user.
892 * @see #ACTION_PROVISION_MANAGED_DEVICE
893 */
894 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
895 public static final String ACTION_DEVICE_OWNER_CHANGED
896 = "android.app.action.DEVICE_OWNER_CHANGED";
897
898 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800899 * The ComponentName of the administrator component.
900 *
901 * @see #ACTION_ADD_DEVICE_ADMIN
902 */
903 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700904
Dianne Hackbornd6847842010-01-12 18:14:19 -0800905 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800906 * An optional CharSequence providing additional explanation for why the
907 * admin is being added.
908 *
909 * @see #ACTION_ADD_DEVICE_ADMIN
910 */
911 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700912
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800913 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700914 * Activity action: have the user enter a new password. This activity should
915 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
916 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
917 * enter a new password that meets the current requirements. You can use
918 * {@link #isActivePasswordSufficient()} to determine whether you need to
919 * have the user select a new password in order to meet the current
920 * constraints. Upon being resumed from this activity, you can check the new
921 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +0000922 *
923 * If the intent is launched from within a managed profile with a profile
924 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
925 * this will trigger entering a new password for the parent of the profile.
926 * For all other cases it will trigger entering a new password for the user
927 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +0000928 *
929 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -0800930 */
931 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
932 public static final String ACTION_SET_NEW_PASSWORD
933 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700934
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000935 /**
Benjamin Franzc9921092016-01-08 17:17:44 +0000936 * Activity action: have the user enter a new password for the parent profile.
937 * If the intent is launched from within a managed profile, this will trigger
938 * entering a new password for the parent of the profile. In all other cases
939 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
940 */
941 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
942 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
943 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
944
945 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000946 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
947 * the parent profile to access intents sent from the managed profile.
948 * That is, when an app in the managed profile calls
949 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
950 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000951 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100952 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000953
954 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000955 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
956 * the managed profile to access intents sent from the parent profile.
957 * That is, when an app in the parent profile calls
958 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
959 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000960 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100961 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700962
Dianne Hackbornd6847842010-01-12 18:14:19 -0800963 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +0100964 * Broadcast action: notify that a new local system update policy has been set by the device
965 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +0000966 */
967 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +0100968 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
969 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +0000970
Amith Yamasanid49489b2015-04-28 14:00:26 -0700971 /**
972 * Permission policy to prompt user for new permission requests for runtime permissions.
973 * Already granted or denied permissions are not affected by this.
974 */
975 public static final int PERMISSION_POLICY_PROMPT = 0;
976
977 /**
978 * Permission policy to always grant new permission requests for runtime permissions.
979 * Already granted or denied permissions are not affected by this.
980 */
981 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
982
983 /**
984 * Permission policy to always deny new permission requests for runtime permissions.
985 * Already granted or denied permissions are not affected by this.
986 */
987 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
988
Svet Ganovd8ecc5a2015-05-20 10:45:43 -0700989 /**
990 * Runtime permission state: The user can manage the permission
991 * through the UI.
992 */
993 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
994
995 /**
996 * Runtime permission state: The permission is granted to the app
997 * and the user cannot manage the permission through the UI.
998 */
999 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
1000
1001 /**
1002 * Runtime permission state: The permission is denied to the app
1003 * and the user cannot manage the permission through the UI.
1004 */
1005 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +00001006
1007 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00001008 * No management for current user in-effect. This is the default.
1009 * @hide
1010 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001011 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001012 public static final int STATE_USER_UNMANAGED = 0;
1013
1014 /**
1015 * Management partially setup, user setup needs to be completed.
1016 * @hide
1017 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001018 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001019 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1020
1021 /**
1022 * Management partially setup, user setup completed.
1023 * @hide
1024 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001025 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001026 public static final int STATE_USER_SETUP_COMPLETE = 2;
1027
1028 /**
1029 * Management setup and active on current user.
1030 * @hide
1031 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001032 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001033 public static final int STATE_USER_SETUP_FINALIZED = 3;
1034
1035 /**
1036 * Management partially setup on a managed profile.
1037 * @hide
1038 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001039 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001040 public static final int STATE_USER_PROFILE_COMPLETE = 4;
1041
1042 /**
1043 * @hide
1044 */
1045 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
1046 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
1047 @Retention(RetentionPolicy.SOURCE)
1048 public @interface UserProvisioningState {}
1049
1050 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001051 * Return true if the given administrator component is currently active (enabled) in the system.
1052 *
1053 * @param admin The administrator component to check for.
1054 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1055 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001056 */
Robin Lee25e26452015-06-02 09:56:29 -07001057 public boolean isAdminActive(@NonNull ComponentName admin) {
Charles He8c760562016-10-25 16:36:53 +01001058 throwIfParentInstance("isAdminActive");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001059 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001060 }
1061
1062 /**
1063 * @see #isAdminActive(ComponentName)
1064 * @hide
1065 */
Robin Lee25e26452015-06-02 09:56:29 -07001066 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001067 if (mService != null) {
1068 try {
Robin Lee25e26452015-06-02 09:56:29 -07001069 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001070 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001071 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001072 }
1073 }
1074 return false;
1075 }
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001076 /**
1077 * Return true if the given administrator component is currently being removed
1078 * for the user.
1079 * @hide
1080 */
Robin Lee25e26452015-06-02 09:56:29 -07001081 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001082 if (mService != null) {
1083 try {
Robin Lee25e26452015-06-02 09:56:29 -07001084 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001085 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001086 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001087 }
1088 }
1089 return false;
1090 }
1091
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001092
Dianne Hackbornd6847842010-01-12 18:14:19 -08001093 /**
Robin Lee25e26452015-06-02 09:56:29 -07001094 * Return a list of all currently active device administrators' component
1095 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001096 * returned.
1097 */
1098 public List<ComponentName> getActiveAdmins() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001099 throwIfParentInstance("getActiveAdmins");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001100 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001101 }
1102
1103 /**
1104 * @see #getActiveAdmins()
1105 * @hide
1106 */
1107 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001108 if (mService != null) {
1109 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001110 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001111 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001112 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001113 }
1114 }
1115 return null;
1116 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001117
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001118 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001119 * Used by package administration code to determine if a package can be stopped
1120 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001121 * @hide
1122 */
1123 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001124 return packageHasActiveAdmins(packageName, myUserId());
1125 }
1126
1127 /**
1128 * Used by package administration code to determine if a package can be stopped
1129 * or uninstalled.
1130 * @hide
1131 */
1132 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001133 if (mService != null) {
1134 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001135 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001136 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001137 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001138 }
1139 }
1140 return false;
1141 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001142
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001143 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001144 * Remove a current administration component. This can only be called
1145 * by the application that owns the administration component; if you
1146 * try to remove someone else's component, a security exception will be
1147 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001148 *
1149 * <p>Note that the operation is not synchronous and the admin might still be active (as
1150 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001151 *
1152 * @param admin The administration compononent to remove.
1153 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001154 */
Robin Lee25e26452015-06-02 09:56:29 -07001155 public void removeActiveAdmin(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001156 throwIfParentInstance("removeActiveAdmin");
Dianne Hackbornd6847842010-01-12 18:14:19 -08001157 if (mService != null) {
1158 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001159 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001160 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001161 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001162 }
1163 }
1164 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001165
Dianne Hackbornd6847842010-01-12 18:14:19 -08001166 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001167 * Returns true if an administrator has been granted a particular device policy. This can be
1168 * used to check whether the administrator was activated under an earlier set of policies, but
1169 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001170 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001171 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1172 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001173 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001174 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001175 */
Robin Lee25e26452015-06-02 09:56:29 -07001176 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001177 throwIfParentInstance("hasGrantedPolicy");
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001178 if (mService != null) {
1179 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001180 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001181 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001182 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001183 }
1184 }
1185 return false;
1186 }
1187
1188 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001189 * Returns true if the Profile Challenge is available to use for the given profile user.
1190 *
1191 * @hide
1192 */
1193 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1194 if (mService != null) {
1195 try {
1196 return mService.isSeparateProfileChallengeAllowed(userHandle);
1197 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001198 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001199 }
1200 }
1201 return false;
1202 }
1203
1204 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001205 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1206 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001207 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001208 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001209 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001210
Dianne Hackbornd6847842010-01-12 18:14:19 -08001211 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001212 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1213 * recognition technology. This implies technologies that can recognize the identity of
1214 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1215 * Note that quality constants are ordered so that higher values are more restrictive.
1216 */
1217 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1218
1219 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001220 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001221 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001222 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001223 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001224 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001225
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001226 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001227 * Constant for {@link #setPasswordQuality}: the user must have entered a
1228 * password containing at least numeric characters. Note that quality
1229 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001230 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001231 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001232
Dianne Hackbornd6847842010-01-12 18:14:19 -08001233 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001234 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001235 * password containing at least numeric characters with no repeating (4444)
1236 * or ordered (1234, 4321, 2468) sequences. Note that quality
1237 * constants are ordered so that higher values are more restrictive.
1238 */
1239 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1240
1241 /**
1242 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001243 * password containing at least alphabetic (or other symbol) characters.
1244 * Note that quality constants are ordered so that higher values are more
1245 * restrictive.
1246 */
1247 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001248
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001249 /**
1250 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001251 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001252 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001253 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001254 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001255 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001256
Dianne Hackbornd6847842010-01-12 18:14:19 -08001257 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001258 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001259 * password containing at least a letter, a numerical digit and a special
1260 * symbol, by default. With this password quality, passwords can be
1261 * restricted to contain various sets of characters, like at least an
1262 * uppercase letter, etc. These are specified using various methods,
1263 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1264 * that quality constants are ordered so that higher values are more
1265 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001266 */
1267 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1268
1269 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001270 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1271 * modify password. In case this password quality is set, the password is
1272 * managed by a profile owner. The profile owner can set any password,
1273 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1274 * that quality constants are ordered so that higher values are more
1275 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1276 * the highest.
1277 * @hide
1278 */
1279 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1280
1281 /**
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001282 * @hide
1283 *
1284 * adb shell dpm set-{device,profile}-owner will normally not allow installing an owner to
1285 * a user with accounts. {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED}
1286 * and {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} are the account features
1287 * used by authenticator to exempt their accounts from this:
1288 *
1289 * <ul>
1290 * <li>Non-test-only DO/PO still can't be installed when there are accounts.
1291 * <p>In order to make an apk test-only, add android:testOnly="true" to the
1292 * &lt;application&gt; tag in the manifest.
1293 *
1294 * <li>Test-only DO/PO can be installed even when there are accounts, as long as all the
1295 * accounts have the {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} feature.
1296 * Some authenticators claim to have any features, so to detect it, we also check
1297 * {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} and disallow installing
1298 * if any of the accounts have it.
1299 * </ul>
1300 */
1301 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED =
1302 "android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED";
1303
1304 /** @hide See {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} */
1305 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED =
1306 "android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED";
1307
1308 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001309 * Called by an application that is administering the device to set the password restrictions it
1310 * is imposing. After setting this, the user will not be able to enter a new password that is
1311 * not at least as restrictive as what has been set. Note that the current password will remain
1312 * until the user has set a new one, so the change does not take place immediately. To prompt
1313 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001314 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001315 * <p>
1316 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1317 * requested quality constant (between the policy set here, the user's preference, and any other
1318 * considerations) is the one that is in effect.
1319 * <p>
1320 * The calling device admin must have requested
1321 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1322 * not, a security exception will be thrown.
1323 * <p>
1324 * This method can be called on the {@link DevicePolicyManager} instance returned by
1325 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1326 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001327 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001328 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001329 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1330 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1331 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1332 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1333 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1334 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001335 */
Robin Lee25e26452015-06-02 09:56:29 -07001336 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001337 if (mService != null) {
1338 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001339 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001340 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001341 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001342 }
1343 }
1344 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001345
Dianne Hackbornd6847842010-01-12 18:14:19 -08001346 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001347 * Retrieve the current minimum password quality for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001348 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001349 * a separate challenge are not taken into account.
1350 *
1351 * <p>This method can be called on the {@link DevicePolicyManager} instance
1352 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1353 * restrictions on the parent profile.
1354 *
Robin Lee25e26452015-06-02 09:56:29 -07001355 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001356 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001357 */
Robin Lee25e26452015-06-02 09:56:29 -07001358 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001359 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001360 }
1361
1362 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001363 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001364 if (mService != null) {
1365 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001366 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001367 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001368 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001369 }
1370 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001371 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001372 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001373
Dianne Hackbornd6847842010-01-12 18:14:19 -08001374 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001375 * Called by an application that is administering the device to set the minimum allowed password
1376 * length. After setting this, the user will not be able to enter a new password that is not at
1377 * least as restrictive as what has been set. Note that the current password will remain until
1378 * the user has set a new one, so the change does not take place immediately. To prompt the user
1379 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1380 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1381 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1382 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1383 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1384 * {@link #setPasswordQuality}.
1385 * <p>
1386 * The calling device admin must have requested
1387 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1388 * not, a security exception will be thrown.
1389 * <p>
1390 * This method can be called on the {@link DevicePolicyManager} instance returned by
1391 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1392 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001393 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001394 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001395 * @param length The new desired minimum password length. A value of 0 means there is no
1396 * restriction.
1397 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1398 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001399 */
Robin Lee25e26452015-06-02 09:56:29 -07001400 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001401 if (mService != null) {
1402 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001403 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001404 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001405 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001406 }
1407 }
1408 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001409
Dianne Hackbornd6847842010-01-12 18:14:19 -08001410 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001411 * Retrieve the current minimum password length for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001412 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001413 * a separate challenge are not taken into account.
1414 *
1415 * <p>This method can be called on the {@link DevicePolicyManager} instance
1416 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1417 * restrictions on the parent profile.
1418 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001419 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001420 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001421 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001422 */
Robin Lee25e26452015-06-02 09:56:29 -07001423 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001424 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001425 }
1426
1427 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001428 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001429 if (mService != null) {
1430 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001431 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001432 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001433 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001434 }
1435 }
1436 return 0;
1437 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001438
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001439 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001440 * Called by an application that is administering the device to set the minimum number of upper
1441 * case letters required in the password. After setting this, the user will not be able to enter
1442 * a new password that is not at least as restrictive as what has been set. Note that the
1443 * current password will remain until the user has set a new one, so the change does not take
1444 * place immediately. To prompt the user for a new password, use
1445 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1446 * setting this value. This constraint is only imposed if the administrator has also requested
1447 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001448 * <p>
1449 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001450 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1451 * not, a security exception will be thrown.
1452 * <p>
1453 * This method can be called on the {@link DevicePolicyManager} instance returned by
1454 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1455 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001456 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001457 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1458 * @param length The new desired minimum number of upper case letters required in the password.
1459 * A value of 0 means there is no restriction.
1460 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1461 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001462 */
Robin Lee25e26452015-06-02 09:56:29 -07001463 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001464 if (mService != null) {
1465 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001466 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001467 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001468 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001469 }
1470 }
1471 }
1472
1473 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001474 * Retrieve the current number of upper case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001475 * for a particular admin or all admins that set restrictions on this user and
Esteban Talaverac1c83592016-02-17 17:56:15 +00001476 * its participating profiles. Restrictions on profiles that have a separate challenge
1477 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001478 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001479 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001480 * and only applies when the password quality is
1481 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001482 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001483 * <p>This method can be called on the {@link DevicePolicyManager} instance
1484 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1485 * restrictions on the parent profile.
1486 *
Robin Lee25e26452015-06-02 09:56:29 -07001487 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001488 * aggregate all admins.
1489 * @return The minimum number of upper case letters required in the
1490 * password.
1491 */
Robin Lee25e26452015-06-02 09:56:29 -07001492 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001493 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001494 }
1495
1496 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001497 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001498 if (mService != null) {
1499 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001500 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001501 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001502 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001503 }
1504 }
1505 return 0;
1506 }
1507
1508 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001509 * Called by an application that is administering the device to set the minimum number of lower
1510 * case letters required in the password. After setting this, the user will not be able to enter
1511 * a new password that is not at least as restrictive as what has been set. Note that the
1512 * current password will remain until the user has set a new one, so the change does not take
1513 * place immediately. To prompt the user for a new password, use
1514 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1515 * setting this value. This constraint is only imposed if the administrator has also requested
1516 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001517 * <p>
1518 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001519 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1520 * not, a security exception will be thrown.
1521 * <p>
1522 * This method can be called on the {@link DevicePolicyManager} instance returned by
1523 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1524 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001525 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001526 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1527 * @param length The new desired minimum number of lower case letters required in the password.
1528 * A value of 0 means there is no restriction.
1529 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1530 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001531 */
Robin Lee25e26452015-06-02 09:56:29 -07001532 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001533 if (mService != null) {
1534 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001535 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001536 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001537 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001538 }
1539 }
1540 }
1541
1542 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001543 * Retrieve the current number of lower case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001544 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001545 * and its participating profiles. Restrictions on profiles that have
1546 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001547 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001548 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001549 * and only applies when the password quality is
1550 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001551 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001552 * <p>This method can be called on the {@link DevicePolicyManager} instance
1553 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1554 * restrictions on the parent profile.
1555 *
Robin Lee25e26452015-06-02 09:56:29 -07001556 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001557 * aggregate all admins.
1558 * @return The minimum number of lower case letters required in the
1559 * password.
1560 */
Robin Lee25e26452015-06-02 09:56:29 -07001561 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001562 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001563 }
1564
1565 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001566 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001567 if (mService != null) {
1568 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001569 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001570 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001571 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001572 }
1573 }
1574 return 0;
1575 }
1576
1577 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001578 * Called by an application that is administering the device to set the minimum number of
1579 * letters required in the password. After setting this, the user will not be able to enter a
1580 * new password that is not at least as restrictive as what has been set. Note that the current
1581 * password will remain until the user has set a new one, so the change does not take place
1582 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1583 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1584 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1585 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001586 * <p>
1587 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001588 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1589 * not, a security exception will be thrown.
1590 * <p>
1591 * This method can be called on the {@link DevicePolicyManager} instance returned by
1592 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1593 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001594 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001595 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1596 * @param length The new desired minimum number of letters required in the password. A value of
1597 * 0 means there is no restriction.
1598 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1599 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001600 */
Robin Lee25e26452015-06-02 09:56:29 -07001601 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001602 if (mService != null) {
1603 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001604 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001605 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001606 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001607 }
1608 }
1609 }
1610
1611 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001612 * Retrieve the current number of letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001613 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001614 * and its participating profiles. Restrictions on profiles that have
1615 * a separate challenge are not taken into account.
1616 * This is the same value as set by
1617 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001618 * and only applies when the password quality is
1619 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001620 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001621 * <p>This method can be called on the {@link DevicePolicyManager} instance
1622 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1623 * restrictions on the parent profile.
1624 *
Robin Lee25e26452015-06-02 09:56:29 -07001625 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001626 * aggregate all admins.
1627 * @return The minimum number of letters required in the password.
1628 */
Robin Lee25e26452015-06-02 09:56:29 -07001629 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001630 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001631 }
1632
1633 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001634 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001635 if (mService != null) {
1636 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001637 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001638 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001639 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001640 }
1641 }
1642 return 0;
1643 }
1644
1645 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001646 * Called by an application that is administering the device to set the minimum number of
1647 * numerical digits required in the password. After setting this, the user will not be able to
1648 * enter a new password that is not at least as restrictive as what has been set. Note that the
1649 * current password will remain until the user has set a new one, so the change does not take
1650 * place immediately. To prompt the user for a new password, use
1651 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1652 * setting this value. This constraint is only imposed if the administrator has also requested
1653 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001654 * <p>
1655 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001656 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1657 * not, a security exception will be thrown.
1658 * <p>
1659 * This method can be called on the {@link DevicePolicyManager} instance returned by
1660 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1661 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001662 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001663 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1664 * @param length The new desired minimum number of numerical digits required in the password. A
1665 * value of 0 means there is no restriction.
1666 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1667 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001668 */
Robin Lee25e26452015-06-02 09:56:29 -07001669 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001670 if (mService != null) {
1671 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001672 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001673 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001674 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001675 }
1676 }
1677 }
1678
1679 /**
1680 * Retrieve the current number of numerical digits required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001681 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001682 * and its participating profiles. Restrictions on profiles that have
1683 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001684 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001685 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001686 * and only applies when the password quality is
1687 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001688 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001689 * <p>This method can be called on the {@link DevicePolicyManager} instance
1690 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1691 * restrictions on the parent profile.
1692 *
Robin Lee25e26452015-06-02 09:56:29 -07001693 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001694 * aggregate all admins.
1695 * @return The minimum number of numerical digits required in the password.
1696 */
Robin Lee25e26452015-06-02 09:56:29 -07001697 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001698 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001699 }
1700
1701 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001702 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001703 if (mService != null) {
1704 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001705 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001706 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001707 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001708 }
1709 }
1710 return 0;
1711 }
1712
1713 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001714 * Called by an application that is administering the device to set the minimum number of
1715 * symbols required in the password. After setting this, the user will not be able to enter a
1716 * new password that is not at least as restrictive as what has been set. Note that the current
1717 * password will remain until the user has set a new one, so the change does not take place
1718 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1719 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1720 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1721 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001722 * <p>
1723 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001724 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1725 * not, a security exception will be thrown.
1726 * <p>
1727 * This method can be called on the {@link DevicePolicyManager} instance returned by
1728 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1729 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001730 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001731 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1732 * @param length The new desired minimum number of symbols required in the password. A value of
1733 * 0 means there is no restriction.
1734 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1735 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001736 */
Robin Lee25e26452015-06-02 09:56:29 -07001737 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001738 if (mService != null) {
1739 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001740 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001741 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001742 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001743 }
1744 }
1745 }
1746
1747 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001748 * Retrieve the current number of symbols required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001749 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001750 * and its participating profiles. Restrictions on profiles that have
1751 * a separate challenge are not taken into account. This is the same value as
1752 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001753 * and only applies when the password quality is
1754 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001755 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001756 * <p>This method can be called on the {@link DevicePolicyManager} instance
1757 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1758 * restrictions on the parent profile.
1759 *
Robin Lee25e26452015-06-02 09:56:29 -07001760 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001761 * aggregate all admins.
1762 * @return The minimum number of symbols required in the password.
1763 */
Robin Lee25e26452015-06-02 09:56:29 -07001764 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001765 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001766 }
1767
1768 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001769 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001770 if (mService != null) {
1771 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001772 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001773 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001774 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001775 }
1776 }
1777 return 0;
1778 }
1779
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001780 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001781 * Called by an application that is administering the device to set the minimum number of
1782 * non-letter characters (numerical digits or symbols) required in the password. After setting
1783 * this, the user will not be able to enter a new password that is not at least as restrictive
1784 * as what has been set. Note that the current password will remain until the user has set a new
1785 * one, so the change does not take place immediately. To prompt the user for a new password,
1786 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1787 * setting this value. This constraint is only imposed if the administrator has also requested
1788 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001789 * <p>
1790 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001791 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1792 * not, a security exception will be thrown.
1793 * <p>
1794 * This method can be called on the {@link DevicePolicyManager} instance returned by
1795 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1796 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001797 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001798 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1799 * @param length The new desired minimum number of letters required in the password. A value of
1800 * 0 means there is no restriction.
1801 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1802 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001803 */
Robin Lee25e26452015-06-02 09:56:29 -07001804 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001805 if (mService != null) {
1806 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001807 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001808 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001809 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001810 }
1811 }
1812 }
1813
1814 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001815 * Retrieve the current number of non-letter characters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001816 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001817 * and its participating profiles. Restrictions on profiles that have
1818 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001819 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001820 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001821 * and only applies when the password quality is
1822 * {@link #PASSWORD_QUALITY_COMPLEX}.
1823 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001824 * <p>This method can be called on the {@link DevicePolicyManager} instance
1825 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1826 * restrictions on the parent profile.
1827 *
Robin Lee25e26452015-06-02 09:56:29 -07001828 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001829 * aggregate all admins.
1830 * @return The minimum number of letters required in the password.
1831 */
Robin Lee25e26452015-06-02 09:56:29 -07001832 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001833 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001834 }
1835
1836 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001837 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001838 if (mService != null) {
1839 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001840 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001841 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001842 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001843 }
1844 }
1845 return 0;
1846 }
1847
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001848 /**
1849 * Called by an application that is administering the device to set the length of the password
1850 * history. After setting this, the user will not be able to enter a new password that is the
1851 * same as any password in the history. Note that the current password will remain until the
1852 * user has set a new one, so the change does not take place immediately. To prompt the user for
1853 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1854 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1855 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1856 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
1857 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
1858 * <p>
1859 * The calling device admin must have requested
1860 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1861 * not, a security exception will be thrown.
1862 * <p>
1863 * This method can be called on the {@link DevicePolicyManager} instance returned by
1864 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1865 * profile.
1866 *
1867 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1868 * @param length The new desired length of password history. A value of 0 means there is no
1869 * restriction.
1870 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1871 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1872 */
Robin Lee25e26452015-06-02 09:56:29 -07001873 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001874 if (mService != null) {
1875 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001876 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001877 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001878 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001879 }
1880 }
1881 }
1882
1883 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001884 * Called by a device admin to set the password expiration timeout. Calling this method will
1885 * restart the countdown for password expiration for the given admin, as will changing the
1886 * device password (for all admins).
1887 * <p>
1888 * The provided timeout is the time delta in ms and will be added to the current time. For
1889 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
1890 * 432000000 ms for timeout.
1891 * <p>
1892 * To disable password expiration, a value of 0 may be used for timeout.
1893 * <p>
1894 * The calling device admin must have requested
1895 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
1896 * not, a security exception will be thrown.
1897 * <p>
1898 * Note that setting the password will automatically reset the expiration time for all active
1899 * admins. Active admins do not need to explicitly call this method in that case.
1900 * <p>
1901 * This method can be called on the {@link DevicePolicyManager} instance returned by
1902 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1903 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001904 *
Jim Millera4e28d12010-11-08 16:15:47 -08001905 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001906 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
1907 * there is no restriction (unlimited).
1908 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1909 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08001910 */
Robin Lee25e26452015-06-02 09:56:29 -07001911 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001912 if (mService != null) {
1913 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001914 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001915 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001916 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001917 }
1918 }
1919 }
1920
1921 /**
Jim Miller6b857682011-02-16 16:27:41 -08001922 * Get the password expiration timeout for the given admin. The expiration timeout is the
1923 * recurring expiration timeout provided in the call to
1924 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001925 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1926 * have set restrictions on profiles that have a separate challenge are not taken into account.
1927 *
1928 * <p>This method can be called on the {@link DevicePolicyManager} instance
1929 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1930 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001931 *
Robin Lee25e26452015-06-02 09:56:29 -07001932 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001933 * @return The timeout for the given admin or the minimum of all timeouts
1934 */
Robin Lee25e26452015-06-02 09:56:29 -07001935 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001936 if (mService != null) {
1937 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001938 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001939 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001940 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001941 }
1942 }
1943 return 0;
1944 }
1945
1946 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001947 * Get the current password expiration time for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001948 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001949 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1950 * of all expiration times is returned - which will be the minimum of all of them.
1951 *
1952 * <p>This method can be called on the {@link DevicePolicyManager} instance
1953 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1954 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001955 *
Robin Lee25e26452015-06-02 09:56:29 -07001956 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001957 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001958 */
Robin Lee25e26452015-06-02 09:56:29 -07001959 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001960 if (mService != null) {
1961 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001962 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001963 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001964 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001965 }
1966 }
1967 return 0;
1968 }
1969
1970 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001971 * Retrieve the current password history length for a particular admin or all admins that
Rubin Xud3609d42016-07-13 18:32:57 +01001972 * set restrictions on this user and its participating profiles. Restrictions on profiles that
Esteban Talaverac1c83592016-02-17 17:56:15 +00001973 * have a separate challenge are not taken into account.
1974 *
1975 * <p>This method can be called on the {@link DevicePolicyManager} instance
1976 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1977 * restrictions on the parent profile.
1978 *
Robin Lee25e26452015-06-02 09:56:29 -07001979 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001980 * all admins.
1981 * @return The length of the password history
1982 */
Robin Lee25e26452015-06-02 09:56:29 -07001983 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001984 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001985 }
1986
1987 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001988 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001989 if (mService != null) {
1990 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001991 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001992 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001993 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001994 }
1995 }
1996 return 0;
1997 }
1998
Dianne Hackbornd6847842010-01-12 18:14:19 -08001999 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08002000 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002001 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08002002 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08002003 * @return Returns the maximum length that the user can enter.
2004 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002005 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002006 // Kind-of arbitrary.
2007 return 16;
2008 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002009
Dianne Hackborn254cb442010-01-27 19:23:59 -08002010 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002011 * Determine whether the current password the user has set is sufficient to meet the policy
2012 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
2013 * user and its participating profiles. Restrictions on profiles that have a separate challenge
2014 * are not taken into account.
2015 * <p>
2016 * The calling device admin must have requested
2017 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2018 * not, a security exception will be thrown.
2019 * <p>
2020 * This method can be called on the {@link DevicePolicyManager} instance returned by
2021 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
2022 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002023 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01002024 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002025 * @throws SecurityException if the calling application does not own an active administrator
2026 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002027 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002028 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002029 if (mService != null) {
2030 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002031 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002032 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002033 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002034 }
2035 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002036 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002037 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002038
Dianne Hackbornd6847842010-01-12 18:14:19 -08002039 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002040 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002041 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002042 * requested by the admins of the parent user and its profiles.
2043 *
2044 * @param userHandle the userId of the profile to check the password for.
2045 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002046 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002047 * @hide
2048 */
2049 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2050 if (mService != null) {
2051 try {
2052 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2053 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002054 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002055 }
2056 }
2057 return false;
2058 }
2059
2060 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002061 * Retrieve the number of times the user has failed at entering a password since that last
2062 * successful password entry.
2063 * <p>
2064 * This method can be called on the {@link DevicePolicyManager} instance returned by
2065 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2066 * password attemts for the parent user.
2067 * <p>
2068 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2069 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002070 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002071 * @return The number of times user has entered an incorrect password since the last correct
2072 * password entry.
2073 * @throws SecurityException if the calling application does not own an active administrator
2074 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002075 */
2076 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002077 return getCurrentFailedPasswordAttempts(myUserId());
2078 }
2079
2080 /**
2081 * Retrieve the number of times the given user has failed at entering a
2082 * password since that last successful password entry.
2083 *
2084 * <p>The calling device admin must have requested
2085 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2086 * not and it is not the system uid, a security exception will be thrown.
2087 *
2088 * @hide
2089 */
2090 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002091 if (mService != null) {
2092 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002093 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002094 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002095 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002096 }
2097 }
2098 return -1;
2099 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002100
2101 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002102 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002103 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002104 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002105 * @hide
2106 */
2107 public boolean getDoNotAskCredentialsOnBoot() {
2108 if (mService != null) {
2109 try {
2110 return mService.getDoNotAskCredentialsOnBoot();
2111 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002112 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002113 }
2114 }
2115 return false;
2116 }
2117
2118 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002119 * Setting this to a value greater than zero enables a built-in policy that will perform a
2120 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2121 * This built-in policy combines watching for failed passwords and wiping the device, and
2122 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002123 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002124 * <p>
2125 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2126 * revoking credentials, or reporting the failure to a server), you should implement
2127 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2128 * use this API, because if the maximum count is reached, the device or profile will be wiped
2129 * immediately, and your callback will not be invoked.
2130 * <p>
2131 * This method can be called on the {@link DevicePolicyManager} instance returned by
2132 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2133 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002134 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002135 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002136 * @param num The number of failed password attempts at which point the device or profile will
2137 * be wiped.
2138 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2139 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2140 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002141 */
Robin Lee25e26452015-06-02 09:56:29 -07002142 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002143 if (mService != null) {
2144 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002145 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002146 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002147 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002148 }
2149 }
2150 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002151
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002152 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002153 * Retrieve the current maximum number of login attempts that are allowed before the device
Rubin Xud3609d42016-07-13 18:32:57 +01002154 * or profile is wiped, for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002155 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2156 * not taken into account.
2157 *
2158 * <p>This method can be called on the {@link DevicePolicyManager} instance
2159 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2160 * the value for the parent profile.
2161 *
Robin Lee25e26452015-06-02 09:56:29 -07002162 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002163 * all admins.
2164 */
Robin Lee25e26452015-06-02 09:56:29 -07002165 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002166 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002167 }
2168
2169 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002170 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002171 if (mService != null) {
2172 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002173 return mService.getMaximumFailedPasswordsForWipe(
2174 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002175 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002176 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002177 }
2178 }
2179 return 0;
2180 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002181
Dianne Hackborn254cb442010-01-27 19:23:59 -08002182 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002183 * Returns the profile with the smallest maximum failed passwords for wipe,
2184 * for the given user. So for primary user, it might return the primary or
2185 * a managed profile. For a secondary user, it would be the same as the
2186 * user passed in.
2187 * @hide Used only by Keyguard
2188 */
2189 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2190 if (mService != null) {
2191 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002192 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2193 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002194 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002195 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002196 }
2197 }
2198 return UserHandle.USER_NULL;
2199 }
2200
2201 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002202 * Flag for {@link #resetPassword}: don't allow other admins to change
2203 * the password again until the user has entered it.
2204 */
2205 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002206
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002207 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002208 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2209 * If the flag is set, the device can be booted without asking for user password.
2210 * The absence of this flag does not change the current boot requirements. This flag
2211 * can be set by the device owner only. If the app is not the device owner, the flag
2212 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2213 * device to factory defaults.
2214 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002215 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002216
2217 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002218 * Force a new device unlock password (the password needed to access the entire device, not for
2219 * individual accounts) on the user. This takes effect immediately.
2220 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002221 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002222 * device admins that are not device owner and not profile owner.
2223 * The password can now only be changed if there is currently no password set. Device owner
Ricky Wai977ade22016-05-24 15:02:41 +01002224 * and profile owner can still do this when user is unlocked and does not have a managed
2225 * profile.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002226 * <p>
2227 * The given password must be sufficient for the current password quality and length constraints
2228 * as returned by {@link #getPasswordQuality(ComponentName)} and
2229 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2230 * it will be rejected and false returned. Note that the password may be a stronger quality
2231 * (containing alphanumeric characters when the requested quality is only numeric), in which
2232 * case the currently active quality will be increased to match.
2233 * <p>
2234 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002235 * current password constraints allow it. <em>Note: This will not work in
2236 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2237 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2238 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002239 * <p>
2240 * The calling device admin must have requested
2241 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2242 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002243 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002244 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002245 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002246 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2247 * @return Returns true if the password was applied, or false if it is not acceptable for the
2248 * current constraints or if the user has not been decrypted yet.
2249 * @throws SecurityException if the calling application does not own an active administrator
2250 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Ricky Wai977ade22016-05-24 15:02:41 +01002251 * @throws IllegalStateException if the calling user is locked or has a managed profile.
Andrew Scull3f81f4e2016-07-29 16:29:58 +01002252 * @throws IllegalArgumentException if the password does not meet system requirements.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002253 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002254 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002255 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002256 if (mService != null) {
2257 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002258 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002259 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002260 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002261 }
2262 }
2263 return false;
2264 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002265
Dianne Hackbornd6847842010-01-12 18:14:19 -08002266 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002267 * Called by an application that is administering the device to set the maximum time for user
2268 * activity until the device will lock. This limits the length that the user can set. It takes
2269 * effect immediately.
2270 * <p>
2271 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2272 * to be able to call this method; if it has not, a security exception will be thrown.
2273 * <p>
2274 * This method can be called on the {@link DevicePolicyManager} instance returned by
2275 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2276 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002277 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002278 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002279 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2280 * is no restriction.
2281 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2282 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002283 */
Robin Lee25e26452015-06-02 09:56:29 -07002284 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002285 if (mService != null) {
2286 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002287 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002288 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002289 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002290 }
2291 }
2292 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002293
Dianne Hackbornd6847842010-01-12 18:14:19 -08002294 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002295 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002296 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002297 * a separate challenge are not taken into account.
2298 *
2299 * <p>This method can be called on the {@link DevicePolicyManager} instance
2300 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2301 * restrictions on the parent profile.
2302 *
Robin Lee25e26452015-06-02 09:56:29 -07002303 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002304 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002305 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002306 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002307 */
Robin Lee25e26452015-06-02 09:56:29 -07002308 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002309 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002310 }
2311
2312 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002313 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002314 if (mService != null) {
2315 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002316 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002317 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002318 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002319 }
2320 }
2321 return 0;
2322 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002323
Dianne Hackbornd6847842010-01-12 18:14:19 -08002324 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002325 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2326 * do not have a separate timeout to lock for work challenge only.
2327 *
2328 * @hide
2329 */
2330 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2331 if (mService != null) {
2332 try {
2333 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2334 } catch (RemoteException e) {
2335 throw e.rethrowFromSystemServer();
2336 }
2337 }
2338 return 0;
2339 }
2340
2341 /**
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002342 * Called by a device/profile owner to set the timeout after which unlocking with secondary, non
2343 * strong auth (e.g. fingerprint, trust agents) times out, i.e. the user has to use a strong
2344 * authentication method like password, pin or pattern.
2345 *
2346 * <p>This timeout is used internally to reset the timer to require strong auth again after
2347 * specified timeout each time it has been successfully used.
2348 *
2349 * <p>Fingerprint can also be disabled altogether using {@link #KEYGUARD_DISABLE_FINGERPRINT}.
2350 *
2351 * <p>Trust agents can also be disabled altogether using {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
2352 *
2353 * <p>The calling device admin must be a device or profile owner. If it is not,
2354 * a {@link SecurityException} will be thrown.
2355 *
Michal Karpinski943aabd2016-10-06 11:09:25 +01002356 * <p>The calling device admin can verify the value it has set by calling
2357 * {@link #getRequiredStrongAuthTimeout(ComponentName)} and passing in its instance.
2358 *
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002359 * <p>This method can be called on the {@link DevicePolicyManager} instance returned by
2360 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2361 * profile.
2362 *
2363 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2364 * @param timeoutMs The new timeout, after which the user will have to unlock with strong
Michal Karpinski943aabd2016-10-06 11:09:25 +01002365 * authentication method. A value of 0 means the admin is not participating in
2366 * controlling the timeout.
2367 * The minimum and maximum timeouts are platform-defined and are typically 1 hour and
2368 * 72 hours, respectively. Though discouraged, the admin may choose to require strong
2369 * auth at all times using {@link #KEYGUARD_DISABLE_FINGERPRINT} and/or
2370 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002371 *
2372 * @throws SecurityException if {@code admin} is not a device or profile owner.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002373 *
2374 * @hide
2375 */
2376 public void setRequiredStrongAuthTimeout(@NonNull ComponentName admin,
2377 long timeoutMs) {
2378 if (mService != null) {
2379 try {
2380 mService.setRequiredStrongAuthTimeout(admin, timeoutMs, mParentInstance);
2381 } catch (RemoteException e) {
2382 throw e.rethrowFromSystemServer();
2383 }
2384 }
2385 }
2386
2387 /**
2388 * Determine for how long the user will be able to use secondary, non strong auth for
2389 * authentication, since last strong method authentication (password, pin or pattern) was used.
2390 * After the returned timeout the user is required to use strong authentication method.
2391 *
2392 * <p>This method can be called on the {@link DevicePolicyManager} instance
2393 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2394 * restrictions on the parent profile.
2395 *
2396 * @param admin The name of the admin component to check, or {@code null} to aggregate
2397 * accross all participating admins.
Michal Karpinski943aabd2016-10-06 11:09:25 +01002398 * @return The timeout or 0 if not configured for the provided admin.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002399 *
2400 * @hide
2401 */
2402 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin) {
2403 return getRequiredStrongAuthTimeout(admin, myUserId());
2404 }
2405
2406 /** @hide per-user version */
2407 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin, @UserIdInt int userId) {
2408 if (mService != null) {
2409 try {
2410 return mService.getRequiredStrongAuthTimeout(admin, userId, mParentInstance);
2411 } catch (RemoteException e) {
2412 throw e.rethrowFromSystemServer();
2413 }
2414 }
2415 return DEFAULT_STRONG_AUTH_TIMEOUT_MS;
2416 }
2417
2418 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002419 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2420 * this call.
2421 * <p>
2422 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2423 * to be able to call this method; if it has not, a security exception will be thrown.
2424 * <p>
2425 * This method can be called on the {@link DevicePolicyManager} instance returned by
2426 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002427 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002428 * @throws SecurityException if the calling application does not own an active administrator
2429 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002430 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002431 public void lockNow() {
2432 if (mService != null) {
2433 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002434 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002435 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002436 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002437 }
2438 }
2439 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002440
Dianne Hackbornd6847842010-01-12 18:14:19 -08002441 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002442 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002443 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002444 */
2445 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2446
2447 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002448 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2449 * data.
2450 *
Paul Crowley2934b262014-12-02 11:21:13 +00002451 * <p>This flag may only be set by device owner admins; if it is set by
2452 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002453 */
2454 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2455
2456 /**
Suprabh Shukla556b05a2016-08-10 15:49:24 -07002457 * Ask that all user data be wiped. If called as a secondary user, the user will be removed and
2458 * other users will remain unaffected. Calling from the primary user will cause the device to
2459 * reboot, erasing all device data - including all the secondary users and their data - while
2460 * booting up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002461 * <p>
2462 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2463 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002464 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002465 * @param flags Bit mask of additional options: currently supported flags are
2466 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2467 * @throws SecurityException if the calling application does not own an active administrator
2468 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002469 */
2470 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002471 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08002472 if (mService != null) {
2473 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002474 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002475 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002476 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002477 }
2478 }
2479 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002480
Dianne Hackbornd6847842010-01-12 18:14:19 -08002481 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002482 * Called by an application that is administering the device to set the
2483 * global proxy and exclusion list.
2484 * <p>
2485 * The calling device admin must have requested
2486 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2487 * this method; if it has not, a security exception will be thrown.
2488 * Only the first device admin can set the proxy. If a second admin attempts
2489 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002490 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002491 * be returned.
2492 * The method can be called repeatedly by the device admin alrady setting the
2493 * proxy to update the proxy and exclusion list.
2494 *
Robin Lee25e26452015-06-02 09:56:29 -07002495 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002496 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2497 * Pass Proxy.NO_PROXY to reset the proxy.
2498 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002499 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2500 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002501 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002502 */
Robin Lee25e26452015-06-02 09:56:29 -07002503 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002504 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002505 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07002506 if (proxySpec == null) {
2507 throw new NullPointerException();
2508 }
2509 if (mService != null) {
2510 try {
2511 String hostSpec;
2512 String exclSpec;
2513 if (proxySpec.equals(Proxy.NO_PROXY)) {
2514 hostSpec = null;
2515 exclSpec = null;
2516 } else {
2517 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2518 throw new IllegalArgumentException();
2519 }
2520 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2521 String hostName = sa.getHostName();
2522 int port = sa.getPort();
2523 StringBuilder hostBuilder = new StringBuilder();
2524 hostSpec = hostBuilder.append(hostName)
2525 .append(":").append(Integer.toString(port)).toString();
2526 if (exclusionList == null) {
2527 exclSpec = "";
2528 } else {
2529 StringBuilder listBuilder = new StringBuilder();
2530 boolean firstDomain = true;
2531 for (String exclDomain : exclusionList) {
2532 if (!firstDomain) {
2533 listBuilder = listBuilder.append(",");
2534 } else {
2535 firstDomain = false;
2536 }
2537 listBuilder = listBuilder.append(exclDomain.trim());
2538 }
2539 exclSpec = listBuilder.toString();
2540 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002541 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2542 != android.net.Proxy.PROXY_VALID)
2543 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002544 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002545 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002546 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002547 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002548 }
2549 }
2550 return null;
2551 }
2552
2553 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002554 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2555 * HTTP proxies - they are generally network dependent. However if you're doing something
2556 * unusual like general internal filtering this may be useful. On a private network where the
2557 * proxy is not accessible, you may break HTTP using this.
2558 * <p>
2559 * This method requires the caller to be the device owner.
2560 * <p>
2561 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04002562 *
Jason Monk03bc9912014-05-13 09:44:57 -04002563 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002564 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2565 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2566 * {@code null} value will clear the global HTTP proxy.
2567 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04002568 */
Robin Lee25e26452015-06-02 09:56:29 -07002569 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2570 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002571 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04002572 if (mService != null) {
2573 try {
2574 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2575 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002576 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04002577 }
2578 }
2579 }
2580
2581 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002582 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002583 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2584 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002585 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002586 */
2587 public ComponentName getGlobalProxyAdmin() {
2588 if (mService != null) {
2589 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002590 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002591 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002592 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002593 }
2594 }
2595 return null;
2596 }
2597
2598 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002599 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002600 * indicating that encryption is not supported.
2601 */
2602 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2603
2604 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002605 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002606 * indicating that encryption is supported, but is not currently active.
2607 */
2608 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2609
2610 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002611 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002612 * indicating that encryption is not currently active, but is currently
2613 * being activated. This is only reported by devices that support
2614 * encryption of data and only when the storage is currently
2615 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2616 * to become encrypted will never return this value.
2617 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002618 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002619
2620 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002621 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002622 * indicating that encryption is active.
Amith Yamasani75db1252016-07-11 14:41:01 -07002623 * <p>
2624 * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002625 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002626 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002627
2628 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002629 * Result code for {@link #getStorageEncryptionStatus}:
2630 * indicating that encryption is active, but an encryption key has not
2631 * been set by the user.
2632 */
2633 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2634
2635 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08002636 * Result code for {@link #getStorageEncryptionStatus}:
Amith Yamasani75db1252016-07-11 14:41:01 -07002637 * indicating that encryption is active and the encryption key is tied to the user or profile.
2638 * <p>
2639 * This value is only returned to apps targeting API level 24 and above. For apps targeting
2640 * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
2641 * encryption key is specific to the user or profile.
Makoto Onukid4c9e542016-02-25 18:17:30 -08002642 */
2643 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2644
2645 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002646 * Activity action: begin the process of encrypting data on the device. This activity should
2647 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2648 * After resuming from this activity, use {@link #getStorageEncryption}
2649 * to check encryption status. However, on some devices this activity may never return, as
2650 * it may trigger a reboot and in some cases a complete data wipe of the device.
2651 */
2652 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2653 public static final String ACTION_START_ENCRYPTION
2654 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002655 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002656 * Widgets are enabled in keyguard
2657 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002658 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002659
2660 /**
Jim Miller50e62182014-04-23 17:25:00 -07002661 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002662 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002663 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2664
2665 /**
2666 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2667 */
2668 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2669
2670 /**
Jim Miller50e62182014-04-23 17:25:00 -07002671 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2672 */
2673 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2674
2675 /**
2676 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2677 */
2678 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2679
2680 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002681 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002682 * (e.g. PIN/Pattern/Password).
2683 */
2684 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2685
2686 /**
Jim Miller06e34502014-07-17 14:46:05 -07002687 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2688 */
2689 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2690
2691 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08002692 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
2693 */
2694 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
2695
2696 /**
Jim Miller35207742012-11-02 15:33:20 -07002697 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002698 */
2699 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002700
2701 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002702 * Called by an application that is administering the device to request that the storage system
2703 * be encrypted.
2704 * <p>
2705 * When multiple device administrators attempt to control device encryption, the most secure,
2706 * supported setting will always be used. If any device administrator requests device
2707 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2708 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002709 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002710 * <p>
2711 * This policy controls encryption of the secure (application data) storage area. Data written
2712 * to other storage areas may or may not be encrypted, and this policy does not require or
2713 * control the encryption of any other storage areas. There is one exception: If
2714 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2715 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2716 * written to disk within the encrypted storage area.
2717 * <p>
2718 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2719 * to create a device PIN or Password. In this case, the storage is encrypted, but the
2720 * encryption key may not be fully secured. For maximum security, the administrator should also
2721 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002722 *
2723 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2724 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002725 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002726 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2727 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2728 * {@link #getStorageEncryptionStatus()} to query the actual device state.
2729 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2730 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002731 */
Robin Lee25e26452015-06-02 09:56:29 -07002732 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002733 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002734 if (mService != null) {
2735 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002736 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002737 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002738 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002739 }
2740 }
2741 return ENCRYPTION_STATUS_UNSUPPORTED;
2742 }
2743
2744 /**
2745 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002746 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002747 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002748 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2749 * this will return the requested encryption setting as an aggregate of all active
2750 * administrators.
2751 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002752 */
Robin Lee25e26452015-06-02 09:56:29 -07002753 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002754 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002755 if (mService != null) {
2756 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002757 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002758 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002759 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002760 }
2761 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002762 return false;
2763 }
2764
2765 /**
2766 * Called by an application that is administering the device to
2767 * determine the current encryption status of the device.
Amith Yamasani75db1252016-07-11 14:41:01 -07002768 * <p>
Andy Stadler22dbfda2011-01-17 12:47:31 -08002769 * Depending on the returned status code, the caller may proceed in different
2770 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2771 * storage system does not support encryption. If the
2772 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2773 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002774 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2775 * storage system has enabled encryption but no password is set so further action
Amith Yamasani75db1252016-07-11 14:41:01 -07002776 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
2777 * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
2778 * no further action is required.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002779 *
Robin Lee7e678712014-07-24 16:41:31 +01002780 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002781 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002782 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
Amith Yamasani75db1252016-07-11 14:41:01 -07002783 * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002784 */
2785 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002786 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002787 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002788 }
2789
2790 /** @hide per-user version */
2791 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002792 if (mService != null) {
2793 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08002794 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002795 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002796 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08002797 }
2798 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002799 return ENCRYPTION_STATUS_UNSUPPORTED;
2800 }
2801
2802 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00002803 * Mark a CA certificate as approved by the device user. This means that they have been notified
2804 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2805 * keep the certificate on the device.
2806 *
2807 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2808 * this certificate.
2809 *
2810 * @hide
2811 */
2812 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2813 if (mService != null) {
2814 try {
2815 return mService.approveCaCert(alias, userHandle, approval);
2816 } catch (RemoteException e) {
2817 throw e.rethrowFromSystemServer();
2818 }
2819 }
2820 return false;
2821 }
2822
2823 /**
2824 * Check whether a CA certificate has been approved by the device user.
2825 *
2826 * @hide
2827 */
2828 public boolean isCaCertApproved(String alias, int userHandle) {
2829 if (mService != null) {
2830 try {
2831 return mService.isCaCertApproved(alias, userHandle);
2832 } catch (RemoteException e) {
2833 throw e.rethrowFromSystemServer();
2834 }
2835 }
2836 return false;
2837 }
2838
2839 /**
Robin Lee7e678712014-07-24 16:41:31 +01002840 * Installs the given certificate as a user CA.
2841 *
Robin Lee25e26452015-06-02 09:56:29 -07002842 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2843 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002844 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002845 *
2846 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002847 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002848 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2849 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002850 */
Robin Lee25e26452015-06-02 09:56:29 -07002851 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002852 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002853 if (mService != null) {
2854 try {
Robin Lee7e678712014-07-24 16:41:31 +01002855 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002856 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002857 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002858 }
2859 }
2860 return false;
2861 }
2862
2863 /**
Robin Lee7e678712014-07-24 16:41:31 +01002864 * Uninstalls the given certificate from trusted user CAs, if present.
2865 *
Robin Lee25e26452015-06-02 09:56:29 -07002866 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2867 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002868 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002869 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2870 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002871 */
Robin Lee25e26452015-06-02 09:56:29 -07002872 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002873 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002874 if (mService != null) {
2875 try {
Robin Lee306fe082014-06-19 14:04:24 +00002876 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002877 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002878 } catch (CertificateException e) {
2879 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002880 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002881 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002882 }
2883 }
2884 }
2885
2886 /**
Robin Lee7e678712014-07-24 16:41:31 +01002887 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2888 * If a user has installed any certificates by other means than device policy these will be
2889 * included too.
2890 *
Robin Lee25e26452015-06-02 09:56:29 -07002891 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2892 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002893 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002894 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2895 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002896 */
Robin Lee25e26452015-06-02 09:56:29 -07002897 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002898 List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01002899 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002900 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002901 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002902 mService.enforceCanManageCaCerts(admin);
2903 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2904 for (String alias : certStore.userAliases()) {
2905 try {
2906 certs.add(certStore.getCertificate(alias).getEncoded());
2907 } catch (CertificateException ce) {
2908 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2909 }
2910 }
2911 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002912 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002913 }
2914 }
2915 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002916 }
2917
2918 /**
Robin Lee7e678712014-07-24 16:41:31 +01002919 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2920 * means other than device policy will also be removed, except for system CA certificates.
2921 *
Robin Lee25e26452015-06-02 09:56:29 -07002922 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2923 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002924 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2925 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01002926 */
Robin Lee25e26452015-06-02 09:56:29 -07002927 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002928 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01002929 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002930 try {
2931 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2932 .toArray(new String[0]));
2933 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002934 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002935 }
2936 }
2937 }
2938
2939 /**
2940 * Returns whether this certificate is installed as a trusted CA.
2941 *
Robin Lee25e26452015-06-02 09:56:29 -07002942 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2943 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002944 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002945 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2946 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002947 */
Robin Lee25e26452015-06-02 09:56:29 -07002948 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002949 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002950 if (mService != null) {
2951 try {
2952 mService.enforceCanManageCaCerts(admin);
2953 return getCaCertAlias(certBuffer) != null;
2954 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002955 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002956 } catch (CertificateException ce) {
2957 Log.w(TAG, "Could not parse certificate", ce);
2958 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002959 }
2960 return false;
2961 }
2962
2963 /**
Robin Leece3399f2016-02-24 12:08:32 +00002964 * Called by a device or profile owner, or delegated certificate installer, to install a
2965 * certificate and corresponding private key. All apps within the profile will be able to access
2966 * the certificate and use the private key, given direct user approval.
2967 *
2968 * <p>Access to the installed credentials will not be granted to the caller of this API without
2969 * direct user approval. This is for security - should a certificate installer become
2970 * compromised, certificates it had already installed will be protected.
2971 *
2972 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00002973 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002974 *
Robin Lee25e26452015-06-02 09:56:29 -07002975 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2976 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002977 * @param privKey The private key to install.
2978 * @param cert The certificate to install.
2979 * @param alias The private key alias under which to install the certificate. If a certificate
2980 * with that alias already exists, it will be overwritten.
2981 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002982 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2983 * owner.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002984 */
Robin Leefbc65642015-08-03 16:21:22 +01002985 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2986 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00002987 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00002988 }
2989
2990 /**
2991 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00002992 * certificate chain and corresponding private key for the leaf certificate. All apps within the
2993 * profile will be able to access the certificate chain and use the private key, given direct
2994 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00002995 *
Robin Leea1b290e2016-03-09 14:38:36 +00002996 * <p>The caller of this API may grant itself access to the certificate and private key
2997 * immediately, without user approval. It is a best practice not to request this unless strictly
2998 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00002999 *
3000 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003001 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00003002 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00003003 * @param certs The certificate chain to install. The chain should start with the leaf
3004 * certificate and include the chain of trust in order. This will be returned by
3005 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00003006 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00003007 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00003008 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00003009 * credentials immediately. Otherwise, access to the credentials will be gated by user
3010 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00003011 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003012 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3013 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00003014 * @see android.security.KeyChain#getCertificateChain
Robin Leece3399f2016-02-24 12:08:32 +00003015 */
3016 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00003017 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003018 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003019 try {
Rubin Xub4365912016-03-23 12:13:22 +00003020 final byte[] pemCert = Credentials.convertToPem(certs[0]);
3021 byte[] pemChain = null;
3022 if (certs.length > 1) {
3023 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
3024 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01003025 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
3026 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Rubin Xub4365912016-03-23 12:13:22 +00003027 return mService.installKeyPair(admin, pkcs8Key, pemCert, pemChain, alias,
3028 requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003029 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003030 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01003031 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
3032 Log.w(TAG, "Failed to obtain private key material", e);
3033 } catch (CertificateException | IOException e) {
3034 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003035 }
3036 return false;
3037 }
3038
3039 /**
Robin Leea1b290e2016-03-09 14:38:36 +00003040 * Called by a device or profile owner, or delegated certificate installer, to remove a
3041 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01003042 *
3043 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003044 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01003045 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00003046 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003047 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3048 * owner.
Robin Leefbc65642015-08-03 16:21:22 +01003049 */
3050 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003051 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01003052 try {
3053 return mService.removeKeyPair(admin, alias);
3054 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003055 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01003056 }
Robin Leefbc65642015-08-03 16:21:22 +01003057 }
3058
3059 /**
Robin Lee25e26452015-06-02 09:56:29 -07003060 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00003061 * doesn't exist.
3062 */
3063 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
3064 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
3065 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
3066 new ByteArrayInputStream(certBuffer));
3067 return new TrustedCertificateStore().getCertificateAlias(cert);
3068 }
3069
3070 /**
Rubin Xuec32b562015-03-03 17:34:05 +00003071 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01003072 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00003073 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01003074 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00003075 * <p>
3076 * Delegated certificate installer is a per-user state. The delegated access is persistent until
3077 * it is later cleared by calling this method with a null value or uninstallling the certificate
3078 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003079 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00003080 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
3081 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003082 * supplied certificate installer package must be installed when calling this API, otherwise an
3083 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00003084 *
Robin Lee25e26452015-06-02 09:56:29 -07003085 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00003086 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003087 * access. If {@code null} is given the current package will be cleared.
3088 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00003089 */
Robin Lee25e26452015-06-02 09:56:29 -07003090 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
3091 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003092 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003093 if (mService != null) {
3094 try {
Robin Lee25e26452015-06-02 09:56:29 -07003095 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00003096 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003097 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003098 }
3099 }
3100 }
3101
3102 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003103 * Called by a profile owner or device owner to retrieve the certificate installer for the user.
3104 * null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00003105 *
Robin Lee25e26452015-06-02 09:56:29 -07003106 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003107 * @return The package name of the current delegated certificate installer, or {@code null} if
3108 * none is set.
3109 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00003110 */
Robin Lee25e26452015-06-02 09:56:29 -07003111 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003112 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003113 if (mService != null) {
3114 try {
Robin Lee25e26452015-06-02 09:56:29 -07003115 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00003116 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003117 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003118 }
3119 }
3120 return null;
3121 }
3122
3123 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003124 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003125 * specific application for the current user.
3126 *
3127 * @deprecated this version only exists for compability with previous developer preview builds.
3128 * TODO: delete once there are no longer any live references.
3129 * @hide
3130 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003131 @Deprecated
Robin Leedc679712016-05-03 13:23:03 +01003132 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3133 throws NameNotFoundException, UnsupportedOperationException {
3134 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3135 }
3136
3137 /**
3138 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003139 * specific application for the current user. This connection is automatically granted and
3140 * persisted after a reboot.
3141 * <p>
3142 * The designated package should declare a {@link android.net.VpnService} in its manifest
3143 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3144 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003145 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003146 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003147 * remove an existing always-on VPN configuration.
3148 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3149 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3150 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003151 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003152 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3153 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3154 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003155 */
Robin Leedc679712016-05-03 13:23:03 +01003156 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3157 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003158 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003159 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003160 if (mService != null) {
3161 try {
Robin Leedc679712016-05-03 13:23:03 +01003162 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003163 throw new NameNotFoundException(vpnPackage);
3164 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003165 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003166 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003167 }
3168 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003169 }
3170
3171 /**
3172 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003173 * always-on VPN connection for the current user. If there is no such package, or the always-on
3174 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003175 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003176 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3177 * is set.
3178 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003179 */
3180 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003181 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003182 if (mService != null) {
3183 try {
3184 return mService.getAlwaysOnVpnPackage(admin);
3185 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003186 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003187 }
3188 }
3189 return null;
3190 }
3191
3192 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003193 * Called by an application that is administering the device to disable all cameras on the
3194 * device, for this user. After setting this, no applications running as this user will be able
3195 * to access any cameras on the device.
3196 * <p>
3197 * If the caller is device owner, then the restriction will be applied to all users.
3198 * <p>
3199 * The calling device admin must have requested
3200 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3201 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003202 *
3203 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3204 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003205 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3206 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003207 */
Robin Lee25e26452015-06-02 09:56:29 -07003208 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003209 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07003210 if (mService != null) {
3211 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003212 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003213 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003214 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003215 }
3216 }
3217 }
3218
3219 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003220 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003221 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003222 * @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 -07003223 * have disabled the camera
3224 */
Robin Lee25e26452015-06-02 09:56:29 -07003225 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003226 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003227 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003228 }
3229
3230 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003231 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003232 if (mService != null) {
3233 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003234 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003235 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003236 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003237 }
3238 }
3239 return false;
3240 }
3241
3242 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003243 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003244 * <p>
3245 * There must be only one user on the device, managed by the device owner. Otherwise a
3246 * {@link SecurityException} will be thrown.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003247 *
3248 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003249 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3250 * wasn't triggered because a previous bugreport operation is still active (either the
3251 * bugreport is still running or waiting for the user to share or decline)
3252 * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3253 * than the one managed by the device owner.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003254 */
3255 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003256 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003257 if (mService != null) {
3258 try {
3259 return mService.requestBugreport(admin);
3260 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003261 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003262 }
3263 }
3264 return false;
3265 }
3266
3267 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07003268 * Determine whether or not creating a guest user has been disabled for the device
3269 *
3270 * @hide
3271 */
3272 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3273 // Currently guest users can always be created if multi-user is enabled
3274 // TODO introduce a policy for guest user creation
3275 return false;
3276 }
3277
3278 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01003279 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3280 * screen capture also prevents the content from being shown on display devices that do not have
3281 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3282 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003283 * <p>
3284 * The calling device admin must be a device or profile owner. If it is not, a security
3285 * exception will be thrown.
3286 * <p>
3287 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3288 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01003289 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003290 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003291 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003292 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003293 */
Robin Lee25e26452015-06-02 09:56:29 -07003294 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003295 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003296 if (mService != null) {
3297 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003298 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003299 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003300 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003301 }
3302 }
3303 }
3304
3305 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003306 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003307 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003308 * @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 +01003309 * have disabled screen capture.
3310 */
Robin Lee25e26452015-06-02 09:56:29 -07003311 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003312 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003313 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003314 }
3315
3316 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003317 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003318 if (mService != null) {
3319 try {
3320 return mService.getScreenCaptureDisabled(admin, userHandle);
3321 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003322 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003323 }
3324 }
3325 return false;
3326 }
3327
3328 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003329 * Called by a device owner to set whether auto time is required. If auto time is required the
3330 * user cannot set the date and time, but has to use network date and time.
3331 * <p>
3332 * Note: if auto time is required the user can still manually set the time zone.
3333 * <p>
3334 * The calling device admin must be a device owner. If it is not, a security exception will be
3335 * thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003336 *
3337 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3338 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003339 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003340 */
Robin Lee25e26452015-06-02 09:56:29 -07003341 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003342 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003343 if (mService != null) {
3344 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003345 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003346 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003347 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003348 }
3349 }
3350 }
3351
3352 /**
3353 * @return true if auto time is required.
3354 */
3355 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003356 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003357 if (mService != null) {
3358 try {
3359 return mService.getAutoTimeRequired();
3360 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003361 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003362 }
3363 }
3364 return false;
3365 }
3366
3367 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003368 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003369 * <p>
3370 * The system user is exempt from this policy - it is never ephemeral.
3371 * <p>
3372 * The calling device admin must be the device owner. If it is not, a security exception will be
3373 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003374 *
3375 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3376 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003377 * subsequently created users will be ephemeral.
3378 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003379 * @hide
3380 */
3381 public void setForceEphemeralUsers(
3382 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003383 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003384 if (mService != null) {
3385 try {
3386 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3387 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003388 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003389 }
3390 }
3391 }
3392
3393 /**
3394 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003395 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003396 * @hide
3397 */
3398 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003399 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003400 if (mService != null) {
3401 try {
3402 return mService.getForceEphemeralUsers(admin);
3403 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003404 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003405 }
3406 }
3407 return false;
3408 }
3409
3410 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003411 * Called by an application that is administering the device to disable keyguard customizations,
3412 * such as widgets. After setting this, keyguard features will be disabled according to the
3413 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003414 * <p>
3415 * The calling device admin must have requested
3416 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3417 * if it has not, a security exception will be thrown.
3418 * <p>
3419 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3420 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3421 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003422 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003423 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003424 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00003425 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003426 * there is one, or the parent user otherwise.
3427 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3428 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003429 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003430 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3431 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003432 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3433 * profile.
3434 * <p>
3435 * Requests to disable other features on a managed profile will be ignored.
3436 * <p>
3437 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003438 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003439 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003440 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003441 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003442 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3443 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3444 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3445 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3446 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3447 * @throws SecurityException if {@code admin} is not an active administrator or does not user
3448 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07003449 */
Robin Lee25e26452015-06-02 09:56:29 -07003450 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003451 if (mService != null) {
3452 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003453 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003454 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003455 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003456 }
3457 }
3458 }
3459
3460 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003461 * Determine whether or not features have been disabled in keyguard either by the calling
Rubin Xud3609d42016-07-13 18:32:57 +01003462 * admin, if specified, or all admins that set restrictions on this user and its participating
Esteban Talaverac1c83592016-02-17 17:56:15 +00003463 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3464 *
3465 * <p>This method can be called on the {@link DevicePolicyManager} instance
3466 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3467 * restrictions on the parent profile.
3468 *
Esteban Talavera62399912016-01-11 15:37:55 +00003469 * @param admin The name of the admin component to check, or {@code null} to check whether any
3470 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003471 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3472 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003473 */
Robin Lee25e26452015-06-02 09:56:29 -07003474 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003475 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003476 }
3477
3478 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003479 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003480 if (mService != null) {
3481 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003482 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003483 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003484 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003485 }
3486 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003487 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003488 }
3489
3490 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003491 * @hide
3492 */
Robin Lee25e26452015-06-02 09:56:29 -07003493 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3494 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003495 if (mService != null) {
3496 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003497 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003498 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003499 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003500 }
3501 }
3502 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003503
Dianne Hackbornd6847842010-01-12 18:14:19 -08003504 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003505 * @hide
3506 */
Robin Lee25e26452015-06-02 09:56:29 -07003507 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003508 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003509 }
3510
3511 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003512 * @hide
3513 */
Robin Lee25e26452015-06-02 09:56:29 -07003514 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003515 if (mService != null) {
3516 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003517 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003518 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003519 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003520 }
3521 }
3522 }
3523
3524 /**
3525 * @hide
3526 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003527 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003528 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003529 if (mService != null) {
3530 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003531 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003532 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003533 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003534 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003535 }
3536 }
3537 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003538
Dianne Hackbornd6847842010-01-12 18:14:19 -08003539 /**
3540 * @hide
3541 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003542 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003543 if (mService != null) {
3544 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003545 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003546 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003547 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003548 }
3549 }
3550 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003551
Dianne Hackbornd6847842010-01-12 18:14:19 -08003552 /**
3553 * @hide
3554 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003555 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003556 if (mService != null) {
3557 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003558 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003559 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003560 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003561 }
3562 }
3563 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003564
3565 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003566 * @hide
3567 */
3568 public void reportFailedFingerprintAttempt(int userHandle) {
3569 if (mService != null) {
3570 try {
3571 mService.reportFailedFingerprintAttempt(userHandle);
3572 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003573 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003574 }
3575 }
3576 }
3577
3578 /**
3579 * @hide
3580 */
3581 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3582 if (mService != null) {
3583 try {
3584 mService.reportSuccessfulFingerprintAttempt(userHandle);
3585 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003586 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003587 }
3588 }
3589 }
3590
3591 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003592 * Should be called when keyguard has been dismissed.
3593 * @hide
3594 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003595 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003596 if (mService != null) {
3597 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003598 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003599 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003600 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003601 }
3602 }
3603 }
3604
3605 /**
3606 * Should be called when keyguard view has been shown to the user.
3607 * @hide
3608 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003609 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003610 if (mService != null) {
3611 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003612 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003613 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003614 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003615 }
3616 }
3617 }
3618
3619 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003620 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003621 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003622 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3623 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003624 * @return whether the package was successfully registered as the device owner.
3625 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003626 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003627 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003628 public boolean setDeviceOwner(ComponentName who) {
3629 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003630 }
3631
3632 /**
3633 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003634 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003635 public boolean setDeviceOwner(ComponentName who, int userId) {
3636 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003637 }
3638
3639 /**
3640 * @hide
3641 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003642 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3643 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003644 }
3645
3646 /**
3647 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003648 * Sets the given package as the device owner. The package must already be installed. There
3649 * must not already be a device owner.
3650 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3651 * this method.
3652 * Calling this after the setup phase of the primary user has completed is allowed only if
3653 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003654 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003655 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003656 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003657 * @return whether the package was successfully registered as the device owner.
3658 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003659 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003660 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003661 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003662 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003663 if (mService != null) {
3664 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003665 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003666 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003667 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003668 }
3669 }
3670 return false;
3671 }
3672
3673 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003674 * Used to determine if a particular package has been registered as a Device Owner app.
3675 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003676 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003677 * package is currently registered as the device owner app, pass in the package name from
3678 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003679 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003680 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3681 * the setup process.
3682 * @param packageName the package name of the app, to compare with the registered device owner
3683 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003684 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003685 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003686 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003687 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003688 return isDeviceOwnerAppOnCallingUser(packageName);
3689 }
3690
3691 /**
3692 * @return true if a package is registered as device owner, only when it's running on the
3693 * calling user.
3694 *
3695 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3696 * @hide
3697 */
3698 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3699 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3700 }
3701
3702 /**
3703 * @return true if a package is registered as device owner, even if it's running on a different
3704 * user.
3705 *
3706 * <p>Requires the MANAGE_USERS permission.
3707 *
3708 * @hide
3709 */
3710 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3711 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3712 }
3713
3714 /**
3715 * @return device owner component name, only when it's running on the calling user.
3716 *
3717 * @hide
3718 */
3719 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3720 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3721 }
3722
3723 /**
3724 * @return device owner component name, even if it's running on a different user.
3725 *
3726 * <p>Requires the MANAGE_USERS permission.
3727 *
3728 * @hide
3729 */
3730 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3731 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3732 }
3733
3734 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003735 if (packageName == null) {
3736 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003737 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003738 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003739 if (deviceOwner == null) {
3740 return false;
3741 }
3742 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003743 }
3744
Makoto Onukic8a5a552015-11-19 14:29:12 -08003745 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3746 if (mService != null) {
3747 try {
3748 return mService.getDeviceOwnerComponent(callingUserOnly);
3749 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003750 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003751 }
3752 }
3753 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003754 }
3755
Jason Monkb0dced82014-06-06 14:36:20 -04003756 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003757 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3758 * no device owner.
3759 *
3760 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003761 *
3762 * @hide
3763 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003764 public int getDeviceOwnerUserId() {
3765 if (mService != null) {
3766 try {
3767 return mService.getDeviceOwnerUserId();
3768 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003769 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003770 }
3771 }
3772 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003773 }
3774
3775 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003776 * Clears the current device owner. The caller must be the device owner. This function should be
3777 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3778 * a part of device setup before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003779 *
3780 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003781 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3782 * does not own the current device owner component.
Jason Monkb0dced82014-06-06 14:36:20 -04003783 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003784 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003785 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04003786 if (mService != null) {
3787 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003788 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003789 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003790 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04003791 }
3792 }
3793 }
3794
Makoto Onukia52562c2015-10-01 16:12:31 -07003795 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003796 * Returns the device owner package name, only if it's running on the calling user.
3797 *
3798 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003799 *
3800 * @hide
3801 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003802 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003803 public String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003804 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003805 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3806 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003807 }
3808
3809 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003810 * @return true if the device is managed by any device owner.
3811 *
3812 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003813 *
3814 * @hide
3815 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003816 public boolean isDeviceManaged() {
3817 return getDeviceOwnerComponentOnAnyUser() != null;
3818 }
3819
3820 /**
3821 * Returns the device owner name. Note this method *will* return the device owner
3822 * name when it's running on a different user.
3823 *
3824 * <p>Requires the MANAGE_USERS permission.
3825 *
3826 * @hide
3827 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003828 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003829 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003830 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07003831 if (mService != null) {
3832 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003833 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003834 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003835 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003836 }
3837 }
3838 return null;
3839 }
Adam Connors776c5552014-01-09 10:42:56 +00003840
3841 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003842 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003843 * @deprecated Do not use
3844 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003845 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003846 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003847 @SystemApi
3848 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003849 return null;
3850 }
3851
3852 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003853 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003854 * @deprecated Do not use
3855 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003856 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003857 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003858 @SystemApi
3859 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003860 return null;
3861 }
3862
Julia Reynolds20118f12015-02-11 12:34:08 -05003863 /**
Adam Connors776c5552014-01-09 10:42:56 +00003864 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003865 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303866 * Sets the given component as an active admin and registers the package as the profile
3867 * owner for this user. The package must already be installed and there shouldn't be
3868 * an existing profile owner registered for this user. Also, this method must be called
3869 * before the user setup has been completed.
3870 * <p>
3871 * This method can only be called by system apps that hold MANAGE_USERS permission and
3872 * MANAGE_DEVICE_ADMINS permission.
3873 * @param admin The component to register as an active admin and profile owner.
3874 * @param ownerName The user-visible name of the entity that is managing this user.
3875 * @return whether the admin was successfully registered as the profile owner.
3876 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3877 * the user has already been set up.
3878 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003879 @Deprecated
Justin Morey80440cc2014-07-24 09:16:35 -05003880 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003881 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303882 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003883 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303884 if (mService != null) {
3885 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003886 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303887 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003888 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303889 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003890 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303891 }
3892 }
3893 return false;
3894 }
3895
3896 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003897 * Clears the active profile owner and removes all user restrictions. The caller must be from
3898 * the same package as the active profile owner for this user, otherwise a SecurityException
3899 * will be thrown.
3900 * <p>
3901 * This doesn't work for managed profile owners.
Makoto Onuki5bf68022016-01-27 13:49:19 -08003902 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003903 * @param admin The component to remove as the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003904 * @throws SecurityException if {@code admin} is not an active profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003905 */
Robin Lee25e26452015-06-02 09:56:29 -07003906 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003907 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003908 if (mService != null) {
3909 try {
3910 mService.clearProfileOwner(admin);
3911 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003912 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003913 }
3914 }
3915 }
3916
3917 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003918 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003919 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003920 */
3921 public boolean hasUserSetupCompleted() {
3922 if (mService != null) {
3923 try {
3924 return mService.hasUserSetupCompleted();
3925 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003926 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003927 }
3928 }
3929 return true;
3930 }
3931
3932 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003933 * @hide
3934 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003935 * already be installed. There must not already be a profile owner for this user.
3936 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3937 * this method.
3938 * Calling this after the setup phase of the specified user has completed is allowed only if:
3939 * - the caller is SYSTEM_UID.
3940 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003941 * @param admin the component name to be registered as profile owner.
3942 * @param ownerName the human readable name of the organisation associated with this DPM.
3943 * @param userHandle the userId to set the profile owner for.
3944 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003945 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3946 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003947 */
Robin Lee25e26452015-06-02 09:56:29 -07003948 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003949 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003950 if (mService != null) {
3951 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003952 if (ownerName == null) {
3953 ownerName = "";
3954 }
3955 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003956 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003957 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003958 }
3959 }
3960 return false;
3961 }
3962
3963 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003964 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003965 * <p>
3966 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003967 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003968 * <p>
3969 * If the device owner information contains only whitespaces then the message on the lock screen
3970 * will be blank and the user will not be allowed to change it.
3971 * <p>
3972 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003973 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3974 * and set a new version of this string accordingly.
3975 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003976 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003977 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003978 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003979 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003980 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003981 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003982 if (mService != null) {
3983 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003984 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003985 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003986 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003987 }
3988 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003989 }
3990
3991 /**
3992 * @return The device owner information. If it is not set returns {@code null}.
3993 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003994 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003995 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003996 if (mService != null) {
3997 try {
3998 return mService.getDeviceOwnerLockScreenInfo();
3999 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004000 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004001 }
4002 }
4003 return null;
4004 }
4005
4006 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004007 * Called by device or profile owners to suspend packages for this user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004008 * <p>
4009 * A suspended package will not be able to start activities. Its notifications will be hidden,
4010 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
4011 * device.
4012 * <p>
4013 * The package must already be installed. If the package is uninstalled while suspended the
4014 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00004015 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004016 *
4017 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004018 * @param packageNames The package names to suspend or unsuspend.
4019 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004020 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004021 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004022 * this method.
4023 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004024 */
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004025 public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004026 boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004027 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004028 if (mService != null) {
4029 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004030 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004031 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004032 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004033 }
4034 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004035 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004036 }
4037
4038 /**
4039 * Called by device or profile owners to determine if a package is suspended.
4040 *
4041 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4042 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00004043 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004044 * suspended, could not be found or an error occurred.
4045 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004046 * @throws NameNotFoundException if the package could not be found.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004047 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004048 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
4049 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004050 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004051 if (mService != null) {
4052 try {
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004053 return mService.isPackageSuspended(admin, packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004054 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004055 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004056 } catch (IllegalArgumentException ex) {
4057 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004058 }
4059 }
4060 return false;
4061 }
4062
4063 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004064 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
4065 * be used. Only the profile owner can call this.
4066 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01004067 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004068 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004069 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004070 */
Robin Lee25e26452015-06-02 09:56:29 -07004071 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004072 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004073 if (mService != null) {
4074 try {
4075 mService.setProfileEnabled(admin);
4076 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004077 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004078 }
4079 }
4080 }
4081
4082 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004083 * Sets the name of the profile. In the device owner case it sets the name of the user which it
4084 * is called from. Only a profile owner or device owner can call this. If this is never called
4085 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004086 *
4087 * @see #isProfileOwnerApp
4088 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07004089 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004090 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004091 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004092 */
Robin Lee25e26452015-06-02 09:56:29 -07004093 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004094 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01004095 if (mService != null) {
4096 try {
Robin Lee25e26452015-06-02 09:56:29 -07004097 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004098 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004099 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004100 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004101 }
4102 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004103
4104 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004105 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08004106 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004107 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00004108 *
4109 * @param packageName The package name of the app to compare with the registered profile owner.
4110 * @return Whether or not the package is registered as the profile owner.
4111 */
4112 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004113 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00004114 if (mService != null) {
4115 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08004116 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01004117 return profileOwner != null
4118 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004119 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004120 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004121 }
4122 }
4123 return false;
4124 }
4125
4126 /**
4127 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004128 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004129 * owner has been set for that user.
4130 * @throws IllegalArgumentException if the userId is invalid.
4131 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004132 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004133 public ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004134 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004135 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4136 }
4137
4138 /**
4139 * @see #getProfileOwner()
4140 * @hide
4141 */
4142 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004143 if (mService != null) {
4144 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004145 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00004146 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004147 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004148 }
4149 }
4150 return null;
4151 }
4152
4153 /**
4154 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004155 * @return the human readable name of the organisation associated with this DPM or {@code null}
4156 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00004157 * @throws IllegalArgumentException if the userId is invalid.
4158 */
4159 public String getProfileOwnerName() throws IllegalArgumentException {
4160 if (mService != null) {
4161 try {
4162 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4163 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004164 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004165 }
4166 }
4167 return null;
4168 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004169
4170 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07004171 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08004172 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07004173 * @return the human readable name of the organisation associated with this profile owner or
4174 * null if one is not set.
4175 * @throws IllegalArgumentException if the userId is invalid.
4176 */
4177 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02004178 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004179 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07004180 if (mService != null) {
4181 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02004182 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07004183 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004184 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07004185 }
4186 }
4187 return null;
4188 }
4189
4190 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004191 * Called by a profile owner or device owner to add a default intent handler activity for
4192 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004193 * handler even if the set of potential event handlers for the intent filter changes and if the
4194 * intent preferences are reset.
4195 * <p>
4196 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
4197 * When the activity is (re)installed, it is automatically reset as default intent handler for
4198 * the filter.
4199 * <p>
4200 * The calling device admin must be a profile owner or device owner. If it is not, a security
4201 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004202 *
4203 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4204 * @param filter The IntentFilter for which a default handler is added.
4205 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004206 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004207 */
Robin Lee25e26452015-06-02 09:56:29 -07004208 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
4209 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004210 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004211 if (mService != null) {
4212 try {
4213 mService.addPersistentPreferredActivity(admin, filter, activity);
4214 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004215 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004216 }
4217 }
4218 }
4219
4220 /**
4221 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00004222 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004223 * <p>
4224 * The calling device admin must be a profile owner. If it is not, a security exception will be
4225 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004226 *
4227 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4228 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004229 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004230 */
Robin Lee25e26452015-06-02 09:56:29 -07004231 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004232 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004233 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004234 if (mService != null) {
4235 try {
4236 mService.clearPackagePersistentPreferredActivities(admin, packageName);
4237 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004238 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004239 }
4240 }
4241 }
Robin Lee66e5d962014-04-09 16:44:21 +01004242
4243 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004244 * Called by a profile owner or device owner to grant permission to a package to manage
4245 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4246 * {@link #getApplicationRestrictions}.
4247 * <p>
4248 * This permission is persistent until it is later cleared by calling this method with a
4249 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00004250 * <p>
4251 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00004252 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004253 *
4254 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4255 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004256 * APIs. If {@code null} is given the current package will be cleared.
4257 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00004258 * @throws NameNotFoundException if {@code packageName} is not found
Esteban Talaverabf60f722015-12-10 16:26:44 +00004259 */
4260 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00004261 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004262 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004263 if (mService != null) {
4264 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00004265 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4266 throw new NameNotFoundException(packageName);
4267 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00004268 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004269 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004270 }
4271 }
4272 }
4273
4274 /**
4275 * Called by a profile owner or device owner to retrieve the application restrictions managing
4276 * package for the current user, or {@code null} if none is set.
4277 *
4278 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4279 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004280 * {@code null} if none is set.
4281 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004282 */
4283 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004284 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004285 if (mService != null) {
4286 try {
4287 return mService.getApplicationRestrictionsManagingPackage(admin);
4288 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004289 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004290 }
4291 }
4292 return null;
4293 }
4294
4295 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00004296 * Called by any application to find out whether it has been granted permission via
4297 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4298 * for the calling user.
4299 *
4300 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4301 * that method.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004302 */
4303 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004304 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004305 if (mService != null) {
4306 try {
4307 return mService.isCallerApplicationRestrictionsManagingPackage();
4308 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004309 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004310 }
4311 }
4312 return false;
4313 }
4314
4315 /**
4316 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004317 * <p>
4318 * The caller must be a profile or device owner on that user, or the package allowed to manage
4319 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4320 * security exception will be thrown.
4321 * <p>
4322 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01004323 * <ul>
4324 * <li>{@code boolean}
4325 * <li>{@code int}
4326 * <li>{@code String} or {@code String[]}
4327 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4328 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004329 * <p>
4330 * If the restrictions are not available yet, but may be applied in the near future, the caller
4331 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004332 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004333 * <p>
4334 * The application restrictions are only made visible to the target application via
4335 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4336 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00004337 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01004338 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07004339 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
4340 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004341 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004342 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004343 * @param packageName The name of the package to update restricted settings for.
4344 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004345 * set of active restrictions.
4346 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004347 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004348 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01004349 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07004350 @WorkerThread
Esteban Talaverabf60f722015-12-10 16:26:44 +00004351 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01004352 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004353 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004354 if (mService != null) {
4355 try {
4356 mService.setApplicationRestrictions(admin, packageName, settings);
4357 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004358 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004359 }
4360 }
4361 }
4362
4363 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004364 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4365 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4366 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07004367 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004368 * <p>
4369 * The calling device admin must have requested
4370 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4371 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01004372 * <p>
4373 * This method can be called on the {@link DevicePolicyManager} instance returned by
4374 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
4375 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004376 *
4377 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004378 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004379 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4380 * strictly disabled according to the state of the
4381 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4382 * <p>
4383 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4384 * admins, then it's up to the TrustAgent itself to aggregate the values from all
4385 * device admins.
4386 * <p>
4387 * Consult documentation for the specific TrustAgent to determine legal options
4388 * parameters.
4389 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4390 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07004391 */
Robin Lee25e26452015-06-02 09:56:29 -07004392 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4393 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004394 if (mService != null) {
4395 try {
Tony Mak089d8402016-04-05 17:42:55 +01004396 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004397 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004398 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004399 }
4400 }
4401 }
4402
4403 /**
Jim Millere303bf42014-08-26 17:12:29 -07004404 * Gets configuration for the given trust agent based on aggregating all calls to
4405 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4406 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01004407 * <p>
4408 * This method can be called on the {@link DevicePolicyManager} instance returned by
4409 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
4410 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004411 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004412 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4413 * this function returns a list of configurations for all admins that declare
4414 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4415 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4416 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4417 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004418 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004419 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004420 */
Robin Lee25e26452015-06-02 09:56:29 -07004421 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4422 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004423 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004424 }
4425
4426 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004427 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4428 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004429 if (mService != null) {
4430 try {
Tony Mak089d8402016-04-05 17:42:55 +01004431 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
4432 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004433 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004434 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004435 }
4436 }
Jim Millere303bf42014-08-26 17:12:29 -07004437 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004438 }
4439
4440 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004441 * Called by a profile owner of a managed profile to set whether caller-Id information from the
4442 * managed profile will be shown in the parent profile, for incoming calls.
4443 * <p>
4444 * The calling device admin must be a profile owner. If it is not, a security exception will be
4445 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004446 *
Robin Lee25e26452015-06-02 09:56:29 -07004447 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004448 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004449 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004450 */
Robin Lee25e26452015-06-02 09:56:29 -07004451 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004452 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004453 if (mService != null) {
4454 try {
Robin Lee25e26452015-06-02 09:56:29 -07004455 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004456 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004457 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004458 }
4459 }
4460 }
4461
4462 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004463 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4464 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004465 * <p>
4466 * The calling device admin must be a profile owner. If it is not, a security exception will be
4467 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004468 *
Robin Lee25e26452015-06-02 09:56:29 -07004469 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004470 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004471 */
Robin Lee25e26452015-06-02 09:56:29 -07004472 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004473 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004474 if (mService != null) {
4475 try {
Robin Lee25e26452015-06-02 09:56:29 -07004476 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004477 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004478 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004479 }
4480 }
4481 return false;
4482 }
4483
4484 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004485 * Determine whether or not caller-Id information has been disabled.
4486 *
4487 * @param userHandle The user for whom to check the caller-id permission
4488 * @hide
4489 */
4490 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4491 if (mService != null) {
4492 try {
4493 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4494 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004495 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07004496 }
4497 }
4498 return false;
4499 }
4500
4501 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004502 * Called by a profile owner of a managed profile to set whether contacts search from the
4503 * managed profile will be shown in the parent profile, for incoming calls.
4504 * <p>
4505 * The calling device admin must be a profile owner. If it is not, a security exception will be
4506 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004507 *
4508 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4509 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004510 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004511 */
4512 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4513 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004514 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004515 if (mService != null) {
4516 try {
4517 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4518 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004519 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004520 }
4521 }
4522 }
4523
4524 /**
4525 * Called by a profile owner of a managed profile to determine whether or not contacts search
4526 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004527 * <p>
4528 * The calling device admin must be a profile owner. If it is not, a security exception will be
4529 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004530 *
4531 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004532 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004533 */
4534 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004535 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004536 if (mService != null) {
4537 try {
4538 return mService.getCrossProfileContactsSearchDisabled(admin);
4539 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004540 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004541 }
4542 }
4543 return false;
4544 }
4545
4546
4547 /**
4548 * Determine whether or not contacts search has been disabled.
4549 *
4550 * @param userHandle The user for whom to check the contacts search permission
4551 * @hide
4552 */
4553 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4554 if (mService != null) {
4555 try {
4556 return mService
4557 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4558 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004559 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004560 }
4561 }
4562 return false;
4563 }
4564
4565 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004566 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004567 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004568 * @hide
4569 */
4570 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004571 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004572 if (mService != null) {
4573 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004574 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4575 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004576 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004577 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07004578 }
4579 }
4580 }
4581
4582 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004583 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004584 * @hide
4585 */
4586 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4587 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004588 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004589 originalIntent);
4590 }
4591
4592 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004593 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4594 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004595 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004596 * The calling device admin must be a profile owner. If it is not, a security exception will be
4597 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004598 * <p>
4599 * This API works on managed profile only.
4600 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004601 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4602 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4603 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004604 */
Robin Lee25e26452015-06-02 09:56:29 -07004605 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004606 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004607 if (mService != null) {
4608 try {
Robin Lee25e26452015-06-02 09:56:29 -07004609 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004610 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004611 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004612 }
4613 }
4614 }
4615
4616 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004617 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4618 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004619 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004620 * The calling device admin must be a profile owner. If it is not, a security exception will be
4621 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004622 * <p>
4623 * This API works on managed profile only.
4624 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004625 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4626 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004627 */
Robin Lee25e26452015-06-02 09:56:29 -07004628 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004629 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004630 if (mService != null) {
4631 try {
Robin Lee25e26452015-06-02 09:56:29 -07004632 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004633 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004634 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004635 }
4636 }
4637 return true;
4638 }
4639
4640 /**
4641 * Determine whether or not Bluetooth devices cannot access contacts.
4642 * <p>
4643 * This API works on managed profile UserHandle only.
4644 *
4645 * @param userHandle The user for whom to check the caller-id permission
4646 * @hide
4647 */
4648 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4649 if (mService != null) {
4650 try {
4651 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4652 .getIdentifier());
4653 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004654 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004655 }
4656 }
4657 return true;
4658 }
4659
4660 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004661 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004662 * profile can also be resolved in the parent, or vice versa. Only activity intents are
4663 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004664 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004665 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004666 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004667 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004668 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004669 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4670 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004671 */
Robin Lee25e26452015-06-02 09:56:29 -07004672 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004673 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004674 if (mService != null) {
4675 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004676 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004677 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004678 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004679 }
4680 }
4681 }
4682
4683 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004684 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4685 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004686 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004687 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004688 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004689 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004690 */
Robin Lee25e26452015-06-02 09:56:29 -07004691 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004692 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004693 if (mService != null) {
4694 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004695 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004696 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004697 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004698 }
4699 }
4700 }
4701
4702 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004703 * Called by a profile or device owner to set the permitted accessibility services. When set by
4704 * a device owner or profile owner the restriction applies to all profiles of the user the
4705 * device owner or profile owner is an admin for. By default the user can use any accessiblity
4706 * service. When zero or more packages have been added, accessiblity services that are not in
4707 * the list and not part of the system can not be enabled by the user.
4708 * <p>
4709 * Calling with a null value for the list disables the restriction so that all services can be
4710 * used, calling with an empty list only allows the builtin system's services.
4711 * <p>
4712 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004713 *
4714 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4715 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004716 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4717 * accessibility services enabled, that are not in the list.
4718 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004719 */
Robin Lee25e26452015-06-02 09:56:29 -07004720 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004721 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004722 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004723 if (mService != null) {
4724 try {
4725 return mService.setPermittedAccessibilityServices(admin, packageNames);
4726 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004727 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004728 }
4729 }
4730 return false;
4731 }
4732
4733 /**
4734 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004735 * <p>
4736 * An empty list means no accessibility services except system services are allowed. Null means
4737 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004738 *
4739 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4740 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004741 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004742 */
Robin Lee25e26452015-06-02 09:56:29 -07004743 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004744 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004745 if (mService != null) {
4746 try {
4747 return mService.getPermittedAccessibilityServices(admin);
4748 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004749 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004750 }
4751 }
4752 return null;
4753 }
4754
4755 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004756 * Called by the system to check if a specific accessibility service is disabled by admin.
4757 *
4758 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4759 * @param packageName Accessibility service package name that needs to be checked.
4760 * @param userHandle user id the admin is running as.
4761 * @return true if the accessibility service is permitted, otherwise false.
4762 *
4763 * @hide
4764 */
4765 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4766 @NonNull String packageName, int userHandle) {
4767 if (mService != null) {
4768 try {
4769 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4770 userHandle);
4771 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004772 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004773 }
4774 }
4775 return false;
4776 }
4777
4778 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004779 * Returns the list of accessibility services permitted by the device or profiles
4780 * owners of this user.
4781 *
4782 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4783 * it will contain the intersection of the permitted lists for any device or profile
4784 * owners that apply to this user. It will also include any system accessibility services.
4785 *
4786 * @param userId which user to check for.
4787 * @return List of accessiblity service package names.
4788 * @hide
4789 */
4790 @SystemApi
4791 public List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004792 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004793 if (mService != null) {
4794 try {
4795 return mService.getPermittedAccessibilityServicesForUser(userId);
4796 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004797 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004798 }
4799 }
4800 return null;
4801 }
4802
4803 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004804 * Called by a profile or device owner to set the permitted input methods services. When set by
4805 * a device owner or profile owner the restriction applies to all profiles of the user the
4806 * device owner or profile owner is an admin for. By default the user can use any input method.
4807 * When zero or more packages have been added, input method that are not in the list and not
4808 * part of the system can not be enabled by the user. This method will fail if it is called for
4809 * a admin that is not for the foreground user or a profile of the foreground user.
4810 * <p>
4811 * Calling with a null value for the list disables the restriction so that all input methods can
4812 * be used, calling with an empty list disables all but the system's own input methods.
4813 * <p>
4814 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004815 *
4816 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4817 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004818 * @return true if setting the restriction succeeded. It will fail if there are one or more
4819 * non-system input methods currently enabled that are not in the packageNames list.
4820 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004821 */
Robin Lee25e26452015-06-02 09:56:29 -07004822 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004823 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004824 if (mService != null) {
4825 try {
4826 return mService.setPermittedInputMethods(admin, packageNames);
4827 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004828 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004829 }
4830 }
4831 return false;
4832 }
4833
4834
4835 /**
4836 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004837 * <p>
4838 * An empty list means no input methods except system input methods are allowed. Null means all
4839 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004840 *
4841 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4842 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004843 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004844 */
Robin Lee25e26452015-06-02 09:56:29 -07004845 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004846 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004847 if (mService != null) {
4848 try {
4849 return mService.getPermittedInputMethods(admin);
4850 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004851 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004852 }
4853 }
4854 return null;
4855 }
4856
4857 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004858 * Called by the system to check if a specific input method is disabled by admin.
4859 *
4860 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4861 * @param packageName Input method package name that needs to be checked.
4862 * @param userHandle user id the admin is running as.
4863 * @return true if the input method is permitted, otherwise false.
4864 *
4865 * @hide
4866 */
4867 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4868 @NonNull String packageName, int userHandle) {
4869 if (mService != null) {
4870 try {
4871 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4872 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004873 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004874 }
4875 }
4876 return false;
4877 }
4878
4879 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004880 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004881 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004882 *
4883 * <p>Null means all input methods are allowed, if a non-null list is returned
4884 * it will contain the intersection of the permitted lists for any device or profile
4885 * owners that apply to this user. It will also include any system input methods.
4886 *
4887 * @return List of input method package names.
4888 * @hide
4889 */
4890 @SystemApi
4891 public List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004892 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004893 if (mService != null) {
4894 try {
4895 return mService.getPermittedInputMethodsForCurrentUser();
4896 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004897 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004898 }
4899 }
4900 return null;
4901 }
4902
4903 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004904 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4905 * currently installed it.
4906 *
4907 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4908 *
4909 * @return List of package names to keep cached.
4910 * @hide
4911 */
4912 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004913 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004914 if (mService != null) {
4915 try {
4916 return mService.getKeepUninstalledPackages(admin);
4917 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004918 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004919 }
4920 }
4921 return null;
4922 }
4923
4924 /**
4925 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4926 * currently installed it.
4927 *
4928 * <p>Please note that setting this policy does not imply that specified apps will be
4929 * automatically pre-cached.</p>
4930 *
4931 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4932 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004933 * @throws SecurityException if {@code admin} is not a device owner.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004934 * @hide
4935 */
4936 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4937 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004938 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004939 if (mService != null) {
4940 try {
4941 mService.setKeepUninstalledPackages(admin, packageNames);
4942 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004943 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004944 }
4945 }
4946 }
4947
4948 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004949 * Called by a device owner to create a user with the specified name. The UserHandle returned
4950 * by this method should not be persisted as user handles are recycled as users are removed and
4951 * created. If you need to persist an identifier for this user, use
4952 * {@link UserManager#getSerialNumberForUser}.
4953 *
4954 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4955 * @param name the user's name
4956 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004957 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4958 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004959 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004960 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004961 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004962 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004963 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004964 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004965 return null;
4966 }
4967
4968 /**
Jason Monk03978a42014-06-10 15:05:30 -04004969 * Called by a device owner to create a user with the specified name. The UserHandle returned
4970 * by this method should not be persisted as user handles are recycled as users are removed and
4971 * created. If you need to persist an identifier for this user, use
4972 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4973 * immediately.
4974 *
4975 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4976 * as registered as an active admin on the new user. The profile owner package will be
4977 * installed on the new user if it already is installed on the device.
4978 *
4979 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4980 * profileOwnerComponent when onEnable is called.
4981 *
4982 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4983 * @param name the user's name
4984 * @param ownerName the human readable name of the organisation associated with this DPM.
4985 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4986 * the user.
4987 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4988 * on the new user.
4989 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004990 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4991 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004992 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004993 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004994 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04004995 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004996 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004997 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4998 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004999 return null;
5000 }
5001
5002 /**
phweissa92e1212016-01-25 17:14:10 +01005003 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01005004 */
5005 public static final int SKIP_SETUP_WIZARD = 0x0001;
5006
5007 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01005008 * Flag used by {@link #createAndManageUser} to specify that the user should be created
5009 * ephemeral.
5010 * @hide
5011 */
5012 public static final int MAKE_USER_EPHEMERAL = 0x0002;
5013
5014 /**
phweissa92e1212016-01-25 17:14:10 +01005015 * Called by a device owner to create a user with the specified name and a given component of
5016 * the calling package as profile owner. The UserHandle returned by this method should not be
5017 * persisted as user handles are recycled as users are removed and created. If you need to
5018 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
5019 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005020 * <p>
5021 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
5022 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
5023 * be registered as an active admin on the new user. The profile owner package will be installed
5024 * on the new user.
5025 * <p>
5026 * If the adminExtras are not null, they will be stored on the device until the user is started
5027 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01005028 *
5029 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5030 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01005031 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005032 * same package as admin, otherwise no user is created and an
5033 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01005034 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005035 * user.
phweissa92e1212016-01-25 17:14:10 +01005036 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01005037 * @see UserHandle
5038 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5039 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005040 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01005041 */
5042 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01005043 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
5044 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005045 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01005046 try {
phweissa92e1212016-01-25 17:14:10 +01005047 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01005048 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005049 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01005050 }
phweiss343fb332016-01-25 14:48:59 +01005051 }
5052
5053 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005054 * Called by a device owner to remove a user and all associated data. The primary user can not
5055 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04005056 *
5057 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5058 * @param userHandle the user to remove.
5059 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005060 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04005061 */
Robin Lee25e26452015-06-02 09:56:29 -07005062 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005063 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04005064 try {
5065 return mService.removeUser(admin, userHandle);
5066 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005067 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04005068 }
5069 }
5070
5071 /**
Jason Monk582d9112014-07-09 19:57:08 -04005072 * Called by a device owner to switch the specified user to the foreground.
5073 *
5074 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5075 * @param userHandle the user to switch to; null will switch to primary.
5076 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005077 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04005078 * @see Intent#ACTION_USER_FOREGROUND
5079 */
Robin Lee25e26452015-06-02 09:56:29 -07005080 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005081 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04005082 try {
5083 return mService.switchUser(admin, userHandle);
5084 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005085 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04005086 }
5087 }
5088
5089 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00005090 * Retrieves the application restrictions for a given target application running in the calling
5091 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005092 * <p>
5093 * The caller must be a profile or device owner on that user, or the package allowed to manage
5094 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
5095 * security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01005096 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005097 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
5098 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00005099 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005100 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01005101 * @param packageName The name of the package to fetch restricted settings of.
5102 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005103 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
5104 * {@link Bundle} if no restrictions have been set.
5105 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005106 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01005107 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005108 @WorkerThread
Esteban Talaverabf60f722015-12-10 16:26:44 +00005109 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005110 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01005111 if (mService != null) {
5112 try {
5113 return mService.getApplicationRestrictions(admin, packageName);
5114 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005115 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01005116 }
5117 }
5118 return null;
5119 }
Amith Yamasanibe465322014-04-24 13:45:17 -07005120
5121 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005122 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005123 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005124 * The calling device admin must be a profile or device owner; if it is not, a security
5125 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005126 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005127 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5128 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5129 * for the list of keys.
5130 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005131 */
Robin Lee25e26452015-06-02 09:56:29 -07005132 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005133 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005134 if (mService != null) {
5135 try {
5136 mService.setUserRestriction(admin, key, true);
5137 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005138 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005139 }
5140 }
5141 }
5142
5143 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005144 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005145 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005146 * The calling device admin must be a profile or device owner; if it is not, a security
5147 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005148 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005149 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5150 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5151 * for the list of keys.
5152 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005153 */
Robin Lee25e26452015-06-02 09:56:29 -07005154 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005155 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005156 if (mService != null) {
5157 try {
5158 mService.setUserRestriction(admin, key, false);
5159 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005160 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005161 }
5162 }
5163 }
Adam Connors010cfd42014-04-16 12:48:13 +01005164
5165 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005166 * Called by a profile or device owner to get user restrictions set with
5167 * {@link #addUserRestriction(ComponentName, String)}.
5168 * <p>
5169 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005170 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005171 * {@link UserManager#getUserRestrictions()}.
5172 *
5173 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005174 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005175 */
5176 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005177 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005178 Bundle ret = null;
5179 if (mService != null) {
5180 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07005181 ret = mService.getUserRestrictions(admin);
5182 } catch (RemoteException e) {
5183 throw e.rethrowFromSystemServer();
5184 }
5185 }
5186 return ret == null ? new Bundle() : ret;
5187 }
5188
5189 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005190 * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
5191 * unavailable for use, but the data and actual package file remain.
Julia Reynolds966881e2014-05-14 12:23:08 -04005192 *
5193 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005194 * @param packageName The name of the package to hide or unhide.
5195 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005196 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005197 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005198 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005199 */
Robin Lee25e26452015-06-02 09:56:29 -07005200 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005201 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005202 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005203 if (mService != null) {
5204 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005205 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04005206 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005207 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005208 }
5209 }
5210 return false;
5211 }
5212
5213 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005214 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04005215 *
5216 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005217 * @param packageName The name of the package to retrieve the hidden status of.
5218 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005219 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005220 */
Robin Lee25e26452015-06-02 09:56:29 -07005221 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005222 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005223 if (mService != null) {
5224 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005225 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04005226 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005227 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005228 }
5229 }
5230 return false;
5231 }
5232
5233 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005234 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005235 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005236 *
5237 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08005238 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005239 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005240 */
Robin Lee25e26452015-06-02 09:56:29 -07005241 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005242 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005243 if (mService != null) {
5244 try {
5245 mService.enableSystemApp(admin, packageName);
5246 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005247 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005248 }
5249 }
5250 }
5251
5252 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005253 * Called by profile or device owners to re-enable system apps by intent that were disabled by
5254 * default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005255 *
5256 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5257 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005258 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00005259 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005260 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005261 */
Robin Lee25e26452015-06-02 09:56:29 -07005262 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005263 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005264 if (mService != null) {
5265 try {
5266 return mService.enableSystemAppWithIntent(admin, intent);
5267 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005268 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005269 }
5270 }
5271 return 0;
5272 }
5273
5274 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00005275 * Called by a device owner or profile owner to disable account management for a specific type
5276 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005277 * <p>
5278 * The calling device admin must be a device owner or profile owner. If it is not, a security
5279 * exception will be thrown.
5280 * <p>
5281 * When account management is disabled for an account type, adding or removing an account of
5282 * that type will not be possible.
5283 * <p>
5284 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00005285 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5286 * management for a specific type is disabled.
5287 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01005288 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5289 * @param accountType For which account management is disabled or enabled.
5290 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005291 * enabled (false).
5292 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01005293 */
Robin Lee25e26452015-06-02 09:56:29 -07005294 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01005295 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005296 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01005297 if (mService != null) {
5298 try {
5299 mService.setAccountManagementDisabled(admin, accountType, disabled);
5300 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005301 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01005302 }
5303 }
5304 }
5305
5306 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005307 * Gets the array of accounts for which account management is disabled by the profile owner.
5308 *
5309 * <p> Account management can be disabled/enabled by calling
5310 * {@link #setAccountManagementDisabled}.
5311 *
5312 * @return a list of account types for which account management has been disabled.
5313 *
5314 * @see #setAccountManagementDisabled
5315 */
5316 public String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005317 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005318 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005319 }
5320
5321 /**
5322 * @see #getAccountTypesWithManagementDisabled()
5323 * @hide
5324 */
5325 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005326 if (mService != null) {
5327 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005328 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005329 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005330 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005331 }
5332 }
5333
5334 return null;
5335 }
justinzhang511e0d82014-03-24 16:09:24 -04005336
5337 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005338 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005339 * <p>
5340 * Any packages that shares uid with an allowed package will also be allowed to activate lock
5341 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5342 * package list results in locked tasks belonging to those packages to be finished. This
5343 * function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005344 *
Jason Monkd7b86212014-06-16 13:15:38 -04005345 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04005346 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005347 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005348 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00005349 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5350 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04005351 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04005352 */
Robin Lee25e26452015-06-02 09:56:29 -07005353 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04005354 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005355 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005356 if (mService != null) {
5357 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005358 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04005359 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005360 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005361 }
5362 }
5363 }
5364
5365 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005366 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04005367 *
5368 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04005369 * @hide
5370 */
Robin Lee25e26452015-06-02 09:56:29 -07005371 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005372 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005373 if (mService != null) {
5374 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005375 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04005376 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005377 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005378 }
5379 }
5380 return null;
5381 }
5382
5383 /**
5384 * This function lets the caller know whether the given component is allowed to start the
5385 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04005386 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04005387 */
Jason Monkd7b86212014-06-16 13:15:38 -04005388 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005389 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04005390 if (mService != null) {
5391 try {
Jason Monkd7b86212014-06-16 13:15:38 -04005392 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04005393 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005394 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005395 }
5396 }
5397 return false;
5398 }
Julia Reynoldsda551652014-05-14 17:15:16 -04005399
5400 /**
5401 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5402 * of the setting is in the correct form for the setting type should be performed by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005403 * <p>
5404 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005405 * <ul>
5406 * <li>{@link Settings.Global#ADB_ENABLED}</li>
5407 * <li>{@link Settings.Global#AUTO_TIME}</li>
5408 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005409 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005410 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005411 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005412 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5413 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5414 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5415 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5416 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005417 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005418 * <p>
5419 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005420 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005421 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5422 * {@link android.bluetooth.BluetoothAdapter#enable()} and
5423 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005424 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005425 * <li>{@link Settings.Global#MODE_RINGER}. Use
5426 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005427 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005428 * <li>{@link Settings.Global#WIFI_ON}. Use
5429 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005430 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005431 *
5432 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5433 * @param setting The name of the setting to update.
5434 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005435 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005436 */
Robin Lee25e26452015-06-02 09:56:29 -07005437 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005438 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005439 if (mService != null) {
5440 try {
5441 mService.setGlobalSetting(admin, setting, value);
5442 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005443 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005444 }
5445 }
5446 }
5447
5448 /**
5449 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5450 * that the value of the setting is in the correct form for the setting type should be performed
5451 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005452 * <p>
5453 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005454 * <ul>
5455 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005456 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005457 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5458 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005459 * <p>
5460 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04005461 * <ul>
5462 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5463 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005464 *
Julia Reynoldsda551652014-05-14 17:15:16 -04005465 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5466 * @param setting The name of the setting to update.
5467 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005468 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005469 */
Robin Lee25e26452015-06-02 09:56:29 -07005470 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005471 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005472 if (mService != null) {
5473 try {
5474 mService.setSecureSetting(admin, setting, value);
5475 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005476 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005477 }
5478 }
5479 }
5480
Amith Yamasanif20d6402014-05-24 15:34:37 -07005481 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005482 * Designates a specific service component as the provider for making permission requests of a
5483 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005484 * <p/>
5485 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005486 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07005487 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005488 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005489 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5490 * provider previously assigned.
5491 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005492 */
Robin Lee25e26452015-06-02 09:56:29 -07005493 public void setRestrictionsProvider(@NonNull ComponentName admin,
5494 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005495 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07005496 if (mService != null) {
5497 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005498 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005499 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005500 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07005501 }
5502 }
5503 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005504
5505 /**
5506 * Called by profile or device owners to set the master volume mute on or off.
Nicolas Prevotaef3ce22016-09-22 12:00:25 +01005507 * This has no effect when set on a managed profile.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005508 *
5509 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5510 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005511 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005512 */
Robin Lee25e26452015-06-02 09:56:29 -07005513 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005514 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005515 if (mService != null) {
5516 try {
5517 mService.setMasterVolumeMuted(admin, on);
5518 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005519 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005520 }
5521 }
5522 }
5523
5524 /**
5525 * Called by profile or device owners to check whether the master volume mute is on or off.
5526 *
5527 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5528 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005529 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005530 */
Robin Lee25e26452015-06-02 09:56:29 -07005531 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005532 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005533 if (mService != null) {
5534 try {
5535 return mService.isMasterVolumeMuted(admin);
5536 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005537 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005538 }
5539 }
5540 return false;
5541 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005542
5543 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005544 * Called by profile or device owners to change whether a user can uninstall a package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005545 *
5546 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5547 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005548 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005549 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005550 */
Robin Lee25e26452015-06-02 09:56:29 -07005551 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005552 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005553 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005554 if (mService != null) {
5555 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005556 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005557 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005558 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005559 }
5560 }
5561 }
5562
5563 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005564 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005565 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005566 * <p>
5567 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005568 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5569 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5570 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005571 *
Robin Lee25e26452015-06-02 09:56:29 -07005572 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005573 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005574 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005575 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005576 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005577 */
Robin Lee25e26452015-06-02 09:56:29 -07005578 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005579 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005580 if (mService != null) {
5581 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005582 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005583 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005584 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005585 }
5586 }
5587 return false;
5588 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005589
5590 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005591 * Called by the profile owner of a managed profile to enable widget providers from a given
5592 * package to be available in the parent profile. As a result the user will be able to add
5593 * widgets from the white-listed package running under the profile to a widget host which runs
5594 * under the parent profile, for example the home screen. Note that a package may have zero or
5595 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07005596 * <p>
5597 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005598 *
5599 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5600 * @param packageName The package from which widget providers are white-listed.
5601 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005602 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005603 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5604 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5605 */
Robin Lee25e26452015-06-02 09:56:29 -07005606 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005607 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005608 if (mService != null) {
5609 try {
5610 return mService.addCrossProfileWidgetProvider(admin, packageName);
5611 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005612 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005613 }
5614 }
5615 return false;
5616 }
5617
5618 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005619 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005620 * package to be available in the parent profile. For this method to take effect the package
5621 * should have been added via
5622 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07005623 * <p>
5624 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005625 *
5626 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005627 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005628 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005629 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005630 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5631 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5632 */
Esteban Talavera62399912016-01-11 15:37:55 +00005633 public boolean removeCrossProfileWidgetProvider(
5634 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005635 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005636 if (mService != null) {
5637 try {
5638 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5639 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005640 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005641 }
5642 }
5643 return false;
5644 }
5645
5646 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005647 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005648 * available in the parent profile.
5649 *
5650 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5651 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07005652 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5653 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005654 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005655 */
Robin Lee25e26452015-06-02 09:56:29 -07005656 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005657 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07005658 if (mService != null) {
5659 try {
5660 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5661 if (providers != null) {
5662 return providers;
5663 }
5664 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005665 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005666 }
5667 }
5668 return Collections.emptyList();
5669 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005670
5671 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005672 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005673 *
5674 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5675 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005676 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005677 */
Robin Lee25e26452015-06-02 09:56:29 -07005678 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005679 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005680 try {
5681 mService.setUserIcon(admin, icon);
5682 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005683 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005684 }
5685 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005686
5687 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005688 * Called by device owners to set a local system update policy. When a new policy is set,
5689 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005690 *
Robin Lee25e26452015-06-02 09:56:29 -07005691 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005692 * components in the device owner package can set system update policies and the most
5693 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07005694 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005695 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005696 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005697 */
Robin Lee25e26452015-06-02 09:56:29 -07005698 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005699 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005700 if (mService != null) {
5701 try {
Robin Lee25e26452015-06-02 09:56:29 -07005702 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005703 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005704 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005705 }
5706 }
5707 }
5708
5709 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005710 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005711 *
Robin Lee25e26452015-06-02 09:56:29 -07005712 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005713 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01005714 public SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005715 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005716 if (mService != null) {
5717 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005718 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005719 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005720 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005721 }
5722 }
5723 return null;
5724 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005725
5726 /**
5727 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005728 * <p>
5729 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5730 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5731 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5732 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01005733 *
5734 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005735 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005736 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005737 * place. {@code true} otherwise.
5738 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01005739 */
Robin Lee25e26452015-06-02 09:56:29 -07005740 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005741 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01005742 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005743 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005744 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005745 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01005746 }
5747 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005748
5749 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005750 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005751 * notifications, quick settings and other screen overlays that allow escaping from a single use
5752 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005753 *
5754 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005755 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005756 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5757 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005758 */
Robin Lee25e26452015-06-02 09:56:29 -07005759 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005760 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00005761 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005762 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005763 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005764 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00005765 }
5766 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005767
5768 /**
5769 * Callable by the system update service to notify device owners about pending updates.
5770 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5771 * permission.
5772 *
5773 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5774 * when the current pending update was first available. -1 if no update is available.
5775 * @hide
5776 */
5777 @SystemApi
5778 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005779 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01005780 if (mService != null) {
5781 try {
5782 mService.notifyPendingSystemUpdate(updateReceivedTime);
5783 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005784 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01005785 }
5786 }
5787 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005788
5789 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005790 * Called by profile or device owners to set the default response for future runtime permission
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005791 * requests by applications. The policy can allow for normal operation which prompts the user to
5792 * grant a permission, or can allow automatic granting or denying of runtime permission requests
5793 * by an application. This also applies to new permissions declared by app updates. When a
5794 * permission is denied or granted this way, the effect is equivalent to setting the permission
5795 * grant state via {@link #setPermissionGrantState}.
5796 * <p/>
5797 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005798 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005799 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005800 * @param admin Which profile or device owner this request is associated with.
5801 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005802 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5803 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005804 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005805 */
Robin Lee25e26452015-06-02 09:56:29 -07005806 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005807 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005808 try {
5809 mService.setPermissionPolicy(admin, policy);
5810 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005811 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005812 }
5813 }
5814
5815 /**
5816 * Returns the current runtime permission policy set by the device or profile owner. The
5817 * default is {@link #PERMISSION_POLICY_PROMPT}.
5818 * @param admin Which profile or device owner this request is associated with.
5819 * @return the current policy for future permission requests.
5820 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005821 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005822 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005823 try {
5824 return mService.getPermissionPolicy(admin);
5825 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005826 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005827 }
5828 }
5829
5830 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005831 * Sets the grant state of a runtime permission for a specific application. The state can be
5832 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5833 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5834 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5835 * the permission is granted and the user cannot manage it through the UI. This might affect all
5836 * permissions in a group that the runtime permission belongs to. This method can only be called
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005837 * by a profile or device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005838 * <p/>
5839 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5840 * the permission. It retains the previous grant, if any.
5841 * <p/>
5842 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005843 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005844 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005845 * @param admin Which profile or device owner this request is associated with.
5846 * @param packageName The application to grant or revoke a permission to.
5847 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005848 * @param grantState The permission grant state which is one of
5849 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5850 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005851 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005852 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005853 * @see #PERMISSION_GRANT_STATE_DENIED
5854 * @see #PERMISSION_GRANT_STATE_DEFAULT
5855 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005856 */
Robin Lee25e26452015-06-02 09:56:29 -07005857 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005858 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005859 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005860 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005861 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005862 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005863 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005864 }
5865 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005866
5867 /**
5868 * Returns the current grant state of a runtime permission for a specific application.
5869 *
5870 * @param admin Which profile or device owner this request is associated with.
5871 * @param packageName The application to check the grant state for.
5872 * @param permission The permission to check for.
5873 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005874 * has not set a grant state, the return value is
5875 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5876 * permission is currently granted for the package.
5877 * <p/>
5878 * If a grant state was set by the profile or device owner, then the return value will
5879 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5880 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5881 * currently denied or granted.
5882 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07005883 * @see #setPermissionGrantState(ComponentName, String, String, int)
5884 * @see PackageManager#checkPermission(String, String)
5885 */
Robin Lee25e26452015-06-02 09:56:29 -07005886 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005887 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005888 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07005889 try {
5890 return mService.getPermissionGrantState(admin, packageName, permission);
5891 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005892 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07005893 }
5894 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005895
5896 /**
5897 * Returns if provisioning a managed profile or device is possible or not.
5898 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5899 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005900 * @return if provisioning a managed profile or device is possible or not.
5901 * @throws IllegalArgumentException if the supplied action is not valid.
5902 */
5903 public boolean isProvisioningAllowed(String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005904 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005905 try {
5906 return mService.isProvisioningAllowed(action);
5907 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005908 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005909 }
5910 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005911
5912 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005913 * Return if this user is a managed profile of another user. An admin can become the profile
5914 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01005915 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005916 * @param admin Which profile owner this request is associated with.
5917 * @return if this user is a managed profile of another user.
5918 */
5919 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005920 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005921 try {
5922 return mService.isManagedProfile(admin);
5923 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005924 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005925 }
5926 }
5927
5928 /**
5929 * @hide
5930 * Return if this user is a system-only user. An admin can manage a device from a system only
5931 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5932 * @param admin Which device owner this request is associated with.
5933 * @return if this user is a system-only user.
5934 */
5935 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5936 try {
5937 return mService.isSystemOnlyUser(admin);
5938 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005939 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005940 }
5941 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005942
5943 /**
5944 * Called by device owner to get the MAC address of the Wi-Fi device.
5945 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005946 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005947 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5948 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5949 * <p>
5950 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5951 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005952 */
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005953 public String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005954 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005955 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005956 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005957 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005958 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005959 }
5960 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005961
5962 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005963 * Called by device owner to reboot the device. If there is an ongoing call on the device,
5964 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005965 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005966 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005967 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005968 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005969 */
5970 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005971 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005972 try {
5973 mService.reboot(admin);
5974 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005975 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005976 }
5977 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005978
5979 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005980 * Called by a device admin to set the short support message. This will be displayed to the user
5981 * in settings screens where funtionality has been disabled by the admin. The message should be
5982 * limited to a short statement such as "This setting is disabled by your administrator. Contact
5983 * someone@example.com for support." If the message is longer than 200 characters it may be
5984 * truncated.
5985 * <p>
5986 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005987 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5988 * and set a new version of this string accordingly.
5989 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005990 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005991 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005992 * @param message Short message to be displayed to the user in settings or null to clear the
5993 * existing message.
5994 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005995 */
5996 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005997 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005998 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005999 if (mService != null) {
6000 try {
6001 mService.setShortSupportMessage(admin, message);
6002 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006003 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006004 }
6005 }
6006 }
6007
6008 /**
6009 * Called by a device admin to get the short support message.
6010 *
6011 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006012 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
6013 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006014 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00006015 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006016 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006017 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00006018 if (mService != null) {
6019 try {
6020 return mService.getShortSupportMessage(admin);
6021 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006022 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006023 }
6024 }
6025 return null;
6026 }
6027
6028 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006029 * Called by a device admin to set the long support message. This will be displayed to the user
6030 * in the device administators settings screen.
6031 * <p>
6032 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006033 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6034 * and set a new version of this string accordingly.
6035 *
Kenny Guy06de4e72015-12-22 12:07:39 +00006036 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00006037 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006038 * @param message Long message to be displayed to the user in settings or null to clear the
6039 * existing message.
6040 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00006041 */
6042 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006043 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006044 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00006045 if (mService != null) {
6046 try {
6047 mService.setLongSupportMessage(admin, message);
6048 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006049 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006050 }
6051 }
6052 }
6053
6054 /**
6055 * Called by a device admin to get the long support message.
6056 *
6057 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006058 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
6059 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006060 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00006061 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006062 public CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006063 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00006064 if (mService != null) {
6065 try {
6066 return mService.getLongSupportMessage(admin);
6067 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006068 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006069 }
6070 }
6071 return null;
6072 }
6073
6074 /**
6075 * Called by the system to get the short support message.
6076 *
6077 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6078 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006079 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00006080 *
6081 * @hide
6082 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006083 public CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
6084 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00006085 if (mService != null) {
6086 try {
6087 return mService.getShortSupportMessageForUser(admin, userHandle);
6088 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006089 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006090 }
6091 }
6092 return null;
6093 }
6094
6095
6096 /**
6097 * Called by the system to get the long support message.
6098 *
6099 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6100 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006101 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00006102 *
6103 * @hide
6104 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006105 public CharSequence getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00006106 if (mService != null) {
6107 try {
6108 return mService.getLongSupportMessageForUser(admin, userHandle);
6109 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006110 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006111 }
6112 }
6113 return null;
6114 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006115
6116 /**
Esteban Talavera62399912016-01-11 15:37:55 +00006117 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
6118 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01006119 *
6120 * <p>The following methods are supported for the parent instance, all other methods will
6121 * throw a SecurityException when called on the parent instance:
6122 * <ul>
6123 * <li>{@link #getPasswordQuality}</li>
6124 * <li>{@link #setPasswordQuality}</li>
6125 * <li>{@link #getPasswordMinimumLength}</li>
6126 * <li>{@link #setPasswordMinimumLength}</li>
6127 * <li>{@link #getPasswordMinimumUpperCase}</li>
6128 * <li>{@link #setPasswordMinimumUpperCase}</li>
6129 * <li>{@link #getPasswordMinimumLowerCase}</li>
6130 * <li>{@link #setPasswordMinimumLowerCase}</li>
6131 * <li>{@link #getPasswordMinimumLetters}</li>
6132 * <li>{@link #setPasswordMinimumLetters}</li>
6133 * <li>{@link #getPasswordMinimumNumeric}</li>
6134 * <li>{@link #setPasswordMinimumNumeric}</li>
6135 * <li>{@link #getPasswordMinimumSymbols}</li>
6136 * <li>{@link #setPasswordMinimumSymbols}</li>
6137 * <li>{@link #getPasswordMinimumNonLetter}</li>
6138 * <li>{@link #setPasswordMinimumNonLetter}</li>
6139 * <li>{@link #getPasswordHistoryLength}</li>
6140 * <li>{@link #setPasswordHistoryLength}</li>
6141 * <li>{@link #getPasswordExpirationTimeout}</li>
6142 * <li>{@link #setPasswordExpirationTimeout}</li>
6143 * <li>{@link #getPasswordExpiration}</li>
Charles He8c760562016-10-25 16:36:53 +01006144 * <li>{@link #getPasswordMaximumLength}</li>
Benjamin Franz66b45f02016-04-05 19:12:39 +01006145 * <li>{@link #isActivePasswordSufficient}</li>
6146 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
6147 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
6148 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
6149 * <li>{@link #getMaximumTimeToLock}</li>
6150 * <li>{@link #setMaximumTimeToLock}</li>
6151 * <li>{@link #lockNow}</li>
6152 * <li>{@link #getKeyguardDisabledFeatures}</li>
6153 * <li>{@link #setKeyguardDisabledFeatures}</li>
6154 * <li>{@link #getTrustAgentConfiguration}</li>
6155 * <li>{@link #setTrustAgentConfiguration}</li>
6156 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006157 *
6158 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006159 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006160 */
6161 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006162 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006163 try {
6164 if (!mService.isManagedProfile(admin)) {
6165 throw new SecurityException("The current user does not have a parent profile.");
6166 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06006167 return new DevicePolicyManager(mContext, mService, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006168 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006169 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006170 }
6171 }
6172
6173 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006174 * Called by device owner to control the security logging feature. Logging can only be
6175 * enabled on single user devices where the sole user is managed by the device owner.
6176 *
6177 * <p> Security logs contain various information intended for security auditing purposes.
6178 * See {@link SecurityEvent} for details.
6179 *
6180 * <p>There must be only one user on the device, managed by the device owner.
6181 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006182 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006183 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006184 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006185 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00006186 * @see #retrieveSecurityLogs
6187 */
6188 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006189 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00006190 try {
6191 mService.setSecurityLoggingEnabled(admin, enabled);
6192 } catch (RemoteException re) {
6193 throw re.rethrowFromSystemServer();
6194 }
6195 }
6196
6197 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006198 * Return whether security logging is enabled or not by the device owner.
6199 *
6200 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
6201 * thrown.
6202 *
6203 * @param admin Which device owner this request is associated with.
6204 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
6205 * @throws SecurityException if {@code admin} is not a device owner.
6206 */
6207 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006208 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006209 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006210 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006211 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006212 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006213 }
6214 }
6215
6216 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006217 * Called by device owner to retrieve all new security logging entries since the last call to
6218 * this API after device boots.
6219 *
6220 * <p> Access to the logs is rate limited and it will only return new logs after the device
6221 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
6222 *
6223 * <p>There must be only one user on the device, managed by the device owner.
6224 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006225 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006226 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006227 * @return the new batch of security logs which is a list of {@link SecurityEvent},
6228 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006229 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006230 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006231 public List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006232 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006233 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006234 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006235 if (list != null) {
6236 return list.getList();
6237 } else {
6238 // Rate limit exceeded.
6239 return null;
6240 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006241 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006242 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006243 }
6244 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00006245
6246 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006247 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
6248 * profile.
6249 *
6250 * @hide
6251 */
6252 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
6253 mContext.checkSelfPermission(
6254 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
6255 if (!uInfo.isManagedProfile()) {
6256 throw new SecurityException("The user " + uInfo.id
6257 + " does not have a parent profile.");
6258 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06006259 return new DevicePolicyManager(mContext, mService, true);
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006260 }
6261
6262 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006263 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006264 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006265 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
6266 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
6267 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
6268 * about data corruption when parsing. </strong>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006269 * <p>
6270 * There must be only one user on the device, managed by the device owner. Otherwise a
6271 * {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006272 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006273 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006274 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
6275 * is not supported on the device.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006276 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006277 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006278 public List<SecurityEvent> retrievePreRebootSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006279 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006280 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006281 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006282 if (list != null) {
6283 return list.getList();
6284 } else {
6285 return null;
6286 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006287 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006288 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006289 }
6290 }
6291
6292 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006293 * Called by a profile owner of a managed profile to set the color used for customization. This
6294 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01006295 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006296 * <p>
6297 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00006298 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
6299 *
6300 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006301 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006302 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006303 */
6304 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006305 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006306 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006307 // always enforce alpha channel to have 100% opacity
6308 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00006309 mService.setOrganizationColor(admin, color);
6310 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006311 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006312 }
6313 }
6314
6315 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006316 * @hide
6317 *
6318 * Sets the color used for customization.
6319 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01006320 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006321 * @param userId which user to set the color to.
6322 * @RequiresPermission(allOf = {
6323 * Manifest.permission.MANAGE_USERS,
6324 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
6325 */
6326 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
6327 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006328 // always enforce alpha channel to have 100% opacity
6329 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006330 mService.setOrganizationColorForUser(color, userId);
6331 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006332 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006333 }
6334 }
6335
6336 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00006337 * Called by a profile owner of a managed profile to retrieve the color used for customization.
6338 * This color is used as background color of the confirm credentials screen for that user.
6339 *
6340 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006341 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006342 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006343 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006344 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006345 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006346 try {
6347 return mService.getOrganizationColor(admin);
6348 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006349 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006350 }
6351 }
6352
6353 /**
6354 * @hide
6355 * Retrieve the customization color for a given user.
6356 *
6357 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006358 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006359 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006360 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00006361 try {
6362 return mService.getOrganizationColorForUser(userHandle);
6363 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006364 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006365 }
6366 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006367
6368 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006369 * Called by a profile owner of a managed profile to set the name of the organization under
6370 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006371 * <p>
6372 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006373 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6374 * and set a new version of this string accordingly.
6375 *
6376 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6377 * @param title The organization name or {@code null} to clear a previously set name.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006378 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006379 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006380 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006381 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006382 try {
6383 mService.setOrganizationName(admin, title);
6384 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006385 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006386 }
6387 }
6388
6389 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006390 * Called by a profile owner of a managed profile to retrieve the name of the organization under
6391 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006392 *
6393 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6394 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006395 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006396 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006397 public CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006398 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006399 try {
6400 return mService.getOrganizationName(admin);
6401 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006402 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006403 }
6404 }
6405
6406 /**
6407 * Retrieve the default title message used in the confirm credentials screen for a given user.
6408 *
6409 * @param userHandle The user id of the user we're interested in.
6410 * @return The organization name or {@code null} if none is set.
6411 *
6412 * @hide
6413 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006414 public CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006415 try {
6416 return mService.getOrganizationNameForUser(userHandle);
6417 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006418 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006419 }
6420 }
6421
6422 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00006423 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6424 * return {@link #STATE_USER_UNMANAGED}
6425 * @hide
6426 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00006427 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00006428 @UserProvisioningState
6429 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006430 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00006431 if (mService != null) {
6432 try {
6433 return mService.getUserProvisioningState();
6434 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006435 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006436 }
6437 }
6438 return STATE_USER_UNMANAGED;
6439 }
6440
6441 /**
6442 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6443 *
6444 * @param state to store
6445 * @param userHandle for user
6446 * @hide
6447 */
6448 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6449 if (mService != null) {
6450 try {
6451 mService.setUserProvisioningState(state, userHandle);
6452 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006453 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006454 }
6455 }
6456 }
6457
6458 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006459 * @hide
6460 * Indicates the entity that controls the device or profile owner. A user/profile is considered
6461 * affiliated if it is managed by the same entity as the device.
6462 *
6463 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6464 * user/profile is considered affiliated if the following conditions are both met:
6465 * <ul>
6466 * <li>The device owner and the user's/profile's profile owner have called this method,
6467 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6468 * and a profile owner intersect, they must have come from the same source, which means that
6469 * the device owner and profile owner are controlled by the same entity.</li>
6470 * <li>The device owner's and profile owner's package names are the same.</li>
6471 * </ul>
6472 *
6473 * @param admin Which profile or device owner this request is associated with.
6474 * @param ids A set of opaque affiliation ids.
6475 */
6476 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006477 throwIfParentInstance("setAffiliationIds");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006478 try {
6479 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6480 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006481 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006482 }
6483 }
6484
6485 /**
6486 * @hide
6487 * Returns whether this user/profile is affiliated with the device. See
6488 * {@link #setAffiliationIds} for the definition of affiliation.
6489 *
6490 * @return whether this user/profile is affiliated with the device.
6491 */
6492 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006493 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006494 try {
6495 return mService != null && mService.isAffiliatedUser();
6496 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006497 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006498 }
6499 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006500
6501 /**
6502 * @hide
6503 * Returns whether the uninstall for {@code packageName} for the current user is in queue
6504 * to be started
6505 * @param packageName the package to check for
6506 * @return whether the uninstall intent for {@code packageName} is pending
6507 */
6508 public boolean isUninstallInQueue(String packageName) {
6509 try {
6510 return mService.isUninstallInQueue(packageName);
6511 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006512 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006513 }
6514 }
6515
6516 /**
6517 * @hide
6518 * @param packageName the package containing active DAs to be uninstalled
6519 */
6520 public void uninstallPackageWithActiveAdmins(String packageName) {
6521 try {
6522 mService.uninstallPackageWithActiveAdmins(packageName);
6523 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006524 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006525 }
6526 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01006527
Kenny Guy38dcca52016-04-19 13:09:18 +01006528 /**
6529 * @hide
6530 * Remove a test admin synchronously without sending it a broadcast about being removed.
6531 * If the admin is a profile owner or device owner it will still be removed.
6532 *
6533 * @param userHandle user id to remove the admin for.
6534 * @param admin The administration compononent to remove.
6535 * @throws SecurityException if the caller is not shell / root or the admin package
6536 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
6537 */
6538 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
6539 try {
6540 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
6541 } catch (RemoteException re) {
6542 throw re.rethrowFromSystemServer();
6543 }
6544 }
6545
Mahaver Chopra790d1982016-07-07 16:06:49 +01006546 /**
6547 * @hide
6548 * @return whether {@link android.provider.Settings.Global#DEVICE_PROVISIONED} has ever been set
6549 * to 1.
6550 */
6551 public boolean isDeviceProvisioned() {
6552 try {
6553 return mService.isDeviceProvisioned();
6554 } catch (RemoteException re) {
6555 throw re.rethrowFromSystemServer();
6556 }
6557 }
6558
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01006559 /**
6560 * @hide
6561 * Writes that the provisioning configuration has been applied.
6562 */
6563 public void setDeviceProvisioningConfigApplied() {
6564 try {
6565 mService.setDeviceProvisioningConfigApplied();
6566 } catch (RemoteException re) {
6567 throw re.rethrowFromSystemServer();
6568 }
6569 }
6570
6571 /**
6572 * @hide
6573 * @return whether the provisioning configuration has been applied.
6574 */
6575 public boolean isDeviceProvisioningConfigApplied() {
6576 try {
6577 return mService.isDeviceProvisioningConfigApplied();
6578 } catch (RemoteException re) {
6579 throw re.rethrowFromSystemServer();
6580 }
6581 }
6582
Victor Chang9bfc65f2016-08-15 12:27:09 +01006583 /**
6584 * @hide
Victor Chang3577ed22016-08-25 18:49:26 +01006585 * Force update user setup completed status. This API has no effect on user build.
6586 * @throws {@link SecurityException} if the caller has no
6587 * {@link android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS} or the caller is
6588 * not {@link UserHandle.SYSTEM_USER}
Victor Chang9bfc65f2016-08-15 12:27:09 +01006589 */
6590 public void forceUpdateUserSetupComplete() {
6591 try {
6592 mService.forceUpdateUserSetupComplete();
6593 } catch (RemoteException re) {
6594 throw re.rethrowFromSystemServer();
6595 }
6596 }
6597
Benjamin Franzbc33c822016-04-15 08:57:52 +01006598 private void throwIfParentInstance(String functionName) {
6599 if (mParentInstance) {
6600 throw new SecurityException(functionName + " cannot be called on the parent instance");
6601 }
6602 }
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02006603
6604 /**
6605 * @hide
6606 * Enable backup service.
6607 * <p>This includes all backup and restore mechanisms.
6608 * Setting this to {@code false} will make backup service no-op or return empty results.
6609 *
6610 * <p>There must be only one user on the device, managed by the device owner.
6611 * Otherwise a {@link SecurityException} will be thrown.
6612 *
6613 * <p>Backup service is off by default when device owner is present.
6614 */
6615 public void setBackupServiceEnabled(@NonNull ComponentName admin, boolean enabled) {
6616 try {
6617 mService.setBackupServiceEnabled(admin, enabled);
6618 } catch (RemoteException re) {
6619 throw re.rethrowFromSystemServer();
6620 }
6621 }
6622
6623 /**
6624 * @hide
6625 * @return {@code true} if backup service is enabled, {@code false} otherwise.
6626 */
6627 public boolean isBackupServiceEnabled(@NonNull ComponentName admin) {
6628 try {
6629 return mService.isBackupServiceEnabled(admin);
6630 } catch (RemoteException re) {
6631 throw re.rethrowFromSystemServer();
6632 }
6633 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006634}