blob: a749fe70fb94d546110beeb7bb3dbcae1476bb15 [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;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060023import android.annotation.RequiresPermission;
Dianne Hackbornd6847842010-01-12 18:14:19 -080024import android.annotation.SdkConstant;
25import android.annotation.SdkConstant.SdkConstantType;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060026import android.annotation.SuppressLint;
Justin Moreyb5deda72014-07-24 10:53:40 -050027import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060028import android.annotation.SystemService;
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +010029import android.annotation.TestApi;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000030import android.annotation.UserIdInt;
Fyodor Kupolov4e9af062016-07-18 16:59:11 -070031import android.annotation.WorkerThread;
Jason Monkd7b86212014-06-16 13:15:38 -040032import android.app.Activity;
Tony Mak46aabe52016-11-14 12:53:06 +000033import android.app.IServiceConnection;
Rubin Xuaab7a412016-12-30 21:13:29 +000034import android.app.KeyguardManager;
Michal Karpinski6235a942016-03-15 12:07:23 +000035import android.app.admin.SecurityLog.SecurityEvent;
Dianne Hackbornd6847842010-01-12 18:14:19 -080036import android.content.ComponentName;
37import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010038import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000039import android.content.IntentFilter;
Tony Mak46aabe52016-11-14 12:53:06 +000040import android.content.ServiceConnection;
Victor Chang98607132017-01-27 11:51:56 +000041import android.content.pm.ApplicationInfo;
Dianne Hackbornd6847842010-01-12 18:14:19 -080042import android.content.pm.PackageManager;
Victor Changcd14c0a2016-03-16 19:10:15 +000043import android.content.pm.PackageManager.NameNotFoundException;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000044import android.content.pm.ParceledListSlice;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000045import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050046import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040047import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000048import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010049import android.os.Bundle;
Victor Changc10f6692016-12-09 15:24:00 +000050import android.os.Parcelable;
Jim Millere303bf42014-08-26 17:12:29 -070051import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000052import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080053import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080054import android.os.RemoteException;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070055import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040056import android.os.UserManager;
Ricky Wai494b95d2015-11-20 16:07:15 +000057import android.provider.ContactsContract.Directory;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010058import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070059import android.service.restrictions.RestrictionsReceiver;
Mahaver Chopra1216ae52016-03-11 15:39:48 +000060import android.telephony.TelephonyManager;
Tony Mak31657432017-04-25 09:29:55 +010061import android.util.ArraySet;
Dianne Hackbornd6847842010-01-12 18:14:19 -080062import android.util.Log;
63
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070064import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040065import com.android.org.conscrypt.TrustedCertificateStore;
66
67import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080068import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000069import java.lang.annotation.Retention;
70import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070071import java.net.InetSocketAddress;
72import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010073import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000074import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010075import java.security.PrivateKey;
76import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040077import java.security.cert.CertificateException;
78import java.security.cert.CertificateFactory;
79import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010080import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000081import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070082import java.util.ArrayList;
Rubin Xub4365912016-03-23 12:13:22 +000083import java.util.Arrays;
Svetoslav976e8bd2014-07-16 15:12:03 -070084import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080085import java.util.List;
Tony Mak31657432017-04-25 09:29:55 +010086import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080087
88/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000089 * Public interface for managing policies enforced on a device. Most clients of this class must be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070090 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
91 * administrator</a>. Additionally, a device administrator may be registered as either a profile or
92 * device owner. A given method is accessible to all device administrators unless the documentation
93 * for that method specifies that it is restricted to either device or profile owners. Any
94 * application calling an api may only pass as an argument a device administrator component it
95 * owns. Otherwise, a {@link SecurityException} will be thrown.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080096 * <div class="special reference">
97 * <h3>Developer Guides</h3>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070098 * <p>
99 * For more information about managing policies for device administration, read the <a href=
100 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
101 * guide. </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -0800102 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -0600103@SystemService(Context.DEVICE_POLICY_SERVICE)
Dianne Hackbornd6847842010-01-12 18:14:19 -0800104public class DevicePolicyManager {
105 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -0800106
107 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -0800108 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +0000109 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700110
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600111 /** @hide */
112 public DevicePolicyManager(Context context, IDevicePolicyManager service) {
113 this(context, service, false);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800114 }
115
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800116 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700117 @VisibleForTesting
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600118 protected DevicePolicyManager(Context context, IDevicePolicyManager service,
119 boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700120 mContext = context;
121 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000122 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700123 }
124
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700125 /** @hide test will override it. */
126 @VisibleForTesting
127 protected int myUserId() {
128 return UserHandle.myUserId();
129 }
130
Dianne Hackbornd6847842010-01-12 18:14:19 -0800131 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000132 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000133 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100134 * <p>A managed profile allows data separation for example for the usage of a
135 * device as a personal and corporate device. The user which provisioning is started from and
136 * the managed profile share a launcher.
137 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800138 * <p>This intent will typically be sent by a mobile device management application (MDM).
139 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
140 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100141 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000142 * <p>It is possible to check if provisioning is allowed or not by querying the method
143 * {@link #isProvisioningAllowed(String)}.
144 *
145 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000146 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700147 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000148 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
149 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000150 *
Benjamin Franzea956242016-03-21 15:45:56 +0000151 * <p>The intent may also contain the following extras:
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000152 * <ul>
Benjamin Franzea956242016-03-21 15:45:56 +0000153 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
154 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
155 * {@link android.os.Build.VERSION_CODES#N}</li>
156 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
157 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
158 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Victor Chang51d84f92016-11-16 12:22:56 +0000159 * <li>{@link #EXTRA_PROVISIONING_SKIP_USER_CONSENT}, optional</li>
Victor Chang89ee2792016-11-23 12:10:55 +0000160 * <li>{@link #EXTRA_PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION}, optional</li>
Victor Changc10f6692016-12-09 15:24:00 +0000161 * <li>{@link #EXTRA_PROVISIONING_DISCLAIMERS}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000162 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000163 *
Benjamin Franzea956242016-03-21 15:45:56 +0000164 * <p>When managed provisioning has completed, broadcasts are sent to the application specified
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000165 * in the provisioning intent. The
166 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
167 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
168 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100169 *
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000170 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when managed provisioning has
171 * completed, along with the above broadcast, activity intent
172 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the application specified in
173 * the provisioning intent.
174 *
Benjamin Franzea956242016-03-21 15:45:56 +0000175 * <p>If provisioning fails, the managedProfile is removed so the device returns to its
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100176 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100177 *
178 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
179 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
180 * the provisioning flow was successful, although this doesn't guarantee the full flow will
181 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
182 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000183 */
184 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
185 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100186 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000187
188 /**
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000189 * Activity action: Starts the provisioning flow which sets up a managed user.
190 *
191 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800192 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000193 * owner who has full control over the user. Provisioning can only happen before user setup has
194 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
195 * allowed.
196 *
Benjamin Franzea956242016-03-21 15:45:56 +0000197 * <p>The intent contains the following extras:
198 * <ul>
199 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
200 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
201 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
202 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
203 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
204 * </ul>
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000205 *
Benjamin Franzea956242016-03-21 15:45:56 +0000206 * <p>If provisioning fails, the device returns to its previous state.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000207 *
208 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
209 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
210 * the provisioning flow was successful, although this doesn't guarantee the full flow will
211 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
212 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Benjamin Franzea956242016-03-21 15:45:56 +0000213 *
214 * @hide
Mahaver Chopra5e732562015-11-05 11:55:12 +0000215 */
216 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
217 public static final String ACTION_PROVISION_MANAGED_USER
218 = "android.app.action.PROVISION_MANAGED_USER";
219
220 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100221 * Activity action: Starts the provisioning flow which sets up a managed device.
222 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
223 *
224 * <p> During device owner provisioning a device admin app is set as the owner of the device.
225 * A device owner has full control over the device. The device owner can not be modified by the
226 * user.
227 *
228 * <p> A typical use case would be a device that is owned by a company, but used by either an
229 * employee or client.
230 *
231 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000232 * It is possible to check if provisioning is allowed or not by querying the method
233 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100234 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000235 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100236 * <ul>
237 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
238 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
239 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100240 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000241 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000242 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Victor Changc10f6692016-12-09 15:24:00 +0000243 * <li>{@link #EXTRA_PROVISIONING_DISCLAIMERS}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100244 * </ul>
245 *
Benjamin Franzea956242016-03-21 15:45:56 +0000246 * <p>When device owner provisioning has completed, an intent of the type
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100247 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
248 * device owner.
249 *
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000250 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has
251 * completed, along with the above broadcast, activity intent
252 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner.
253 *
Benjamin Franzea956242016-03-21 15:45:56 +0000254 * <p>If provisioning fails, the device is factory reset.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100255 *
Alan Treadway4582f812015-07-28 11:49:35 +0100256 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
257 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
258 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
259 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100260 */
261 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
262 public static final String ACTION_PROVISION_MANAGED_DEVICE
263 = "android.app.action.PROVISION_MANAGED_DEVICE";
264
265 /**
Victor Chang18800092017-04-11 19:41:43 +0100266 * Activity action: launch when user provisioning completed, i.e.
267 * {@link #getUserProvisioningState()} returns one of the complete state.
268 *
269 * <p> Please note that the API behavior is not necessarily consistent across various releases,
270 * and devices, as it's contract between SetupWizard and ManagedProvisioning. The default
271 * implementation is that ManagedProvisioning launches SetupWizard in NFC provisioning only.
272 *
273 * <p> The activity must be protected by permission
274 * {@link android.Manifest.permission#BIND_DEVICE_ADMIN}, and the process must hold
275 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE} to be launched.
276 * Only one {@link ComponentName} in the entire system should be enabled, and the rest of the
277 * components are not started by this intent.
278 * @hide
279 */
280 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Victor Chang18800092017-04-11 19:41:43 +0100281 public static final String ACTION_STATE_USER_SETUP_COMPLETE =
282 "android.app.action.STATE_USER_SETUP_COMPLETE";
283
284 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000285 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000286 *
287 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
288 * the device. A device owner has full control over the device. The device owner can not be
289 * modified by the user and the only way of resetting the device is via factory reset.
290 *
291 * <p>A typical use case would be a device that is owned by a company, but used by either an
292 * employee or client.
293 *
294 * <p>The provisioning message should be sent to an unprovisioned device.
295 *
296 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
297 * by a privileged app with the permission
298 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
299 *
300 * <p>The provisioning intent contains the following properties:
301 * <ul>
302 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
303 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
304 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
305 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Victor Chang38cfd9c2017-01-04 17:41:11 +0000306 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL}, optional</li>
307 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI}, optional</li>
Steven Ng980a1b62016-02-02 17:43:18 +0000308 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
309 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
310 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
311 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
312 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
313 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
314 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
315 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
316 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
317 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
318 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
Victor Chang38cfd9c2017-01-04 17:41:11 +0000319 * <li>{@link #EXTRA_PROVISIONING_SUPPORT_URL}, optional</li>
320 * <li>{@link #EXTRA_PROVISIONING_ORGANIZATION_NAME}, optional</li>
Steven Ng980a1b62016-02-02 17:43:18 +0000321 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
322 *
323 * @hide
324 */
325 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
326 @SystemApi
327 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
328 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
329
330 /**
331 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000332 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
333 *
334 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
335 * management state that is distinct from that reached by
336 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
337 * user, and only has control over device-wide policies, not individual users and their data.
338 * The primary benefit is that multiple non-system users are supported when provisioning using
339 * this form of device management.
340 *
Benjamin Franzea956242016-03-21 15:45:56 +0000341 * <p>During device owner provisioning a device admin app is set as the owner of the device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000342 * A device owner has full control over the device. The device owner can not be modified by the
343 * user.
344 *
Benjamin Franzea956242016-03-21 15:45:56 +0000345 * <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 +0000346 * employee or client.
347 *
Benjamin Franzea956242016-03-21 15:45:56 +0000348 * <p>An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000349 * It is possible to check if provisioning is allowed or not by querying the method
350 * {@link #isProvisioningAllowed(String)}.
351 *
352 * <p>The intent contains the following extras:
353 * <ul>
354 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
355 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
356 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
357 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Benjamin Franzea956242016-03-21 15:45:56 +0000358 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
359 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Alan Treadway46dd4492015-11-09 13:57:19 +0000360 * </ul>
361 *
Benjamin Franzea956242016-03-21 15:45:56 +0000362 * <p>When device owner provisioning has completed, an intent of the type
Alan Treadway46dd4492015-11-09 13:57:19 +0000363 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
364 * device owner.
365 *
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000366 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has
367 * completed, along with the above broadcast, activity intent
368 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner.
369 *
Benjamin Franzea956242016-03-21 15:45:56 +0000370 * <p>If provisioning fails, the device is factory reset.
Alan Treadway46dd4492015-11-09 13:57:19 +0000371 *
372 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
373 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
374 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
375 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
376 *
377 * @hide
378 */
379 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
380 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
381 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
382
383 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000384 * Activity action: Finalizes management provisioning, should be used after user-setup
385 * has been completed and {@link #getUserProvisioningState()} returns one of:
386 * <ul>
387 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
388 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
389 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
390 * </ul>
391 *
392 * @hide
393 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000394 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000395 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
396 public static final String ACTION_PROVISION_FINALIZATION
397 = "android.app.action.PROVISION_FINALIZATION";
398
399 /**
Michal Karpinskiba244092016-02-25 17:28:24 +0000400 * Action: Bugreport sharing with device owner has been accepted by the user.
401 *
402 * @hide
403 */
404 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
Rubin Xu7226c7d2017-02-06 17:18:50 +0000405 "com.android.server.action.REMOTE_BUGREPORT_SHARING_ACCEPTED";
Michal Karpinskiba244092016-02-25 17:28:24 +0000406
407 /**
408 * Action: Bugreport sharing with device owner has been declined by the user.
409 *
410 * @hide
411 */
412 public static final String ACTION_BUGREPORT_SHARING_DECLINED =
Rubin Xu7226c7d2017-02-06 17:18:50 +0000413 "com.android.server.action.REMOTE_BUGREPORT_SHARING_DECLINED";
Michal Karpinskiba244092016-02-25 17:28:24 +0000414
415 /**
Esteban Talavera01576862016-12-15 11:16:44 +0000416 * Action: Bugreport has been collected and is dispatched to {@code DevicePolicyManagerService}.
Michal Karpinskiba244092016-02-25 17:28:24 +0000417 *
418 * @hide
419 */
420 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
421 "android.intent.action.REMOTE_BUGREPORT_DISPATCH";
422
423 /**
424 * Extra for shared bugreport's SHA-256 hash.
425 *
426 * @hide
427 */
428 public static final String EXTRA_REMOTE_BUGREPORT_HASH =
429 "android.intent.extra.REMOTE_BUGREPORT_HASH";
430
431 /**
432 * Extra for remote bugreport notification shown type.
433 *
434 * @hide
435 */
436 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
437 "android.app.extra.bugreport_notification_type";
438
439 /**
440 * Notification type for a started remote bugreport flow.
441 *
442 * @hide
443 */
444 public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
445
446 /**
447 * Notification type for a bugreport that has already been accepted to be shared, but is still
448 * being taken.
449 *
450 * @hide
451 */
452 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
453
454 /**
455 * Notification type for a bugreport that has been taken and can be shared or declined.
456 *
457 * @hide
458 */
459 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
460
461 /**
Michal Karpinski8f010dd2016-06-21 15:05:53 +0100462 * Default and maximum timeout in milliseconds after which unlocking with weak auth times out,
463 * i.e. the user has to use a strong authentication method like password, PIN or pattern.
464 *
465 * @hide
466 */
467 public static final long DEFAULT_STRONG_AUTH_TIMEOUT_MS = 72 * 60 * 60 * 1000; // 72h
468
469 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100470 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100471 * allows a mobile device management application or NFC programmer application which starts
472 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100473 * <p>
474 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
475 * sends the intent to pass data to itself on the newly created profile.
476 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
477 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100478 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
479 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
480 * message should contain a stringified {@link java.util.Properties} instance, whose string
481 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
482 * management application after provisioning.
483 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100484 * <p>
485 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700486 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
487 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100488 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100489 */
490 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100491 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100492
493 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100494 * A String extra holding the package name of the mobile device management application that
495 * will be set as the profile owner or device owner.
496 *
497 * <p>If an application starts provisioning directly via an intent with action
498 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
499 * application that started provisioning. The package will be set as profile owner in that case.
500 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000501 * <p>This package is set as device owner when device owner provisioning is started by an NFC
502 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000503 *
504 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700505 * This receiver will be set as the profile or device owner and active admin.
Benjamin Franzea956242016-03-21 15:45:56 +0000506 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000507 * @see DeviceAdminReceiver
508 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100509 * supported, but only if there is only one device admin receiver in the package that requires
510 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000511 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000512 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000513 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100514 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000515
516 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000517 * A ComponentName extra indicating the device admin receiver of the mobile device management
518 * application that will be set as the profile owner or device owner and active admin.
519 *
520 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100521 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
522 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
523 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000524 *
525 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100526 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
527 * message containing an NFC record with MIME type
Benjamin Franzea956242016-03-21 15:45:56 +0000528 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000529 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000530 *
531 * @see DeviceAdminReceiver
532 */
533 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
534 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
535
536 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000537 * An {@link android.accounts.Account} extra holding the account to migrate during managed
538 * profile provisioning. If the account supplied is present in the primary user, it will be
539 * copied, along with its credentials to the managed profile and removed from the primary user.
540 *
541 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
542 */
543
544 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
545 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
546
547 /**
Victor Changaa9cbc02016-12-05 20:50:57 +0000548 * Boolean extra to indicate that the migrated account should be kept. This is used in
549 * conjunction with {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}. If it's set to {@code true},
550 * the account will not be removed from the primary user after it is migrated to the newly
551 * created user or profile.
Victor Chang89ee2792016-11-23 12:10:55 +0000552 *
553 * <p> Defaults to {@code false}
554 *
Victor Changaa9cbc02016-12-05 20:50:57 +0000555 * <p> Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
556 * {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}
Victor Chang89ee2792016-11-23 12:10:55 +0000557 */
558 public static final String EXTRA_PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION
559 = "android.app.extra.PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION";
560
561 /**
Mahaver761ce772017-03-13 16:40:45 +0000562 * @deprecated From {@link android.os.Build.VERSION_CODES#O}, never used while provisioning the
563 * device.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100564 */
Mahaver761ce772017-03-13 16:40:45 +0000565 @Deprecated
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100566 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
567 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100568
569 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000570 * A integer extra indicating the predominant color to show during the provisioning.
571 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000572 *
573 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
574 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
575 */
576 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
577 "android.app.extra.PROVISIONING_MAIN_COLOR";
578
579 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000580 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700581 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000582 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100583 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
584 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000585 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000586 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
587 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000588
589 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100590 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
591 * will be set to.
592 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000593 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
594 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100595 */
596 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100597 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100598
599 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100600 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
601 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100602 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000603 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
604 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100605 */
606 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100607 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100608
609 /**
610 * A String extra holding the {@link java.util.Locale} that the device will be set to.
611 * Format: xx_yy, where xx is the language code, and yy the country code.
612 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000613 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
614 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100615 */
616 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100617 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100618
619 /**
620 * A String extra holding the ssid of the wifi network that should be used during nfc device
621 * owner provisioning for downloading the mobile device management application.
622 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000623 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
624 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100625 */
626 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100627 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100628
629 /**
630 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
631 * is hidden or not.
632 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000633 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
634 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100635 */
636 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100637 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100638
639 /**
640 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100641 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
642 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100643 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000644 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
645 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100646 */
647 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100648 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100649
650 /**
651 * A String extra holding the password of the wifi network in
652 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
653 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000654 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
655 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100656 */
657 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100658 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100659
660 /**
661 * A String extra holding the proxy host for the wifi network in
662 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
663 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000664 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
665 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100666 */
667 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100668 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100669
670 /**
671 * An int extra holding the proxy port for the wifi network in
672 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
673 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000674 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
675 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100676 */
677 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100678 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100679
680 /**
681 * A String extra holding the proxy bypass for the wifi network in
682 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
683 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000684 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
685 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100686 */
687 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100688 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100689
690 /**
691 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
692 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
693 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000694 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
695 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100696 */
697 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100698 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100699
700 /**
701 * A String extra holding a url that specifies the download location of the device admin
702 * package. When not provided it is assumed that the device admin package is already installed.
703 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000704 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
705 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100706 */
707 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100708 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100709
710 /**
Victor Chang38cfd9c2017-01-04 17:41:11 +0000711 * A String extra holding the localized name of the organization under management.
712 *
713 * The name is displayed only during provisioning.
714 *
715 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
716 *
717 * @hide
718 */
719 @SystemApi
720 public static final String EXTRA_PROVISIONING_ORGANIZATION_NAME =
721 "android.app.extra.PROVISIONING_ORGANIZATION_NAME";
722
723 /**
Alejandro Fernándezbfd61932017-04-04 19:33:01 +0100724 * A String extra holding a url to the website of the device provider so the user can open it
725 * during provisioning. If the url is not HTTPS, an error will be shown.
Victor Chang38cfd9c2017-01-04 17:41:11 +0000726 *
727 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
728 *
729 * @hide
730 */
731 @SystemApi
732 public static final String EXTRA_PROVISIONING_SUPPORT_URL =
733 "android.app.extra.PROVISIONING_SUPPORT_URL";
734
735 /**
736 * A String extra holding the localized name of the device admin package. It should be the same
737 * as the app label of the package.
738 *
739 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
740 *
741 * @hide
742 */
743 @SystemApi
744 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL =
745 "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL";
746
747 /**
748 * A {@link Uri} extra pointing to the app icon of device admin package. This image will be
749 * shown during the provisioning.
750 * <h5>The following URI schemes are accepted:</h5>
751 * <ul>
752 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
753 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
754 * </ul>
755 *
756 * <p> It is the responsibility of the caller to provide an image with a reasonable
757 * pixel density for the device.
758 *
759 * <p> If a content: URI is passed, the intent should have the flag
760 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
761 * {@link android.content.ClipData} of the intent too.
762 *
763 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
764 *
765 * @hide
766 */
767 @SystemApi
768 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI =
769 "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI";
770
771 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400772 * An int extra holding a minimum required version code for the device admin package. If the
773 * device admin is already installed on the device, it will only be re-downloaded from
774 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
775 * installed package is less than this version code.
776 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400777 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400778 * provisioning via an NFC bump.
779 */
780 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
781 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
782
783 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100784 * A String extra holding a http cookie header which should be used in the http request to the
785 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
786 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000787 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
788 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100789 */
790 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100791 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100792
793 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100794 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
795 * the file at download location specified in
796 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100797 *
Benjamin Franzea956242016-03-21 15:45:56 +0000798 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
799 * present. The provided checksum must match the checksum of the file at the download
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100800 * location. If the checksum doesn't match an error will be shown to the user and the user will
801 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100802 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000803 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
804 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100805 *
806 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
807 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700808 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100809 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100810 */
811 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100812 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100813
814 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100815 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100816 * android package archive at the download location specified in {@link
817 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
818 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100819 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100820 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
821 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
822 *
Benjamin Franzea956242016-03-21 15:45:56 +0000823 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
824 * present. The provided checksum must match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100825 * the download location. If the checksum does not match an error will be shown to the user and
826 * the user will be asked to factory reset the device.
827 *
828 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
829 * provisioning via an NFC bump.
830 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100831 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
832 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100833
834 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000835 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
836 * has completed successfully.
837 *
838 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700839 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000840 *
Mahaver7074caf2016-11-29 20:52:18 +0000841 * <p>This intent will contain the following extras
842 * <ul>
843 * <li>{@link Intent#EXTRA_USER}, corresponds to the {@link UserHandle} of the managed
844 * profile.</li>
845 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, corresponds to the account requested to
846 * be migrated at provisioning time, if any.</li>
847 * </ul>
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000848 */
849 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
850 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
851 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
852
853 /**
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000854 * Activity action: This activity action is sent to indicate that provisioning of a managed
855 * profile or managed device has completed successfully. It'll be sent at the same time as
856 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast but this will be
857 * delivered faster as it's an activity intent.
858 *
859 * <p>The intent is only sent to the application on the profile that requested provisioning. In
860 * the device owner case the profile is the primary user.
861 *
862 * @see #ACTION_PROVISION_MANAGED_PROFILE
863 * @see #ACTION_PROVISION_MANAGED_DEVICE
864 */
865 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
866 public static final String ACTION_PROVISIONING_SUCCESSFUL =
867 "android.app.action.PROVISIONING_SUCCESSFUL";
868
869 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000870 * A boolean extra indicating whether device encryption can be skipped as part of device owner
871 * or managed profile provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500872 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400873 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100874 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Benjamin Franzea956242016-03-21 15:45:56 +0000875 *
876 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
877 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500878 */
879 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
880 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
881
882 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000883 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
884 * provisioning. If this extra is not passed, a default image will be shown.
885 * <h5>The following URI schemes are accepted:</h5>
886 * <ul>
887 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
888 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
889 * </ul>
890 *
Victor Changc10f6692016-12-09 15:24:00 +0000891 * <p> It is the responsibility of the caller to provide an image with a reasonable
Victor Chang38cfd9c2017-01-04 17:41:11 +0000892 * pixel density for the device.
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000893 *
894 * <p> If a content: URI is passed, the intent should have the flag
895 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
896 * {@link android.content.ClipData} of the intent too.
897 *
898 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
899 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
900 */
901 public static final String EXTRA_PROVISIONING_LOGO_URI =
902 "android.app.extra.PROVISIONING_LOGO_URI";
903
904 /**
Victor Changc10f6692016-12-09 15:24:00 +0000905 * A {@link Bundle}[] extra consisting of list of disclaimer headers and disclaimer contents.
906 * Each {@link Bundle} must have both {@link #EXTRA_PROVISIONING_DISCLAIMER_HEADER}
907 * as disclaimer header, and {@link #EXTRA_PROVISIONING_DISCLAIMER_CONTENT} as disclaimer
908 * content.
909 *
910 * <p> The extra typically contains one disclaimer from the company of mobile device
911 * management application (MDM), and one disclaimer from the organization.
912 *
913 * <p> Call {@link Bundle#putParcelableArray(String, Parcelable[])} to put the {@link Bundle}[]
914 *
915 * <p> Maximum 3 key-value pairs can be specified. The rest will be ignored.
916 *
917 * <p> Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
918 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
919 */
920 public static final String EXTRA_PROVISIONING_DISCLAIMERS =
921 "android.app.extra.PROVISIONING_DISCLAIMERS";
922
923 /**
924 * A String extra of localized disclaimer header.
925 *
926 * <p> The extra is typically the company name of mobile device management application (MDM)
927 * or the organization name.
928 *
929 * <p> Use in Bundle {@link #EXTRA_PROVISIONING_DISCLAIMERS}
Victor Chang98607132017-01-27 11:51:56 +0000930 *
931 * <p> System app, i.e. application with {@link ApplicationInfo#FLAG_SYSTEM}, can also insert a
932 * disclaimer by declaring an application-level meta-data in {@code AndroidManifest.xml}.
933 * Must use it with {@link #EXTRA_PROVISIONING_DISCLAIMER_CONTENT}. Here is the example:
934 *
935 * <pre>
936 * &lt;meta-data
937 * android:name="android.app.extra.PROVISIONING_DISCLAIMER_HEADER"
938 * android:resource="@string/disclaimer_header"
939 * /&gt;</pre>
Victor Changc10f6692016-12-09 15:24:00 +0000940 */
941 public static final String EXTRA_PROVISIONING_DISCLAIMER_HEADER =
942 "android.app.extra.PROVISIONING_DISCLAIMER_HEADER";
943
944 /**
945 * A {@link Uri} extra pointing to disclaimer content.
946 *
947 * <h5>The following URI schemes are accepted:</h5>
948 * <ul>
949 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
950 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
951 * </ul>
952 *
953 * <p> Styled text is supported in the disclaimer content. The content is parsed by
954 * {@link android.text.Html#fromHtml(String)} and displayed in a
955 * {@link android.widget.TextView}.
956 *
957 * <p> If a <code>content:</code> URI is passed, URI is passed, the intent should have the flag
958 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
959 * {@link android.content.ClipData} of the intent too.
960 *
961 * <p> Use in Bundle {@link #EXTRA_PROVISIONING_DISCLAIMERS}
Victor Chang98607132017-01-27 11:51:56 +0000962 *
963 * <p> System app, i.e. application with {@link ApplicationInfo#FLAG_SYSTEM}, can also insert a
964 * disclaimer by declaring an application-level meta-data in {@code AndroidManifest.xml}.
965 * Must use it with {@link #EXTRA_PROVISIONING_DISCLAIMER_HEADER}. Here is the example:
966 *
967 * <pre>
968 * &lt;meta-data
969 * android:name="android.app.extra.PROVISIONING_DISCLAIMER_CONTENT"
970 * android:resource="@string/disclaimer_content"
971 * /&gt;</pre>
Victor Changc10f6692016-12-09 15:24:00 +0000972 */
973 public static final String EXTRA_PROVISIONING_DISCLAIMER_CONTENT =
974 "android.app.extra.PROVISIONING_DISCLAIMER_CONTENT";
975
976 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000977 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
978 * during setup-wizard.
979 *
980 * <p>If unspecified, defaults to {@code true} to match the behavior in
981 * {@link android.os.Build.VERSION_CODES#M} and earlier.
982 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000983 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
984 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000985 *
986 * @hide
987 */
988 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
989 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
990
991 /**
Victor Chang51d84f92016-11-16 12:22:56 +0000992 * A boolean extra indicating if the user consent steps from the provisioning flow should be
993 * skipped. If unspecified, defaults to {@code false}.
994 *
995 * It can only be used by an existing device owner trying to create a managed profile via
996 * {@link #ACTION_PROVISION_MANAGED_PROFILE}. Otherwise it is ignored.
997 */
998 public static final String EXTRA_PROVISIONING_SKIP_USER_CONSENT =
999 "android.app.extra.PROVISIONING_SKIP_USER_CONSENT";
1000
1001 /**
Benjamin Franzea956242016-03-21 15:45:56 +00001002 * This MIME type is used for starting the device owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +01001003 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -04001004 * <p>During device owner provisioning a device admin app is set as the owner of the device.
1005 * A device owner has full control over the device. The device owner can not be modified by the
1006 * user and the only way of resetting the device is if the device owner app calls a factory
1007 * reset.
1008 *
1009 * <p> A typical use case would be a device that is owned by a company, but used by either an
1010 * employee or client.
1011 *
Benjamin Franzea956242016-03-21 15:45:56 +00001012 * <p> The NFC message must be sent to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +01001013 *
Sander Alewijnse8c411562014-11-12 18:03:11 +00001014 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +01001015 * contains the following properties:
1016 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -04001017 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
1018 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +01001019 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -04001020 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +01001021 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
1022 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
1023 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
1024 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
1025 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
1026 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
1027 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
1028 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
1029 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
1030 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +01001031 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
1032 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
1033 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +01001034 *
Nicolas Prevot18440252015-03-09 14:07:17 +00001035 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001036 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -04001037 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
1038 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
1039 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -04001040 */
1041 public static final String MIME_TYPE_PROVISIONING_NFC
1042 = "application/com.android.managedprovisioning";
1043
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +01001044 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001045 * Activity action: ask the user to add a new device administrator to the system.
1046 * The desired policy is the ComponentName of the policy in the
1047 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
1048 * bring the user through adding the device administrator to the system (or
1049 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001050 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001051 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
1052 * field to provide the user with additional explanation (in addition
1053 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001054 *
1055 * <p>If your administrator is already active, this will ordinarily return immediately (without
1056 * user intervention). However, if your administrator has been updated and is requesting
1057 * additional uses-policy flags, the user will be presented with the new list. New policies
1058 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001059 */
1060 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1061 public static final String ACTION_ADD_DEVICE_ADMIN
1062 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001063
Dianne Hackbornd6847842010-01-12 18:14:19 -08001064 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001065 * @hide
1066 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -07001067 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001068 *
Amith Yamasani814e9872015-03-23 14:04:53 -07001069 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
1070 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001071 * to remotely control restrictions on the user.
1072 *
Makoto Onukic8a5a552015-11-19 14:29:12 -08001073 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001074 * result of whether or not the user approved the action. If approved, the result will
1075 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
1076 * as a profile owner.
1077 *
1078 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
1079 * field to provide the user with additional explanation (in addition
1080 * to your component's description) about what is being added.
1081 *
Amith Yamasani814e9872015-03-23 14:04:53 -07001082 * <p>If there is already a profile owner active or the caller is not a system app, the
1083 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001084 */
1085 @SystemApi
1086 public static final String ACTION_SET_PROFILE_OWNER
1087 = "android.app.action.SET_PROFILE_OWNER";
1088
1089 /**
1090 * @hide
1091 * Name of the profile owner admin that controls the user.
1092 */
1093 @SystemApi
1094 public static final String EXTRA_PROFILE_OWNER_NAME
1095 = "android.app.extra.PROFILE_OWNER_NAME";
1096
1097 /**
Nicolas Prevot00799002015-07-27 18:15:20 +01001098 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -07001099 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001100 *
Jim Miller284b62e2010-06-08 14:27:42 -07001101 * @hide
1102 */
1103 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
1104 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
1105
1106 /**
Tony Mak1970f972016-08-30 17:41:48 +01001107 * Broadcast action: sent when the device owner is set, changed or cleared.
Nicolas Prevot00799002015-07-27 18:15:20 +01001108 *
1109 * This broadcast is sent only to the primary user.
1110 * @see #ACTION_PROVISION_MANAGED_DEVICE
1111 */
1112 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1113 public static final String ACTION_DEVICE_OWNER_CHANGED
1114 = "android.app.action.DEVICE_OWNER_CHANGED";
1115
1116 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001117 * The ComponentName of the administrator component.
1118 *
1119 * @see #ACTION_ADD_DEVICE_ADMIN
1120 */
1121 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001122
Dianne Hackbornd6847842010-01-12 18:14:19 -08001123 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001124 * An optional CharSequence providing additional explanation for why the
1125 * admin is being added.
1126 *
1127 * @see #ACTION_ADD_DEVICE_ADMIN
1128 */
1129 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001130
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001131 /**
phweiss73145f42017-01-17 19:06:38 +01001132 * Constant to indicate the feature of disabling the camera. Used as argument to
1133 * {@link #createAdminSupportIntent(String)}.
1134 * @see #setCameraDisabled(ComponentName, boolean)
1135 */
1136 public static final String POLICY_DISABLE_CAMERA = "policy_disable_camera";
1137
1138 /**
1139 * Constant to indicate the feature of disabling screen captures. Used as argument to
1140 * {@link #createAdminSupportIntent(String)}.
1141 * @see #setScreenCaptureDisabled(ComponentName, boolean)
1142 */
1143 public static final String POLICY_DISABLE_SCREEN_CAPTURE = "policy_disable_screen_capture";
1144
1145 /**
1146 * A String indicating a specific restricted feature. Can be a user restriction from the
1147 * {@link UserManager}, e.g. {@link UserManager#DISALLOW_ADJUST_VOLUME}, or one of the values
1148 * {@link #POLICY_DISABLE_CAMERA} or {@link #POLICY_DISABLE_SCREEN_CAPTURE}.
1149 * @see #createAdminSupportIntent(String)
1150 * @hide
1151 */
1152 @TestApi
1153 public static final String EXTRA_RESTRICTION = "android.app.extra.RESTRICTION";
1154
1155 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001156 * Activity action: have the user enter a new password. This activity should
1157 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
1158 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
1159 * enter a new password that meets the current requirements. You can use
1160 * {@link #isActivePasswordSufficient()} to determine whether you need to
1161 * have the user select a new password in order to meet the current
1162 * constraints. Upon being resumed from this activity, you can check the new
1163 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +00001164 *
1165 * If the intent is launched from within a managed profile with a profile
1166 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
1167 * this will trigger entering a new password for the parent of the profile.
1168 * For all other cases it will trigger entering a new password for the user
1169 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001170 *
1171 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -08001172 */
1173 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1174 public static final String ACTION_SET_NEW_PASSWORD
1175 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001176
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00001177 /**
Benjamin Franzc9921092016-01-08 17:17:44 +00001178 * Activity action: have the user enter a new password for the parent profile.
1179 * If the intent is launched from within a managed profile, this will trigger
1180 * entering a new password for the parent of the profile. In all other cases
1181 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
1182 */
1183 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1184 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
1185 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
1186
1187 /**
phweissa0cb2512016-12-14 21:37:48 +01001188 * Broadcast action: Tell the status bar to open the device monitoring dialog, e.g. when
1189 * Network logging was enabled and the user tapped the notification.
1190 * <p class="note">This is a protected intent that can only be sent by the system.</p>
1191 * @hide
1192 */
1193 public static final String ACTION_SHOW_DEVICE_MONITORING_DIALOG
1194 = "android.app.action.SHOW_DEVICE_MONITORING_DIALOG";
1195
1196 /**
Edman Anjos9e62c312017-01-26 22:22:58 +01001197 * Broadcast Action: Sent after application delegation scopes are changed. The new delegation
1198 * scopes will be sent in an {@code ArrayList<String>} extra identified by the
1199 * {@link #EXTRA_DELEGATION_SCOPES} key.
Edman Anjosf9946772016-11-28 16:35:15 +01001200 *
1201 * <p class=”note”> Note: This is a protected intent that can only be sent by the system.</p>
1202 */
1203 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1204 public static final String ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED =
1205 "android.app.action.APPLICATION_DELEGATION_SCOPES_CHANGED";
1206
1207 /**
Edman Anjos9e62c312017-01-26 22:22:58 +01001208 * An {@code ArrayList<String>} corresponding to the delegation scopes given to an app in the
Edman Anjosf9946772016-11-28 16:35:15 +01001209 * {@link #ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED} broadcast.
1210 */
1211 public static final String EXTRA_DELEGATION_SCOPES = "android.app.extra.DELEGATION_SCOPES";
1212
1213 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +00001214 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
1215 * the parent profile to access intents sent from the managed profile.
1216 * That is, when an app in the managed profile calls
1217 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
1218 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00001219 */
Nicolas Prevot86a96732014-09-08 12:13:05 +01001220 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00001221
1222 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +00001223 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
1224 * the managed profile to access intents sent from the parent profile.
1225 * That is, when an app in the parent profile calls
1226 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
1227 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00001228 */
Nicolas Prevot86a96732014-09-08 12:13:05 +01001229 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001230
Dianne Hackbornd6847842010-01-12 18:14:19 -08001231 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01001232 * Broadcast action: notify that a new local system update policy has been set by the device
1233 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00001234 */
1235 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +01001236 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
1237 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +00001238
Amith Yamasanid49489b2015-04-28 14:00:26 -07001239 /**
1240 * Permission policy to prompt user for new permission requests for runtime permissions.
1241 * Already granted or denied permissions are not affected by this.
1242 */
1243 public static final int PERMISSION_POLICY_PROMPT = 0;
1244
1245 /**
1246 * Permission policy to always grant new permission requests for runtime permissions.
1247 * Already granted or denied permissions are not affected by this.
1248 */
1249 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
1250
1251 /**
1252 * Permission policy to always deny new permission requests for runtime permissions.
1253 * Already granted or denied permissions are not affected by this.
1254 */
1255 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
1256
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07001257 /**
1258 * Runtime permission state: The user can manage the permission
1259 * through the UI.
1260 */
1261 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
1262
1263 /**
1264 * Runtime permission state: The permission is granted to the app
1265 * and the user cannot manage the permission through the UI.
1266 */
1267 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
1268
1269 /**
1270 * Runtime permission state: The permission is denied to the app
1271 * and the user cannot manage the permission through the UI.
1272 */
1273 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +00001274
1275 /**
Edman Anjosf9946772016-11-28 16:35:15 +01001276 * Delegation of certificate installation and management. This scope grants access to the
1277 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
1278 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair} APIs.
1279 */
1280 public static final String DELEGATION_CERT_INSTALL = "delegation-cert-install";
1281
1282 /**
1283 * Delegation of application restrictions management. This scope grants access to the
1284 * {@link #setApplicationRestrictions} and {@link #getApplicationRestrictions} APIs.
1285 */
1286 public static final String DELEGATION_APP_RESTRICTIONS = "delegation-app-restrictions";
1287
1288 /**
Edman Anjosa5f2fb12016-12-19 11:25:54 -08001289 * Delegation of application uninstall block. This scope grants access to the
1290 * {@link #setUninstallBlocked} API.
1291 */
1292 public static final String DELEGATION_BLOCK_UNINSTALL = "delegation-block-uninstall";
1293
1294 /**
Edman Anjos52088e42017-01-13 22:26:17 +01001295 * Delegation of permission policy and permission grant state. This scope grants access to the
1296 * {@link #setPermissionPolicy}, {@link #getPermissionGrantState},
1297 * and {@link #setPermissionGrantState} APIs.
1298 */
1299 public static final String DELEGATION_PERMISSION_GRANT = "delegation-permission-grant";
1300
1301 /**
1302 * Delegation of package access state. This scope grants access to the
1303 * {@link #isApplicationHidden}, {@link #setApplicationHidden}, {@link #isPackageSuspended}, and
1304 * {@link #setPackagesSuspended} APIs.
1305 */
1306 public static final String DELEGATION_PACKAGE_ACCESS = "delegation-package-access";
1307
1308 /**
1309 * Delegation for enabling system apps. This scope grants access to the {@link #enableSystemApp}
1310 * API.
1311 */
1312 public static final String DELEGATION_ENABLE_SYSTEM_APP = "delegation-enable-system-app";
1313
1314 /**
1315 * Delegation of management of uninstalled packages. This scope grants access to the
1316 * {@code #setKeepUninstalledPackages} and {@code #getKeepUninstalledPackages} APIs.
1317 * @hide
1318 */
1319 public static final String DELEGATION_KEEP_UNINSTALLED_PACKAGES =
1320 "delegation-keep-uninstalled-packages";
1321
1322 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00001323 * No management for current user in-effect. This is the default.
1324 * @hide
1325 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001326 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001327 public static final int STATE_USER_UNMANAGED = 0;
1328
1329 /**
1330 * Management partially setup, user setup needs to be completed.
1331 * @hide
1332 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001333 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001334 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1335
1336 /**
1337 * Management partially setup, user setup completed.
1338 * @hide
1339 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001340 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001341 public static final int STATE_USER_SETUP_COMPLETE = 2;
1342
1343 /**
1344 * Management setup and active on current user.
1345 * @hide
1346 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001347 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001348 public static final int STATE_USER_SETUP_FINALIZED = 3;
1349
1350 /**
1351 * Management partially setup on a managed profile.
1352 * @hide
1353 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001354 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001355 public static final int STATE_USER_PROFILE_COMPLETE = 4;
1356
1357 /**
1358 * @hide
1359 */
1360 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
1361 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
1362 @Retention(RetentionPolicy.SOURCE)
1363 public @interface UserProvisioningState {}
1364
1365 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001366 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001367 *
1368 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1369 * {@link #ACTION_PROVISION_MANAGED_PROFILE}, {@link #ACTION_PROVISION_MANAGED_USER} and
1370 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when provisioning is allowed.
1371 *
1372 * @hide
1373 */
1374 public static final int CODE_OK = 0;
1375
1376 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001377 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001378 *
1379 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and
1380 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the device already has a device
1381 * owner.
1382 *
1383 * @hide
1384 */
1385 public static final int CODE_HAS_DEVICE_OWNER = 1;
1386
1387 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001388 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001389 *
1390 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1391 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the user has a profile owner and for
1392 * {@link #ACTION_PROVISION_MANAGED_PROFILE} when the profile owner is already set.
1393 *
1394 * @hide
1395 */
1396 public static final int CODE_USER_HAS_PROFILE_OWNER = 2;
1397
1398 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001399 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001400 *
1401 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and
1402 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the user isn't running.
1403 *
1404 * @hide
1405 */
1406 public static final int CODE_USER_NOT_RUNNING = 3;
1407
1408 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001409 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001410 *
1411 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1412 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} if the device has already been setup and
1413 * for {@link #ACTION_PROVISION_MANAGED_USER} if the user has already been setup.
1414 *
1415 * @hide
1416 */
1417 public static final int CODE_USER_SETUP_COMPLETED = 4;
1418
1419 /**
1420 * Code used to indicate that the device also has a user other than the system user.
1421 *
1422 * @hide
1423 */
1424 public static final int CODE_NONSYSTEM_USER_EXISTS = 5;
1425
1426 /**
1427 * Code used to indicate that device has an account that prevents provisioning.
1428 *
1429 * @hide
1430 */
1431 public static final int CODE_ACCOUNTS_NOT_EMPTY = 6;
1432
1433 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001434 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001435 *
1436 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and
1437 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} if the user is not a system user.
1438 *
1439 * @hide
1440 */
1441 public static final int CODE_NOT_SYSTEM_USER = 7;
1442
1443 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001444 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001445 *
1446 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1447 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} and {@link #ACTION_PROVISION_MANAGED_USER}
1448 * when the device is a watch and is already paired.
1449 *
1450 * @hide
1451 */
1452 public static final int CODE_HAS_PAIRED = 8;
1453
1454 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001455 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001456 *
1457 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} and
1458 * {@link #ACTION_PROVISION_MANAGED_USER} on devices which do not support managed users.
1459 *
1460 * @see {@link PackageManager#FEATURE_MANAGED_USERS}
1461 * @hide
1462 */
1463 public static final int CODE_MANAGED_USERS_NOT_SUPPORTED = 9;
1464
1465 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001466 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001467 *
1468 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_USER} if the user is a system user.
1469 *
1470 * @hide
1471 */
1472 public static final int CODE_SYSTEM_USER = 10;
1473
1474 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001475 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001476 *
1477 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when the user cannot have more
1478 * managed profiles.
1479 *
1480 * @hide
1481 */
1482 public static final int CODE_CANNOT_ADD_MANAGED_PROFILE = 11;
1483
1484 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001485 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001486 *
1487 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_USER} and
1488 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} on devices not running with split system
1489 * user.
1490 *
1491 * @hide
1492 */
1493 public static final int CODE_NOT_SYSTEM_USER_SPLIT = 12;
1494
1495 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001496 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001497 *
1498 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1499 * {@link #ACTION_PROVISION_MANAGED_PROFILE}, {@link #ACTION_PROVISION_MANAGED_USER} and
1500 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} on devices which do no support device
1501 * admins.
1502 *
1503 * @hide
1504 */
1505 public static final int CODE_DEVICE_ADMIN_NOT_SUPPORTED = 13;
1506
1507 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001508 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001509 *
Esteban Talavera6c9116a2016-11-24 16:12:44 +00001510 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when the device the user is a
1511 * system user on a split system user device.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001512 *
1513 * @hide
1514 */
1515 public static final int CODE_SPLIT_SYSTEM_USER_DEVICE_SYSTEM_USER = 14;
1516
1517 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001518 * Result code for {@link #checkProvisioningPreCondition}.
1519 *
1520 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when adding a managed profile is
1521 * disallowed by {@link UserManager#DISALLOW_ADD_MANAGED_PROFILE}.
1522 *
1523 * @hide
1524 */
1525 public static final int CODE_ADD_MANAGED_PROFILE_DISALLOWED = 15;
1526
1527 /**
1528 * Result codes for {@link #checkProvisioningPreCondition} indicating all the provisioning pre
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001529 * conditions.
1530 *
1531 * @hide
1532 */
1533 @Retention(RetentionPolicy.SOURCE)
1534 @IntDef({CODE_OK, CODE_HAS_DEVICE_OWNER, CODE_USER_HAS_PROFILE_OWNER, CODE_USER_NOT_RUNNING,
1535 CODE_USER_SETUP_COMPLETED, CODE_NOT_SYSTEM_USER, CODE_HAS_PAIRED,
1536 CODE_MANAGED_USERS_NOT_SUPPORTED, CODE_SYSTEM_USER, CODE_CANNOT_ADD_MANAGED_PROFILE,
1537 CODE_NOT_SYSTEM_USER_SPLIT, CODE_DEVICE_ADMIN_NOT_SUPPORTED,
Esteban Talavera01576862016-12-15 11:16:44 +00001538 CODE_SPLIT_SYSTEM_USER_DEVICE_SYSTEM_USER, CODE_ADD_MANAGED_PROFILE_DISALLOWED})
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001539 public @interface ProvisioningPreCondition {}
1540
1541 /**
Makoto Onukifc73d792017-03-22 14:22:35 -07001542 * Service action: Action for a service that device owner and profile owner can optionally
1543 * own. If a device owner or a profile owner has such a service, the system tries to keep
1544 * a bound connection to it, in order to keep their process always running.
Makoto Onukife739702017-04-25 13:26:21 -07001545 * The service must be protected with the {@link android.Manifest.permission#BIND_DEVICE_ADMIN}
1546 * permission.
Makoto Onukifc73d792017-03-22 14:22:35 -07001547 */
1548 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1549 public static final String ACTION_DEVICE_ADMIN_SERVICE
1550 = "android.app.action.DEVICE_ADMIN_SERVICE";
1551
1552 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001553 * Return true if the given administrator component is currently active (enabled) in the system.
1554 *
1555 * @param admin The administrator component to check for.
1556 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1557 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001558 */
Robin Lee25e26452015-06-02 09:56:29 -07001559 public boolean isAdminActive(@NonNull ComponentName admin) {
Charles He8c760562016-10-25 16:36:53 +01001560 throwIfParentInstance("isAdminActive");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001561 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001562 }
1563
1564 /**
1565 * @see #isAdminActive(ComponentName)
1566 * @hide
1567 */
Robin Lee25e26452015-06-02 09:56:29 -07001568 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001569 if (mService != null) {
1570 try {
Robin Lee25e26452015-06-02 09:56:29 -07001571 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001572 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001573 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001574 }
1575 }
1576 return false;
1577 }
Charles Hedea0c3b2017-01-13 10:04:12 +00001578
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001579 /**
1580 * Return true if the given administrator component is currently being removed
1581 * for the user.
1582 * @hide
1583 */
Robin Lee25e26452015-06-02 09:56:29 -07001584 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001585 if (mService != null) {
1586 try {
Robin Lee25e26452015-06-02 09:56:29 -07001587 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001588 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001589 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001590 }
1591 }
1592 return false;
1593 }
1594
Dianne Hackbornd6847842010-01-12 18:14:19 -08001595 /**
Robin Lee25e26452015-06-02 09:56:29 -07001596 * Return a list of all currently active device administrators' component
1597 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001598 * returned.
1599 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07001600 public @Nullable List<ComponentName> getActiveAdmins() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001601 throwIfParentInstance("getActiveAdmins");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001602 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001603 }
1604
1605 /**
1606 * @see #getActiveAdmins()
1607 * @hide
1608 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07001609 public @Nullable List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001610 if (mService != null) {
1611 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001612 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001613 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001614 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001615 }
1616 }
1617 return null;
1618 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001619
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001620 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001621 * Used by package administration code to determine if a package can be stopped
1622 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001623 * @hide
1624 */
David Ouyang3a83a332017-01-11 16:36:40 -08001625 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001626 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001627 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001628 return packageHasActiveAdmins(packageName, myUserId());
1629 }
1630
1631 /**
1632 * Used by package administration code to determine if a package can be stopped
1633 * or uninstalled.
1634 * @hide
1635 */
1636 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001637 if (mService != null) {
1638 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001639 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001640 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001641 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001642 }
1643 }
1644 return false;
1645 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001646
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001647 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001648 * Remove a current administration component. This can only be called
1649 * by the application that owns the administration component; if you
1650 * try to remove someone else's component, a security exception will be
1651 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001652 *
1653 * <p>Note that the operation is not synchronous and the admin might still be active (as
1654 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001655 *
1656 * @param admin The administration compononent to remove.
1657 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001658 */
Robin Lee25e26452015-06-02 09:56:29 -07001659 public void removeActiveAdmin(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001660 throwIfParentInstance("removeActiveAdmin");
Dianne Hackbornd6847842010-01-12 18:14:19 -08001661 if (mService != null) {
1662 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001663 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001664 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001665 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001666 }
1667 }
1668 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001669
Dianne Hackbornd6847842010-01-12 18:14:19 -08001670 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001671 * Returns true if an administrator has been granted a particular device policy. This can be
1672 * used to check whether the administrator was activated under an earlier set of policies, but
1673 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001674 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001675 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1676 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001677 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001678 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001679 */
Robin Lee25e26452015-06-02 09:56:29 -07001680 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001681 throwIfParentInstance("hasGrantedPolicy");
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001682 if (mService != null) {
1683 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001684 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001685 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001686 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001687 }
1688 }
1689 return false;
1690 }
1691
1692 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001693 * Returns true if the Profile Challenge is available to use for the given profile user.
1694 *
1695 * @hide
1696 */
1697 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1698 if (mService != null) {
1699 try {
1700 return mService.isSeparateProfileChallengeAllowed(userHandle);
1701 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001702 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001703 }
1704 }
1705 return false;
1706 }
1707
1708 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001709 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1710 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001711 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001712 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001713 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001714
Dianne Hackbornd6847842010-01-12 18:14:19 -08001715 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001716 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1717 * recognition technology. This implies technologies that can recognize the identity of
1718 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1719 * Note that quality constants are ordered so that higher values are more restrictive.
1720 */
1721 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1722
1723 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001724 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001725 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001726 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001727 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001728 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001729
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001730 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001731 * Constant for {@link #setPasswordQuality}: the user must have entered a
1732 * password containing at least numeric characters. Note that quality
1733 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001734 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001735 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001736
Dianne Hackbornd6847842010-01-12 18:14:19 -08001737 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001738 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001739 * password containing at least numeric characters with no repeating (4444)
1740 * or ordered (1234, 4321, 2468) sequences. Note that quality
1741 * constants are ordered so that higher values are more restrictive.
1742 */
1743 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1744
1745 /**
1746 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001747 * password containing at least alphabetic (or other symbol) characters.
1748 * Note that quality constants are ordered so that higher values are more
1749 * restrictive.
1750 */
1751 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001752
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001753 /**
1754 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001755 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001756 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001757 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001758 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001759 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001760
Dianne Hackbornd6847842010-01-12 18:14:19 -08001761 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001762 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001763 * password containing at least a letter, a numerical digit and a special
1764 * symbol, by default. With this password quality, passwords can be
1765 * restricted to contain various sets of characters, like at least an
1766 * uppercase letter, etc. These are specified using various methods,
1767 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1768 * that quality constants are ordered so that higher values are more
1769 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001770 */
1771 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1772
1773 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001774 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1775 * modify password. In case this password quality is set, the password is
1776 * managed by a profile owner. The profile owner can set any password,
1777 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1778 * that quality constants are ordered so that higher values are more
1779 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1780 * the highest.
1781 * @hide
1782 */
1783 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1784
1785 /**
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001786 * @hide
1787 *
1788 * adb shell dpm set-{device,profile}-owner will normally not allow installing an owner to
1789 * a user with accounts. {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED}
1790 * and {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} are the account features
1791 * used by authenticator to exempt their accounts from this:
1792 *
1793 * <ul>
1794 * <li>Non-test-only DO/PO still can't be installed when there are accounts.
1795 * <p>In order to make an apk test-only, add android:testOnly="true" to the
1796 * &lt;application&gt; tag in the manifest.
1797 *
1798 * <li>Test-only DO/PO can be installed even when there are accounts, as long as all the
1799 * accounts have the {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} feature.
1800 * Some authenticators claim to have any features, so to detect it, we also check
1801 * {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} and disallow installing
1802 * if any of the accounts have it.
1803 * </ul>
1804 */
Makoto Onuki47c203d2017-02-13 16:21:19 -08001805 @SystemApi
1806 @TestApi
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001807 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED =
1808 "android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED";
1809
1810 /** @hide See {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} */
Makoto Onuki47c203d2017-02-13 16:21:19 -08001811 @SystemApi
1812 @TestApi
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001813 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED =
1814 "android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED";
1815
1816 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001817 * Called by an application that is administering the device to set the password restrictions it
1818 * is imposing. After setting this, the user will not be able to enter a new password that is
1819 * not at least as restrictive as what has been set. Note that the current password will remain
1820 * until the user has set a new one, so the change does not take place immediately. To prompt
1821 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001822 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001823 * <p>
1824 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1825 * requested quality constant (between the policy set here, the user's preference, and any other
1826 * considerations) is the one that is in effect.
1827 * <p>
1828 * The calling device admin must have requested
1829 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1830 * not, a security exception will be thrown.
1831 * <p>
1832 * This method can be called on the {@link DevicePolicyManager} instance returned by
1833 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1834 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001835 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001836 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001837 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1838 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1839 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1840 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1841 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1842 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001843 */
Robin Lee25e26452015-06-02 09:56:29 -07001844 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001845 if (mService != null) {
1846 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001847 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001848 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001849 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001850 }
1851 }
1852 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001853
Dianne Hackbornd6847842010-01-12 18:14:19 -08001854 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001855 * Retrieve the current minimum password quality for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001856 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001857 * a separate challenge are not taken into account.
1858 *
1859 * <p>This method can be called on the {@link DevicePolicyManager} instance
1860 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1861 * restrictions on the parent profile.
1862 *
Robin Lee25e26452015-06-02 09:56:29 -07001863 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001864 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001865 */
Robin Lee25e26452015-06-02 09:56:29 -07001866 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001867 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001868 }
1869
1870 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001871 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001872 if (mService != null) {
1873 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001874 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001875 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001876 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001877 }
1878 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001879 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001880 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001881
Dianne Hackbornd6847842010-01-12 18:14:19 -08001882 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001883 * Called by an application that is administering the device to set the minimum allowed password
1884 * length. After setting this, the user will not be able to enter a new password that is not at
1885 * least as restrictive as what has been set. Note that the current password will remain until
1886 * the user has set a new one, so the change does not take place immediately. To prompt the user
1887 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1888 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1889 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1890 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1891 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1892 * {@link #setPasswordQuality}.
1893 * <p>
1894 * The calling device admin must have requested
1895 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1896 * not, a security exception will be thrown.
1897 * <p>
1898 * This method can be called on the {@link DevicePolicyManager} instance returned by
1899 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1900 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001901 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001902 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001903 * @param length The new desired minimum password length. A value of 0 means there is no
1904 * restriction.
1905 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1906 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001907 */
Robin Lee25e26452015-06-02 09:56:29 -07001908 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001909 if (mService != null) {
1910 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001911 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001912 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001913 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001914 }
1915 }
1916 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001917
Dianne Hackbornd6847842010-01-12 18:14:19 -08001918 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001919 * Retrieve the current minimum password length for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001920 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001921 * a separate challenge are not taken into account.
1922 *
1923 * <p>This method can be called on the {@link DevicePolicyManager} instance
1924 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1925 * restrictions on the parent profile.
1926 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001927 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001928 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001929 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001930 */
Robin Lee25e26452015-06-02 09:56:29 -07001931 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001932 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001933 }
1934
1935 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001936 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001937 if (mService != null) {
1938 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001939 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001940 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001941 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001942 }
1943 }
1944 return 0;
1945 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001946
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001947 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001948 * Called by an application that is administering the device to set the minimum number of upper
1949 * case letters required in the password. After setting this, the user will not be able to enter
1950 * a new password that is not at least as restrictive as what has been set. Note that the
1951 * current password will remain until the user has set a new one, so the change does not take
1952 * place immediately. To prompt the user for a new password, use
1953 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1954 * setting this value. This constraint is only imposed if the administrator has also requested
1955 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001956 * <p>
1957 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001958 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1959 * not, a security exception will be thrown.
1960 * <p>
1961 * This method can be called on the {@link DevicePolicyManager} instance returned by
1962 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1963 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001964 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001965 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1966 * @param length The new desired minimum number of upper case letters required in the password.
1967 * A value of 0 means there is no restriction.
1968 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1969 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001970 */
Robin Lee25e26452015-06-02 09:56:29 -07001971 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001972 if (mService != null) {
1973 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001974 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001975 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001976 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001977 }
1978 }
1979 }
1980
1981 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001982 * Retrieve the current number of upper case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001983 * for a particular admin or all admins that set restrictions on this user and
Esteban Talaverac1c83592016-02-17 17:56:15 +00001984 * its participating profiles. Restrictions on profiles that have a separate challenge
1985 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001986 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001987 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001988 * and only applies when the password quality is
1989 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001990 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001991 * <p>This method can be called on the {@link DevicePolicyManager} instance
1992 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1993 * restrictions on the parent profile.
1994 *
Robin Lee25e26452015-06-02 09:56:29 -07001995 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001996 * aggregate all admins.
1997 * @return The minimum number of upper case letters required in the
1998 * password.
1999 */
Robin Lee25e26452015-06-02 09:56:29 -07002000 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002001 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002002 }
2003
2004 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002005 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002006 if (mService != null) {
2007 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002008 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002009 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002010 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002011 }
2012 }
2013 return 0;
2014 }
2015
2016 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002017 * Called by an application that is administering the device to set the minimum number of lower
2018 * case letters required in the password. After setting this, the user will not be able to enter
2019 * a new password that is not at least as restrictive as what has been set. Note that the
2020 * current password will remain until the user has set a new one, so the change does not take
2021 * place immediately. To prompt the user for a new password, use
2022 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
2023 * setting this value. This constraint is only imposed if the administrator has also requested
2024 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002025 * <p>
2026 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002027 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2028 * not, a security exception will be thrown.
2029 * <p>
2030 * This method can be called on the {@link DevicePolicyManager} instance returned by
2031 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2032 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002033 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002034 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2035 * @param length The new desired minimum number of lower case letters required in the password.
2036 * A value of 0 means there is no restriction.
2037 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2038 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002039 */
Robin Lee25e26452015-06-02 09:56:29 -07002040 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002041 if (mService != null) {
2042 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002043 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002044 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002045 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002046 }
2047 }
2048 }
2049
2050 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002051 * Retrieve the current number of lower case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002052 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002053 * and its participating profiles. Restrictions on profiles that have
2054 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01002055 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00002056 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002057 * and only applies when the password quality is
2058 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002059 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002060 * <p>This method can be called on the {@link DevicePolicyManager} instance
2061 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2062 * restrictions on the parent profile.
2063 *
Robin Lee25e26452015-06-02 09:56:29 -07002064 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002065 * aggregate all admins.
2066 * @return The minimum number of lower case letters required in the
2067 * password.
2068 */
Robin Lee25e26452015-06-02 09:56:29 -07002069 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002070 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002071 }
2072
2073 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002074 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002075 if (mService != null) {
2076 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002077 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002078 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002079 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002080 }
2081 }
2082 return 0;
2083 }
2084
2085 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002086 * Called by an application that is administering the device to set the minimum number of
2087 * letters required in the password. After setting this, the user will not be able to enter a
2088 * new password that is not at least as restrictive as what has been set. Note that the current
2089 * password will remain until the user has set a new one, so the change does not take place
2090 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
2091 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
2092 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
2093 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002094 * <p>
2095 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002096 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2097 * not, a security exception will be thrown.
2098 * <p>
2099 * This method can be called on the {@link DevicePolicyManager} instance returned by
2100 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2101 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002102 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002103 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2104 * @param length The new desired minimum number of letters required in the password. A value of
2105 * 0 means there is no restriction.
2106 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2107 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002108 */
Robin Lee25e26452015-06-02 09:56:29 -07002109 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002110 if (mService != null) {
2111 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002112 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002113 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002114 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002115 }
2116 }
2117 }
2118
2119 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002120 * Retrieve the current number of letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002121 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002122 * and its participating profiles. Restrictions on profiles that have
2123 * a separate challenge are not taken into account.
2124 * This is the same value as set by
2125 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002126 * and only applies when the password quality is
2127 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002128 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002129 * <p>This method can be called on the {@link DevicePolicyManager} instance
2130 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2131 * restrictions on the parent profile.
2132 *
Robin Lee25e26452015-06-02 09:56:29 -07002133 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002134 * aggregate all admins.
2135 * @return The minimum number of letters required in the password.
2136 */
Robin Lee25e26452015-06-02 09:56:29 -07002137 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002138 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002139 }
2140
2141 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002142 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002143 if (mService != null) {
2144 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002145 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002146 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002147 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002148 }
2149 }
2150 return 0;
2151 }
2152
2153 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002154 * Called by an application that is administering the device to set the minimum number of
2155 * numerical digits required in the password. After setting this, the user will not be able to
2156 * enter a new password that is not at least as restrictive as what has been set. Note that the
2157 * current password will remain until the user has set a new one, so the change does not take
2158 * place immediately. To prompt the user for a new password, use
2159 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
2160 * setting this value. This constraint is only imposed if the administrator has also requested
2161 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002162 * <p>
2163 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002164 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2165 * not, a security exception will be thrown.
2166 * <p>
2167 * This method can be called on the {@link DevicePolicyManager} instance returned by
2168 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2169 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002170 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002171 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2172 * @param length The new desired minimum number of numerical digits required in the password. A
2173 * value of 0 means there is no restriction.
2174 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2175 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002176 */
Robin Lee25e26452015-06-02 09:56:29 -07002177 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002178 if (mService != null) {
2179 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002180 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002181 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002182 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002183 }
2184 }
2185 }
2186
2187 /**
2188 * Retrieve the current number of numerical digits required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002189 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002190 * and its participating profiles. Restrictions on profiles that have
2191 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01002192 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00002193 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002194 * and only applies when the password quality is
2195 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002196 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002197 * <p>This method can be called on the {@link DevicePolicyManager} instance
2198 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2199 * restrictions on the parent profile.
2200 *
Robin Lee25e26452015-06-02 09:56:29 -07002201 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002202 * aggregate all admins.
2203 * @return The minimum number of numerical digits required in the password.
2204 */
Robin Lee25e26452015-06-02 09:56:29 -07002205 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002206 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002207 }
2208
2209 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002210 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002211 if (mService != null) {
2212 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002213 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002214 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002215 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002216 }
2217 }
2218 return 0;
2219 }
2220
2221 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002222 * Called by an application that is administering the device to set the minimum number of
2223 * symbols required in the password. After setting this, the user will not be able to enter a
2224 * new password that is not at least as restrictive as what has been set. Note that the current
2225 * password will remain until the user has set a new one, so the change does not take place
2226 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
2227 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
2228 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
2229 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002230 * <p>
2231 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002232 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2233 * not, a security exception will be thrown.
2234 * <p>
2235 * This method can be called on the {@link DevicePolicyManager} instance returned by
2236 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2237 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002238 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002239 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2240 * @param length The new desired minimum number of symbols required in the password. A value of
2241 * 0 means there is no restriction.
2242 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2243 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002244 */
Robin Lee25e26452015-06-02 09:56:29 -07002245 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002246 if (mService != null) {
2247 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002248 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002249 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002250 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002251 }
2252 }
2253 }
2254
2255 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002256 * Retrieve the current number of symbols required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002257 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002258 * and its participating profiles. Restrictions on profiles that have
2259 * a separate challenge are not taken into account. This is the same value as
2260 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002261 * and only applies when the password quality is
2262 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002263 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002264 * <p>This method can be called on the {@link DevicePolicyManager} instance
2265 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2266 * restrictions on the parent profile.
2267 *
Robin Lee25e26452015-06-02 09:56:29 -07002268 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002269 * aggregate all admins.
2270 * @return The minimum number of symbols required in the password.
2271 */
Robin Lee25e26452015-06-02 09:56:29 -07002272 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002273 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002274 }
2275
2276 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002277 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002278 if (mService != null) {
2279 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002280 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002281 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002282 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002283 }
2284 }
2285 return 0;
2286 }
2287
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002288 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002289 * Called by an application that is administering the device to set the minimum number of
2290 * non-letter characters (numerical digits or symbols) required in the password. After setting
2291 * this, the user will not be able to enter a new password that is not at least as restrictive
2292 * as what has been set. Note that the current password will remain until the user has set a new
2293 * one, so the change does not take place immediately. To prompt the user for a new password,
2294 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
2295 * setting this value. This constraint is only imposed if the administrator has also requested
2296 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002297 * <p>
2298 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002299 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2300 * not, a security exception will be thrown.
2301 * <p>
2302 * This method can be called on the {@link DevicePolicyManager} instance returned by
2303 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2304 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002305 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002306 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2307 * @param length The new desired minimum number of letters required in the password. A value of
2308 * 0 means there is no restriction.
2309 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2310 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002311 */
Robin Lee25e26452015-06-02 09:56:29 -07002312 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002313 if (mService != null) {
2314 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002315 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002316 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002317 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002318 }
2319 }
2320 }
2321
2322 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002323 * Retrieve the current number of non-letter characters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002324 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002325 * and its participating profiles. Restrictions on profiles that have
2326 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01002327 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00002328 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002329 * and only applies when the password quality is
2330 * {@link #PASSWORD_QUALITY_COMPLEX}.
2331 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002332 * <p>This method can be called on the {@link DevicePolicyManager} instance
2333 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2334 * restrictions on the parent profile.
2335 *
Robin Lee25e26452015-06-02 09:56:29 -07002336 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002337 * aggregate all admins.
2338 * @return The minimum number of letters required in the password.
2339 */
Robin Lee25e26452015-06-02 09:56:29 -07002340 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002341 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002342 }
2343
2344 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002345 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002346 if (mService != null) {
2347 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002348 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002349 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002350 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002351 }
2352 }
2353 return 0;
2354 }
2355
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002356 /**
2357 * Called by an application that is administering the device to set the length of the password
2358 * history. After setting this, the user will not be able to enter a new password that is the
2359 * same as any password in the history. Note that the current password will remain until the
2360 * user has set a new one, so the change does not take place immediately. To prompt the user for
2361 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
2362 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
2363 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
2364 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
2365 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
2366 * <p>
2367 * The calling device admin must have requested
2368 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2369 * not, a security exception will be thrown.
2370 * <p>
2371 * This method can be called on the {@link DevicePolicyManager} instance returned by
2372 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2373 * profile.
2374 *
2375 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2376 * @param length The new desired length of password history. A value of 0 means there is no
2377 * restriction.
2378 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2379 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
2380 */
Robin Lee25e26452015-06-02 09:56:29 -07002381 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002382 if (mService != null) {
2383 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002384 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002385 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002386 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002387 }
2388 }
2389 }
2390
2391 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002392 * Called by a device admin to set the password expiration timeout. Calling this method will
2393 * restart the countdown for password expiration for the given admin, as will changing the
2394 * device password (for all admins).
2395 * <p>
2396 * The provided timeout is the time delta in ms and will be added to the current time. For
2397 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
2398 * 432000000 ms for timeout.
2399 * <p>
2400 * To disable password expiration, a value of 0 may be used for timeout.
2401 * <p>
2402 * The calling device admin must have requested
2403 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
2404 * not, a security exception will be thrown.
2405 * <p>
2406 * Note that setting the password will automatically reset the expiration time for all active
2407 * admins. Active admins do not need to explicitly call this method in that case.
2408 * <p>
2409 * This method can be called on the {@link DevicePolicyManager} instance returned by
2410 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2411 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002412 *
Jim Millera4e28d12010-11-08 16:15:47 -08002413 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002414 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
2415 * there is no restriction (unlimited).
2416 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2417 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08002418 */
Robin Lee25e26452015-06-02 09:56:29 -07002419 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08002420 if (mService != null) {
2421 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002422 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08002423 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002424 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08002425 }
2426 }
2427 }
2428
2429 /**
Jim Miller6b857682011-02-16 16:27:41 -08002430 * Get the password expiration timeout for the given admin. The expiration timeout is the
2431 * recurring expiration timeout provided in the call to
2432 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00002433 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
2434 * have set restrictions on profiles that have a separate challenge are not taken into account.
2435 *
2436 * <p>This method can be called on the {@link DevicePolicyManager} instance
2437 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2438 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08002439 *
Robin Lee25e26452015-06-02 09:56:29 -07002440 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08002441 * @return The timeout for the given admin or the minimum of all timeouts
2442 */
Robin Lee25e26452015-06-02 09:56:29 -07002443 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08002444 if (mService != null) {
2445 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002446 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08002447 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002448 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08002449 }
2450 }
2451 return 0;
2452 }
2453
2454 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002455 * Get the current password expiration time for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002456 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002457 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
2458 * of all expiration times is returned - which will be the minimum of all of them.
2459 *
2460 * <p>This method can be called on the {@link DevicePolicyManager} instance
2461 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2462 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08002463 *
Robin Lee25e26452015-06-02 09:56:29 -07002464 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002465 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08002466 */
Robin Lee25e26452015-06-02 09:56:29 -07002467 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08002468 if (mService != null) {
2469 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002470 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08002471 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002472 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08002473 }
2474 }
2475 return 0;
2476 }
2477
2478 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002479 * Retrieve the current password history length for a particular admin or all admins that
Rubin Xud3609d42016-07-13 18:32:57 +01002480 * set restrictions on this user and its participating profiles. Restrictions on profiles that
Esteban Talaverac1c83592016-02-17 17:56:15 +00002481 * have a separate challenge are not taken into account.
2482 *
2483 * <p>This method can be called on the {@link DevicePolicyManager} instance
2484 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2485 * restrictions on the parent profile.
2486 *
Robin Lee25e26452015-06-02 09:56:29 -07002487 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002488 * all admins.
2489 * @return The length of the password history
2490 */
Robin Lee25e26452015-06-02 09:56:29 -07002491 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002492 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002493 }
2494
2495 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002496 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002497 if (mService != null) {
2498 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002499 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002500 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002501 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002502 }
2503 }
2504 return 0;
2505 }
2506
Dianne Hackbornd6847842010-01-12 18:14:19 -08002507 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08002508 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002509 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08002510 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08002511 * @return Returns the maximum length that the user can enter.
2512 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002513 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002514 // Kind-of arbitrary.
2515 return 16;
2516 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002517
Dianne Hackborn254cb442010-01-27 19:23:59 -08002518 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002519 * Determine whether the current password the user has set is sufficient to meet the policy
2520 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
2521 * user and its participating profiles. Restrictions on profiles that have a separate challenge
Andrew Scull5daf2732016-11-14 15:02:45 +00002522 * are not taken into account. The user must be unlocked in order to perform the check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002523 * <p>
2524 * The calling device admin must have requested
2525 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2526 * not, a security exception will be thrown.
2527 * <p>
2528 * This method can be called on the {@link DevicePolicyManager} instance returned by
2529 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
2530 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002531 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01002532 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002533 * @throws SecurityException if the calling application does not own an active administrator
2534 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Andrew Scull5daf2732016-11-14 15:02:45 +00002535 * @throws InvalidStateException if the user is not unlocked.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002536 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002537 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002538 if (mService != null) {
2539 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002540 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002541 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002542 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002543 }
2544 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002545 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002546 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002547
Dianne Hackbornd6847842010-01-12 18:14:19 -08002548 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002549 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002550 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002551 * requested by the admins of the parent user and its profiles.
2552 *
2553 * @param userHandle the userId of the profile to check the password for.
2554 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002555 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002556 * @hide
2557 */
2558 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2559 if (mService != null) {
2560 try {
2561 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2562 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002563 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002564 }
2565 }
2566 return false;
2567 }
2568
2569 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002570 * Retrieve the number of times the user has failed at entering a password since that last
2571 * successful password entry.
2572 * <p>
2573 * This method can be called on the {@link DevicePolicyManager} instance returned by
2574 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2575 * password attemts for the parent user.
2576 * <p>
2577 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2578 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002579 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002580 * @return The number of times user has entered an incorrect password since the last correct
2581 * password entry.
2582 * @throws SecurityException if the calling application does not own an active administrator
2583 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002584 */
2585 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002586 return getCurrentFailedPasswordAttempts(myUserId());
2587 }
2588
2589 /**
2590 * Retrieve the number of times the given user has failed at entering a
2591 * password since that last successful password entry.
2592 *
2593 * <p>The calling device admin must have requested
2594 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2595 * not and it is not the system uid, a security exception will be thrown.
2596 *
2597 * @hide
2598 */
2599 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002600 if (mService != null) {
2601 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002602 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002603 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002604 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002605 }
2606 }
2607 return -1;
2608 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002609
2610 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002611 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002612 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002613 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002614 * @hide
2615 */
2616 public boolean getDoNotAskCredentialsOnBoot() {
2617 if (mService != null) {
2618 try {
2619 return mService.getDoNotAskCredentialsOnBoot();
2620 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002621 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002622 }
2623 }
2624 return false;
2625 }
2626
2627 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002628 * Setting this to a value greater than zero enables a built-in policy that will perform a
2629 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2630 * This built-in policy combines watching for failed passwords and wiping the device, and
2631 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002632 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002633 * <p>
2634 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2635 * revoking credentials, or reporting the failure to a server), you should implement
2636 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2637 * use this API, because if the maximum count is reached, the device or profile will be wiped
2638 * immediately, and your callback will not be invoked.
2639 * <p>
2640 * This method can be called on the {@link DevicePolicyManager} instance returned by
2641 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2642 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002643 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002644 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002645 * @param num The number of failed password attempts at which point the device or profile will
2646 * be wiped.
2647 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2648 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2649 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002650 */
Robin Lee25e26452015-06-02 09:56:29 -07002651 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002652 if (mService != null) {
2653 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002654 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002655 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002656 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002657 }
2658 }
2659 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002660
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002661 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002662 * Retrieve the current maximum number of login attempts that are allowed before the device
Rubin Xud3609d42016-07-13 18:32:57 +01002663 * or profile is wiped, for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002664 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2665 * not taken into account.
2666 *
2667 * <p>This method can be called on the {@link DevicePolicyManager} instance
2668 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2669 * the value for the parent profile.
2670 *
Robin Lee25e26452015-06-02 09:56:29 -07002671 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002672 * all admins.
2673 */
Robin Lee25e26452015-06-02 09:56:29 -07002674 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002675 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002676 }
2677
2678 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002679 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002680 if (mService != null) {
2681 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002682 return mService.getMaximumFailedPasswordsForWipe(
2683 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002684 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002685 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002686 }
2687 }
2688 return 0;
2689 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002690
Dianne Hackborn254cb442010-01-27 19:23:59 -08002691 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002692 * Returns the profile with the smallest maximum failed passwords for wipe,
2693 * for the given user. So for primary user, it might return the primary or
2694 * a managed profile. For a secondary user, it would be the same as the
2695 * user passed in.
2696 * @hide Used only by Keyguard
2697 */
2698 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2699 if (mService != null) {
2700 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002701 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2702 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002703 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002704 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002705 }
2706 }
2707 return UserHandle.USER_NULL;
2708 }
2709
2710 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002711 * Flag for {@link #resetPassword}: don't allow other admins to change
2712 * the password again until the user has entered it.
2713 */
2714 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002715
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002716 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002717 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2718 * If the flag is set, the device can be booted without asking for user password.
2719 * The absence of this flag does not change the current boot requirements. This flag
2720 * can be set by the device owner only. If the app is not the device owner, the flag
2721 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2722 * device to factory defaults.
2723 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002724 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002725
2726 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002727 * Force a new device unlock password (the password needed to access the entire device, not for
2728 * individual accounts) on the user. This takes effect immediately.
2729 * <p>
Rubin Xuaab7a412016-12-30 21:13:29 +00002730 * <em>For device owner and profile owners targeting SDK level
2731 * {@link android.os.Build.VERSION_CODES#O} or above, this API is no longer available and will
2732 * throw {@link SecurityException}. Please use the new API {@link #resetPasswordWithToken}
2733 * instead. </em>
2734 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002735 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002736 * device admins that are not device owner and not profile owner.
2737 * The password can now only be changed if there is currently no password set. Device owner
Ricky Wai977ade22016-05-24 15:02:41 +01002738 * and profile owner can still do this when user is unlocked and does not have a managed
2739 * profile.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002740 * <p>
2741 * The given password must be sufficient for the current password quality and length constraints
2742 * as returned by {@link #getPasswordQuality(ComponentName)} and
2743 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2744 * it will be rejected and false returned. Note that the password may be a stronger quality
2745 * (containing alphanumeric characters when the requested quality is only numeric), in which
2746 * case the currently active quality will be increased to match.
2747 * <p>
2748 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002749 * current password constraints allow it. <em>Note: This will not work in
2750 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2751 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2752 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002753 * <p>
2754 * The calling device admin must have requested
2755 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2756 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002757 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002758 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002759 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002760 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2761 * @return Returns true if the password was applied, or false if it is not acceptable for the
2762 * current constraints or if the user has not been decrypted yet.
2763 * @throws SecurityException if the calling application does not own an active administrator
2764 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Ricky Wai977ade22016-05-24 15:02:41 +01002765 * @throws IllegalStateException if the calling user is locked or has a managed profile.
Andrew Scull3f81f4e2016-07-29 16:29:58 +01002766 * @throws IllegalArgumentException if the password does not meet system requirements.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002767 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002768 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002769 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002770 if (mService != null) {
2771 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002772 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002773 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002774 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002775 }
2776 }
2777 return false;
2778 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002779
Dianne Hackbornd6847842010-01-12 18:14:19 -08002780 /**
Rubin Xuaab7a412016-12-30 21:13:29 +00002781 * Called by a profile or device owner to provision a token which can later be used to reset the
Esteban Talavera7e4cbad2017-03-30 17:59:50 +01002782 * device lockscreen password (if called by device owner), or managed profile challenge (if
2783 * called by profile owner), via {@link #resetPasswordWithToken}.
Rubin Xuaab7a412016-12-30 21:13:29 +00002784 * <p>
2785 * If the user currently has a lockscreen password, the provisioned token will not be
2786 * immediately usable; it only becomes active after the user performs a confirm credential
2787 * operation, which can be triggered by {@link KeyguardManager#createConfirmDeviceCredentialIntent}.
2788 * If the user has no lockscreen password, the token is activated immediately. In all cases,
2789 * the active state of the current token can be checked by {@link #isResetPasswordTokenActive}.
2790 * For security reasons, un-activated tokens are only stored in memory and will be lost once
2791 * the device reboots. In this case a new token needs to be provisioned again.
2792 * <p>
2793 * Once provisioned and activated, the token will remain effective even if the user changes
2794 * or clears the lockscreen password.
2795 * <p>
2796 * <em>This token is highly sensitive and should be treated at the same level as user
Rubin Xuf7b036d2017-04-05 18:37:07 +01002797 * credentials. In particular, NEVER store this token on device in plaintext. Do not store
2798 * the plaintext token in device-encrypted storage if it will be needed to reset password on
2799 * file-based encryption devices before user unlocks. Consider carefully how any password token
2800 * will be stored on your server and who will need access to them. Tokens may be the subject of
2801 * legal access requests.
Rubin Xuaab7a412016-12-30 21:13:29 +00002802 * </em>
2803 *
2804 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2805 * @param token a secure token a least 32-byte long, which must be generated by a
2806 * cryptographically strong random number generator.
2807 * @return true if the operation is successful, false otherwise.
2808 * @throws IllegalArgumentException if the supplied token is invalid.
2809 * @throws SecurityException
2810 */
2811 public boolean setResetPasswordToken(ComponentName admin, byte[] token) {
2812 throwIfParentInstance("setResetPasswordToken");
2813 if (mService != null) {
2814 try {
2815 return mService.setResetPasswordToken(admin, token);
2816 } catch (RemoteException e) {
2817 throw e.rethrowFromSystemServer();
2818 }
2819 }
2820 return false;
2821 }
2822
2823 /**
2824 * Called by a profile or device owner to revoke the current password reset token.
2825 *
2826 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2827 * @return true if the operation is successful, false otherwise.
2828 */
2829 public boolean clearResetPasswordToken(ComponentName admin) {
2830 throwIfParentInstance("clearResetPasswordToken");
2831 if (mService != null) {
2832 try {
2833 return mService.clearResetPasswordToken(admin);
2834 } catch (RemoteException e) {
2835 throw e.rethrowFromSystemServer();
2836 }
2837 }
2838 return false;
2839 }
2840
2841 /**
2842 * Called by a profile or device owner to check if the current reset password token is active.
2843 *
2844 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2845 * @return true if the token is active, false otherwise.
2846 * @throws IllegalStateException if no token has been set.
2847 */
2848 public boolean isResetPasswordTokenActive(ComponentName admin) {
2849 throwIfParentInstance("isResetPasswordTokenActive");
2850 if (mService != null) {
2851 try {
2852 return mService.isResetPasswordTokenActive(admin);
2853 } catch (RemoteException e) {
2854 throw e.rethrowFromSystemServer();
2855 }
2856 }
2857 return false;
2858 }
2859
2860 /**
Esteban Talavera7e4cbad2017-03-30 17:59:50 +01002861 * Called by device or profile owner to force set a new device unlock password or a managed
2862 * profile challenge on current user. This takes effect immediately.
Rubin Xuaab7a412016-12-30 21:13:29 +00002863 * <p>
2864 * Unlike {@link #resetPassword}, this API can change the password even before the user or
2865 * device is unlocked or decrypted. The supplied token must have been previously provisioned via
2866 * {@link #setResetPasswordToken}, and in active state {@link #isResetPasswordTokenActive}.
2867 * <p>
2868 * The given password must be sufficient for the current password quality and length constraints
2869 * as returned by {@link #getPasswordQuality(ComponentName)} and
2870 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2871 * it will be rejected and false returned. Note that the password may be a stronger quality
2872 * (containing alphanumeric characters when the requested quality is only numeric), in which
2873 * case the currently active quality will be increased to match.
2874 * <p>
2875 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
2876 * current password constraints allow it.
2877 *
2878 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2879 * @param password The new password for the user. Null or empty clears the password.
2880 * @param token the password reset token previously provisioned by #setResetPasswordToken.
2881 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
2882 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2883 * @return Returns true if the password was applied, or false if it is not acceptable for the
2884 * current constraints.
2885 * @throws SecurityException if the calling application does not own an active administrator
2886 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
2887 * @throws IllegalStateException if the provided token is not valid.
2888 * @throws IllegalArgumentException if the password does not meet system requirements.
2889 */
2890 public boolean resetPasswordWithToken(@NonNull ComponentName admin, String password,
2891 byte[] token, int flags) {
2892 throwIfParentInstance("resetPassword");
2893 if (mService != null) {
2894 try {
2895 return mService.resetPasswordWithToken(admin, password, token, flags);
2896 } catch (RemoteException e) {
2897 throw e.rethrowFromSystemServer();
2898 }
2899 }
2900 return false;
2901 }
2902
2903 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002904 * Called by an application that is administering the device to set the maximum time for user
2905 * activity until the device will lock. This limits the length that the user can set. It takes
2906 * effect immediately.
2907 * <p>
2908 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2909 * to be able to call this method; if it has not, a security exception will be thrown.
2910 * <p>
2911 * This method can be called on the {@link DevicePolicyManager} instance returned by
2912 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2913 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002914 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002915 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002916 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2917 * is no restriction.
2918 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2919 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002920 */
Robin Lee25e26452015-06-02 09:56:29 -07002921 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002922 if (mService != null) {
2923 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002924 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002925 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002926 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002927 }
2928 }
2929 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002930
Dianne Hackbornd6847842010-01-12 18:14:19 -08002931 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002932 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002933 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002934 * a separate challenge are not taken into account.
2935 *
2936 * <p>This method can be called on the {@link DevicePolicyManager} instance
2937 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2938 * restrictions on the parent profile.
2939 *
Robin Lee25e26452015-06-02 09:56:29 -07002940 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002941 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002942 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002943 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002944 */
Robin Lee25e26452015-06-02 09:56:29 -07002945 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002946 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002947 }
2948
2949 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002950 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002951 if (mService != null) {
2952 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002953 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002954 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002955 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002956 }
2957 }
2958 return 0;
2959 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002960
Dianne Hackbornd6847842010-01-12 18:14:19 -08002961 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002962 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2963 * do not have a separate timeout to lock for work challenge only.
2964 *
2965 * @hide
2966 */
2967 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2968 if (mService != null) {
2969 try {
2970 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2971 } catch (RemoteException e) {
2972 throw e.rethrowFromSystemServer();
2973 }
2974 }
2975 return 0;
2976 }
2977
2978 /**
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002979 * Called by a device/profile owner to set the timeout after which unlocking with secondary, non
2980 * strong auth (e.g. fingerprint, trust agents) times out, i.e. the user has to use a strong
2981 * authentication method like password, pin or pattern.
2982 *
2983 * <p>This timeout is used internally to reset the timer to require strong auth again after
2984 * specified timeout each time it has been successfully used.
2985 *
2986 * <p>Fingerprint can also be disabled altogether using {@link #KEYGUARD_DISABLE_FINGERPRINT}.
2987 *
2988 * <p>Trust agents can also be disabled altogether using {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
2989 *
2990 * <p>The calling device admin must be a device or profile owner. If it is not,
2991 * a {@link SecurityException} will be thrown.
2992 *
Michal Karpinski943aabd2016-10-06 11:09:25 +01002993 * <p>The calling device admin can verify the value it has set by calling
2994 * {@link #getRequiredStrongAuthTimeout(ComponentName)} and passing in its instance.
2995 *
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002996 * <p>This method can be called on the {@link DevicePolicyManager} instance returned by
2997 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2998 * profile.
2999 *
3000 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xu5d39ea72017-04-24 20:26:30 +01003001 * @param timeoutMs The new timeout in milliseconds, after which the user will have to unlock
3002 * with strong authentication method. A value of 0 means the admin is not participating
3003 * in controlling the timeout.
Michal Karpinski943aabd2016-10-06 11:09:25 +01003004 * The minimum and maximum timeouts are platform-defined and are typically 1 hour and
3005 * 72 hours, respectively. Though discouraged, the admin may choose to require strong
3006 * auth at all times using {@link #KEYGUARD_DISABLE_FINGERPRINT} and/or
3007 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01003008 *
3009 * @throws SecurityException if {@code admin} is not a device or profile owner.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01003010 */
3011 public void setRequiredStrongAuthTimeout(@NonNull ComponentName admin,
3012 long timeoutMs) {
3013 if (mService != null) {
3014 try {
3015 mService.setRequiredStrongAuthTimeout(admin, timeoutMs, mParentInstance);
3016 } catch (RemoteException e) {
3017 throw e.rethrowFromSystemServer();
3018 }
3019 }
3020 }
3021
3022 /**
3023 * Determine for how long the user will be able to use secondary, non strong auth for
3024 * authentication, since last strong method authentication (password, pin or pattern) was used.
3025 * After the returned timeout the user is required to use strong authentication method.
3026 *
3027 * <p>This method can be called on the {@link DevicePolicyManager} instance
3028 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3029 * restrictions on the parent profile.
3030 *
3031 * @param admin The name of the admin component to check, or {@code null} to aggregate
3032 * accross all participating admins.
Rubin Xu5d39ea72017-04-24 20:26:30 +01003033 * @return The timeout in milliseconds or 0 if not configured for the provided admin.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01003034 */
3035 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin) {
3036 return getRequiredStrongAuthTimeout(admin, myUserId());
3037 }
3038
3039 /** @hide per-user version */
3040 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin, @UserIdInt int userId) {
3041 if (mService != null) {
3042 try {
3043 return mService.getRequiredStrongAuthTimeout(admin, userId, mParentInstance);
3044 } catch (RemoteException e) {
3045 throw e.rethrowFromSystemServer();
3046 }
3047 }
3048 return DEFAULT_STRONG_AUTH_TIMEOUT_MS;
3049 }
3050
3051 /**
Andrew Scull85a63bc2016-10-24 13:47:47 +01003052 * Flag for {@link #lockNow(int)}: also evict the user's credential encryption key from the
3053 * keyring. The user's credential will need to be entered again in order to derive the
3054 * credential encryption key that will be stored back in the keyring for future use.
3055 * <p>
Andrew Scull17e1b5d2017-04-25 14:44:24 +01003056 * This flag can only be used by a profile owner when locking a managed profile when
3057 * {@link #getStorageEncryptionStatus} returns {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andrew Scull85a63bc2016-10-24 13:47:47 +01003058 * <p>
3059 * In order to secure user data, the user will be stopped and restarted so apps should wait
3060 * until they are next run to perform further actions.
3061 */
Andrew Scull17e1b5d2017-04-25 14:44:24 +01003062 public static final int FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY = 1;
3063
Andrew Scull85a63bc2016-10-24 13:47:47 +01003064 /** @hide */
3065 @Retention(RetentionPolicy.SOURCE)
Andrew Scull17e1b5d2017-04-25 14:44:24 +01003066 @IntDef(flag=true, value={FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY})
Andrew Scull85a63bc2016-10-24 13:47:47 +01003067 public @interface LockNowFlag {}
3068
3069 /**
3070 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
3071 * this call.
3072 * <p>
3073 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
3074 * to be able to call this method; if it has not, a security exception will be thrown.
3075 * <p>
3076 * This method can be called on the {@link DevicePolicyManager} instance returned by
3077 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
3078 * <p>
3079 * Equivalent to calling {@link #lockNow(int)} with no flags.
3080 *
3081 * @throws SecurityException if the calling application does not own an active administrator
3082 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
3083 */
3084 public void lockNow() {
3085 lockNow(0);
3086 }
3087
3088 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003089 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
3090 * this call.
3091 * <p>
3092 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
3093 * to be able to call this method; if it has not, a security exception will be thrown.
3094 * <p>
3095 * This method can be called on the {@link DevicePolicyManager} instance returned by
3096 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003097 *
Andrew Scull17e1b5d2017-04-25 14:44:24 +01003098 * @param flags May be 0 or {@link #FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003099 * @throws SecurityException if the calling application does not own an active administrator
Andrew Scull85a63bc2016-10-24 13:47:47 +01003100 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} or the
Andrew Scull17e1b5d2017-04-25 14:44:24 +01003101 * {@link #FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY} flag is passed by an application
3102 * that is not a profile
Andrew Scull85a63bc2016-10-24 13:47:47 +01003103 * owner of a managed profile.
Andrew Scull17e1b5d2017-04-25 14:44:24 +01003104 * @throws IllegalArgumentException if the {@link #FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY} flag is
3105 * passed when locking the parent profile.
3106 * @throws UnsupportedOperationException if the {@link #FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY}
3107 * flag is passed when {@link #getStorageEncryptionStatus} does not return
3108 * {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08003109 */
Andrew Scull85a63bc2016-10-24 13:47:47 +01003110 public void lockNow(@LockNowFlag int flags) {
Dianne Hackborndf83afa2010-01-20 13:37:26 -08003111 if (mService != null) {
3112 try {
Andrew Scull85a63bc2016-10-24 13:47:47 +01003113 mService.lockNow(flags, mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08003114 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003115 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08003116 }
3117 }
3118 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003119
Dianne Hackbornd6847842010-01-12 18:14:19 -08003120 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07003121 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00003122 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07003123 */
3124 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
3125
3126 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00003127 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
3128 * data.
3129 *
Paul Crowley2934b262014-12-02 11:21:13 +00003130 * <p>This flag may only be set by device owner admins; if it is set by
3131 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00003132 */
3133 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
3134
3135 /**
yinxuf4f9cec2017-06-19 10:28:19 -07003136 * Flag for {@link #wipeData(int)}: also erase the device's eUICC data.
3137 *
3138 * TODO(b/35851809): make this public.
3139 * @hide
3140 */
3141 public static final int WIPE_EUICC = 0x0004;
3142
3143 /**
Suprabh Shukla556b05a2016-08-10 15:49:24 -07003144 * Ask that all user data be wiped. If called as a secondary user, the user will be removed and
3145 * other users will remain unaffected. Calling from the primary user will cause the device to
3146 * reboot, erasing all device data - including all the secondary users and their data - while
3147 * booting up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003148 * <p>
3149 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
3150 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003151 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003152 * @param flags Bit mask of additional options: currently supported flags are
3153 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
3154 * @throws SecurityException if the calling application does not own an active administrator
3155 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08003156 */
3157 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003158 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08003159 if (mService != null) {
3160 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003161 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003162 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003163 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003164 }
3165 }
3166 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003167
Dianne Hackbornd6847842010-01-12 18:14:19 -08003168 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07003169 * Called by an application that is administering the device to set the
3170 * global proxy and exclusion list.
3171 * <p>
3172 * The calling device admin must have requested
3173 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
3174 * this method; if it has not, a security exception will be thrown.
3175 * Only the first device admin can set the proxy. If a second admin attempts
3176 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07003177 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07003178 * be returned.
3179 * The method can be called repeatedly by the device admin alrady setting the
3180 * proxy to update the proxy and exclusion list.
3181 *
Robin Lee25e26452015-06-02 09:56:29 -07003182 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07003183 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
3184 * Pass Proxy.NO_PROXY to reset the proxy.
3185 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07003186 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
3187 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08003188 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07003189 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003190 public @Nullable ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07003191 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003192 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07003193 if (proxySpec == null) {
3194 throw new NullPointerException();
3195 }
3196 if (mService != null) {
3197 try {
3198 String hostSpec;
3199 String exclSpec;
3200 if (proxySpec.equals(Proxy.NO_PROXY)) {
3201 hostSpec = null;
3202 exclSpec = null;
3203 } else {
3204 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
3205 throw new IllegalArgumentException();
3206 }
3207 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
3208 String hostName = sa.getHostName();
3209 int port = sa.getPort();
3210 StringBuilder hostBuilder = new StringBuilder();
3211 hostSpec = hostBuilder.append(hostName)
3212 .append(":").append(Integer.toString(port)).toString();
3213 if (exclusionList == null) {
3214 exclSpec = "";
3215 } else {
3216 StringBuilder listBuilder = new StringBuilder();
3217 boolean firstDomain = true;
3218 for (String exclDomain : exclusionList) {
3219 if (!firstDomain) {
3220 listBuilder = listBuilder.append(",");
3221 } else {
3222 firstDomain = false;
3223 }
3224 listBuilder = listBuilder.append(exclDomain.trim());
3225 }
3226 exclSpec = listBuilder.toString();
3227 }
Yuhao Zheng90704842014-02-28 17:22:45 -08003228 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
3229 != android.net.Proxy.PROXY_VALID)
3230 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07003231 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003232 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07003233 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003234 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07003235 }
3236 }
3237 return null;
3238 }
3239
3240 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003241 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
3242 * HTTP proxies - they are generally network dependent. However if you're doing something
3243 * unusual like general internal filtering this may be useful. On a private network where the
3244 * proxy is not accessible, you may break HTTP using this.
3245 * <p>
3246 * This method requires the caller to be the device owner.
3247 * <p>
3248 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04003249 *
Jason Monk03bc9912014-05-13 09:44:57 -04003250 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003251 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3252 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
3253 * {@code null} value will clear the global HTTP proxy.
3254 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04003255 */
Robin Lee25e26452015-06-02 09:56:29 -07003256 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
3257 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003258 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04003259 if (mService != null) {
3260 try {
3261 mService.setRecommendedGlobalProxy(admin, proxyInfo);
3262 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003263 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04003264 }
3265 }
3266 }
3267
3268 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07003269 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07003270 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
3271 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08003272 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07003273 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003274 public @Nullable ComponentName getGlobalProxyAdmin() {
Oscar Montemayor69238c62010-08-03 10:51:06 -07003275 if (mService != null) {
3276 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003277 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07003278 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003279 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07003280 }
3281 }
3282 return null;
3283 }
3284
3285 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08003286 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003287 * indicating that encryption is not supported.
3288 */
3289 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
3290
3291 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08003292 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003293 * indicating that encryption is supported, but is not currently active.
3294 */
3295 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
3296
3297 /**
Robin Lee3795fb02015-02-16 14:17:23 +00003298 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003299 * indicating that encryption is not currently active, but is currently
3300 * being activated. This is only reported by devices that support
3301 * encryption of data and only when the storage is currently
3302 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
3303 * to become encrypted will never return this value.
3304 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08003305 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003306
3307 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08003308 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003309 * indicating that encryption is active.
Amith Yamasani75db1252016-07-11 14:41:01 -07003310 * <p>
3311 * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003312 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08003313 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003314
3315 /**
Robin Lee3795fb02015-02-16 14:17:23 +00003316 * Result code for {@link #getStorageEncryptionStatus}:
3317 * indicating that encryption is active, but an encryption key has not
3318 * been set by the user.
3319 */
3320 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
3321
3322 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08003323 * Result code for {@link #getStorageEncryptionStatus}:
Amith Yamasani75db1252016-07-11 14:41:01 -07003324 * indicating that encryption is active and the encryption key is tied to the user or profile.
3325 * <p>
3326 * This value is only returned to apps targeting API level 24 and above. For apps targeting
3327 * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
3328 * encryption key is specific to the user or profile.
Makoto Onukid4c9e542016-02-25 18:17:30 -08003329 */
3330 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
3331
3332 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003333 * Activity action: begin the process of encrypting data on the device. This activity should
3334 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
3335 * After resuming from this activity, use {@link #getStorageEncryption}
3336 * to check encryption status. However, on some devices this activity may never return, as
3337 * it may trigger a reboot and in some cases a complete data wipe of the device.
3338 */
3339 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3340 public static final String ACTION_START_ENCRYPTION
3341 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003342 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07003343 * Widgets are enabled in keyguard
3344 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07003345 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07003346
3347 /**
Jim Miller50e62182014-04-23 17:25:00 -07003348 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07003349 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07003350 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
3351
3352 /**
3353 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
3354 */
3355 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
3356
3357 /**
Jim Miller50e62182014-04-23 17:25:00 -07003358 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
3359 */
3360 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
3361
3362 /**
3363 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
3364 */
3365 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
3366
3367 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02003368 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07003369 * (e.g. PIN/Pattern/Password).
3370 */
3371 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
3372
3373 /**
Jim Miller06e34502014-07-17 14:46:05 -07003374 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
3375 */
3376 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
3377
3378 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08003379 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
3380 */
3381 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
3382
3383 /**
Jim Miller35207742012-11-02 15:33:20 -07003384 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07003385 */
3386 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07003387
3388 /**
Robin Leeacdeac62017-02-21 22:13:38 +00003389 * Keyguard features that when set on a managed profile that doesn't have its own challenge will
3390 * affect the profile's parent user. These can also be set on the managed profile's parent
3391 * {@link DevicePolicyManager} instance.
3392 *
3393 * @hide
3394 */
3395 public static final int PROFILE_KEYGUARD_FEATURES_AFFECT_OWNER =
3396 DevicePolicyManager.KEYGUARD_DISABLE_TRUST_AGENTS
3397 | DevicePolicyManager.KEYGUARD_DISABLE_FINGERPRINT;
3398
3399 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003400 * Called by an application that is administering the device to request that the storage system
3401 * be encrypted.
3402 * <p>
3403 * When multiple device administrators attempt to control device encryption, the most secure,
3404 * supported setting will always be used. If any device administrator requests device
3405 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
3406 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003407 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003408 * <p>
3409 * This policy controls encryption of the secure (application data) storage area. Data written
3410 * to other storage areas may or may not be encrypted, and this policy does not require or
3411 * control the encryption of any other storage areas. There is one exception: If
3412 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
3413 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
3414 * written to disk within the encrypted storage area.
3415 * <p>
3416 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
3417 * to create a device PIN or Password. In this case, the storage is encrypted, but the
3418 * encryption key may not be fully secured. For maximum security, the administrator should also
3419 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003420 *
3421 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3422 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08003423 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003424 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
3425 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
3426 * {@link #getStorageEncryptionStatus()} to query the actual device state.
3427 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3428 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003429 */
Robin Lee25e26452015-06-02 09:56:29 -07003430 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003431 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003432 if (mService != null) {
3433 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003434 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003435 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003436 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003437 }
3438 }
3439 return ENCRYPTION_STATUS_UNSUPPORTED;
3440 }
3441
3442 /**
3443 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08003444 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003445 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08003446 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
3447 * this will return the requested encryption setting as an aggregate of all active
3448 * administrators.
3449 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003450 */
Robin Lee25e26452015-06-02 09:56:29 -07003451 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003452 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003453 if (mService != null) {
3454 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003455 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003456 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003457 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003458 }
3459 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08003460 return false;
3461 }
3462
3463 /**
3464 * Called by an application that is administering the device to
3465 * determine the current encryption status of the device.
Amith Yamasani75db1252016-07-11 14:41:01 -07003466 * <p>
Andy Stadler22dbfda2011-01-17 12:47:31 -08003467 * Depending on the returned status code, the caller may proceed in different
3468 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
3469 * storage system does not support encryption. If the
3470 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
3471 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00003472 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
3473 * storage system has enabled encryption but no password is set so further action
Amith Yamasani75db1252016-07-11 14:41:01 -07003474 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
3475 * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
3476 * no further action is required.
Andy Stadler22dbfda2011-01-17 12:47:31 -08003477 *
Robin Lee7e678712014-07-24 16:41:31 +01003478 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08003479 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00003480 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
Amith Yamasani75db1252016-07-11 14:41:01 -07003481 * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08003482 */
3483 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003484 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003485 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003486 }
3487
3488 /** @hide per-user version */
3489 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08003490 if (mService != null) {
3491 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08003492 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08003493 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003494 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08003495 }
3496 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003497 return ENCRYPTION_STATUS_UNSUPPORTED;
3498 }
3499
3500 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00003501 * Mark a CA certificate as approved by the device user. This means that they have been notified
3502 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
3503 * keep the certificate on the device.
3504 *
3505 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
3506 * this certificate.
3507 *
3508 * @hide
3509 */
3510 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
3511 if (mService != null) {
3512 try {
3513 return mService.approveCaCert(alias, userHandle, approval);
3514 } catch (RemoteException e) {
3515 throw e.rethrowFromSystemServer();
3516 }
3517 }
3518 return false;
3519 }
3520
3521 /**
3522 * Check whether a CA certificate has been approved by the device user.
3523 *
3524 * @hide
3525 */
3526 public boolean isCaCertApproved(String alias, int userHandle) {
3527 if (mService != null) {
3528 try {
3529 return mService.isCaCertApproved(alias, userHandle);
3530 } catch (RemoteException e) {
3531 throw e.rethrowFromSystemServer();
3532 }
3533 }
3534 return false;
3535 }
3536
3537 /**
Robin Lee7e678712014-07-24 16:41:31 +01003538 * Installs the given certificate as a user CA.
3539 *
Edman Anjosf9946772016-11-28 16:35:15 +01003540 * The caller must be a profile or device owner on that user, or a delegate package given the
3541 * {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a
3542 * security exception will be thrown.
3543 *
Robin Lee25e26452015-06-02 09:56:29 -07003544 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3545 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003546 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04003547 *
3548 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01003549 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003550 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3551 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003552 * @see #setDelegatedScopes
3553 * @see #DELEGATION_CERT_INSTALL
Maggie Benthallda51e682013-08-08 22:35:44 -04003554 */
Robin Lee25e26452015-06-02 09:56:29 -07003555 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003556 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04003557 if (mService != null) {
3558 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003559 return mService.installCaCert(admin, mContext.getPackageName(), certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04003560 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003561 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04003562 }
3563 }
3564 return false;
3565 }
3566
3567 /**
Robin Lee7e678712014-07-24 16:41:31 +01003568 * Uninstalls the given certificate from trusted user CAs, if present.
3569 *
Edman Anjosf9946772016-11-28 16:35:15 +01003570 * The caller must be a profile or device owner on that user, or a delegate package given the
3571 * {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a
3572 * security exception will be thrown.
3573 *
Robin Lee25e26452015-06-02 09:56:29 -07003574 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3575 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003576 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003577 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3578 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003579 * @see #setDelegatedScopes
3580 * @see #DELEGATION_CERT_INSTALL
Maggie Benthallda51e682013-08-08 22:35:44 -04003581 */
Robin Lee25e26452015-06-02 09:56:29 -07003582 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003583 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04003584 if (mService != null) {
3585 try {
Robin Lee306fe082014-06-19 14:04:24 +00003586 final String alias = getCaCertAlias(certBuffer);
Edman Anjosf9946772016-11-28 16:35:15 +01003587 mService.uninstallCaCerts(admin, mContext.getPackageName(), new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00003588 } catch (CertificateException e) {
3589 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04003590 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003591 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04003592 }
3593 }
3594 }
3595
3596 /**
Robin Lee7e678712014-07-24 16:41:31 +01003597 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
3598 * If a user has installed any certificates by other means than device policy these will be
3599 * included too.
3600 *
Robin Lee25e26452015-06-02 09:56:29 -07003601 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3602 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003603 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003604 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3605 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04003606 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003607 public @NonNull List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
3608 final List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01003609 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003610 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01003611 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003612 mService.enforceCanManageCaCerts(admin, mContext.getPackageName());
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003613 final TrustedCertificateStore certStore = new TrustedCertificateStore();
3614 for (String alias : certStore.userAliases()) {
3615 try {
3616 certs.add(certStore.getCertificate(alias).getEncoded());
3617 } catch (CertificateException ce) {
3618 Log.w(TAG, "Could not encode certificate: " + alias, ce);
3619 }
3620 }
3621 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003622 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01003623 }
3624 }
3625 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04003626 }
3627
3628 /**
Robin Lee7e678712014-07-24 16:41:31 +01003629 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
3630 * means other than device policy will also be removed, except for system CA certificates.
3631 *
Robin Lee25e26452015-06-02 09:56:29 -07003632 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3633 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003634 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3635 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01003636 */
Robin Lee25e26452015-06-02 09:56:29 -07003637 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003638 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01003639 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07003640 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003641 mService.uninstallCaCerts(admin, mContext.getPackageName(),
3642 new TrustedCertificateStore().userAliases() .toArray(new String[0]));
Robin Lee83881bd2015-06-09 16:04:38 -07003643 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003644 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01003645 }
3646 }
3647 }
3648
3649 /**
3650 * Returns whether this certificate is installed as a trusted CA.
3651 *
Robin Lee25e26452015-06-02 09:56:29 -07003652 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3653 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003654 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003655 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3656 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04003657 */
Robin Lee25e26452015-06-02 09:56:29 -07003658 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003659 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003660 if (mService != null) {
3661 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003662 mService.enforceCanManageCaCerts(admin, mContext.getPackageName());
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003663 return getCaCertAlias(certBuffer) != null;
3664 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003665 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003666 } catch (CertificateException ce) {
3667 Log.w(TAG, "Could not parse certificate", ce);
3668 }
Maggie Benthallda51e682013-08-08 22:35:44 -04003669 }
3670 return false;
3671 }
3672
3673 /**
Robin Leece3399f2016-02-24 12:08:32 +00003674 * Called by a device or profile owner, or delegated certificate installer, to install a
3675 * certificate and corresponding private key. All apps within the profile will be able to access
3676 * the certificate and use the private key, given direct user approval.
3677 *
3678 * <p>Access to the installed credentials will not be granted to the caller of this API without
3679 * direct user approval. This is for security - should a certificate installer become
3680 * compromised, certificates it had already installed will be protected.
3681 *
3682 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00003683 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003684 *
Robin Lee25e26452015-06-02 09:56:29 -07003685 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3686 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003687 * @param privKey The private key to install.
3688 * @param cert The certificate to install.
3689 * @param alias The private key alias under which to install the certificate. If a certificate
3690 * with that alias already exists, it will be overwritten.
3691 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003692 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3693 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003694 * @see #setDelegatedScopes
3695 * @see #DELEGATION_CERT_INSTALL
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003696 */
Robin Leefbc65642015-08-03 16:21:22 +01003697 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
3698 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00003699 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00003700 }
3701
3702 /**
3703 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00003704 * certificate chain and corresponding private key for the leaf certificate. All apps within the
3705 * profile will be able to access the certificate chain and use the private key, given direct
3706 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00003707 *
Robin Leea1b290e2016-03-09 14:38:36 +00003708 * <p>The caller of this API may grant itself access to the certificate and private key
3709 * immediately, without user approval. It is a best practice not to request this unless strictly
3710 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00003711 *
3712 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003713 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00003714 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00003715 * @param certs The certificate chain to install. The chain should start with the leaf
3716 * certificate and include the chain of trust in order. This will be returned by
3717 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00003718 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00003719 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00003720 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00003721 * credentials immediately. Otherwise, access to the credentials will be gated by user
3722 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00003723 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003724 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3725 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00003726 * @see android.security.KeyChain#getCertificateChain
Edman Anjosf9946772016-11-28 16:35:15 +01003727 * @see #setDelegatedScopes
3728 * @see #DELEGATION_CERT_INSTALL
Robin Leece3399f2016-02-24 12:08:32 +00003729 */
3730 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00003731 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003732 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003733 try {
Rubin Xub4365912016-03-23 12:13:22 +00003734 final byte[] pemCert = Credentials.convertToPem(certs[0]);
3735 byte[] pemChain = null;
3736 if (certs.length > 1) {
3737 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
3738 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01003739 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
3740 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Edman Anjosf9946772016-11-28 16:35:15 +01003741 return mService.installKeyPair(admin, mContext.getPackageName(), pkcs8Key, pemCert,
3742 pemChain, alias, requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003743 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003744 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01003745 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
3746 Log.w(TAG, "Failed to obtain private key material", e);
3747 } catch (CertificateException | IOException e) {
3748 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003749 }
3750 return false;
3751 }
3752
3753 /**
Robin Leea1b290e2016-03-09 14:38:36 +00003754 * Called by a device or profile owner, or delegated certificate installer, to remove a
3755 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01003756 *
3757 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003758 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01003759 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00003760 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003761 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3762 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003763 * @see #setDelegatedScopes
3764 * @see #DELEGATION_CERT_INSTALL
Robin Leefbc65642015-08-03 16:21:22 +01003765 */
3766 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003767 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01003768 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003769 return mService.removeKeyPair(admin, mContext.getPackageName(), alias);
Robin Leefbc65642015-08-03 16:21:22 +01003770 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003771 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01003772 }
Robin Leefbc65642015-08-03 16:21:22 +01003773 }
3774
3775 /**
Robin Lee25e26452015-06-02 09:56:29 -07003776 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00003777 * doesn't exist.
3778 */
3779 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
3780 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
3781 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
3782 new ByteArrayInputStream(certBuffer));
3783 return new TrustedCertificateStore().getCertificateAlias(cert);
3784 }
3785
3786 /**
Rubin Xuec32b562015-03-03 17:34:05 +00003787 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01003788 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00003789 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01003790 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00003791 * <p>
3792 * Delegated certificate installer is a per-user state. The delegated access is persistent until
3793 * it is later cleared by calling this method with a null value or uninstallling the certificate
3794 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003795 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00003796 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
3797 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003798 * supplied certificate installer package must be installed when calling this API, otherwise an
3799 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00003800 *
Robin Lee25e26452015-06-02 09:56:29 -07003801 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00003802 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003803 * access. If {@code null} is given the current package will be cleared.
3804 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003805 *
3806 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes}
3807 * with the {@link #DELEGATION_CERT_INSTALL} scope instead.
Rubin Xuec32b562015-03-03 17:34:05 +00003808 */
Edman Anjosf9946772016-11-28 16:35:15 +01003809 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07003810 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
3811 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003812 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003813 if (mService != null) {
3814 try {
Robin Lee25e26452015-06-02 09:56:29 -07003815 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00003816 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003817 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003818 }
3819 }
3820 }
3821
3822 /**
Edman Anjosf9946772016-11-28 16:35:15 +01003823 * Called by a profile owner or device owner to retrieve the certificate installer for the user,
3824 * or {@code null} if none is set. If there are multiple delegates this function will return one
3825 * of them.
Rubin Xuec32b562015-03-03 17:34:05 +00003826 *
Robin Lee25e26452015-06-02 09:56:29 -07003827 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003828 * @return The package name of the current delegated certificate installer, or {@code null} if
3829 * none is set.
3830 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003831 *
3832 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages}
3833 * with the {@link #DELEGATION_CERT_INSTALL} scope instead.
Rubin Xuec32b562015-03-03 17:34:05 +00003834 */
Edman Anjosf9946772016-11-28 16:35:15 +01003835 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07003836 public @Nullable String getCertInstallerPackage(@NonNull ComponentName admin)
3837 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003838 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003839 if (mService != null) {
3840 try {
Robin Lee25e26452015-06-02 09:56:29 -07003841 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00003842 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003843 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003844 }
3845 }
3846 return null;
3847 }
3848
3849 /**
Edman Anjosf9946772016-11-28 16:35:15 +01003850 * Called by a profile owner or device owner to grant access to privileged APIs to another app.
3851 * Granted APIs are determined by {@code scopes}, which is a list of the {@code DELEGATION_*}
3852 * constants.
3853 * <p>
Edman Anjos9e62c312017-01-26 22:22:58 +01003854 * A broadcast with the {@link #ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED} action will be
3855 * sent to the {@code delegatePackage} with its new scopes in an {@code ArrayList<String>} extra
3856 * under the {@link #EXTRA_DELEGATION_SCOPES} key. The broadcast is sent with the
3857 * {@link Intent#FLAG_RECEIVER_REGISTERED_ONLY} flag.
3858 * <p>
Edman Anjosf9946772016-11-28 16:35:15 +01003859 * Delegated scopes are a per-user state. The delegated access is persistent until it is later
3860 * cleared by calling this method with an empty {@code scopes} list or uninstalling the
3861 * {@code delegatePackage}.
3862 *
3863 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3864 * @param delegatePackage The package name of the app which will be given access.
3865 * @param scopes The groups of privileged APIs whose access should be granted to
3866 * {@code delegatedPackage}.
3867 * @throws SecurityException if {@code admin} is not a device or a profile owner.
3868 */
3869 public void setDelegatedScopes(@NonNull ComponentName admin, @NonNull String delegatePackage,
3870 @NonNull List<String> scopes) {
3871 throwIfParentInstance("setDelegatedScopes");
3872 if (mService != null) {
3873 try {
3874 mService.setDelegatedScopes(admin, delegatePackage, scopes);
3875 } catch (RemoteException e) {
3876 throw e.rethrowFromSystemServer();
3877 }
3878 }
3879 }
3880
3881 /**
3882 * Called by a profile owner or device owner to retrieve a list of the scopes given to a
3883 * delegate package. Other apps can use this method to retrieve their own delegated scopes by
3884 * passing {@code null} for {@code admin} and their own package name as
3885 * {@code delegatedPackage}.
3886 *
3887 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3888 * {@code null} if the caller is {@code delegatedPackage}.
3889 * @param delegatedPackage The package name of the app whose scopes should be retrieved.
3890 * @return A list containing the scopes given to {@code delegatedPackage}.
3891 * @throws SecurityException if {@code admin} is not a device or a profile owner.
3892 */
3893 @NonNull
Edman Anjos9e62c312017-01-26 22:22:58 +01003894 public List<String> getDelegatedScopes(@Nullable ComponentName admin,
Edman Anjosf9946772016-11-28 16:35:15 +01003895 @NonNull String delegatedPackage) {
3896 throwIfParentInstance("getDelegatedScopes");
3897 if (mService != null) {
3898 try {
3899 return mService.getDelegatedScopes(admin, delegatedPackage);
3900 } catch (RemoteException e) {
3901 throw e.rethrowFromSystemServer();
3902 }
3903 }
3904 return null;
3905 }
3906
3907 /**
3908 * Called by a profile owner or device owner to retrieve a list of delegate packages that were
3909 * granted a delegation scope.
3910 *
3911 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3912 * @param delegationScope The scope whose delegates should be retrieved.
3913 * @return A list of package names of the current delegated packages for
3914 {@code delegationScope}.
3915 * @throws SecurityException if {@code admin} is not a device or a profile owner.
3916 */
3917 @Nullable
3918 public List<String> getDelegatePackages(@NonNull ComponentName admin,
3919 @NonNull String delegationScope) {
3920 throwIfParentInstance("getDelegatePackages");
3921 if (mService != null) {
3922 try {
3923 return mService.getDelegatePackages(admin, delegationScope);
3924 } catch (RemoteException e) {
3925 throw e.rethrowFromSystemServer();
3926 }
3927 }
3928 return null;
3929 }
3930
3931 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003932 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003933 * specific application for the current user.
3934 *
3935 * @deprecated this version only exists for compability with previous developer preview builds.
3936 * TODO: delete once there are no longer any live references.
3937 * @hide
3938 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003939 @Deprecated
Robin Leedc679712016-05-03 13:23:03 +01003940 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3941 throws NameNotFoundException, UnsupportedOperationException {
3942 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3943 }
3944
3945 /**
3946 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003947 * specific application for the current user. This connection is automatically granted and
3948 * persisted after a reboot.
3949 * <p>
3950 * The designated package should declare a {@link android.net.VpnService} in its manifest
3951 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3952 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003953 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003954 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003955 * remove an existing always-on VPN configuration.
3956 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3957 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3958 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003959 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003960 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3961 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3962 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003963 */
Robin Leedc679712016-05-03 13:23:03 +01003964 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3965 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003966 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003967 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003968 if (mService != null) {
3969 try {
Robin Leedc679712016-05-03 13:23:03 +01003970 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003971 throw new NameNotFoundException(vpnPackage);
3972 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003973 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003974 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003975 }
3976 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003977 }
3978
3979 /**
3980 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003981 * always-on VPN connection for the current user. If there is no such package, or the always-on
3982 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003983 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003984 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3985 * is set.
3986 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003987 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003988 public @Nullable String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003989 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003990 if (mService != null) {
3991 try {
3992 return mService.getAlwaysOnVpnPackage(admin);
3993 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003994 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003995 }
3996 }
3997 return null;
3998 }
3999
4000 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004001 * Called by an application that is administering the device to disable all cameras on the
4002 * device, for this user. After setting this, no applications running as this user will be able
4003 * to access any cameras on the device.
4004 * <p>
4005 * If the caller is device owner, then the restriction will be applied to all users.
4006 * <p>
4007 * The calling device admin must have requested
4008 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
4009 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07004010 *
4011 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4012 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004013 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4014 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07004015 */
Robin Lee25e26452015-06-02 09:56:29 -07004016 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004017 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07004018 if (mService != null) {
4019 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08004020 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07004021 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004022 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07004023 }
4024 }
4025 }
4026
4027 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07004028 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08004029 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07004030 * @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 -07004031 * have disabled the camera
4032 */
Robin Lee25e26452015-06-02 09:56:29 -07004033 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004034 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004035 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004036 }
4037
4038 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004039 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07004040 if (mService != null) {
4041 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004042 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07004043 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004044 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07004045 }
4046 }
4047 return false;
4048 }
4049
4050 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004051 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004052 * <p>
Esteban Talaverad36dd152016-12-15 08:51:45 +00004053 * If the device contains secondary users or profiles, they must be affiliated with the device
4054 * owner user. Otherwise a {@link SecurityException} will be thrown. See
4055 * {@link #setAffiliationIds}.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004056 *
4057 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004058 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
4059 * wasn't triggered because a previous bugreport operation is still active (either the
4060 * bugreport is still running or waiting for the user to share or decline)
Esteban Talaverad36dd152016-12-15 08:51:45 +00004061 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
4062 * profile or secondary user that is not affiliated with the device owner user.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004063 */
4064 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004065 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004066 if (mService != null) {
4067 try {
4068 return mService.requestBugreport(admin);
4069 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004070 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004071 }
4072 }
4073 return false;
4074 }
4075
4076 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07004077 * Determine whether or not creating a guest user has been disabled for the device
4078 *
4079 * @hide
4080 */
4081 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
4082 // Currently guest users can always be created if multi-user is enabled
4083 // TODO introduce a policy for guest user creation
4084 return false;
4085 }
4086
4087 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01004088 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
4089 * screen capture also prevents the content from being shown on display devices that do not have
4090 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
4091 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004092 * <p>
4093 * The calling device admin must be a device or profile owner. If it is not, a security
4094 * exception will be thrown.
4095 * <p>
4096 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
4097 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01004098 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004099 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004100 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004101 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004102 */
Robin Lee25e26452015-06-02 09:56:29 -07004103 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004104 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004105 if (mService != null) {
4106 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08004107 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004108 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004109 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004110 }
4111 }
4112 }
4113
4114 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004115 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004116 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07004117 * @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 +01004118 * have disabled screen capture.
4119 */
Robin Lee25e26452015-06-02 09:56:29 -07004120 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004121 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004122 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004123 }
4124
4125 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004126 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004127 if (mService != null) {
4128 try {
4129 return mService.getScreenCaptureDisabled(admin, userHandle);
4130 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004131 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004132 }
4133 }
4134 return false;
4135 }
4136
4137 /**
Jason Parks841cb0a2017-01-17 15:25:17 -06004138 * Called by a device or profile owner to set whether auto time is required. If auto time is
4139 * required, no user will be able set the date and time and network date and time will be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004140 * <p>
4141 * Note: if auto time is required the user can still manually set the time zone.
4142 * <p>
Jason Parks841cb0a2017-01-17 15:25:17 -06004143 * The calling device admin must be a device or profile owner. If it is not, a security
4144 * exception will be thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004145 *
4146 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4147 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004148 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004149 */
Robin Lee25e26452015-06-02 09:56:29 -07004150 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004151 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004152 if (mService != null) {
4153 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08004154 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004155 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004156 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004157 }
4158 }
4159 }
4160
4161 /**
4162 * @return true if auto time is required.
4163 */
4164 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004165 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004166 if (mService != null) {
4167 try {
4168 return mService.getAutoTimeRequired();
4169 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004170 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004171 }
4172 }
4173 return false;
4174 }
4175
4176 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004177 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004178 * <p>
4179 * The system user is exempt from this policy - it is never ephemeral.
4180 * <p>
4181 * The calling device admin must be the device owner. If it is not, a security exception will be
4182 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004183 *
4184 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4185 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004186 * subsequently created users will be ephemeral.
4187 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004188 * @hide
4189 */
4190 public void setForceEphemeralUsers(
4191 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004192 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004193 if (mService != null) {
4194 try {
4195 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
4196 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004197 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004198 }
4199 }
4200 }
4201
4202 /**
4203 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004204 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004205 * @hide
4206 */
4207 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004208 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004209 if (mService != null) {
4210 try {
4211 return mService.getForceEphemeralUsers(admin);
4212 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004213 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004214 }
4215 }
4216 return false;
4217 }
4218
4219 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07004220 * Called by an application that is administering the device to disable keyguard customizations,
4221 * such as widgets. After setting this, keyguard features will be disabled according to the
4222 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004223 * <p>
4224 * The calling device admin must have requested
4225 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4226 * if it has not, a security exception will be thrown.
4227 * <p>
4228 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
4229 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
4230 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00004231 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00004232 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004233 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00004234 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004235 * there is one, or the parent user otherwise.
4236 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
4237 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00004238 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00004239 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
4240 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004241 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
4242 * profile.
4243 * <p>
4244 * Requests to disable other features on a managed profile will be ignored.
4245 * <p>
4246 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00004247 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07004248 *
Jim Millerb8ec4702012-08-31 17:19:10 -07004249 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07004250 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004251 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
4252 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
4253 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
4254 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
4255 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
4256 * @throws SecurityException if {@code admin} is not an active administrator or does not user
4257 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07004258 */
Robin Lee25e26452015-06-02 09:56:29 -07004259 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07004260 if (mService != null) {
4261 try {
Esteban Talavera62399912016-01-11 15:37:55 +00004262 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07004263 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004264 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07004265 }
4266 }
4267 }
4268
4269 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004270 * Determine whether or not features have been disabled in keyguard either by the calling
Rubin Xud3609d42016-07-13 18:32:57 +01004271 * admin, if specified, or all admins that set restrictions on this user and its participating
Esteban Talaverac1c83592016-02-17 17:56:15 +00004272 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
4273 *
4274 * <p>This method can be called on the {@link DevicePolicyManager} instance
4275 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
4276 * restrictions on the parent profile.
4277 *
Esteban Talavera62399912016-01-11 15:37:55 +00004278 * @param admin The name of the admin component to check, or {@code null} to check whether any
4279 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07004280 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
4281 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07004282 */
Robin Lee25e26452015-06-02 09:56:29 -07004283 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004284 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004285 }
4286
4287 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004288 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07004289 if (mService != null) {
4290 try {
Esteban Talavera62399912016-01-11 15:37:55 +00004291 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07004292 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004293 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07004294 }
4295 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07004296 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07004297 }
4298
4299 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08004300 * @hide
4301 */
Robin Lee25e26452015-06-02 09:56:29 -07004302 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
4303 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004304 if (mService != null) {
4305 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01004306 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004307 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004308 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004309 }
4310 }
4311 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07004312
Dianne Hackbornd6847842010-01-12 18:14:19 -08004313 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01004314 * @hide
4315 */
Robin Lee25e26452015-06-02 09:56:29 -07004316 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004317 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01004318 }
4319
4320 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08004321 * @hide
4322 */
Robin Lee25e26452015-06-02 09:56:29 -07004323 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08004324 if (mService != null) {
4325 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004326 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08004327 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004328 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08004329 }
4330 }
4331 }
4332
4333 /**
4334 * @hide
4335 */
Andrew Scull5f9e6f32016-08-02 14:22:17 +01004336 public void setActivePasswordState(PasswordMetrics metrics, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004337 if (mService != null) {
4338 try {
Andrew Scull5f9e6f32016-08-02 14:22:17 +01004339 mService.setActivePasswordState(metrics, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004340 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004341 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004342 }
4343 }
4344 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07004345
Dianne Hackbornd6847842010-01-12 18:14:19 -08004346 /**
4347 * @hide
4348 */
Andrew Scull5daf2732016-11-14 15:02:45 +00004349 public void reportPasswordChanged(@UserIdInt int userId) {
4350 if (mService != null) {
4351 try {
4352 mService.reportPasswordChanged(userId);
4353 } catch (RemoteException e) {
4354 throw e.rethrowFromSystemServer();
4355 }
4356 }
4357 }
4358
4359 /**
4360 * @hide
4361 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004362 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004363 if (mService != null) {
4364 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004365 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004366 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004367 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004368 }
4369 }
4370 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07004371
Dianne Hackbornd6847842010-01-12 18:14:19 -08004372 /**
4373 * @hide
4374 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004375 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004376 if (mService != null) {
4377 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004378 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004379 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004380 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004381 }
4382 }
4383 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07004384
4385 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004386 * @hide
4387 */
4388 public void reportFailedFingerprintAttempt(int userHandle) {
4389 if (mService != null) {
4390 try {
4391 mService.reportFailedFingerprintAttempt(userHandle);
4392 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004393 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004394 }
4395 }
4396 }
4397
4398 /**
4399 * @hide
4400 */
4401 public void reportSuccessfulFingerprintAttempt(int userHandle) {
4402 if (mService != null) {
4403 try {
4404 mService.reportSuccessfulFingerprintAttempt(userHandle);
4405 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004406 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004407 }
4408 }
4409 }
4410
4411 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00004412 * Should be called when keyguard has been dismissed.
4413 * @hide
4414 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004415 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00004416 if (mService != null) {
4417 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004418 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00004419 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004420 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00004421 }
4422 }
4423 }
4424
4425 /**
4426 * Should be called when keyguard view has been shown to the user.
4427 * @hide
4428 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004429 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00004430 if (mService != null) {
4431 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004432 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00004433 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004434 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00004435 }
4436 }
4437 }
4438
4439 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07004440 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00004441 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07004442 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
4443 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07004444 * @return whether the package was successfully registered as the device owner.
4445 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00004446 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07004447 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004448 public boolean setDeviceOwner(ComponentName who) {
4449 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004450 }
4451
4452 /**
4453 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07004454 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004455 public boolean setDeviceOwner(ComponentName who, int userId) {
4456 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07004457 }
4458
4459 /**
4460 * @hide
4461 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004462 public boolean setDeviceOwner(ComponentName who, String ownerName) {
4463 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07004464 }
4465
4466 /**
4467 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00004468 * Sets the given package as the device owner. The package must already be installed. There
4469 * must not already be a device owner.
4470 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
4471 * this method.
4472 * Calling this after the setup phase of the primary user has completed is allowed only if
4473 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07004474 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004475 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07004476 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004477 * @return whether the package was successfully registered as the device owner.
4478 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00004479 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004480 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004481 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004482 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07004483 if (mService != null) {
4484 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07004485 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07004486 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004487 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07004488 }
4489 }
4490 return false;
4491 }
4492
4493 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004494 * Used to determine if a particular package has been registered as a Device Owner app.
4495 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07004496 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004497 * package is currently registered as the device owner app, pass in the package name from
4498 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07004499 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004500 * exact mechanism by which a device admin app is registered as a device owner app is defined by
4501 * the setup process.
4502 * @param packageName the package name of the app, to compare with the registered device owner
4503 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08004504 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07004505 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004506 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004507 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08004508 return isDeviceOwnerAppOnCallingUser(packageName);
4509 }
4510
4511 /**
4512 * @return true if a package is registered as device owner, only when it's running on the
4513 * calling user.
4514 *
4515 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
4516 * @hide
4517 */
4518 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
4519 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
4520 }
4521
4522 /**
4523 * @return true if a package is registered as device owner, even if it's running on a different
4524 * user.
4525 *
4526 * <p>Requires the MANAGE_USERS permission.
4527 *
4528 * @hide
4529 */
4530 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
4531 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
4532 }
4533
4534 /**
4535 * @return device owner component name, only when it's running on the calling user.
4536 *
4537 * @hide
4538 */
4539 public ComponentName getDeviceOwnerComponentOnCallingUser() {
4540 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
4541 }
4542
4543 /**
4544 * @return device owner component name, even if it's running on a different user.
4545 *
Makoto Onukic8a5a552015-11-19 14:29:12 -08004546 * @hide
4547 */
Polina Bondarenko23561db2016-12-16 11:47:28 +01004548 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06004549 @RequiresPermission(android.Manifest.permission.MANAGE_USERS)
Makoto Onukic8a5a552015-11-19 14:29:12 -08004550 public ComponentName getDeviceOwnerComponentOnAnyUser() {
4551 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
4552 }
4553
4554 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08004555 if (packageName == null) {
4556 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07004557 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08004558 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08004559 if (deviceOwner == null) {
4560 return false;
4561 }
4562 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07004563 }
4564
Makoto Onukic8a5a552015-11-19 14:29:12 -08004565 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
4566 if (mService != null) {
4567 try {
4568 return mService.getDeviceOwnerComponent(callingUserOnly);
4569 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004570 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08004571 }
4572 }
4573 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004574 }
4575
Jason Monkb0dced82014-06-06 14:36:20 -04004576 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08004577 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
4578 * no device owner.
4579 *
4580 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07004581 *
4582 * @hide
4583 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08004584 public int getDeviceOwnerUserId() {
4585 if (mService != null) {
4586 try {
4587 return mService.getDeviceOwnerUserId();
4588 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004589 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08004590 }
4591 }
4592 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07004593 }
4594
4595 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004596 * Clears the current device owner. The caller must be the device owner. This function should be
4597 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004598 * a part of device setup, before it completes.
4599 * <p>
4600 * While some policies previously set by the device owner will be cleared by this method, it is
4601 * a best-effort process and some other policies will still remain in place after the device
4602 * owner is cleared.
Jason Monk94d2cf92014-06-18 09:53:34 -04004603 *
4604 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004605 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
4606 * does not own the current device owner component.
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004607 *
4608 * @deprecated This method is expected to be used for testing purposes only. The device owner
4609 * will lose control of the device and its data after calling it. In order to protect any
4610 * sensitive data that remains on the device, it is advised that the device owner factory resets
4611 * the device instead of calling this method. See {@link #wipeData(int)}.
Jason Monkb0dced82014-06-06 14:36:20 -04004612 */
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004613 @Deprecated
Jason Monk94d2cf92014-06-18 09:53:34 -04004614 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004615 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04004616 if (mService != null) {
4617 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04004618 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04004619 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004620 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04004621 }
4622 }
4623 }
4624
Makoto Onukia52562c2015-10-01 16:12:31 -07004625 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08004626 * Returns the device owner package name, only if it's running on the calling user.
4627 *
4628 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07004629 *
4630 * @hide
4631 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004632 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06004633 @RequiresPermission(android.Manifest.permission.MANAGE_USERS)
Makoto Onuki408e8e42016-10-25 12:10:27 -07004634 public @Nullable String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004635 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08004636 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
4637 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07004638 }
4639
4640 /**
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004641 * Called by the system to find out whether the device is managed by a Device Owner.
Makoto Onukic8a5a552015-11-19 14:29:12 -08004642 *
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004643 * @return whether the device is managed by a Device Owner.
4644 * @throws SecurityException if the caller is not the device owner, does not hold the
4645 * MANAGE_USERS permission and is not the system.
Makoto Onukia52562c2015-10-01 16:12:31 -07004646 *
4647 * @hide
4648 */
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004649 @SystemApi
4650 @TestApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06004651 @SuppressLint("Doclava125")
Makoto Onukic8a5a552015-11-19 14:29:12 -08004652 public boolean isDeviceManaged() {
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004653 try {
4654 return mService.hasDeviceOwner();
4655 } catch (RemoteException re) {
4656 throw re.rethrowFromSystemServer();
4657 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08004658 }
4659
4660 /**
4661 * Returns the device owner name. Note this method *will* return the device owner
4662 * name when it's running on a different user.
4663 *
Makoto Onukic8a5a552015-11-19 14:29:12 -08004664 * @hide
4665 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08004666 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06004667 @RequiresPermission(android.Manifest.permission.MANAGE_USERS)
Makoto Onukic8a5a552015-11-19 14:29:12 -08004668 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004669 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07004670 if (mService != null) {
4671 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07004672 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07004673 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004674 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004675 }
4676 }
4677 return null;
4678 }
Adam Connors776c5552014-01-09 10:42:56 +00004679
4680 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04004681 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004682 * @deprecated Do not use
4683 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05004684 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004685 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05004686 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06004687 @SuppressLint("Doclava125")
Makoto Onuki408e8e42016-10-25 12:10:27 -07004688 public @Nullable String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05004689 return null;
4690 }
4691
4692 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004693 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004694 * @deprecated Do not use
4695 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004696 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004697 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004698 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06004699 @SuppressLint("Doclava125")
Makoto Onuki408e8e42016-10-25 12:10:27 -07004700 public @Nullable ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004701 return null;
4702 }
4703
Julia Reynolds20118f12015-02-11 12:34:08 -05004704 /**
Adam Connors776c5552014-01-09 10:42:56 +00004705 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004706 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304707 * Sets the given component as an active admin and registers the package as the profile
4708 * owner for this user. The package must already be installed and there shouldn't be
4709 * an existing profile owner registered for this user. Also, this method must be called
4710 * before the user setup has been completed.
4711 * <p>
4712 * This method can only be called by system apps that hold MANAGE_USERS permission and
4713 * MANAGE_DEVICE_ADMINS permission.
4714 * @param admin The component to register as an active admin and profile owner.
4715 * @param ownerName The user-visible name of the entity that is managing this user.
4716 * @return whether the admin was successfully registered as the profile owner.
4717 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
4718 * the user has already been set up.
4719 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004720 @Deprecated
Justin Morey80440cc2014-07-24 09:16:35 -05004721 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06004722 @RequiresPermission(android.Manifest.permission.MANAGE_DEVICE_ADMINS)
Robin Lee25e26452015-06-02 09:56:29 -07004723 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304724 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004725 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304726 if (mService != null) {
4727 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004728 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304729 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004730 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304731 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004732 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304733 }
4734 }
4735 return false;
4736 }
4737
4738 /**
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004739 * Clears the active profile owner. The caller must be the profile owner of this user, otherwise
4740 * a SecurityException will be thrown. This method is not available to managed profile owners.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004741 * <p>
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004742 * While some policies previously set by the profile owner will be cleared by this method, it is
4743 * a best-effort process and some other policies will still remain in place after the profile
4744 * owner is cleared.
Makoto Onuki5bf68022016-01-27 13:49:19 -08004745 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004746 * @param admin The component to remove as the profile owner.
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004747 * @throws SecurityException if {@code admin} is not an active profile owner, or the method is
4748 * being called from a managed profile.
4749 *
4750 * @deprecated This method is expected to be used for testing purposes only. The profile owner
4751 * will lose control of the user and its data after calling it. In order to protect any
4752 * sensitive data that remains on this user, it is advised that the profile owner deletes it
4753 * instead of calling this method. See {@link #wipeData(int)}.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004754 */
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004755 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004756 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004757 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004758 if (mService != null) {
4759 try {
4760 mService.clearProfileOwner(admin);
4761 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004762 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004763 }
4764 }
4765 }
4766
4767 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05004768 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004769 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004770 */
4771 public boolean hasUserSetupCompleted() {
4772 if (mService != null) {
4773 try {
4774 return mService.hasUserSetupCompleted();
4775 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004776 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004777 }
4778 }
4779 return true;
4780 }
4781
4782 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004783 * @hide
4784 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00004785 * already be installed. There must not already be a profile owner for this user.
4786 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
4787 * this method.
4788 * Calling this after the setup phase of the specified user has completed is allowed only if:
4789 * - the caller is SYSTEM_UID.
4790 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004791 * @param admin the component name to be registered as profile owner.
4792 * @param ownerName the human readable name of the organisation associated with this DPM.
4793 * @param userHandle the userId to set the profile owner for.
4794 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00004795 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
4796 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004797 */
Robin Lee25e26452015-06-02 09:56:29 -07004798 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01004799 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004800 if (mService != null) {
4801 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004802 if (ownerName == null) {
4803 ownerName = "";
4804 }
4805 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00004806 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004807 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004808 }
4809 }
4810 return false;
4811 }
4812
4813 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004814 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004815 * <p>
4816 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004817 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004818 * <p>
4819 * If the device owner information contains only whitespaces then the message on the lock screen
4820 * will be blank and the user will not be allowed to change it.
4821 * <p>
4822 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00004823 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
4824 * and set a new version of this string accordingly.
4825 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004826 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004827 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004828 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004829 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004830 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004831 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004832 if (mService != null) {
4833 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004834 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004835 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004836 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004837 }
4838 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004839 }
4840
4841 /**
4842 * @return The device owner information. If it is not set returns {@code null}.
4843 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004844 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004845 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004846 if (mService != null) {
4847 try {
4848 return mService.getDeviceOwnerLockScreenInfo();
4849 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004850 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004851 }
4852 }
4853 return null;
4854 }
4855
4856 /**
Edman Anjos52088e42017-01-13 22:26:17 +01004857 * Called by device or profile owners to suspend packages for this user. This function can be
4858 * called by a device owner, profile owner, or by a delegate given the
4859 * {@link #DELEGATION_PACKAGE_ACCESS} scope via {@link #setDelegatedScopes}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004860 * <p>
4861 * A suspended package will not be able to start activities. Its notifications will be hidden,
4862 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
4863 * device.
4864 * <p>
4865 * The package must already be installed. If the package is uninstalled while suspended the
4866 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00004867 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004868 *
Edman Anjos52088e42017-01-13 22:26:17 +01004869 * @param admin The name of the admin component to check, or {@code null} if the caller is a
4870 * package access delegate.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004871 * @param packageNames The package names to suspend or unsuspend.
4872 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004873 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004874 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004875 * this method.
4876 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01004877 * @see #setDelegatedScopes
4878 * @see #DELEGATION_PACKAGE_ACCESS
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004879 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004880 public @NonNull String[] setPackagesSuspended(@NonNull ComponentName admin,
4881 @NonNull String[] packageNames, boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004882 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004883 if (mService != null) {
4884 try {
Edman Anjos52088e42017-01-13 22:26:17 +01004885 return mService.setPackagesSuspended(admin, mContext.getPackageName(), packageNames,
4886 suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004887 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004888 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004889 }
4890 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004891 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004892 }
4893
4894 /**
Edman Anjos52088e42017-01-13 22:26:17 +01004895 * Determine if a package is suspended. This function can be called by a device owner, profile
4896 * owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
4897 * {@link #setDelegatedScopes}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004898 *
Edman Anjos52088e42017-01-13 22:26:17 +01004899 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
4900 * {@code null} if the caller is a package access delegate.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004901 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00004902 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004903 * suspended, could not be found or an error occurred.
4904 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004905 * @throws NameNotFoundException if the package could not be found.
Edman Anjos52088e42017-01-13 22:26:17 +01004906 * @see #setDelegatedScopes
4907 * @see #DELEGATION_PACKAGE_ACCESS
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004908 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004909 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
4910 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004911 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004912 if (mService != null) {
4913 try {
Edman Anjos52088e42017-01-13 22:26:17 +01004914 return mService.isPackageSuspended(admin, mContext.getPackageName(), packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004915 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004916 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004917 } catch (IllegalArgumentException ex) {
4918 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004919 }
4920 }
4921 return false;
4922 }
4923
4924 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004925 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
4926 * be used. Only the profile owner can call this.
4927 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01004928 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004929 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004930 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004931 */
Robin Lee25e26452015-06-02 09:56:29 -07004932 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004933 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004934 if (mService != null) {
4935 try {
4936 mService.setProfileEnabled(admin);
4937 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004938 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004939 }
4940 }
4941 }
4942
4943 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004944 * Sets the name of the profile. In the device owner case it sets the name of the user which it
4945 * is called from. Only a profile owner or device owner can call this. If this is never called
4946 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004947 *
4948 * @see #isProfileOwnerApp
4949 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07004950 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004951 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004952 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004953 */
Robin Lee25e26452015-06-02 09:56:29 -07004954 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004955 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01004956 if (mService != null) {
4957 try {
Robin Lee25e26452015-06-02 09:56:29 -07004958 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004959 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004960 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004961 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004962 }
4963 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004964
4965 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004966 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08004967 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004968 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00004969 *
4970 * @param packageName The package name of the app to compare with the registered profile owner.
4971 * @return Whether or not the package is registered as the profile owner.
4972 */
4973 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004974 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00004975 if (mService != null) {
4976 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08004977 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01004978 return profileOwner != null
4979 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004980 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004981 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004982 }
4983 }
4984 return false;
4985 }
4986
4987 /**
4988 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004989 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004990 * owner has been set for that user.
4991 * @throws IllegalArgumentException if the userId is invalid.
4992 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004993 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004994 public @Nullable ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004995 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004996 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4997 }
4998
4999 /**
5000 * @see #getProfileOwner()
5001 * @hide
5002 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005003 public @Nullable ComponentName getProfileOwnerAsUser(final int userId)
5004 throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00005005 if (mService != null) {
5006 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01005007 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00005008 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005009 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00005010 }
5011 }
5012 return null;
5013 }
5014
5015 /**
5016 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07005017 * @return the human readable name of the organisation associated with this DPM or {@code null}
5018 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00005019 * @throws IllegalArgumentException if the userId is invalid.
5020 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005021 public @Nullable String getProfileOwnerName() throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00005022 if (mService != null) {
5023 try {
5024 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
5025 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005026 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00005027 }
5028 }
5029 return null;
5030 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005031
5032 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07005033 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08005034 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07005035 * @return the human readable name of the organisation associated with this profile owner or
5036 * null if one is not set.
5037 * @throws IllegalArgumentException if the userId is invalid.
5038 */
5039 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06005040 @RequiresPermission(android.Manifest.permission.MANAGE_USERS)
Makoto Onuki408e8e42016-10-25 12:10:27 -07005041 public @Nullable String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005042 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07005043 if (mService != null) {
5044 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02005045 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07005046 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005047 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07005048 }
5049 }
5050 return null;
5051 }
5052
5053 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005054 * Called by a profile owner or device owner to add a default intent handler activity for
5055 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005056 * handler even if the set of potential event handlers for the intent filter changes and if the
5057 * intent preferences are reset.
5058 * <p>
5059 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
5060 * When the activity is (re)installed, it is automatically reset as default intent handler for
5061 * the filter.
5062 * <p>
5063 * The calling device admin must be a profile owner or device owner. If it is not, a security
5064 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005065 *
5066 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5067 * @param filter The IntentFilter for which a default handler is added.
5068 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005069 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005070 */
Robin Lee25e26452015-06-02 09:56:29 -07005071 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
5072 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005073 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005074 if (mService != null) {
5075 try {
5076 mService.addPersistentPreferredActivity(admin, filter, activity);
5077 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005078 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005079 }
5080 }
5081 }
5082
5083 /**
5084 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00005085 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005086 * <p>
5087 * The calling device admin must be a profile owner. If it is not, a security exception will be
5088 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005089 *
5090 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5091 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005092 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005093 */
Robin Lee25e26452015-06-02 09:56:29 -07005094 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005095 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005096 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005097 if (mService != null) {
5098 try {
5099 mService.clearPackagePersistentPreferredActivities(admin, packageName);
5100 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005101 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005102 }
5103 }
5104 }
Robin Lee66e5d962014-04-09 16:44:21 +01005105
5106 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00005107 * Called by a profile owner or device owner to grant permission to a package to manage
5108 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
5109 * {@link #getApplicationRestrictions}.
5110 * <p>
5111 * This permission is persistent until it is later cleared by calling this method with a
5112 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00005113 * <p>
5114 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00005115 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005116 *
5117 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5118 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005119 * APIs. If {@code null} is given the current package will be cleared.
5120 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00005121 * @throws NameNotFoundException if {@code packageName} is not found
Edman Anjosf9946772016-11-28 16:35:15 +01005122 *
5123 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes}
5124 * with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005125 */
Edman Anjosf9946772016-11-28 16:35:15 +01005126 @Deprecated
Esteban Talaverabf60f722015-12-10 16:26:44 +00005127 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00005128 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005129 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00005130 if (mService != null) {
5131 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00005132 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
5133 throw new NameNotFoundException(packageName);
5134 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00005135 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005136 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00005137 }
5138 }
5139 }
5140
5141 /**
5142 * Called by a profile owner or device owner to retrieve the application restrictions managing
Edman Anjosf9946772016-11-28 16:35:15 +01005143 * package for the current user, or {@code null} if none is set. If there are multiple
5144 * delegates this function will return one of them.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005145 *
5146 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5147 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005148 * {@code null} if none is set.
5149 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01005150 *
5151 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages}
5152 * with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005153 */
Edman Anjosf9946772016-11-28 16:35:15 +01005154 @Deprecated
5155 @Nullable
5156 public String getApplicationRestrictionsManagingPackage(
Makoto Onuki408e8e42016-10-25 12:10:27 -07005157 @NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005158 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00005159 if (mService != null) {
5160 try {
5161 return mService.getApplicationRestrictionsManagingPackage(admin);
5162 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005163 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00005164 }
5165 }
5166 return null;
5167 }
5168
5169 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00005170 * Called by any application to find out whether it has been granted permission via
5171 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
5172 * for the calling user.
5173 *
5174 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
5175 * that method.
Edman Anjosf9946772016-11-28 16:35:15 +01005176 *
5177 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatedScopes}
5178 * instead.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005179 */
Edman Anjosf9946772016-11-28 16:35:15 +01005180 @Deprecated
Esteban Talaverabf60f722015-12-10 16:26:44 +00005181 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005182 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00005183 if (mService != null) {
5184 try {
Edman Anjosf9946772016-11-28 16:35:15 +01005185 return mService.isCallerApplicationRestrictionsManagingPackage(
5186 mContext.getPackageName());
Esteban Talaverabf60f722015-12-10 16:26:44 +00005187 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005188 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00005189 }
5190 }
5191 return false;
5192 }
5193
5194 /**
5195 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005196 * <p>
5197 * The caller must be a profile or device owner on that user, or the package allowed to manage
Edman Anjosf9946772016-11-28 16:35:15 +01005198 * application restrictions via {@link #setDelegatedScopes} with the
5199 * {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005200 * <p>
5201 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01005202 * <ul>
5203 * <li>{@code boolean}
5204 * <li>{@code int}
5205 * <li>{@code String} or {@code String[]}
5206 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
5207 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005208 * <p>
5209 * If the restrictions are not available yet, but may be applied in the near future, the caller
5210 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00005211 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005212 * <p>
5213 * The application restrictions are only made visible to the target application via
5214 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
5215 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00005216 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01005217 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005218 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
5219 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00005220 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005221 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01005222 * @param packageName The name of the package to update restricted settings for.
5223 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005224 * set of active restrictions.
5225 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01005226 * @see #setDelegatedScopes
5227 * @see #DELEGATION_APP_RESTRICTIONS
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00005228 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01005229 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005230 @WorkerThread
Esteban Talaverabf60f722015-12-10 16:26:44 +00005231 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01005232 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005233 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01005234 if (mService != null) {
5235 try {
Edman Anjosf9946772016-11-28 16:35:15 +01005236 mService.setApplicationRestrictions(admin, mContext.getPackageName(), packageName,
5237 settings);
Robin Lee66e5d962014-04-09 16:44:21 +01005238 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005239 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01005240 }
5241 }
5242 }
5243
5244 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005245 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
5246 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
5247 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07005248 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005249 * <p>
5250 * The calling device admin must have requested
5251 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
5252 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01005253 * <p>
5254 * This method can be called on the {@link DevicePolicyManager} instance returned by
5255 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
5256 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07005257 *
5258 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07005259 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005260 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
5261 * strictly disabled according to the state of the
5262 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
5263 * <p>
5264 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
5265 * admins, then it's up to the TrustAgent itself to aggregate the values from all
5266 * device admins.
5267 * <p>
5268 * Consult documentation for the specific TrustAgent to determine legal options
5269 * parameters.
5270 * @throws SecurityException if {@code admin} is not an active administrator or does not use
5271 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07005272 */
Robin Lee25e26452015-06-02 09:56:29 -07005273 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
5274 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07005275 if (mService != null) {
5276 try {
Tony Mak089d8402016-04-05 17:42:55 +01005277 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07005278 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005279 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07005280 }
5281 }
5282 }
5283
5284 /**
Jim Millere303bf42014-08-26 17:12:29 -07005285 * Gets configuration for the given trust agent based on aggregating all calls to
5286 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
5287 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01005288 * <p>
5289 * This method can be called on the {@link DevicePolicyManager} instance returned by
5290 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
5291 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07005292 *
Jim Millerb5db57a2015-01-14 18:17:19 -08005293 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
5294 * this function returns a list of configurations for all admins that declare
5295 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
5296 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
5297 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
5298 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07005299 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07005300 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07005301 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005302 public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
5303 @Nullable ComponentName admin, @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005304 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07005305 }
5306
5307 /** @hide per-user version */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005308 public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
5309 @Nullable ComponentName admin, @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07005310 if (mService != null) {
5311 try {
Tony Mak089d8402016-04-05 17:42:55 +01005312 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
5313 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07005314 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005315 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07005316 }
5317 }
Jim Millere303bf42014-08-26 17:12:29 -07005318 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07005319 }
5320
5321 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005322 * Called by a profile owner of a managed profile to set whether caller-Id information from the
5323 * managed profile will be shown in the parent profile, for incoming calls.
5324 * <p>
5325 * The calling device admin must be a profile owner. If it is not, a security exception will be
5326 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01005327 *
Robin Lee25e26452015-06-02 09:56:29 -07005328 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01005329 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005330 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01005331 */
Robin Lee25e26452015-06-02 09:56:29 -07005332 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005333 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01005334 if (mService != null) {
5335 try {
Robin Lee25e26452015-06-02 09:56:29 -07005336 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01005337 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005338 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01005339 }
5340 }
5341 }
5342
5343 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005344 * Called by a profile owner of a managed profile to determine whether or not caller-Id
5345 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005346 * <p>
5347 * The calling device admin must be a profile owner. If it is not, a security exception will be
5348 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01005349 *
Robin Lee25e26452015-06-02 09:56:29 -07005350 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005351 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01005352 */
Robin Lee25e26452015-06-02 09:56:29 -07005353 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005354 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01005355 if (mService != null) {
5356 try {
Robin Lee25e26452015-06-02 09:56:29 -07005357 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01005358 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005359 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01005360 }
5361 }
5362 return false;
5363 }
5364
5365 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07005366 * Determine whether or not caller-Id information has been disabled.
5367 *
5368 * @param userHandle The user for whom to check the caller-id permission
5369 * @hide
5370 */
5371 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
5372 if (mService != null) {
5373 try {
5374 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
5375 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005376 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07005377 }
5378 }
5379 return false;
5380 }
5381
5382 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005383 * Called by a profile owner of a managed profile to set whether contacts search from the
5384 * managed profile will be shown in the parent profile, for incoming calls.
5385 * <p>
5386 * The calling device admin must be a profile owner. If it is not, a security exception will be
5387 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00005388 *
5389 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5390 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005391 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00005392 */
5393 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
5394 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005395 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00005396 if (mService != null) {
5397 try {
5398 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
5399 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005400 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00005401 }
5402 }
5403 }
5404
5405 /**
5406 * Called by a profile owner of a managed profile to determine whether or not contacts search
5407 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005408 * <p>
5409 * The calling device admin must be a profile owner. If it is not, a security exception will be
5410 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00005411 *
5412 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005413 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00005414 */
5415 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005416 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00005417 if (mService != null) {
5418 try {
5419 return mService.getCrossProfileContactsSearchDisabled(admin);
5420 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005421 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00005422 }
5423 }
5424 return false;
5425 }
5426
5427
5428 /**
5429 * Determine whether or not contacts search has been disabled.
5430 *
5431 * @param userHandle The user for whom to check the contacts search permission
5432 * @hide
5433 */
5434 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
5435 if (mService != null) {
5436 try {
5437 return mService
5438 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
5439 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005440 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00005441 }
5442 }
5443 return false;
5444 }
5445
5446 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005447 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00005448 *
Makoto Onuki1040da12015-03-19 11:24:00 -07005449 * @hide
5450 */
5451 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00005452 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07005453 if (mService != null) {
5454 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00005455 mService.startManagedQuickContact(actualLookupKey, actualContactId,
5456 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07005457 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005458 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07005459 }
5460 }
5461 }
5462
5463 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005464 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00005465 * @hide
5466 */
5467 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
5468 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00005469 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00005470 originalIntent);
5471 }
5472
5473 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005474 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
5475 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01005476 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005477 * The calling device admin must be a profile owner. If it is not, a security exception will be
5478 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01005479 * <p>
5480 * This API works on managed profile only.
5481 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005482 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5483 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
5484 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01005485 */
Robin Lee25e26452015-06-02 09:56:29 -07005486 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005487 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01005488 if (mService != null) {
5489 try {
Robin Lee25e26452015-06-02 09:56:29 -07005490 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01005491 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005492 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01005493 }
5494 }
5495 }
5496
5497 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005498 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
5499 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01005500 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005501 * The calling device admin must be a profile owner. If it is not, a security exception will be
5502 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01005503 * <p>
5504 * This API works on managed profile only.
5505 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005506 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5507 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01005508 */
Robin Lee25e26452015-06-02 09:56:29 -07005509 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005510 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01005511 if (mService != null) {
5512 try {
Robin Lee25e26452015-06-02 09:56:29 -07005513 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01005514 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005515 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01005516 }
5517 }
5518 return true;
5519 }
5520
5521 /**
5522 * Determine whether or not Bluetooth devices cannot access contacts.
5523 * <p>
5524 * This API works on managed profile UserHandle only.
5525 *
5526 * @param userHandle The user for whom to check the caller-id permission
5527 * @hide
5528 */
5529 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
5530 if (mService != null) {
5531 try {
5532 return mService.getBluetoothContactSharingDisabledForUser(userHandle
5533 .getIdentifier());
5534 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005535 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01005536 }
5537 }
5538 return true;
5539 }
5540
5541 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005542 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005543 * profile can also be resolved in the parent, or vice versa. Only activity intents are
5544 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00005545 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005546 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01005547 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005548 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01005549 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005550 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
5551 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005552 */
Robin Lee25e26452015-06-02 09:56:29 -07005553 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005554 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005555 if (mService != null) {
5556 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01005557 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005558 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005559 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005560 }
5561 }
5562 }
5563
5564 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005565 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
5566 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01005567 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005568 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005569 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005570 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005571 */
Robin Lee25e26452015-06-02 09:56:29 -07005572 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005573 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005574 if (mService != null) {
5575 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01005576 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005577 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005578 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005579 }
5580 }
5581 }
5582
5583 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005584 * Called by a profile or device owner to set the permitted accessibility services. When set by
5585 * a device owner or profile owner the restriction applies to all profiles of the user the
5586 * device owner or profile owner is an admin for. By default the user can use any accessiblity
5587 * service. When zero or more packages have been added, accessiblity services that are not in
5588 * the list and not part of the system can not be enabled by the user.
5589 * <p>
5590 * Calling with a null value for the list disables the restriction so that all services can be
5591 * used, calling with an empty list only allows the builtin system's services.
5592 * <p>
Esteban Talavera7e4cbad2017-03-30 17:59:50 +01005593 * System accessibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005594 *
5595 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5596 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005597 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
5598 * accessibility services enabled, that are not in the list.
5599 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005600 */
Robin Lee25e26452015-06-02 09:56:29 -07005601 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005602 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005603 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005604 if (mService != null) {
5605 try {
5606 return mService.setPermittedAccessibilityServices(admin, packageNames);
5607 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005608 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005609 }
5610 }
5611 return false;
5612 }
5613
5614 /**
5615 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005616 * <p>
5617 * An empty list means no accessibility services except system services are allowed. Null means
5618 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005619 *
5620 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5621 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005622 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005623 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005624 public @Nullable List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005625 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005626 if (mService != null) {
5627 try {
5628 return mService.getPermittedAccessibilityServices(admin);
5629 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005630 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005631 }
5632 }
5633 return null;
5634 }
5635
5636 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00005637 * Called by the system to check if a specific accessibility service is disabled by admin.
5638 *
5639 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5640 * @param packageName Accessibility service package name that needs to be checked.
5641 * @param userHandle user id the admin is running as.
5642 * @return true if the accessibility service is permitted, otherwise false.
5643 *
5644 * @hide
5645 */
5646 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
5647 @NonNull String packageName, int userHandle) {
5648 if (mService != null) {
5649 try {
5650 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
5651 userHandle);
5652 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005653 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00005654 }
5655 }
5656 return false;
5657 }
5658
5659 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005660 * Returns the list of accessibility services permitted by the device or profiles
5661 * owners of this user.
5662 *
5663 * <p>Null means all accessibility services are allowed, if a non-null list is returned
5664 * it will contain the intersection of the permitted lists for any device or profile
5665 * owners that apply to this user. It will also include any system accessibility services.
5666 *
5667 * @param userId which user to check for.
5668 * @return List of accessiblity service package names.
5669 * @hide
5670 */
5671 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07005672 public @Nullable List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005673 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005674 if (mService != null) {
5675 try {
5676 return mService.getPermittedAccessibilityServicesForUser(userId);
5677 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005678 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005679 }
5680 }
5681 return null;
5682 }
5683
5684 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005685 * Called by a profile or device owner to set the permitted input methods services. When set by
5686 * a device owner or profile owner the restriction applies to all profiles of the user the
5687 * device owner or profile owner is an admin for. By default the user can use any input method.
5688 * When zero or more packages have been added, input method that are not in the list and not
5689 * part of the system can not be enabled by the user. This method will fail if it is called for
5690 * a admin that is not for the foreground user or a profile of the foreground user.
5691 * <p>
5692 * Calling with a null value for the list disables the restriction so that all input methods can
5693 * be used, calling with an empty list disables all but the system's own input methods.
5694 * <p>
5695 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005696 *
5697 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5698 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005699 * @return true if setting the restriction succeeded. It will fail if there are one or more
5700 * non-system input methods currently enabled that are not in the packageNames list.
5701 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005702 */
Esteban Talavera7e4cbad2017-03-30 17:59:50 +01005703 public boolean setPermittedInputMethods(
5704 @NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005705 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005706 if (mService != null) {
5707 try {
5708 return mService.setPermittedInputMethods(admin, packageNames);
5709 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005710 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005711 }
5712 }
5713 return false;
5714 }
5715
5716
5717 /**
5718 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005719 * <p>
5720 * An empty list means no input methods except system input methods are allowed. Null means all
5721 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005722 *
5723 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5724 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005725 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005726 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005727 public @Nullable List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005728 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005729 if (mService != null) {
5730 try {
5731 return mService.getPermittedInputMethods(admin);
5732 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005733 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005734 }
5735 }
5736 return null;
5737 }
5738
5739 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00005740 * Called by the system to check if a specific input method is disabled by admin.
5741 *
5742 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5743 * @param packageName Input method package name that needs to be checked.
5744 * @param userHandle user id the admin is running as.
5745 * @return true if the input method is permitted, otherwise false.
5746 *
5747 * @hide
5748 */
5749 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
5750 @NonNull String packageName, int userHandle) {
5751 if (mService != null) {
5752 try {
5753 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
5754 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005755 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00005756 }
5757 }
5758 return false;
5759 }
5760
5761 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005762 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08005763 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005764 *
5765 * <p>Null means all input methods are allowed, if a non-null list is returned
5766 * it will contain the intersection of the permitted lists for any device or profile
5767 * owners that apply to this user. It will also include any system input methods.
5768 *
5769 * @return List of input method package names.
5770 * @hide
5771 */
5772 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07005773 public @Nullable List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005774 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005775 if (mService != null) {
5776 try {
5777 return mService.getPermittedInputMethodsForCurrentUser();
5778 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005779 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005780 }
5781 }
5782 return null;
5783 }
5784
5785 /**
Esteban Talavera7e4cbad2017-03-30 17:59:50 +01005786 * Called by a profile owner of a managed profile to set the packages that are allowed to use
5787 * a {@link android.service.notification.NotificationListenerService} in the primary user to
5788 * see notifications from the managed profile. By default all packages are permitted by this
5789 * policy. When zero or more packages have been added, notification listeners installed on the
5790 * primary user that are not in the list and are not part of the system won't receive events
5791 * for managed profile notifications.
5792 * <p>
5793 * Calling with a {@code null} value for the list disables the restriction so that all
5794 * notification listener services be used. Calling with an empty list disables all but the
5795 * system's own notification listeners. System notification listener services are always
5796 * available to the user.
5797 * <p>
5798 * If a device or profile owner want to stop notification listeners in their user from seeing
5799 * that user's notifications they should prevent that service from running instead (e.g. via
5800 * {@link #setApplicationHidden(ComponentName, String, boolean)})
5801 *
5802 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5803 * @param packageList List of package names to whitelist
5804 * @return true if setting the restriction succeeded. It will fail if called outside a managed
5805 * profile
5806 * @throws SecurityException if {@code admin} is not a profile owner.
5807 *
5808 * @see android.service.notification.NotificationListenerService
5809 */
5810 public boolean setPermittedCrossProfileNotificationListeners(
5811 @NonNull ComponentName admin, @Nullable List<String> packageList) {
5812 throwIfParentInstance("setPermittedCrossProfileNotificationListeners");
5813 if (mService != null) {
5814 try {
5815 return mService.setPermittedCrossProfileNotificationListeners(admin, packageList);
5816 } catch (RemoteException e) {
5817 throw e.rethrowFromSystemServer();
5818 }
5819 }
5820 return false;
5821 }
5822
5823 /**
5824 * Returns the list of packages installed on the primary user that allowed to use a
5825 * {@link android.service.notification.NotificationListenerService} to receive
5826 * notifications from this managed profile, as set by the profile owner.
5827 * <p>
5828 * An empty list means no notification listener services except system ones are allowed.
5829 * A {@code null} return value indicates that all notification listeners are allowed.
5830 */
5831 public @Nullable List<String> getPermittedCrossProfileNotificationListeners(
5832 @NonNull ComponentName admin) {
5833 throwIfParentInstance("getPermittedCrossProfileNotificationListeners");
5834 if (mService != null) {
5835 try {
5836 return mService.getPermittedCrossProfileNotificationListeners(admin);
5837 } catch (RemoteException e) {
5838 throw e.rethrowFromSystemServer();
5839 }
5840 }
5841 return null;
5842 }
5843
5844 /**
5845 * Returns true if {@code NotificationListenerServices} from the given package are allowed to
5846 * receive events for notifications from the given user id. Can only be called by the system uid
5847 *
5848 * @see #setPermittedCrossProfileNotificationListeners(ComponentName, List)
5849 *
5850 * @hide
5851 */
5852 public boolean isNotificationListenerServicePermitted(
5853 @NonNull String packageName, @UserIdInt int userId) {
5854 if (mService != null) {
5855 try {
5856 return mService.isNotificationListenerServicePermitted(packageName, userId);
5857 } catch (RemoteException e) {
5858 throw e.rethrowFromSystemServer();
5859 }
5860 }
5861 return true;
5862 }
5863
5864 /**
Edman Anjos52088e42017-01-13 22:26:17 +01005865 * Get the list of apps to keep around as APKs even if no user has currently installed it. This
5866 * function can be called by a device owner or by a delegate given the
5867 * {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}.
5868 * <p>
5869 * Please note that packages returned in this method are not automatically pre-cached.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005870 *
Edman Anjos52088e42017-01-13 22:26:17 +01005871 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
5872 * {@code null} if the caller is a keep uninstalled packages delegate.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005873 * @return List of package names to keep cached.
Edman Anjos52088e42017-01-13 22:26:17 +01005874 * @see #setDelegatedScopes
5875 * @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005876 * @hide
5877 */
Edman Anjos52088e42017-01-13 22:26:17 +01005878 public @Nullable List<String> getKeepUninstalledPackages(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005879 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005880 if (mService != null) {
5881 try {
Edman Anjos52088e42017-01-13 22:26:17 +01005882 return mService.getKeepUninstalledPackages(admin, mContext.getPackageName());
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005883 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005884 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005885 }
5886 }
5887 return null;
5888 }
5889
5890 /**
Edman Anjos52088e42017-01-13 22:26:17 +01005891 * Set a list of apps to keep around as APKs even if no user has currently installed it. This
5892 * function can be called by a device owner or by a delegate given the
5893 * {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005894 *
5895 * <p>Please note that setting this policy does not imply that specified apps will be
5896 * automatically pre-cached.</p>
5897 *
Edman Anjos52088e42017-01-13 22:26:17 +01005898 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
5899 * {@code null} if the caller is a keep uninstalled packages delegate.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005900 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005901 * @throws SecurityException if {@code admin} is not a device owner.
Edman Anjos52088e42017-01-13 22:26:17 +01005902 * @see #setDelegatedScopes
5903 * @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005904 * @hide
5905 */
Edman Anjos52088e42017-01-13 22:26:17 +01005906 public void setKeepUninstalledPackages(@Nullable ComponentName admin,
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005907 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005908 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005909 if (mService != null) {
5910 try {
Edman Anjos52088e42017-01-13 22:26:17 +01005911 mService.setKeepUninstalledPackages(admin, mContext.getPackageName(), packageNames);
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005912 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005913 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005914 }
5915 }
5916 }
5917
5918 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04005919 * Called by a device owner to create a user with the specified name. The UserHandle returned
5920 * by this method should not be persisted as user handles are recycled as users are removed and
5921 * created. If you need to persist an identifier for this user, use
5922 * {@link UserManager#getSerialNumberForUser}.
5923 *
5924 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5925 * @param name the user's name
5926 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07005927 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5928 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01005929 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005930 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01005931 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04005932 */
Kenny Guy14f48e52015-06-29 15:12:36 +01005933 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07005934 public @Nullable UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04005935 return null;
5936 }
5937
5938 /**
Jason Monk03978a42014-06-10 15:05:30 -04005939 * Called by a device owner to create a user with the specified name. The UserHandle returned
5940 * by this method should not be persisted as user handles are recycled as users are removed and
5941 * created. If you need to persist an identifier for this user, use
5942 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
5943 * immediately.
5944 *
5945 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
5946 * as registered as an active admin on the new user. The profile owner package will be
5947 * installed on the new user if it already is installed on the device.
5948 *
5949 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
5950 * profileOwnerComponent when onEnable is called.
5951 *
5952 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5953 * @param name the user's name
5954 * @param ownerName the human readable name of the organisation associated with this DPM.
5955 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
5956 * the user.
5957 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
5958 * on the new user.
5959 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07005960 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5961 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01005962 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005963 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01005964 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04005965 */
Kenny Guy14f48e52015-06-29 15:12:36 +01005966 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07005967 public @Nullable UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
Robin Lee25e26452015-06-02 09:56:29 -07005968 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04005969 return null;
5970 }
5971
5972 /**
phweissa92e1212016-01-25 17:14:10 +01005973 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01005974 */
5975 public static final int SKIP_SETUP_WIZARD = 0x0001;
5976
5977 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01005978 * Flag used by {@link #createAndManageUser} to specify that the user should be created
5979 * ephemeral.
5980 * @hide
5981 */
5982 public static final int MAKE_USER_EPHEMERAL = 0x0002;
5983
5984 /**
Christine Franks361b8252017-06-23 18:12:46 -07005985 * Flag used by {@link #createAndManageUser} to specify that the user should be created as a
5986 * demo user.
5987 * @hide
5988 */
5989 public static final int MAKE_USER_DEMO = 0x0004;
5990
5991 /**
phweissa92e1212016-01-25 17:14:10 +01005992 * Called by a device owner to create a user with the specified name and a given component of
5993 * the calling package as profile owner. The UserHandle returned by this method should not be
5994 * persisted as user handles are recycled as users are removed and created. If you need to
5995 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
5996 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005997 * <p>
5998 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
5999 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
6000 * be registered as an active admin on the new user. The profile owner package will be installed
6001 * on the new user.
6002 * <p>
6003 * If the adminExtras are not null, they will be stored on the device until the user is started
6004 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01006005 *
6006 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6007 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01006008 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006009 * same package as admin, otherwise no user is created and an
6010 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01006011 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006012 * user.
phweissa92e1212016-01-25 17:14:10 +01006013 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01006014 * @see UserHandle
6015 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
6016 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006017 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01006018 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006019 public @Nullable UserHandle createAndManageUser(@NonNull ComponentName admin,
6020 @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01006021 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
6022 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006023 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01006024 try {
phweissa92e1212016-01-25 17:14:10 +01006025 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01006026 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006027 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01006028 }
phweiss343fb332016-01-25 14:48:59 +01006029 }
6030
6031 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006032 * Called by a device owner to remove a user and all associated data. The primary user can not
6033 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04006034 *
6035 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6036 * @param userHandle the user to remove.
6037 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006038 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04006039 */
Robin Lee25e26452015-06-02 09:56:29 -07006040 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006041 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04006042 try {
6043 return mService.removeUser(admin, userHandle);
6044 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006045 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04006046 }
6047 }
6048
6049 /**
Jason Monk582d9112014-07-09 19:57:08 -04006050 * Called by a device owner to switch the specified user to the foreground.
6051 *
6052 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6053 * @param userHandle the user to switch to; null will switch to primary.
6054 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006055 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04006056 * @see Intent#ACTION_USER_FOREGROUND
6057 */
Robin Lee25e26452015-06-02 09:56:29 -07006058 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006059 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04006060 try {
6061 return mService.switchUser(admin, userHandle);
6062 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006063 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04006064 }
6065 }
6066
6067 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00006068 * Retrieves the application restrictions for a given target application running in the calling
6069 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006070 * <p>
6071 * The caller must be a profile or device owner on that user, or the package allowed to manage
Edman Anjosf9946772016-11-28 16:35:15 +01006072 * application restrictions via {@link #setDelegatedScopes} with the
6073 * {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01006074 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07006075 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
6076 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00006077 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006078 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01006079 * @param packageName The name of the package to fetch restricted settings of.
6080 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006081 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
6082 * {@link Bundle} if no restrictions have been set.
6083 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01006084 * @see #setDelegatedScopes
6085 * @see #DELEGATION_APP_RESTRICTIONS
Robin Lee66e5d962014-04-09 16:44:21 +01006086 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07006087 @WorkerThread
Makoto Onuki408e8e42016-10-25 12:10:27 -07006088 public @NonNull Bundle getApplicationRestrictions(
6089 @Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006090 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01006091 if (mService != null) {
6092 try {
Edman Anjosf9946772016-11-28 16:35:15 +01006093 return mService.getApplicationRestrictions(admin, mContext.getPackageName(),
6094 packageName);
Robin Lee66e5d962014-04-09 16:44:21 +01006095 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006096 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01006097 }
6098 }
6099 return null;
6100 }
Amith Yamasanibe465322014-04-24 13:45:17 -07006101
6102 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05006103 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07006104 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006105 * The calling device admin must be a profile or device owner; if it is not, a security
6106 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07006107 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006108 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6109 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
6110 * for the list of keys.
6111 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07006112 */
Robin Lee25e26452015-06-02 09:56:29 -07006113 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006114 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07006115 if (mService != null) {
6116 try {
6117 mService.setUserRestriction(admin, key, true);
6118 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006119 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07006120 }
6121 }
6122 }
6123
6124 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05006125 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07006126 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006127 * The calling device admin must be a profile or device owner; if it is not, a security
6128 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07006129 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006130 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6131 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
6132 * for the list of keys.
6133 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07006134 */
Robin Lee25e26452015-06-02 09:56:29 -07006135 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006136 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07006137 if (mService != null) {
6138 try {
6139 mService.setUserRestriction(admin, key, false);
6140 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006141 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07006142 }
6143 }
6144 }
Adam Connors010cfd42014-04-16 12:48:13 +01006145
6146 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006147 * Called by a profile or device owner to get user restrictions set with
6148 * {@link #addUserRestriction(ComponentName, String)}.
6149 * <p>
6150 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006151 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006152 * {@link UserManager#getUserRestrictions()}.
6153 *
6154 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006155 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006156 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006157 public @NonNull Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006158 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006159 Bundle ret = null;
6160 if (mService != null) {
6161 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07006162 ret = mService.getUserRestrictions(admin);
6163 } catch (RemoteException e) {
6164 throw e.rethrowFromSystemServer();
6165 }
6166 }
6167 return ret == null ? new Bundle() : ret;
6168 }
6169
6170 /**
phweiss73145f42017-01-17 19:06:38 +01006171 * Called by any app to display a support dialog when a feature was disabled by an admin.
6172 * This returns an intent that can be used with {@link Context#startActivity(Intent)} to
6173 * display the dialog. It will tell the user that the feature indicated by {@code restriction}
6174 * was disabled by an admin, and include a link for more information. The default content of
6175 * the dialog can be changed by the restricting admin via
6176 * {@link #setShortSupportMessage(ComponentName, CharSequence)}. If the restriction is not
6177 * set (i.e. the feature is available), then the return value will be {@code null}.
6178 * @param restriction Indicates for which feature the dialog should be displayed. Can be a
6179 * user restriction from {@link UserManager}, e.g.
6180 * {@link UserManager#DISALLOW_ADJUST_VOLUME}, or one of the constants
6181 * {@link #POLICY_DISABLE_CAMERA} or {@link #POLICY_DISABLE_SCREEN_CAPTURE}.
6182 * @return Intent An intent to be used to start the dialog-activity if the restriction is
6183 * set by an admin, or null if the restriction does not exist or no admin set it.
6184 */
6185 public Intent createAdminSupportIntent(@NonNull String restriction) {
6186 throwIfParentInstance("createAdminSupportIntent");
6187 if (mService != null) {
6188 try {
6189 return mService.createAdminSupportIntent(restriction);
6190 } catch (RemoteException e) {
6191 throw e.rethrowFromSystemServer();
6192 }
6193 }
6194 return null;
6195 }
6196
6197 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006198 * Hide or unhide packages. When a package is hidden it is unavailable for use, but the data and
6199 * actual package file remain. This function can be called by a device owner, profile owner, or
6200 * by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
6201 * {@link #setDelegatedScopes}.
Julia Reynolds966881e2014-05-14 12:23:08 -04006202 *
Edman Anjos52088e42017-01-13 22:26:17 +01006203 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6204 * {@code null} if the caller is a package access delegate.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006205 * @param packageName The name of the package to hide or unhide.
6206 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006207 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006208 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006209 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006210 * @see #setDelegatedScopes
6211 * @see #DELEGATION_PACKAGE_ACCESS
Julia Reynolds966881e2014-05-14 12:23:08 -04006212 */
Robin Lee25e26452015-06-02 09:56:29 -07006213 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006214 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006215 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04006216 if (mService != null) {
6217 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006218 return mService.setApplicationHidden(admin, mContext.getPackageName(), packageName,
6219 hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04006220 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006221 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04006222 }
6223 }
6224 return false;
6225 }
6226
6227 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006228 * Determine if a package is hidden. This function can be called by a device owner, profile
6229 * owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
6230 * {@link #setDelegatedScopes}.
Julia Reynolds966881e2014-05-14 12:23:08 -04006231 *
Edman Anjos52088e42017-01-13 22:26:17 +01006232 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6233 * {@code null} if the caller is a package access delegate.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006234 * @param packageName The name of the package to retrieve the hidden status of.
6235 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006236 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006237 * @see #setDelegatedScopes
6238 * @see #DELEGATION_PACKAGE_ACCESS
Julia Reynolds966881e2014-05-14 12:23:08 -04006239 */
Robin Lee25e26452015-06-02 09:56:29 -07006240 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006241 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04006242 if (mService != null) {
6243 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006244 return mService.isApplicationHidden(admin, mContext.getPackageName(), packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04006245 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006246 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04006247 }
6248 }
6249 return false;
6250 }
6251
6252 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006253 * Re-enable a system app that was disabled by default when the user was initialized. This
6254 * function can be called by a device owner, profile owner, or by a delegate given the
6255 * {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}.
Adam Connors655be2a2014-07-14 09:01:25 +00006256 *
Edman Anjos52088e42017-01-13 22:26:17 +01006257 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6258 * {@code null} if the caller is an enable system app delegate.
Makoto Onuki32b30572015-12-11 14:29:51 -08006259 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006260 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006261 * @see #setDelegatedScopes
6262 * @see #DELEGATION_PACKAGE_ACCESS
Adam Connors655be2a2014-07-14 09:01:25 +00006263 */
Robin Lee25e26452015-06-02 09:56:29 -07006264 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006265 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00006266 if (mService != null) {
6267 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006268 mService.enableSystemApp(admin, mContext.getPackageName(), packageName);
Adam Connors655be2a2014-07-14 09:01:25 +00006269 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006270 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00006271 }
6272 }
6273 }
6274
6275 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006276 * Re-enable system apps by intent that were disabled by default when the user was initialized.
6277 * This function can be called by a device owner, profile owner, or by a delegate given the
6278 * {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}.
Adam Connors655be2a2014-07-14 09:01:25 +00006279 *
Edman Anjos52088e42017-01-13 22:26:17 +01006280 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6281 * {@code null} if the caller is an enable system app delegate.
Adam Connors655be2a2014-07-14 09:01:25 +00006282 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006283 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00006284 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006285 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006286 * @see #setDelegatedScopes
6287 * @see #DELEGATION_PACKAGE_ACCESS
Adam Connors655be2a2014-07-14 09:01:25 +00006288 */
Robin Lee25e26452015-06-02 09:56:29 -07006289 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006290 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00006291 if (mService != null) {
6292 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006293 return mService.enableSystemAppWithIntent(admin, mContext.getPackageName(), intent);
Adam Connors655be2a2014-07-14 09:01:25 +00006294 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006295 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00006296 }
6297 }
6298 return 0;
6299 }
6300
6301 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00006302 * Called by a device owner or profile owner to disable account management for a specific type
6303 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006304 * <p>
6305 * The calling device admin must be a device owner or profile owner. If it is not, a security
6306 * exception will be thrown.
6307 * <p>
6308 * When account management is disabled for an account type, adding or removing an account of
6309 * that type will not be possible.
6310 * <p>
6311 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00006312 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
6313 * management for a specific type is disabled.
6314 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01006315 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6316 * @param accountType For which account management is disabled or enabled.
6317 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006318 * enabled (false).
6319 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01006320 */
Robin Lee25e26452015-06-02 09:56:29 -07006321 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01006322 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006323 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01006324 if (mService != null) {
6325 try {
6326 mService.setAccountManagementDisabled(admin, accountType, disabled);
6327 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006328 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01006329 }
6330 }
6331 }
6332
6333 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006334 * Gets the array of accounts for which account management is disabled by the profile owner.
6335 *
6336 * <p> Account management can be disabled/enabled by calling
6337 * {@link #setAccountManagementDisabled}.
6338 *
6339 * @return a list of account types for which account management has been disabled.
6340 *
6341 * @see #setAccountManagementDisabled
6342 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006343 public @Nullable String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006344 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07006345 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01006346 }
6347
6348 /**
6349 * @see #getAccountTypesWithManagementDisabled()
6350 * @hide
6351 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006352 public @Nullable String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006353 if (mService != null) {
6354 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01006355 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006356 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006357 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006358 }
6359 }
6360
6361 return null;
6362 }
justinzhang511e0d82014-03-24 16:09:24 -04006363
6364 /**
Jason Monkd7b86212014-06-16 13:15:38 -04006365 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006366 * <p>
Esteban Talaverabdcada92017-02-01 14:20:06 +00006367 * Any packages that share uid with an allowed package will also be allowed to activate lock
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006368 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
Esteban Talaverabdcada92017-02-01 14:20:06 +00006369 * package list results in locked tasks belonging to those packages to be finished.
6370 * <p>
6371 * This function can only be called by the device owner or by a profile owner of a user/profile
6372 * that is affiliated with the device owner user. See {@link #setAffiliationIds}. Any packages
6373 * set via this method will be cleared if the user becomes unaffiliated.
Jason Monkd7b86212014-06-16 13:15:38 -04006374 *
Jason Monkd7b86212014-06-16 13:15:38 -04006375 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04006376 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Esteban Talaverabdcada92017-02-01 14:20:06 +00006377 * @throws SecurityException if {@code admin} is not the device owner, or the profile owner of
6378 * an affiliated user or profile.
Jason Monkd7b86212014-06-16 13:15:38 -04006379 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00006380 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
6381 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04006382 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04006383 */
Esteban Talaverabdcada92017-02-01 14:20:06 +00006384 public void setLockTaskPackages(@NonNull ComponentName admin, @NonNull String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04006385 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006386 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04006387 if (mService != null) {
6388 try {
Jason Monk48aacba2014-08-13 16:29:08 -04006389 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04006390 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006391 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04006392 }
6393 }
6394 }
6395
6396 /**
Esteban Talaverabdcada92017-02-01 14:20:06 +00006397 * Returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04006398 *
Esteban Talaverabdcada92017-02-01 14:20:06 +00006399 * @throws SecurityException if {@code admin} is not the device owner, or the profile owner of
6400 * an affiliated user or profile.
6401 * @see #setLockTaskPackages
justinzhang511e0d82014-03-24 16:09:24 -04006402 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006403 public @NonNull String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006404 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04006405 if (mService != null) {
6406 try {
Jason Monk48aacba2014-08-13 16:29:08 -04006407 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04006408 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006409 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04006410 }
6411 }
Esteban Talaverabdcada92017-02-01 14:20:06 +00006412 return new String[0];
justinzhang511e0d82014-03-24 16:09:24 -04006413 }
6414
6415 /**
6416 * This function lets the caller know whether the given component is allowed to start the
6417 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04006418 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04006419 */
Jason Monkd7b86212014-06-16 13:15:38 -04006420 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006421 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04006422 if (mService != null) {
6423 try {
Jason Monkd7b86212014-06-16 13:15:38 -04006424 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04006425 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006426 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04006427 }
6428 }
6429 return false;
6430 }
Julia Reynoldsda551652014-05-14 17:15:16 -04006431
6432 /**
6433 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
6434 * 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 -07006435 * <p>
6436 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006437 * <ul>
6438 * <li>{@link Settings.Global#ADB_ENABLED}</li>
6439 * <li>{@link Settings.Global#AUTO_TIME}</li>
6440 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006441 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006442 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006443 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006444 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
6445 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
6446 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
6447 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
6448 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006449 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006450 * <p>
6451 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006452 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006453 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
6454 * {@link android.bluetooth.BluetoothAdapter#enable()} and
6455 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006456 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006457 * <li>{@link Settings.Global#MODE_RINGER}. Use
6458 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006459 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006460 * <li>{@link Settings.Global#WIFI_ON}. Use
6461 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006462 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04006463 *
6464 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6465 * @param setting The name of the setting to update.
6466 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006467 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04006468 */
Robin Lee25e26452015-06-02 09:56:29 -07006469 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006470 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04006471 if (mService != null) {
6472 try {
6473 mService.setGlobalSetting(admin, setting, value);
6474 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006475 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04006476 }
6477 }
6478 }
6479
6480 /**
6481 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
6482 * that the value of the setting is in the correct form for the setting type should be performed
6483 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006484 * <p>
6485 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006486 * <ul>
6487 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
6488 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
6489 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006490 * <p>
6491 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04006492 * <ul>
6493 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
6494 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006495 *
Suprabh Shukla0b1356f2017-02-21 14:33:50 -08006496 * <strong>Note: Starting from Android O, apps should no longer call this method with the
6497 * setting {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS}, which is
6498 * deprecated. Instead, device owners or profile owners should use the restriction
6499 * {@link UserManager#DISALLOW_INSTALL_UNKNOWN_SOURCES}.
6500 * If any app targeting {@link android.os.Build.VERSION_CODES#O} or higher calls this method
6501 * with {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS},
6502 * an {@link UnsupportedOperationException} is thrown.
6503 * </strong>
6504 *
Julia Reynoldsda551652014-05-14 17:15:16 -04006505 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6506 * @param setting The name of the setting to update.
6507 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006508 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04006509 */
Robin Lee25e26452015-06-02 09:56:29 -07006510 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006511 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04006512 if (mService != null) {
6513 try {
6514 mService.setSecureSetting(admin, setting, value);
6515 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006516 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04006517 }
6518 }
6519 }
6520
Amith Yamasanif20d6402014-05-24 15:34:37 -07006521 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006522 * Designates a specific service component as the provider for making permission requests of a
6523 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07006524 * <p/>
6525 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006526 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07006527 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07006528 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006529 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
6530 * provider previously assigned.
6531 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07006532 */
Robin Lee25e26452015-06-02 09:56:29 -07006533 public void setRestrictionsProvider(@NonNull ComponentName admin,
6534 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006535 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07006536 if (mService != null) {
6537 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07006538 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07006539 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006540 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07006541 }
6542 }
6543 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04006544
6545 /**
6546 * Called by profile or device owners to set the master volume mute on or off.
Nicolas Prevotaef3ce22016-09-22 12:00:25 +01006547 * This has no effect when set on a managed profile.
Julia Reynolds4a21b252014-06-04 11:11:43 -04006548 *
6549 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6550 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006551 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04006552 */
Robin Lee25e26452015-06-02 09:56:29 -07006553 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006554 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04006555 if (mService != null) {
6556 try {
6557 mService.setMasterVolumeMuted(admin, on);
6558 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006559 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04006560 }
6561 }
6562 }
6563
6564 /**
6565 * Called by profile or device owners to check whether the master volume mute is on or off.
6566 *
6567 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6568 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006569 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04006570 */
Robin Lee25e26452015-06-02 09:56:29 -07006571 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006572 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04006573 if (mService != null) {
6574 try {
6575 return mService.isMasterVolumeMuted(admin);
6576 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006577 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04006578 }
6579 }
6580 return false;
6581 }
Kenny Guyc13053b2014-05-29 14:17:17 +01006582
6583 /**
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006584 * Change whether a user can uninstall a package. This function can be called by a device owner,
6585 * profile owner, or by a delegate given the {@link #DELEGATION_BLOCK_UNINSTALL} scope via
6586 * {@link #setDelegatedScopes}.
Kenny Guyc13053b2014-05-29 14:17:17 +01006587 *
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006588 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6589 * {@code null} if the caller is a block uninstall delegate.
Kenny Guyc13053b2014-05-29 14:17:17 +01006590 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01006591 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006592 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006593 * @see #setDelegatedScopes
6594 * @see #DELEGATION_BLOCK_UNINSTALL
Kenny Guyc13053b2014-05-29 14:17:17 +01006595 */
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006596 public void setUninstallBlocked(@Nullable ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01006597 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006598 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01006599 if (mService != null) {
6600 try {
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006601 mService.setUninstallBlocked(admin, mContext.getPackageName(), packageName,
6602 uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01006603 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006604 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01006605 }
6606 }
6607 }
6608
6609 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08006610 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00006611 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00006612 * <p>
6613 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006614 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
6615 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
6616 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01006617 *
Robin Lee25e26452015-06-02 09:56:29 -07006618 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006619 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01006620 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00006621 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006622 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01006623 */
Robin Lee25e26452015-06-02 09:56:29 -07006624 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006625 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01006626 if (mService != null) {
6627 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01006628 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01006629 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006630 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01006631 }
6632 }
6633 return false;
6634 }
Svetoslav976e8bd2014-07-16 15:12:03 -07006635
6636 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006637 * Called by the profile owner of a managed profile to enable widget providers from a given
6638 * package to be available in the parent profile. As a result the user will be able to add
6639 * widgets from the white-listed package running under the profile to a widget host which runs
6640 * under the parent profile, for example the home screen. Note that a package may have zero or
6641 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07006642 * <p>
6643 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07006644 *
6645 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6646 * @param packageName The package from which widget providers are white-listed.
6647 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006648 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07006649 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
6650 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
6651 */
Robin Lee25e26452015-06-02 09:56:29 -07006652 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006653 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07006654 if (mService != null) {
6655 try {
6656 return mService.addCrossProfileWidgetProvider(admin, packageName);
6657 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006658 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07006659 }
6660 }
6661 return false;
6662 }
6663
6664 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07006665 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006666 * package to be available in the parent profile. For this method to take effect the package
6667 * should have been added via
6668 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07006669 * <p>
6670 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07006671 *
6672 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006673 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07006674 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006675 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07006676 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
6677 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
6678 */
Esteban Talavera62399912016-01-11 15:37:55 +00006679 public boolean removeCrossProfileWidgetProvider(
6680 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006681 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07006682 if (mService != null) {
6683 try {
6684 return mService.removeCrossProfileWidgetProvider(admin, packageName);
6685 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006686 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07006687 }
6688 }
6689 return false;
6690 }
6691
6692 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07006693 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07006694 * available in the parent profile.
6695 *
6696 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6697 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07006698 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
6699 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006700 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07006701 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006702 public @NonNull List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006703 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07006704 if (mService != null) {
6705 try {
6706 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
6707 if (providers != null) {
6708 return providers;
6709 }
6710 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006711 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07006712 }
6713 }
6714 return Collections.emptyList();
6715 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006716
6717 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08006718 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006719 *
6720 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6721 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006722 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006723 */
Robin Lee25e26452015-06-02 09:56:29 -07006724 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006725 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006726 try {
6727 mService.setUserIcon(admin, icon);
6728 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006729 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006730 }
6731 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04006732
6733 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01006734 * Called by device owners to set a local system update policy. When a new policy is set,
6735 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00006736 *
Robin Lee25e26452015-06-02 09:56:29 -07006737 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006738 * components in the device owner package can set system update policies and the most
6739 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07006740 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006741 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01006742 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00006743 */
Robin Lee25e26452015-06-02 09:56:29 -07006744 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006745 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00006746 if (mService != null) {
6747 try {
Robin Lee25e26452015-06-02 09:56:29 -07006748 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00006749 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006750 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00006751 }
6752 }
6753 }
6754
6755 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01006756 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00006757 *
Robin Lee25e26452015-06-02 09:56:29 -07006758 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00006759 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006760 public @Nullable SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006761 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00006762 if (mService != null) {
6763 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01006764 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00006765 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006766 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00006767 }
6768 }
6769 return null;
6770 }
Benjamin Franze36087e2015-04-07 16:40:34 +01006771
6772 /**
6773 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006774 * <p>
6775 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
6776 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
6777 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
6778 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01006779 *
6780 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01006781 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01006782 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006783 * place. {@code true} otherwise.
6784 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01006785 */
Robin Lee25e26452015-06-02 09:56:29 -07006786 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006787 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01006788 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01006789 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01006790 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006791 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01006792 }
6793 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00006794
6795 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01006796 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006797 * notifications, quick settings and other screen overlays that allow escaping from a single use
6798 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00006799 *
6800 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01006801 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006802 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
6803 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00006804 */
Robin Lee25e26452015-06-02 09:56:29 -07006805 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006806 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00006807 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01006808 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00006809 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006810 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00006811 }
6812 }
Rubin Xudc105cc2015-04-14 23:38:01 +01006813
6814 /**
Charles Hedea0c3b2017-01-13 10:04:12 +00006815 * Called by the system update service to notify device and profile owners of pending system
6816 * updates.
Rubin Xudc105cc2015-04-14 23:38:01 +01006817 *
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06006818 * This method should only be used when it is unknown whether the pending system
Charles Hedea0c3b2017-01-13 10:04:12 +00006819 * update is a security patch. Otherwise, use
6820 * {@link #notifyPendingSystemUpdate(long, boolean)}.
6821 *
6822 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()}
6823 * indicating when the current pending update was first available. {@code -1} if no
6824 * update is available.
6825 * @see #notifyPendingSystemUpdate(long, boolean)
Rubin Xudc105cc2015-04-14 23:38:01 +01006826 * @hide
6827 */
6828 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06006829 @RequiresPermission(android.Manifest.permission.NOTIFY_PENDING_SYSTEM_UPDATE)
Rubin Xudc105cc2015-04-14 23:38:01 +01006830 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006831 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01006832 if (mService != null) {
6833 try {
Charles Hedea0c3b2017-01-13 10:04:12 +00006834 mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime));
6835 } catch (RemoteException re) {
6836 throw re.rethrowFromSystemServer();
6837 }
6838 }
6839 }
6840
6841 /**
6842 * Called by the system update service to notify device and profile owners of pending system
6843 * updates.
6844 *
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06006845 * This method should be used instead of {@link #notifyPendingSystemUpdate(long)}
Charles Hedea0c3b2017-01-13 10:04:12 +00006846 * when it is known whether the pending system update is a security patch.
6847 *
6848 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()}
6849 * indicating when the current pending update was first available. {@code -1} if no
6850 * update is available.
6851 * @param isSecurityPatch {@code true} if this system update is purely a security patch;
6852 * {@code false} if not.
6853 * @see #notifyPendingSystemUpdate(long)
6854 * @hide
6855 */
6856 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06006857 @RequiresPermission(android.Manifest.permission.NOTIFY_PENDING_SYSTEM_UPDATE)
Charles Hedea0c3b2017-01-13 10:04:12 +00006858 public void notifyPendingSystemUpdate(long updateReceivedTime, boolean isSecurityPatch) {
6859 throwIfParentInstance("notifyPendingSystemUpdate");
6860 if (mService != null) {
6861 try {
6862 mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime,
6863 isSecurityPatch));
Rubin Xudc105cc2015-04-14 23:38:01 +01006864 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006865 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01006866 }
6867 }
6868 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04006869
6870 /**
Pavel Grafovd65799e2016-12-02 11:21:45 +00006871 * Called by device or profile owners to get information about a pending system update.
6872 *
6873 * @param admin Which profile or device owner this request is associated with.
6874 * @return Information about a pending system update or {@code null} if no update pending.
6875 * @throws SecurityException if {@code admin} is not a device or profile owner.
6876 * @see DeviceAdminReceiver#onSystemUpdatePending(Context, Intent, long)
6877 */
6878 public @Nullable SystemUpdateInfo getPendingSystemUpdate(@NonNull ComponentName admin) {
6879 throwIfParentInstance("getPendingSystemUpdate");
6880 try {
6881 return mService.getPendingSystemUpdate(admin);
6882 } catch (RemoteException re) {
6883 throw re.rethrowFromSystemServer();
6884 }
6885 }
6886
6887 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006888 * Set the default response for future runtime permission requests by applications. This
6889 * function can be called by a device owner, profile owner, or by a delegate given the
6890 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
6891 * The policy can allow for normal operation which prompts the user to grant a permission, or
6892 * can allow automatic granting or denying of runtime permission requests by an application.
6893 * This also applies to new permissions declared by app updates. When a permission is denied or
6894 * granted this way, the effect is equivalent to setting the permission * grant state via
6895 * {@link #setPermissionGrantState}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006896 * <p/>
6897 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07006898 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01006899 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07006900 * @param admin Which profile or device owner this request is associated with.
6901 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006902 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
6903 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01006904 * @see #setPermissionGrantState
Edman Anjos52088e42017-01-13 22:26:17 +01006905 * @see #setDelegatedScopes
6906 * @see #DELEGATION_PERMISSION_GRANT
Amith Yamasanid49489b2015-04-28 14:00:26 -07006907 */
Robin Lee25e26452015-06-02 09:56:29 -07006908 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006909 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07006910 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006911 mService.setPermissionPolicy(admin, mContext.getPackageName(), policy);
Amith Yamasanid49489b2015-04-28 14:00:26 -07006912 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006913 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07006914 }
6915 }
6916
6917 /**
6918 * Returns the current runtime permission policy set by the device or profile owner. The
6919 * default is {@link #PERMISSION_POLICY_PROMPT}.
Edman Anjos52088e42017-01-13 22:26:17 +01006920 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07006921 * @param admin Which profile or device owner this request is associated with.
6922 * @return the current policy for future permission requests.
6923 */
Esteban Talavera28b95702015-06-24 15:23:42 +01006924 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006925 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07006926 try {
6927 return mService.getPermissionPolicy(admin);
6928 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006929 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07006930 }
6931 }
6932
6933 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006934 * Sets the grant state of a runtime permission for a specific application. The state can be
6935 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
6936 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
6937 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
6938 * the permission is granted and the user cannot manage it through the UI. This might affect all
6939 * permissions in a group that the runtime permission belongs to. This method can only be called
Edman Anjos52088e42017-01-13 22:26:17 +01006940 * by a profile owner, device owner, or a delegate given the
6941 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006942 * <p/>
6943 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
6944 * the permission. It retains the previous grant, if any.
6945 * <p/>
6946 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07006947 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07006948 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07006949 * @param admin Which profile or device owner this request is associated with.
6950 * @param packageName The application to grant or revoke a permission to.
6951 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006952 * @param grantState The permission grant state which is one of
6953 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
6954 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07006955 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006956 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07006957 * @see #PERMISSION_GRANT_STATE_DENIED
6958 * @see #PERMISSION_GRANT_STATE_DEFAULT
6959 * @see #PERMISSION_GRANT_STATE_GRANTED
Edman Anjos52088e42017-01-13 22:26:17 +01006960 * @see #setDelegatedScopes
6961 * @see #DELEGATION_PERMISSION_GRANT
Amith Yamasanid49489b2015-04-28 14:00:26 -07006962 */
Robin Lee25e26452015-06-02 09:56:29 -07006963 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07006964 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006965 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07006966 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006967 return mService.setPermissionGrantState(admin, mContext.getPackageName(), packageName,
6968 permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07006969 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006970 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07006971 }
6972 }
Amith Yamasani184b3752015-05-22 13:00:51 -07006973
6974 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006975 * Returns the current grant state of a runtime permission for a specific application. This
6976 * function can be called by a device owner, profile owner, or by a delegate given the
6977 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
Amith Yamasani184b3752015-05-22 13:00:51 -07006978 *
Edman Anjos52088e42017-01-13 22:26:17 +01006979 * @param admin Which profile or device owner this request is associated with, or {@code null}
6980 * if the caller is a permission grant delegate.
Amith Yamasani184b3752015-05-22 13:00:51 -07006981 * @param packageName The application to check the grant state for.
6982 * @param permission The permission to check for.
6983 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006984 * has not set a grant state, the return value is
6985 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
6986 * permission is currently granted for the package.
6987 * <p/>
6988 * If a grant state was set by the profile or device owner, then the return value will
6989 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
6990 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
6991 * currently denied or granted.
6992 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07006993 * @see #setPermissionGrantState(ComponentName, String, String, int)
6994 * @see PackageManager#checkPermission(String, String)
Edman Anjos52088e42017-01-13 22:26:17 +01006995 * @see #setDelegatedScopes
6996 * @see #DELEGATION_PERMISSION_GRANT
Amith Yamasani184b3752015-05-22 13:00:51 -07006997 */
Bartosz Fabianowski4b0624f2017-01-16 11:47:28 +01006998 public int getPermissionGrantState(@Nullable ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07006999 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007000 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07007001 try {
Edman Anjos52088e42017-01-13 22:26:17 +01007002 return mService.getPermissionGrantState(admin, mContext.getPackageName(), packageName,
7003 permission);
Amith Yamasani184b3752015-05-22 13:00:51 -07007004 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007005 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07007006 }
7007 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00007008
7009 /**
Esteban Talavera01576862016-12-15 11:16:44 +00007010 * Returns whether it is possible for the caller to initiate provisioning of a managed profile
7011 * or device, setting itself as the device or profile owner.
7012 *
Nicolas Prevot07387fe2015-10-30 17:53:30 +00007013 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
7014 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Esteban Talavera01576862016-12-15 11:16:44 +00007015 * @return whether provisioning a managed profile or device is possible.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00007016 * @throws IllegalArgumentException if the supplied action is not valid.
7017 */
Esteban Talavera01576862016-12-15 11:16:44 +00007018 public boolean isProvisioningAllowed(@NonNull String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007019 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00007020 try {
Esteban Talavera01576862016-12-15 11:16:44 +00007021 return mService.isProvisioningAllowed(action, mContext.getPackageName());
Nicolas Prevot07387fe2015-10-30 17:53:30 +00007022 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007023 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00007024 }
7025 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00007026
7027 /**
Esteban Talavera01576862016-12-15 11:16:44 +00007028 * Checks whether it is possible to initiate provisioning a managed device,
7029 * profile or user, setting the given package as owner.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00007030 *
7031 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
7032 * {@link #ACTION_PROVISION_MANAGED_PROFILE},
7033 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE},
7034 * {@link #ACTION_PROVISION_MANAGED_USER}
Esteban Talavera01576862016-12-15 11:16:44 +00007035 * @param packageName The package of the component that would be set as device, user, or profile
7036 * owner.
7037 * @return A {@link ProvisioningPreCondition} value indicating whether provisioning is allowed.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00007038 * @hide
7039 */
Esteban Talavera01576862016-12-15 11:16:44 +00007040 public @ProvisioningPreCondition int checkProvisioningPreCondition(
7041 String action, @NonNull String packageName) {
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00007042 try {
Esteban Talavera01576862016-12-15 11:16:44 +00007043 return mService.checkProvisioningPreCondition(action, packageName);
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00007044 } catch (RemoteException re) {
7045 throw re.rethrowFromSystemServer();
7046 }
7047 }
7048
7049 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00007050 * Return if this user is a managed profile of another user. An admin can become the profile
7051 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01007052 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00007053 * @param admin Which profile owner this request is associated with.
7054 * @return if this user is a managed profile of another user.
7055 */
7056 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007057 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00007058 try {
7059 return mService.isManagedProfile(admin);
7060 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007061 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00007062 }
7063 }
7064
7065 /**
7066 * @hide
7067 * Return if this user is a system-only user. An admin can manage a device from a system only
7068 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
7069 * @param admin Which device owner this request is associated with.
7070 * @return if this user is a system-only user.
7071 */
7072 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
7073 try {
7074 return mService.isSystemOnlyUser(admin);
7075 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007076 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00007077 }
7078 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08007079
7080 /**
7081 * Called by device owner to get the MAC address of the Wi-Fi device.
7082 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08007083 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007084 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
7085 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
7086 * <p>
7087 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
7088 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08007089 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007090 public @Nullable String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007091 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08007092 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08007093 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08007094 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007095 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08007096 }
7097 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00007098
7099 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00007100 * Called by device owner to reboot the device. If there is an ongoing call on the device,
7101 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007102 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00007103 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007104 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00007105 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00007106 */
7107 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007108 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00007109 try {
7110 mService.reboot(admin);
7111 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007112 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00007113 }
7114 }
Kenny Guy06de4e72015-12-22 12:07:39 +00007115
7116 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007117 * Called by a device admin to set the short support message. This will be displayed to the user
7118 * in settings screens where funtionality has been disabled by the admin. The message should be
7119 * limited to a short statement such as "This setting is disabled by your administrator. Contact
7120 * someone@example.com for support." If the message is longer than 200 characters it may be
7121 * truncated.
7122 * <p>
7123 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007124 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
7125 * and set a new version of this string accordingly.
7126 *
Kenny Guy06de4e72015-12-22 12:07:39 +00007127 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00007128 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007129 * @param message Short message to be displayed to the user in settings or null to clear the
7130 * existing message.
7131 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007132 */
7133 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007134 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007135 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007136 if (mService != null) {
7137 try {
7138 mService.setShortSupportMessage(admin, message);
7139 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007140 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007141 }
7142 }
7143 }
7144
7145 /**
7146 * Called by a device admin to get the short support message.
7147 *
7148 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007149 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
7150 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007151 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007152 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007153 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007154 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007155 if (mService != null) {
7156 try {
7157 return mService.getShortSupportMessage(admin);
7158 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007159 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007160 }
7161 }
7162 return null;
7163 }
7164
7165 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007166 * Called by a device admin to set the long support message. This will be displayed to the user
7167 * in the device administators settings screen.
7168 * <p>
7169 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007170 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
7171 * and set a new version of this string accordingly.
7172 *
Kenny Guy06de4e72015-12-22 12:07:39 +00007173 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00007174 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007175 * @param message Long message to be displayed to the user in settings or null to clear the
7176 * existing message.
7177 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007178 */
7179 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007180 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007181 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007182 if (mService != null) {
7183 try {
7184 mService.setLongSupportMessage(admin, message);
7185 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007186 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007187 }
7188 }
7189 }
7190
7191 /**
7192 * Called by a device admin to get the long support message.
7193 *
7194 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007195 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
7196 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007197 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007198 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007199 public @Nullable CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007200 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007201 if (mService != null) {
7202 try {
7203 return mService.getLongSupportMessage(admin);
7204 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007205 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007206 }
7207 }
7208 return null;
7209 }
7210
7211 /**
7212 * Called by the system to get the short support message.
7213 *
7214 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7215 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007216 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00007217 *
7218 * @hide
7219 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007220 public @Nullable CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007221 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00007222 if (mService != null) {
7223 try {
7224 return mService.getShortSupportMessageForUser(admin, userHandle);
7225 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007226 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007227 }
7228 }
7229 return null;
7230 }
7231
7232
7233 /**
7234 * Called by the system to get the long support message.
7235 *
7236 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7237 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007238 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00007239 *
7240 * @hide
7241 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007242 public @Nullable CharSequence getLongSupportMessageForUser(
7243 @NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00007244 if (mService != null) {
7245 try {
7246 return mService.getLongSupportMessageForUser(admin, userHandle);
7247 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007248 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007249 }
7250 }
7251 return null;
7252 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007253
7254 /**
Esteban Talavera62399912016-01-11 15:37:55 +00007255 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
7256 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01007257 *
7258 * <p>The following methods are supported for the parent instance, all other methods will
7259 * throw a SecurityException when called on the parent instance:
7260 * <ul>
7261 * <li>{@link #getPasswordQuality}</li>
7262 * <li>{@link #setPasswordQuality}</li>
7263 * <li>{@link #getPasswordMinimumLength}</li>
7264 * <li>{@link #setPasswordMinimumLength}</li>
7265 * <li>{@link #getPasswordMinimumUpperCase}</li>
7266 * <li>{@link #setPasswordMinimumUpperCase}</li>
7267 * <li>{@link #getPasswordMinimumLowerCase}</li>
7268 * <li>{@link #setPasswordMinimumLowerCase}</li>
7269 * <li>{@link #getPasswordMinimumLetters}</li>
7270 * <li>{@link #setPasswordMinimumLetters}</li>
7271 * <li>{@link #getPasswordMinimumNumeric}</li>
7272 * <li>{@link #setPasswordMinimumNumeric}</li>
7273 * <li>{@link #getPasswordMinimumSymbols}</li>
7274 * <li>{@link #setPasswordMinimumSymbols}</li>
7275 * <li>{@link #getPasswordMinimumNonLetter}</li>
7276 * <li>{@link #setPasswordMinimumNonLetter}</li>
7277 * <li>{@link #getPasswordHistoryLength}</li>
7278 * <li>{@link #setPasswordHistoryLength}</li>
7279 * <li>{@link #getPasswordExpirationTimeout}</li>
7280 * <li>{@link #setPasswordExpirationTimeout}</li>
7281 * <li>{@link #getPasswordExpiration}</li>
Charles He8c760562016-10-25 16:36:53 +01007282 * <li>{@link #getPasswordMaximumLength}</li>
Benjamin Franz66b45f02016-04-05 19:12:39 +01007283 * <li>{@link #isActivePasswordSufficient}</li>
7284 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
7285 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
7286 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
7287 * <li>{@link #getMaximumTimeToLock}</li>
7288 * <li>{@link #setMaximumTimeToLock}</li>
7289 * <li>{@link #lockNow}</li>
7290 * <li>{@link #getKeyguardDisabledFeatures}</li>
7291 * <li>{@link #setKeyguardDisabledFeatures}</li>
7292 * <li>{@link #getTrustAgentConfiguration}</li>
7293 * <li>{@link #setTrustAgentConfiguration}</li>
Michal Karpinskia20d8bb2016-11-23 12:09:08 +00007294 * <li>{@link #getRequiredStrongAuthTimeout}</li>
7295 * <li>{@link #setRequiredStrongAuthTimeout}</li>
Benjamin Franz66b45f02016-04-05 19:12:39 +01007296 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007297 *
7298 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007299 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007300 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007301 public @NonNull DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007302 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007303 try {
7304 if (!mService.isManagedProfile(admin)) {
7305 throw new SecurityException("The current user does not have a parent profile.");
7306 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06007307 return new DevicePolicyManager(mContext, mService, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007308 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007309 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007310 }
7311 }
7312
7313 /**
Esteban Talaverad36dd152016-12-15 08:51:45 +00007314 * Called by device owner to control the security logging feature.
Michal Karpinski6235a942016-03-15 12:07:23 +00007315 *
7316 * <p> Security logs contain various information intended for security auditing purposes.
7317 * See {@link SecurityEvent} for details.
7318 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007319 * <p><strong>Note:</strong> The device owner won't be able to retrieve security logs if there
7320 * are unaffiliated secondary users or profiles on the device, regardless of whether the
7321 * feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for
7322 * all users to become affiliated. Therefore it's recommended that affiliation ids are set for
7323 * new users as soon as possible after provisioning via {@link #setAffiliationIds}.
Michal Karpinskib58e4962016-03-01 14:55:10 +00007324 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007325 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00007326 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007327 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00007328 * @see #retrieveSecurityLogs
7329 */
7330 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007331 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00007332 try {
7333 mService.setSecurityLoggingEnabled(admin, enabled);
7334 } catch (RemoteException re) {
7335 throw re.rethrowFromSystemServer();
7336 }
7337 }
7338
7339 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00007340 * Return whether security logging is enabled or not by the device owner.
7341 *
7342 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
7343 * thrown.
7344 *
7345 * @param admin Which device owner this request is associated with.
7346 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
7347 * @throws SecurityException if {@code admin} is not a device owner.
7348 */
Bartosz Fabianowski0ec00002017-03-24 14:22:24 +01007349 public boolean isSecurityLoggingEnabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007350 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007351 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00007352 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007353 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007354 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007355 }
7356 }
7357
7358 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00007359 * Called by device owner to retrieve all new security logging entries since the last call to
7360 * this API after device boots.
7361 *
7362 * <p> Access to the logs is rate limited and it will only return new logs after the device
7363 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
7364 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007365 * <p>If there is any other user or profile on the device, it must be affiliated with the
7366 * device owner. Otherwise a {@link SecurityException} will be thrown. See
7367 * {@link #setAffiliationIds}
Michal Karpinskib58e4962016-03-01 14:55:10 +00007368 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007369 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00007370 * @return the new batch of security logs which is a list of {@link SecurityEvent},
7371 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007372 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
7373 * profile or secondary user that is not affiliated with the device owner user.
7374 * @see DeviceAdminReceiver#onSecurityLogsAvailable
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007375 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007376 public @Nullable List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007377 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007378 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00007379 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007380 if (list != null) {
7381 return list.getList();
7382 } else {
7383 // Rate limit exceeded.
7384 return null;
7385 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007386 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007387 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007388 }
7389 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00007390
7391 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00007392 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
7393 * profile.
7394 *
7395 * @hide
7396 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007397 public @NonNull DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00007398 mContext.checkSelfPermission(
7399 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
7400 if (!uInfo.isManagedProfile()) {
7401 throw new SecurityException("The user " + uInfo.id
7402 + " does not have a parent profile.");
7403 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06007404 return new DevicePolicyManager(mContext, mService, true);
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00007405 }
7406
7407 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007408 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007409 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01007410 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
7411 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
7412 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
7413 * about data corruption when parsing. </strong>
Esteban Talaverad36dd152016-12-15 08:51:45 +00007414 *
7415 * <p>If there is any other user or profile on the device, it must be affiliated with the
7416 * device owner. Otherwise a {@link SecurityException} will be thrown. See
7417 * {@link #setAffiliationIds}
Michal Karpinskib58e4962016-03-01 14:55:10 +00007418 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007419 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01007420 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
7421 * is not supported on the device.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007422 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
7423 * profile or secondary user that is not affiliated with the device owner user.
7424 * @see #retrieveSecurityLogs
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007425 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007426 public @Nullable List<SecurityEvent> retrievePreRebootSecurityLogs(
7427 @NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007428 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007429 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00007430 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01007431 if (list != null) {
7432 return list.getList();
7433 } else {
7434 return null;
7435 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007436 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007437 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007438 }
7439 }
7440
7441 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007442 * Called by a profile owner of a managed profile to set the color used for customization. This
7443 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01007444 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007445 * <p>
7446 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00007447 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
7448 *
7449 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01007450 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007451 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00007452 */
7453 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007454 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00007455 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01007456 // always enforce alpha channel to have 100% opacity
7457 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00007458 mService.setOrganizationColor(admin, color);
7459 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007460 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00007461 }
7462 }
7463
7464 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007465 * @hide
7466 *
7467 * Sets the color used for customization.
7468 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01007469 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007470 * @param userId which user to set the color to.
7471 * @RequiresPermission(allOf = {
7472 * Manifest.permission.MANAGE_USERS,
7473 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
7474 */
7475 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
7476 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01007477 // always enforce alpha channel to have 100% opacity
7478 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007479 mService.setOrganizationColorForUser(color, userId);
7480 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007481 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007482 }
7483 }
7484
7485 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00007486 * Called by a profile owner of a managed profile to retrieve the color used for customization.
7487 * This color is used as background color of the confirm credentials screen for that user.
7488 *
7489 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01007490 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007491 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00007492 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01007493 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007494 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00007495 try {
7496 return mService.getOrganizationColor(admin);
7497 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007498 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00007499 }
7500 }
7501
7502 /**
7503 * @hide
7504 * Retrieve the customization color for a given user.
7505 *
7506 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01007507 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00007508 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01007509 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00007510 try {
7511 return mService.getOrganizationColorForUser(userHandle);
7512 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007513 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00007514 }
7515 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007516
7517 /**
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007518 * Called by the device owner or profile owner to set the name of the organization under
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007519 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007520 * <p>
7521 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007522 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
7523 * and set a new version of this string accordingly.
7524 *
7525 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7526 * @param title The organization name or {@code null} to clear a previously set name.
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007527 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007528 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01007529 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007530 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007531 try {
7532 mService.setOrganizationName(admin, title);
7533 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007534 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007535 }
7536 }
7537
7538 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007539 * Called by a profile owner of a managed profile to retrieve the name of the organization under
7540 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007541 *
7542 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7543 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007544 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007545 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007546 public @Nullable CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007547 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007548 try {
7549 return mService.getOrganizationName(admin);
7550 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007551 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007552 }
7553 }
7554
7555 /**
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007556 * Called by the system to retrieve the name of the organization managing the device.
7557 *
7558 * @return The organization name or {@code null} if none is set.
7559 * @throws SecurityException if the caller is not the device owner, does not hold the
7560 * MANAGE_USERS permission and is not the system.
7561 *
7562 * @hide
7563 */
7564 @SystemApi
7565 @TestApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06007566 @SuppressLint("Doclava125")
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007567 public @Nullable CharSequence getDeviceOwnerOrganizationName() {
7568 try {
7569 return mService.getDeviceOwnerOrganizationName();
7570 } catch (RemoteException re) {
7571 throw re.rethrowFromSystemServer();
7572 }
7573 }
7574
7575 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007576 * Retrieve the default title message used in the confirm credentials screen for a given user.
7577 *
7578 * @param userHandle The user id of the user we're interested in.
7579 * @return The organization name or {@code null} if none is set.
7580 *
7581 * @hide
7582 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007583 public @Nullable CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007584 try {
7585 return mService.getOrganizationNameForUser(userHandle);
7586 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007587 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007588 }
7589 }
7590
7591 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00007592 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
7593 * return {@link #STATE_USER_UNMANAGED}
7594 * @hide
7595 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00007596 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00007597 @UserProvisioningState
7598 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007599 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00007600 if (mService != null) {
7601 try {
7602 return mService.getUserProvisioningState();
7603 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007604 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00007605 }
7606 }
7607 return STATE_USER_UNMANAGED;
7608 }
7609
7610 /**
7611 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
7612 *
7613 * @param state to store
7614 * @param userHandle for user
7615 * @hide
7616 */
7617 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
7618 if (mService != null) {
7619 try {
7620 mService.setUserProvisioningState(state, userHandle);
7621 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007622 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00007623 }
7624 }
7625 }
7626
7627 /**
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007628 * Indicates the entity that controls the device or profile owner. Two users/profiles are
7629 * affiliated if the set of ids set by their device or profile owners intersect.
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007630 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007631 * <p><strong>Note:</strong> Features that depend on user affiliation (such as security logging
7632 * or {@link #bindDeviceAdminServiceAsUser}) won't be available when a secondary user or profile
7633 * is created, until it becomes affiliated. Therefore it is recommended that the appropriate
7634 * affiliation ids are set by its profile owner as soon as possible after the user/profile is
7635 * created.
7636 *
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007637 * @param admin Which profile or device owner this request is associated with.
Tony Mak31657432017-04-25 09:29:55 +01007638 * @param ids A set of opaque non-empty affiliation ids.
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007639 *
Tony Mak31657432017-04-25 09:29:55 +01007640 * @throws IllegalArgumentException if {@code ids} is null or contains an empty string.
7641 */
7642 public void setAffiliationIds(@NonNull ComponentName admin, @NonNull Set<String> ids) {
7643 throwIfParentInstance("setAffiliationIds");
7644 if (ids == null) {
7645 throw new IllegalArgumentException("ids must not be null");
7646 }
7647 try {
7648 mService.setAffiliationIds(admin, new ArrayList<>(ids));
7649 } catch (RemoteException e) {
7650 throw e.rethrowFromSystemServer();
7651 }
7652 }
7653
7654 /**
Tony Mak31657432017-04-25 09:29:55 +01007655 * Returns the set of affiliation ids previously set via {@link #setAffiliationIds}, or an
7656 * empty set if none have been set.
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007657 */
Tony Mak31657432017-04-25 09:29:55 +01007658 public @NonNull Set<String> getAffiliationIds(@NonNull ComponentName admin) {
Tony Mak62cf5862017-05-02 13:50:18 +01007659 throwIfParentInstance("getAffiliationIds");
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007660 try {
Tony Mak31657432017-04-25 09:29:55 +01007661 return new ArraySet<>(mService.getAffiliationIds(admin));
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007662 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007663 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007664 }
7665 }
7666
7667 /**
7668 * @hide
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007669 * Returns whether this user/profile is affiliated with the device.
7670 * <p>
7671 * By definition, the user that the device owner runs on is always affiliated with the device.
7672 * Any other user/profile is considered affiliated with the device if the set specified by its
7673 * profile owner via {@link #setAffiliationIds} intersects with the device owner's.
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007674 *
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007675 */
7676 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007677 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007678 try {
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007679 return mService.isAffiliatedUser();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007680 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007681 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007682 }
7683 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08007684
7685 /**
7686 * @hide
7687 * Returns whether the uninstall for {@code packageName} for the current user is in queue
7688 * to be started
7689 * @param packageName the package to check for
7690 * @return whether the uninstall intent for {@code packageName} is pending
7691 */
7692 public boolean isUninstallInQueue(String packageName) {
7693 try {
7694 return mService.isUninstallInQueue(packageName);
7695 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007696 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08007697 }
7698 }
7699
7700 /**
7701 * @hide
7702 * @param packageName the package containing active DAs to be uninstalled
7703 */
7704 public void uninstallPackageWithActiveAdmins(String packageName) {
7705 try {
7706 mService.uninstallPackageWithActiveAdmins(packageName);
7707 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007708 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08007709 }
7710 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01007711
Kenny Guy38dcca52016-04-19 13:09:18 +01007712 /**
7713 * @hide
7714 * Remove a test admin synchronously without sending it a broadcast about being removed.
7715 * If the admin is a profile owner or device owner it will still be removed.
7716 *
7717 * @param userHandle user id to remove the admin for.
7718 * @param admin The administration compononent to remove.
7719 * @throws SecurityException if the caller is not shell / root or the admin package
7720 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
7721 */
7722 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
7723 try {
7724 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
7725 } catch (RemoteException re) {
7726 throw re.rethrowFromSystemServer();
7727 }
7728 }
7729
Mahaver Chopra790d1982016-07-07 16:06:49 +01007730 /**
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007731 * Returns whether the device has been provisioned.
7732 *
7733 * <p>Not for use by third-party applications.
7734 *
Mahaver Chopra790d1982016-07-07 16:06:49 +01007735 * @hide
Mahaver Chopra790d1982016-07-07 16:06:49 +01007736 */
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007737 @SystemApi
Mahaver Chopra790d1982016-07-07 16:06:49 +01007738 public boolean isDeviceProvisioned() {
7739 try {
7740 return mService.isDeviceProvisioned();
7741 } catch (RemoteException re) {
7742 throw re.rethrowFromSystemServer();
7743 }
7744 }
7745
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007746 /**
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007747 * Writes that the provisioning configuration has been applied.
7748 *
7749 * <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS}
7750 * permission.
7751 *
7752 * <p>Not for use by third-party applications.
7753 *
7754 * @hide
7755 */
7756 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06007757 @RequiresPermission(android.Manifest.permission.MANAGE_USERS)
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007758 public void setDeviceProvisioningConfigApplied() {
7759 try {
7760 mService.setDeviceProvisioningConfigApplied();
7761 } catch (RemoteException re) {
7762 throw re.rethrowFromSystemServer();
7763 }
7764 }
7765
7766 /**
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007767 * Returns whether the provisioning configuration has been applied.
7768 *
7769 * <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS} permission.
7770 *
7771 * <p>Not for use by third-party applications.
7772 *
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007773 * @return whether the provisioning configuration has been applied.
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007774 *
7775 * @hide
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007776 */
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007777 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06007778 @RequiresPermission(android.Manifest.permission.MANAGE_USERS)
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007779 public boolean isDeviceProvisioningConfigApplied() {
7780 try {
7781 return mService.isDeviceProvisioningConfigApplied();
7782 } catch (RemoteException re) {
7783 throw re.rethrowFromSystemServer();
7784 }
7785 }
7786
Victor Chang9bfc65f2016-08-15 12:27:09 +01007787 /**
7788 * @hide
Victor Chang3577ed22016-08-25 18:49:26 +01007789 * Force update user setup completed status. This API has no effect on user build.
7790 * @throws {@link SecurityException} if the caller has no
Esteban Talavera01576862016-12-15 11:16:44 +00007791 * {@code android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS} or the caller is
7792 * not {@link UserHandle#SYSTEM_USER}
Victor Chang9bfc65f2016-08-15 12:27:09 +01007793 */
7794 public void forceUpdateUserSetupComplete() {
7795 try {
7796 mService.forceUpdateUserSetupComplete();
7797 } catch (RemoteException re) {
7798 throw re.rethrowFromSystemServer();
7799 }
7800 }
7801
Benjamin Franzbc33c822016-04-15 08:57:52 +01007802 private void throwIfParentInstance(String functionName) {
7803 if (mParentInstance) {
7804 throw new SecurityException(functionName + " cannot be called on the parent instance");
7805 }
7806 }
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007807
7808 /**
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007809 * Allows the device owner to enable or disable the backup service.
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007810 *
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007811 * <p> Backup service manages all backup and restore mechanisms on the device. Setting this to
7812 * false will prevent data from being backed up or restored.
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007813 *
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007814 * <p> Backup service is off by default when device owner is present.
7815 *
Rubin Xu0367f072017-04-24 20:17:16 +01007816 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7817 * @param enabled {@code true} to enable the backup service, {@code false} to disable it.
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007818 * @throws SecurityException if {@code admin} is not a device owner.
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007819 */
7820 public void setBackupServiceEnabled(@NonNull ComponentName admin, boolean enabled) {
Esteban Talavera5b7f2d02017-02-17 09:45:24 +00007821 throwIfParentInstance("setBackupServiceEnabled");
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007822 try {
7823 mService.setBackupServiceEnabled(admin, enabled);
7824 } catch (RemoteException re) {
7825 throw re.rethrowFromSystemServer();
7826 }
7827 }
7828
7829 /**
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007830 * Return whether the backup service is enabled by the device owner.
7831 *
7832 * <p> Backup service manages all backup and restore mechanisms on the device.
7833 *
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007834 * @return {@code true} if backup service is enabled, {@code false} otherwise.
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007835 * @see #setBackupServiceEnabled
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007836 */
7837 public boolean isBackupServiceEnabled(@NonNull ComponentName admin) {
Esteban Talavera5b7f2d02017-02-17 09:45:24 +00007838 throwIfParentInstance("isBackupServiceEnabled");
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007839 try {
7840 return mService.isBackupServiceEnabled(admin);
7841 } catch (RemoteException re) {
7842 throw re.rethrowFromSystemServer();
7843 }
7844 }
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007845
7846 /**
Esteban Talaverad36dd152016-12-15 08:51:45 +00007847 * Called by a device owner to control the network logging feature.
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007848 *
Robin Leea40a2fb2017-02-08 17:07:06 +00007849 * <p> Network logs contain DNS lookup and connect() library call events. The following library
7850 * functions are recorded while network logging is active:
7851 * <ul>
7852 * <li>{@code getaddrinfo()}</li>
7853 * <li>{@code gethostbyname()}</li>
7854 * <li>{@code connect()}</li>
7855 * </ul>
7856 *
7857 * <p> Network logging is a low-overhead tool for forensics but it is not guaranteed to use
7858 * full system call logging; event reporting is enabled by default for all processes but not
7859 * strongly enforced.
7860 * Events from applications using alternative implementations of libc, making direct kernel
7861 * calls, or deliberately obfuscating traffic may not be recorded.
7862 *
7863 * <p> Some common network events may not be reported. For example:
7864 * <ul>
7865 * <li>Applications may hardcode IP addresses to reduce the number of DNS lookups, or use
7866 * an alternative system for name resolution, and so avoid calling
7867 * {@code getaddrinfo()} or {@code gethostbyname}.</li>
7868 * <li>Applications may use datagram sockets for performance reasons, for example
7869 * for a game client. Calling {@code connect()} is unnecessary for this kind of
7870 * socket, so it will not trigger a network event.</li>
7871 * </ul>
7872 *
7873 * <p> It is possible to directly intercept layer 3 traffic leaving the device using an
7874 * always-on VPN service.
7875 * See {@link #setAlwaysOnVpnPackage(ComponentName, String, boolean)}
7876 * and {@link android.net.VpnService} for details.
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007877 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007878 * <p><strong>Note:</strong> The device owner won't be able to retrieve network logs if there
7879 * are unaffiliated secondary users or profiles on the device, regardless of whether the
7880 * feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for
7881 * all users to become affiliated. Therefore it's recommended that affiliation ids are set for
7882 * new users as soon as possible after provisioning via {@link #setAffiliationIds}.
7883 *
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007884 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7885 * @param enabled whether network logging should be enabled or not.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007886 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007887 * @see #retrieveNetworkLogs
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007888 */
7889 public void setNetworkLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
7890 throwIfParentInstance("setNetworkLoggingEnabled");
7891 try {
7892 mService.setNetworkLoggingEnabled(admin, enabled);
7893 } catch (RemoteException re) {
7894 throw re.rethrowFromSystemServer();
7895 }
7896 }
7897
7898 /**
7899 * Return whether network logging is enabled by a device owner.
7900 *
phweissa4e169e2016-11-24 16:20:57 +01007901 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Can only
7902 * be {@code null} if the caller has MANAGE_USERS permission.
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007903 * @return {@code true} if network logging is enabled by device owner, {@code false} otherwise.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007904 * @throws SecurityException if {@code admin} is not a device owner and caller has
phweissa4e169e2016-11-24 16:20:57 +01007905 * no MANAGE_USERS permission
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007906 */
phweissa4e169e2016-11-24 16:20:57 +01007907 public boolean isNetworkLoggingEnabled(@Nullable ComponentName admin) {
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007908 throwIfParentInstance("isNetworkLoggingEnabled");
7909 try {
7910 return mService.isNetworkLoggingEnabled(admin);
7911 } catch (RemoteException re) {
7912 throw re.rethrowFromSystemServer();
7913 }
7914 }
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007915
7916 /**
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007917 * Called by device owner to retrieve the most recent batch of network logging events.
7918 * A device owner has to provide a batchToken provided as part of
7919 * {@link DeviceAdminReceiver#onNetworkLogsAvailable} callback. If the token doesn't match the
7920 * token of the most recent available batch of logs, {@code null} will be returned.
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007921 *
7922 * <p> {@link NetworkEvent} can be one of {@link DnsEvent} or {@link ConnectEvent}.
7923 *
7924 * <p> The list of network events is sorted chronologically, and contains at most 1200 events.
7925 *
7926 * <p> Access to the logs is rate limited and this method will only return a new batch of logs
7927 * after the device device owner has been notified via
7928 * {@link DeviceAdminReceiver#onNetworkLogsAvailable}.
7929 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007930 * <p>If a secondary user or profile is created, calling this method will throw a
7931 * {@link SecurityException} until all users become affiliated again. It will also no longer be
7932 * possible to retrieve the network logs batch with the most recent batchToken provided
7933 * by {@link DeviceAdminReceiver#onNetworkLogsAvailable}. See
7934 * {@link DevicePolicyManager#setAffiliationIds}.
7935 *
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007936 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007937 * @param batchToken A token of the batch to retrieve
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007938 * @return A new batch of network logs which is a list of {@link NetworkEvent}. Returns
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007939 * {@code null} if the batch represented by batchToken is no longer available or if
7940 * logging is disabled.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007941 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
7942 * profile or secondary user that is not affiliated with the device owner user.
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007943 * @see DeviceAdminReceiver#onNetworkLogsAvailable
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007944 */
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007945 public @Nullable List<NetworkEvent> retrieveNetworkLogs(@NonNull ComponentName admin,
7946 long batchToken) {
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007947 throwIfParentInstance("retrieveNetworkLogs");
7948 try {
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007949 return mService.retrieveNetworkLogs(admin, batchToken);
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007950 } catch (RemoteException re) {
7951 throw re.rethrowFromSystemServer();
7952 }
7953 }
Tony Mak46aabe52016-11-14 12:53:06 +00007954
7955 /**
Esteban Talavera2f897912017-01-26 10:30:48 +00007956 * Called by a device owner to bind to a service from a profile owner or vice versa.
7957 * See {@link #getBindDeviceAdminTargetUsers} for a definition of which
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007958 * device/profile owners are allowed to bind to services of another profile/device owner.
7959 * <p>
Tony Makeda0a9a2017-04-25 12:07:14 +01007960 * The service must be protected by {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
7961 * Note that the {@link Context} used to obtain this
Tony Mak46aabe52016-11-14 12:53:06 +00007962 * {@link DevicePolicyManager} instance via {@link Context#getSystemService(Class)} will be used
7963 * to bind to the {@link android.app.Service}.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007964 *
Tony Mak46aabe52016-11-14 12:53:06 +00007965 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7966 * @param serviceIntent Identifies the service to connect to. The Intent must specify either an
7967 * explicit component name or a package name to match an
7968 * {@link IntentFilter} published by a service.
Tony Makbf9928d2016-12-22 11:02:45 +00007969 * @param conn Receives information as the service is started and stopped in main thread. This
7970 * must be a valid {@link ServiceConnection} object; it must not be {@code null}.
Tony Mak46aabe52016-11-14 12:53:06 +00007971 * @param flags Operation options for the binding operation. See
7972 * {@link Context#bindService(Intent, ServiceConnection, int)}.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007973 * @param targetUser Which user to bind to. Must be one of the users returned by
7974 * {@link #getBindDeviceAdminTargetUsers}, otherwise a {@link SecurityException} will
7975 * be thrown.
Tony Mak46aabe52016-11-14 12:53:06 +00007976 * @return If you have successfully bound to the service, {@code true} is returned;
7977 * {@code false} is returned if the connection is not made and you will not
7978 * receive the service object.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007979 *
Tony Mak46aabe52016-11-14 12:53:06 +00007980 * @see Context#bindService(Intent, ServiceConnection, int)
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007981 * @see #getBindDeviceAdminTargetUsers(ComponentName)
Tony Mak46aabe52016-11-14 12:53:06 +00007982 */
7983 public boolean bindDeviceAdminServiceAsUser(
7984 @NonNull ComponentName admin, Intent serviceIntent, @NonNull ServiceConnection conn,
7985 @Context.BindServiceFlags int flags, @NonNull UserHandle targetUser) {
7986 throwIfParentInstance("bindDeviceAdminServiceAsUser");
7987 // Keep this in sync with ContextImpl.bindServiceCommon.
7988 try {
Tony Makbf9928d2016-12-22 11:02:45 +00007989 final IServiceConnection sd = mContext.getServiceDispatcher(
7990 conn, mContext.getMainThreadHandler(), flags);
Tony Mak46aabe52016-11-14 12:53:06 +00007991 serviceIntent.prepareToLeaveProcess(mContext);
7992 return mService.bindDeviceAdminServiceAsUser(admin,
7993 mContext.getIApplicationThread(), mContext.getActivityToken(), serviceIntent,
7994 sd, flags, targetUser.getIdentifier());
7995 } catch (RemoteException re) {
7996 throw re.rethrowFromSystemServer();
7997 }
7998 }
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007999
8000 /**
Esteban Talaverafc291bc2016-11-21 13:52:03 +00008001 * Returns the list of target users that the calling device or profile owner can use when
8002 * calling {@link #bindDeviceAdminServiceAsUser}.
8003 * <p>
Esteban Talavera2f897912017-01-26 10:30:48 +00008004 * A device owner can bind to a service from a profile owner and vice versa, provided that:
Esteban Talaverafc291bc2016-11-21 13:52:03 +00008005 * <ul>
8006 * <li>Both belong to the same package name.
Esteban Talavera2f897912017-01-26 10:30:48 +00008007 * <li>Both users are affiliated. See {@link #setAffiliationIds}.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00008008 * </ul>
8009 */
8010 public @NonNull List<UserHandle> getBindDeviceAdminTargetUsers(@NonNull ComponentName admin) {
8011 throwIfParentInstance("getBindDeviceAdminTargetUsers");
8012 try {
8013 return mService.getBindDeviceAdminTargetUsers(admin);
8014 } catch (RemoteException re) {
8015 throw re.rethrowFromSystemServer();
8016 }
8017 }
8018
8019 /**
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01008020 * Called by the system to get the time at which the device owner last retrieved security
8021 * logging entries.
8022 *
8023 * @return the time at which the device owner most recently retrieved security logging entries,
8024 * in milliseconds since epoch; -1 if security logging entries were never retrieved.
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01008025 * @throws SecurityException if the caller is not the device owner, does not hold the
8026 * MANAGE_USERS permission and is not the system.
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01008027 *
8028 * @hide
8029 */
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01008030 @TestApi
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01008031 public long getLastSecurityLogRetrievalTime() {
8032 try {
8033 return mService.getLastSecurityLogRetrievalTime();
8034 } catch (RemoteException re) {
8035 throw re.rethrowFromSystemServer();
8036 }
8037 }
8038
8039 /**
8040 * Called by the system to get the time at which the device owner last requested a bug report.
8041 *
8042 * @return the time at which the device owner most recently requested a bug report, in
8043 * milliseconds since epoch; -1 if a bug report was never requested.
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01008044 * @throws SecurityException if the caller is not the device owner, does not hold the
8045 * MANAGE_USERS permission and is not the system.
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01008046 *
8047 * @hide
8048 */
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01008049 @TestApi
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01008050 public long getLastBugReportRequestTime() {
8051 try {
8052 return mService.getLastBugReportRequestTime();
8053 } catch (RemoteException re) {
8054 throw re.rethrowFromSystemServer();
8055 }
8056 }
8057
8058 /**
8059 * Called by the system to get the time at which the device owner last retrieved network logging
8060 * events.
8061 *
8062 * @return the time at which the device owner most recently retrieved network logging events, in
8063 * milliseconds since epoch; -1 if network logging events were never retrieved.
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01008064 * @throws SecurityException if the caller is not the device owner, does not hold the
8065 * MANAGE_USERS permission and is not the system.
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01008066 *
8067 * @hide
8068 */
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01008069 @TestApi
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01008070 public long getLastNetworkLogRetrievalTime() {
8071 try {
8072 return mService.getLastNetworkLogRetrievalTime();
8073 } catch (RemoteException re) {
8074 throw re.rethrowFromSystemServer();
8075 }
8076 }
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01008077
8078 /**
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01008079 * Called by the system to find out whether the current user's IME was set by the device/profile
8080 * owner or the user.
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01008081 *
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01008082 * @return {@code true} if the user's IME was set by the device or profile owner, {@code false}
8083 * otherwise.
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01008084 * @throws SecurityException if the caller is not the device owner/profile owner.
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01008085 *
8086 * @hide
8087 */
8088 @TestApi
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01008089 public boolean isCurrentInputMethodSetByOwner() {
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01008090 try {
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01008091 return mService.isCurrentInputMethodSetByOwner();
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01008092 } catch (RemoteException re) {
8093 throw re.rethrowFromSystemServer();
8094 }
8095 }
Bartosz Fabianowski05dc9f72017-02-22 23:41:14 +01008096
Bartosz Fabianowski05dc9f72017-02-22 23:41:14 +01008097 /**
8098 * Called by the system to get a list of CA certificates that were installed by the device or
8099 * profile owner.
8100 *
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01008101 * <p> The caller must be the target user's device owner/profile Owner or hold the
Bartosz Fabianowski05dc9f72017-02-22 23:41:14 +01008102 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS_FULL} permission.
8103 *
8104 * @param user The user for whom to retrieve information.
8105 * @return list of aliases identifying CA certificates installed by the device or profile owner
8106 * @throws SecurityException if the caller does not have permission to retrieve information
8107 * about the given user's CA certificates.
8108 *
8109 * @hide
8110 */
8111 @TestApi
8112 public List<String> getOwnerInstalledCaCerts(@NonNull UserHandle user) {
8113 try {
8114 return mService.getOwnerInstalledCaCerts(user).getList();
8115 } catch (RemoteException re) {
8116 throw re.rethrowFromSystemServer();
8117 }
8118 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08008119}