blob: d53cfdecc9bb7f0cd14249a83baa047461769bcd [file] [log] [blame]
Dianne Hackbornd6847842010-01-12 18:14:19 -08001/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Dianne Hackborn87bba1e2010-02-26 17:25:54 -080017package android.app.admin;
Dianne Hackbornd6847842010-01-12 18:14:19 -080018
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000019import android.annotation.ColorInt;
Alan Treadwayafad8782016-01-19 15:15:08 +000020import android.annotation.IntDef;
Robin Lee25e26452015-06-02 09:56:29 -070021import android.annotation.NonNull;
22import android.annotation.Nullable;
Dianne Hackbornd6847842010-01-12 18:14:19 -080023import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
Justin Moreyb5deda72014-07-24 10:53:40 -050025import android.annotation.SystemApi;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000026import android.annotation.UserIdInt;
Fyodor Kupolov4e9af062016-07-18 16:59:11 -070027import android.annotation.WorkerThread;
Jason Monkd7b86212014-06-16 13:15:38 -040028import android.app.Activity;
Michal Karpinskif77ee4f2016-10-12 16:40:06 +010029import android.app.admin.NetworkEvent;
Andrew Scull5f9e6f32016-08-02 14:22:17 +010030import android.app.admin.PasswordMetrics;
Michal Karpinski6235a942016-03-15 12:07:23 +000031import android.app.admin.SecurityLog.SecurityEvent;
Dianne Hackbornd6847842010-01-12 18:14:19 -080032import android.content.ComponentName;
33import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010034import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000035import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080036import android.content.pm.PackageManager;
Victor Changcd14c0a2016-03-16 19:10:15 +000037import android.content.pm.PackageManager.NameNotFoundException;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000038import android.content.pm.ParceledListSlice;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000039import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050040import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040041import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000042import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010043import android.os.Bundle;
Jim Millere303bf42014-08-26 17:12:29 -070044import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000045import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080046import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080047import android.os.RemoteException;
48import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070049import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040050import android.os.UserManager;
Jeff Sharkey49ca5292016-05-10 12:54:45 -060051import android.os.ServiceManager.ServiceNotFoundException;
Ricky Wai494b95d2015-11-20 16:07:15 +000052import android.provider.ContactsContract.Directory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000053import android.provider.Settings;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010054import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070055import android.service.restrictions.RestrictionsReceiver;
Mahaver Chopra1216ae52016-03-11 15:39:48 +000056import android.telephony.TelephonyManager;
Dianne Hackbornd6847842010-01-12 18:14:19 -080057import android.util.Log;
58
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070059import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040060import com.android.org.conscrypt.TrustedCertificateStore;
61
62import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080063import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000064import java.lang.annotation.Retention;
65import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070066import java.net.InetSocketAddress;
67import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010068import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000069import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010070import java.security.PrivateKey;
71import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040072import java.security.cert.CertificateException;
73import java.security.cert.CertificateFactory;
74import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010075import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000076import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070077import java.util.ArrayList;
Rubin Xub4365912016-03-23 12:13:22 +000078import java.util.Arrays;
Svetoslav976e8bd2014-07-16 15:12:03 -070079import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080080import java.util.List;
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +010081import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080082
83/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000084 * Public interface for managing policies enforced on a device. Most clients of this class must be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070085 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
86 * administrator</a>. Additionally, a device administrator may be registered as either a profile or
87 * device owner. A given method is accessible to all device administrators unless the documentation
88 * for that method specifies that it is restricted to either device or profile owners. Any
89 * application calling an api may only pass as an argument a device administrator component it
90 * owns. Otherwise, a {@link SecurityException} will be thrown.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080091 * <div class="special reference">
92 * <h3>Developer Guides</h3>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070093 * <p>
94 * For more information about managing policies for device administration, read the <a href=
95 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
96 * guide. </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080097 */
98public class DevicePolicyManager {
99 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -0800100
101 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -0800102 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +0000103 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700104
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600105 /** @hide */
106 public DevicePolicyManager(Context context, IDevicePolicyManager service) {
107 this(context, service, false);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800108 }
109
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800110 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700111 @VisibleForTesting
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600112 protected DevicePolicyManager(Context context, IDevicePolicyManager service,
113 boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700114 mContext = context;
115 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000116 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700117 }
118
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700119 /** @hide test will override it. */
120 @VisibleForTesting
121 protected int myUserId() {
122 return UserHandle.myUserId();
123 }
124
Dianne Hackbornd6847842010-01-12 18:14:19 -0800125 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000126 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000127 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100128 * <p>A managed profile allows data separation for example for the usage of a
129 * device as a personal and corporate device. The user which provisioning is started from and
130 * the managed profile share a launcher.
131 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800132 * <p>This intent will typically be sent by a mobile device management application (MDM).
133 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
134 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100135 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000136 * <p>It is possible to check if provisioning is allowed or not by querying the method
137 * {@link #isProvisioningAllowed(String)}.
138 *
139 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000140 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700141 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000142 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
143 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000144 *
Benjamin Franzea956242016-03-21 15:45:56 +0000145 * <p>The intent may also contain the following extras:
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000146 * <ul>
Benjamin Franzea956242016-03-21 15:45:56 +0000147 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
148 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
149 * {@link android.os.Build.VERSION_CODES#N}</li>
150 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
151 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
152 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000153 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000154 *
Benjamin Franzea956242016-03-21 15:45:56 +0000155 * <p>When managed provisioning has completed, broadcasts are sent to the application specified
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000156 * in the provisioning intent. The
157 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
158 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
159 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100160 *
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000161 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when managed provisioning has
162 * completed, along with the above broadcast, activity intent
163 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the application specified in
164 * the provisioning intent.
165 *
Benjamin Franzea956242016-03-21 15:45:56 +0000166 * <p>If provisioning fails, the managedProfile is removed so the device returns to its
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100167 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100168 *
169 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
170 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
171 * the provisioning flow was successful, although this doesn't guarantee the full flow will
172 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
173 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000174 */
175 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
176 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100177 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000178
179 /**
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000180 * Activity action: Starts the provisioning flow which sets up a managed user.
181 *
182 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800183 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000184 * owner who has full control over the user. Provisioning can only happen before user setup has
185 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
186 * allowed.
187 *
Benjamin Franzea956242016-03-21 15:45:56 +0000188 * <p>The intent contains the following extras:
189 * <ul>
190 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
191 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
192 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
193 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
194 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
195 * </ul>
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000196 *
Benjamin Franzea956242016-03-21 15:45:56 +0000197 * <p>If provisioning fails, the device returns to its previous state.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000198 *
199 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
200 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
201 * the provisioning flow was successful, although this doesn't guarantee the full flow will
202 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
203 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Benjamin Franzea956242016-03-21 15:45:56 +0000204 *
205 * @hide
Mahaver Chopra5e732562015-11-05 11:55:12 +0000206 */
207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
208 public static final String ACTION_PROVISION_MANAGED_USER
209 = "android.app.action.PROVISION_MANAGED_USER";
210
211 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100212 * Activity action: Starts the provisioning flow which sets up a managed device.
213 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
214 *
215 * <p> During device owner provisioning a device admin app is set as the owner of the device.
216 * A device owner has full control over the device. The device owner can not be modified by the
217 * user.
218 *
219 * <p> A typical use case would be a device that is owned by a company, but used by either an
220 * employee or client.
221 *
222 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000223 * It is possible to check if provisioning is allowed or not by querying the method
224 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100225 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000226 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100227 * <ul>
228 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
229 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
230 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100231 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000232 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000233 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100234 * </ul>
235 *
Benjamin Franzea956242016-03-21 15:45:56 +0000236 * <p>When device owner provisioning has completed, an intent of the type
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100237 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
238 * device owner.
239 *
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000240 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has
241 * completed, along with the above broadcast, activity intent
242 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner.
243 *
Benjamin Franzea956242016-03-21 15:45:56 +0000244 * <p>If provisioning fails, the device is factory reset.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100245 *
Alan Treadway4582f812015-07-28 11:49:35 +0100246 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
247 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
248 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
249 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100250 */
251 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
252 public static final String ACTION_PROVISION_MANAGED_DEVICE
253 = "android.app.action.PROVISION_MANAGED_DEVICE";
254
255 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000256 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000257 *
258 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
259 * the device. A device owner has full control over the device. The device owner can not be
260 * modified by the user and the only way of resetting the device is via factory reset.
261 *
262 * <p>A typical use case would be a device that is owned by a company, but used by either an
263 * employee or client.
264 *
265 * <p>The provisioning message should be sent to an unprovisioned device.
266 *
267 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
268 * by a privileged app with the permission
269 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
270 *
271 * <p>The provisioning intent contains the following properties:
272 * <ul>
273 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
274 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
275 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
276 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
277 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
278 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
279 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
280 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
281 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
282 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
283 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
284 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
285 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
286 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
287 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
288 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
289 *
290 * @hide
291 */
292 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
293 @SystemApi
294 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
295 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
296
297 /**
298 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000299 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
300 *
301 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
302 * management state that is distinct from that reached by
303 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
304 * user, and only has control over device-wide policies, not individual users and their data.
305 * The primary benefit is that multiple non-system users are supported when provisioning using
306 * this form of device management.
307 *
Benjamin Franzea956242016-03-21 15:45:56 +0000308 * <p>During device owner provisioning a device admin app is set as the owner of the device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000309 * A device owner has full control over the device. The device owner can not be modified by the
310 * user.
311 *
Benjamin Franzea956242016-03-21 15:45:56 +0000312 * <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 +0000313 * employee or client.
314 *
Benjamin Franzea956242016-03-21 15:45:56 +0000315 * <p>An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000316 * It is possible to check if provisioning is allowed or not by querying the method
317 * {@link #isProvisioningAllowed(String)}.
318 *
319 * <p>The intent contains the following extras:
320 * <ul>
321 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
322 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
323 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
324 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Benjamin Franzea956242016-03-21 15:45:56 +0000325 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
326 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Alan Treadway46dd4492015-11-09 13:57:19 +0000327 * </ul>
328 *
Benjamin Franzea956242016-03-21 15:45:56 +0000329 * <p>When device owner provisioning has completed, an intent of the type
Alan Treadway46dd4492015-11-09 13:57:19 +0000330 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
331 * device owner.
332 *
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000333 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has
334 * completed, along with the above broadcast, activity intent
335 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner.
336 *
Benjamin Franzea956242016-03-21 15:45:56 +0000337 * <p>If provisioning fails, the device is factory reset.
Alan Treadway46dd4492015-11-09 13:57:19 +0000338 *
339 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
340 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
341 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
342 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
343 *
344 * @hide
345 */
346 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
347 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
348 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
349
350 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000351 * Activity action: Finalizes management provisioning, should be used after user-setup
352 * has been completed and {@link #getUserProvisioningState()} returns one of:
353 * <ul>
354 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
355 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
356 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
357 * </ul>
358 *
359 * @hide
360 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000361 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000362 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
363 public static final String ACTION_PROVISION_FINALIZATION
364 = "android.app.action.PROVISION_FINALIZATION";
365
366 /**
Michal Karpinskiba244092016-02-25 17:28:24 +0000367 * Action: Bugreport sharing with device owner has been accepted by the user.
368 *
369 * @hide
370 */
371 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
372 "com.android.server.action.BUGREPORT_SHARING_ACCEPTED";
373
374 /**
375 * Action: Bugreport sharing with device owner has been declined by the user.
376 *
377 * @hide
378 */
379 public static final String ACTION_BUGREPORT_SHARING_DECLINED =
380 "com.android.server.action.BUGREPORT_SHARING_DECLINED";
381
382 /**
383 * Action: Bugreport has been collected and is dispatched to {@link DevicePolicyManagerService}.
384 *
385 * @hide
386 */
387 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
388 "android.intent.action.REMOTE_BUGREPORT_DISPATCH";
389
390 /**
391 * Extra for shared bugreport's SHA-256 hash.
392 *
393 * @hide
394 */
395 public static final String EXTRA_REMOTE_BUGREPORT_HASH =
396 "android.intent.extra.REMOTE_BUGREPORT_HASH";
397
398 /**
399 * Extra for remote bugreport notification shown type.
400 *
401 * @hide
402 */
403 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
404 "android.app.extra.bugreport_notification_type";
405
406 /**
407 * Notification type for a started remote bugreport flow.
408 *
409 * @hide
410 */
411 public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
412
413 /**
414 * Notification type for a bugreport that has already been accepted to be shared, but is still
415 * being taken.
416 *
417 * @hide
418 */
419 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
420
421 /**
422 * Notification type for a bugreport that has been taken and can be shared or declined.
423 *
424 * @hide
425 */
426 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
427
428 /**
Michal Karpinski8f010dd2016-06-21 15:05:53 +0100429 * Default and maximum timeout in milliseconds after which unlocking with weak auth times out,
430 * i.e. the user has to use a strong authentication method like password, PIN or pattern.
431 *
432 * @hide
433 */
434 public static final long DEFAULT_STRONG_AUTH_TIMEOUT_MS = 72 * 60 * 60 * 1000; // 72h
435
436 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100437 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100438 * allows a mobile device management application or NFC programmer application which starts
439 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100440 * <p>
441 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
442 * sends the intent to pass data to itself on the newly created profile.
443 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
444 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100445 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
446 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
447 * message should contain a stringified {@link java.util.Properties} instance, whose string
448 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
449 * management application after provisioning.
450 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100451 * <p>
452 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700453 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
454 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100455 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100456 */
457 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100458 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100459
460 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100461 * A String extra holding the package name of the mobile device management application that
462 * will be set as the profile owner or device owner.
463 *
464 * <p>If an application starts provisioning directly via an intent with action
465 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
466 * application that started provisioning. The package will be set as profile owner in that case.
467 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000468 * <p>This package is set as device owner when device owner provisioning is started by an NFC
469 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000470 *
471 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700472 * This receiver will be set as the profile or device owner and active admin.
Benjamin Franzea956242016-03-21 15:45:56 +0000473 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000474 * @see DeviceAdminReceiver
475 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100476 * supported, but only if there is only one device admin receiver in the package that requires
477 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000478 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000479 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000480 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100481 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000482
483 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000484 * A ComponentName extra indicating the device admin receiver of the mobile device management
485 * application that will be set as the profile owner or device owner and active admin.
486 *
487 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100488 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
489 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
490 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000491 *
492 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100493 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
494 * message containing an NFC record with MIME type
Benjamin Franzea956242016-03-21 15:45:56 +0000495 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000496 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000497 *
498 * @see DeviceAdminReceiver
499 */
500 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
501 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
502
503 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000504 * An {@link android.accounts.Account} extra holding the account to migrate during managed
505 * profile provisioning. If the account supplied is present in the primary user, it will be
506 * copied, along with its credentials to the managed profile and removed from the primary user.
507 *
508 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
509 */
510
511 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
512 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
513
514 /**
Jessica Hummele3da7902014-08-20 15:20:11 +0100515 * A String extra that, holds the email address of the account which a managed profile is
516 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
517 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100518 *
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100519 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
520 *
Jessica Hummele3da7902014-08-20 15:20:11 +0100521 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
522 * contains this extra, it is forwarded in the
523 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
524 * device management application that was set as the profile owner during provisioning.
525 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100526 */
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100527 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
528 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100529
530 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000531 * A integer extra indicating the predominant color to show during the provisioning.
532 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000533 *
534 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
535 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
536 */
537 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
538 "android.app.extra.PROVISIONING_MAIN_COLOR";
539
540 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000541 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700542 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000543 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100544 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
545 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000546 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000547 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
548 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000549
550 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100551 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
552 * will be set to.
553 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000554 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
555 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100556 */
557 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100558 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100559
560 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100561 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
562 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100563 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000564 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
565 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100566 */
567 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100568 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100569
570 /**
571 * A String extra holding the {@link java.util.Locale} that the device will be set to.
572 * Format: xx_yy, where xx is the language code, and yy the country code.
573 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000574 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
575 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100576 */
577 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100578 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100579
580 /**
581 * A String extra holding the ssid of the wifi network that should be used during nfc device
582 * owner provisioning for downloading the mobile device management application.
583 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000584 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
585 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100586 */
587 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100588 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100589
590 /**
591 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
592 * is hidden or not.
593 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000594 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
595 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100596 */
597 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100598 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100599
600 /**
601 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100602 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
603 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100604 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000605 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
606 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100607 */
608 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100609 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100610
611 /**
612 * A String extra holding the password of the wifi network in
613 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
614 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000615 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
616 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100617 */
618 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100619 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100620
621 /**
622 * A String extra holding the proxy host for the wifi network in
623 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
624 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000625 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
626 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100627 */
628 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100629 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100630
631 /**
632 * An int extra holding the proxy port for the wifi network in
633 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
634 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000635 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
636 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100637 */
638 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100639 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100640
641 /**
642 * A String extra holding the proxy bypass for the wifi network in
643 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
644 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000645 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
646 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100647 */
648 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100649 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100650
651 /**
652 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
653 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
654 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000655 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
656 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100657 */
658 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100659 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100660
661 /**
662 * A String extra holding a url that specifies the download location of the device admin
663 * package. When not provided it is assumed that the device admin package is already installed.
664 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000665 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
666 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100667 */
668 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100669 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100670
671 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400672 * An int extra holding a minimum required version code for the device admin package. If the
673 * device admin is already installed on the device, it will only be re-downloaded from
674 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
675 * installed package is less than this version code.
676 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400677 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400678 * provisioning via an NFC bump.
679 */
680 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
681 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
682
683 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100684 * A String extra holding a http cookie header which should be used in the http request to the
685 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
686 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000687 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
688 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100689 */
690 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100691 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100692
693 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100694 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
695 * the file at download location specified in
696 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100697 *
Benjamin Franzea956242016-03-21 15:45:56 +0000698 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
699 * present. The provided checksum must match the checksum of the file at the download
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100700 * location. If the checksum doesn't match an error will be shown to the user and the user will
701 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100702 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000703 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
704 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100705 *
706 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
707 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700708 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100709 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100710 */
711 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100712 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100713
714 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100715 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100716 * android package archive at the download location specified in {@link
717 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
718 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100719 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100720 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
721 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
722 *
Benjamin Franzea956242016-03-21 15:45:56 +0000723 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
724 * present. The provided checksum must match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100725 * the download location. If the checksum does not match an error will be shown to the user and
726 * the user will be asked to factory reset the device.
727 *
728 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
729 * provisioning via an NFC bump.
730 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100731 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
732 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100733
734 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000735 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
736 * has completed successfully.
737 *
738 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700739 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000740 *
Ying Wang7f38aab2015-02-20 11:50:09 -0800741 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000742 * corresponds to the account requested to be migrated at provisioning time, if any.
743 */
744 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
745 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
746 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
747
748 /**
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000749 * Activity action: This activity action is sent to indicate that provisioning of a managed
750 * profile or managed device has completed successfully. It'll be sent at the same time as
751 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast but this will be
752 * delivered faster as it's an activity intent.
753 *
754 * <p>The intent is only sent to the application on the profile that requested provisioning. In
755 * the device owner case the profile is the primary user.
756 *
757 * @see #ACTION_PROVISION_MANAGED_PROFILE
758 * @see #ACTION_PROVISION_MANAGED_DEVICE
759 */
760 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
761 public static final String ACTION_PROVISIONING_SUCCESSFUL =
762 "android.app.action.PROVISIONING_SUCCESSFUL";
763
764 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000765 * A boolean extra indicating whether device encryption can be skipped as part of device owner
766 * or managed profile provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500767 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400768 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100769 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Benjamin Franzea956242016-03-21 15:45:56 +0000770 *
771 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
772 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500773 */
774 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
775 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
776
777 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000778 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
779 * provisioning. If this extra is not passed, a default image will be shown.
780 * <h5>The following URI schemes are accepted:</h5>
781 * <ul>
782 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
783 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
784 * </ul>
785 *
786 * <p> It is the responsability of the caller to provide an image with a reasonable
787 * pixed density for the device.
788 *
789 * <p> If a content: URI is passed, the intent should have the flag
790 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
791 * {@link android.content.ClipData} of the intent too.
792 *
793 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
794 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
795 */
796 public static final String EXTRA_PROVISIONING_LOGO_URI =
797 "android.app.extra.PROVISIONING_LOGO_URI";
798
799 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000800 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
801 * during setup-wizard.
802 *
803 * <p>If unspecified, defaults to {@code true} to match the behavior in
804 * {@link android.os.Build.VERSION_CODES#M} and earlier.
805 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000806 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
807 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000808 *
809 * @hide
810 */
811 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
812 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
813
814 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000815 * This MIME type is used for starting the device owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100816 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400817 * <p>During device owner provisioning a device admin app is set as the owner of the device.
818 * A device owner has full control over the device. The device owner can not be modified by the
819 * user and the only way of resetting the device is if the device owner app calls a factory
820 * reset.
821 *
822 * <p> A typical use case would be a device that is owned by a company, but used by either an
823 * employee or client.
824 *
Benjamin Franzea956242016-03-21 15:45:56 +0000825 * <p> The NFC message must be sent to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100826 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000827 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100828 * contains the following properties:
829 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400830 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
831 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100832 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400833 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100834 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
835 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
836 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
837 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
838 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
839 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
840 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
841 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
842 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
843 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100844 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
845 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
846 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100847 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000848 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700849 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400850 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
851 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
852 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400853 */
854 public static final String MIME_TYPE_PROVISIONING_NFC
855 = "application/com.android.managedprovisioning";
856
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100857 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800858 * Activity action: ask the user to add a new device administrator to the system.
859 * The desired policy is the ComponentName of the policy in the
860 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
861 * bring the user through adding the device administrator to the system (or
862 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700863 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800864 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
865 * field to provide the user with additional explanation (in addition
866 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800867 *
868 * <p>If your administrator is already active, this will ordinarily return immediately (without
869 * user intervention). However, if your administrator has been updated and is requesting
870 * additional uses-policy flags, the user will be presented with the new list. New policies
871 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800872 */
873 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
874 public static final String ACTION_ADD_DEVICE_ADMIN
875 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700876
Dianne Hackbornd6847842010-01-12 18:14:19 -0800877 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700878 * @hide
879 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -0700880 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700881 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700882 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
883 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700884 * to remotely control restrictions on the user.
885 *
Makoto Onukic8a5a552015-11-19 14:29:12 -0800886 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700887 * result of whether or not the user approved the action. If approved, the result will
888 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
889 * as a profile owner.
890 *
891 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
892 * field to provide the user with additional explanation (in addition
893 * to your component's description) about what is being added.
894 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700895 * <p>If there is already a profile owner active or the caller is not a system app, the
896 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700897 */
898 @SystemApi
899 public static final String ACTION_SET_PROFILE_OWNER
900 = "android.app.action.SET_PROFILE_OWNER";
901
902 /**
903 * @hide
904 * Name of the profile owner admin that controls the user.
905 */
906 @SystemApi
907 public static final String EXTRA_PROFILE_OWNER_NAME
908 = "android.app.extra.PROFILE_OWNER_NAME";
909
910 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100911 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -0700912 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700913 *
Jim Miller284b62e2010-06-08 14:27:42 -0700914 * @hide
915 */
916 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
917 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
918
919 /**
Tony Mak1970f972016-08-30 17:41:48 +0100920 * Broadcast action: sent when the device owner is set, changed or cleared.
Nicolas Prevot00799002015-07-27 18:15:20 +0100921 *
922 * This broadcast is sent only to the primary user.
923 * @see #ACTION_PROVISION_MANAGED_DEVICE
924 */
925 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
926 public static final String ACTION_DEVICE_OWNER_CHANGED
927 = "android.app.action.DEVICE_OWNER_CHANGED";
928
929 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800930 * The ComponentName of the administrator component.
931 *
932 * @see #ACTION_ADD_DEVICE_ADMIN
933 */
934 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700935
Dianne Hackbornd6847842010-01-12 18:14:19 -0800936 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800937 * An optional CharSequence providing additional explanation for why the
938 * admin is being added.
939 *
940 * @see #ACTION_ADD_DEVICE_ADMIN
941 */
942 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700943
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800944 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700945 * Activity action: have the user enter a new password. This activity should
946 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
947 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
948 * enter a new password that meets the current requirements. You can use
949 * {@link #isActivePasswordSufficient()} to determine whether you need to
950 * have the user select a new password in order to meet the current
951 * constraints. Upon being resumed from this activity, you can check the new
952 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +0000953 *
954 * If the intent is launched from within a managed profile with a profile
955 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
956 * this will trigger entering a new password for the parent of the profile.
957 * For all other cases it will trigger entering a new password for the user
958 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +0000959 *
960 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -0800961 */
962 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
963 public static final String ACTION_SET_NEW_PASSWORD
964 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700965
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000966 /**
Benjamin Franzc9921092016-01-08 17:17:44 +0000967 * Activity action: have the user enter a new password for the parent profile.
968 * If the intent is launched from within a managed profile, this will trigger
969 * entering a new password for the parent of the profile. In all other cases
970 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
971 */
972 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
973 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
974 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
975
976 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000977 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
978 * the parent profile to access intents sent from the managed profile.
979 * That is, when an app in the managed profile calls
980 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
981 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000982 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100983 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000984
985 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000986 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
987 * the managed profile to access intents sent from the parent profile.
988 * That is, when an app in the parent profile calls
989 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
990 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000991 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100992 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700993
Dianne Hackbornd6847842010-01-12 18:14:19 -0800994 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +0100995 * Broadcast action: notify that a new local system update policy has been set by the device
996 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +0000997 */
998 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +0100999 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
1000 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +00001001
Amith Yamasanid49489b2015-04-28 14:00:26 -07001002 /**
1003 * Permission policy to prompt user for new permission requests for runtime permissions.
1004 * Already granted or denied permissions are not affected by this.
1005 */
1006 public static final int PERMISSION_POLICY_PROMPT = 0;
1007
1008 /**
1009 * Permission policy to always grant new permission requests for runtime permissions.
1010 * Already granted or denied permissions are not affected by this.
1011 */
1012 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
1013
1014 /**
1015 * Permission policy to always deny new permission requests for runtime permissions.
1016 * Already granted or denied permissions are not affected by this.
1017 */
1018 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
1019
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07001020 /**
1021 * Runtime permission state: The user can manage the permission
1022 * through the UI.
1023 */
1024 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
1025
1026 /**
1027 * Runtime permission state: The permission is granted to the app
1028 * and the user cannot manage the permission through the UI.
1029 */
1030 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
1031
1032 /**
1033 * Runtime permission state: The permission is denied to the app
1034 * and the user cannot manage the permission through the UI.
1035 */
1036 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +00001037
1038 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00001039 * No management for current user in-effect. This is the default.
1040 * @hide
1041 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001042 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001043 public static final int STATE_USER_UNMANAGED = 0;
1044
1045 /**
1046 * Management partially setup, user setup needs to be completed.
1047 * @hide
1048 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001049 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001050 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1051
1052 /**
1053 * Management partially setup, user setup completed.
1054 * @hide
1055 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001056 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001057 public static final int STATE_USER_SETUP_COMPLETE = 2;
1058
1059 /**
1060 * Management setup and active on current user.
1061 * @hide
1062 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001063 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001064 public static final int STATE_USER_SETUP_FINALIZED = 3;
1065
1066 /**
1067 * Management partially setup on a managed profile.
1068 * @hide
1069 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001070 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001071 public static final int STATE_USER_PROFILE_COMPLETE = 4;
1072
1073 /**
1074 * @hide
1075 */
1076 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
1077 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
1078 @Retention(RetentionPolicy.SOURCE)
1079 public @interface UserProvisioningState {}
1080
1081 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001082 * Return true if the given administrator component is currently active (enabled) in the system.
1083 *
1084 * @param admin The administrator component to check for.
1085 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1086 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001087 */
Robin Lee25e26452015-06-02 09:56:29 -07001088 public boolean isAdminActive(@NonNull ComponentName admin) {
Charles He8c760562016-10-25 16:36:53 +01001089 throwIfParentInstance("isAdminActive");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001090 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001091 }
1092
1093 /**
1094 * @see #isAdminActive(ComponentName)
1095 * @hide
1096 */
Robin Lee25e26452015-06-02 09:56:29 -07001097 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001098 if (mService != null) {
1099 try {
Robin Lee25e26452015-06-02 09:56:29 -07001100 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001101 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001102 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001103 }
1104 }
1105 return false;
1106 }
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001107 /**
1108 * Return true if the given administrator component is currently being removed
1109 * for the user.
1110 * @hide
1111 */
Robin Lee25e26452015-06-02 09:56:29 -07001112 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001113 if (mService != null) {
1114 try {
Robin Lee25e26452015-06-02 09:56:29 -07001115 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001116 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001117 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001118 }
1119 }
1120 return false;
1121 }
1122
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001123
Dianne Hackbornd6847842010-01-12 18:14:19 -08001124 /**
Robin Lee25e26452015-06-02 09:56:29 -07001125 * Return a list of all currently active device administrators' component
1126 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001127 * returned.
1128 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07001129 public @Nullable List<ComponentName> getActiveAdmins() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001130 throwIfParentInstance("getActiveAdmins");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001131 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001132 }
1133
1134 /**
1135 * @see #getActiveAdmins()
1136 * @hide
1137 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07001138 public @Nullable List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001139 if (mService != null) {
1140 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001141 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001142 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001143 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001144 }
1145 }
1146 return null;
1147 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001148
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001149 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001150 * Used by package administration code to determine if a package can be stopped
1151 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001152 * @hide
1153 */
1154 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001155 return packageHasActiveAdmins(packageName, myUserId());
1156 }
1157
1158 /**
1159 * Used by package administration code to determine if a package can be stopped
1160 * or uninstalled.
1161 * @hide
1162 */
1163 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001164 if (mService != null) {
1165 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001166 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001167 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001168 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001169 }
1170 }
1171 return false;
1172 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001173
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001174 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001175 * Remove a current administration component. This can only be called
1176 * by the application that owns the administration component; if you
1177 * try to remove someone else's component, a security exception will be
1178 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001179 *
1180 * <p>Note that the operation is not synchronous and the admin might still be active (as
1181 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001182 *
1183 * @param admin The administration compononent to remove.
1184 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001185 */
Robin Lee25e26452015-06-02 09:56:29 -07001186 public void removeActiveAdmin(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001187 throwIfParentInstance("removeActiveAdmin");
Dianne Hackbornd6847842010-01-12 18:14:19 -08001188 if (mService != null) {
1189 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001190 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001191 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001192 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001193 }
1194 }
1195 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001196
Dianne Hackbornd6847842010-01-12 18:14:19 -08001197 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001198 * Returns true if an administrator has been granted a particular device policy. This can be
1199 * used to check whether the administrator was activated under an earlier set of policies, but
1200 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001201 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001202 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1203 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001204 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001205 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001206 */
Robin Lee25e26452015-06-02 09:56:29 -07001207 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001208 throwIfParentInstance("hasGrantedPolicy");
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001209 if (mService != null) {
1210 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001211 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001212 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001213 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001214 }
1215 }
1216 return false;
1217 }
1218
1219 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001220 * Returns true if the Profile Challenge is available to use for the given profile user.
1221 *
1222 * @hide
1223 */
1224 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1225 if (mService != null) {
1226 try {
1227 return mService.isSeparateProfileChallengeAllowed(userHandle);
1228 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001229 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001230 }
1231 }
1232 return false;
1233 }
1234
1235 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001236 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1237 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001238 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001239 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001240 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001241
Dianne Hackbornd6847842010-01-12 18:14:19 -08001242 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001243 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1244 * recognition technology. This implies technologies that can recognize the identity of
1245 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1246 * Note that quality constants are ordered so that higher values are more restrictive.
1247 */
1248 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1249
1250 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001251 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001252 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001253 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001254 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001255 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001256
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001257 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001258 * Constant for {@link #setPasswordQuality}: the user must have entered a
1259 * password containing at least numeric characters. Note that quality
1260 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001261 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001262 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001263
Dianne Hackbornd6847842010-01-12 18:14:19 -08001264 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001265 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001266 * password containing at least numeric characters with no repeating (4444)
1267 * or ordered (1234, 4321, 2468) sequences. Note that quality
1268 * constants are ordered so that higher values are more restrictive.
1269 */
1270 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1271
1272 /**
1273 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001274 * password containing at least alphabetic (or other symbol) characters.
1275 * Note that quality constants are ordered so that higher values are more
1276 * restrictive.
1277 */
1278 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001279
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001280 /**
1281 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001282 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001283 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001284 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001285 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001286 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001287
Dianne Hackbornd6847842010-01-12 18:14:19 -08001288 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001289 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001290 * password containing at least a letter, a numerical digit and a special
1291 * symbol, by default. With this password quality, passwords can be
1292 * restricted to contain various sets of characters, like at least an
1293 * uppercase letter, etc. These are specified using various methods,
1294 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1295 * that quality constants are ordered so that higher values are more
1296 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001297 */
1298 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1299
1300 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001301 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1302 * modify password. In case this password quality is set, the password is
1303 * managed by a profile owner. The profile owner can set any password,
1304 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1305 * that quality constants are ordered so that higher values are more
1306 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1307 * the highest.
1308 * @hide
1309 */
1310 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1311
1312 /**
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001313 * @hide
1314 *
1315 * adb shell dpm set-{device,profile}-owner will normally not allow installing an owner to
1316 * a user with accounts. {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED}
1317 * and {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} are the account features
1318 * used by authenticator to exempt their accounts from this:
1319 *
1320 * <ul>
1321 * <li>Non-test-only DO/PO still can't be installed when there are accounts.
1322 * <p>In order to make an apk test-only, add android:testOnly="true" to the
1323 * &lt;application&gt; tag in the manifest.
1324 *
1325 * <li>Test-only DO/PO can be installed even when there are accounts, as long as all the
1326 * accounts have the {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} feature.
1327 * Some authenticators claim to have any features, so to detect it, we also check
1328 * {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} and disallow installing
1329 * if any of the accounts have it.
1330 * </ul>
1331 */
1332 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED =
1333 "android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED";
1334
1335 /** @hide See {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} */
1336 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED =
1337 "android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED";
1338
1339 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001340 * Called by an application that is administering the device to set the password restrictions it
1341 * is imposing. After setting this, the user will not be able to enter a new password that is
1342 * not at least as restrictive as what has been set. Note that the current password will remain
1343 * until the user has set a new one, so the change does not take place immediately. To prompt
1344 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001345 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001346 * <p>
1347 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1348 * requested quality constant (between the policy set here, the user's preference, and any other
1349 * considerations) is the one that is in effect.
1350 * <p>
1351 * The calling device admin must have requested
1352 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1353 * not, a security exception will be thrown.
1354 * <p>
1355 * This method can be called on the {@link DevicePolicyManager} instance returned by
1356 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1357 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001358 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001359 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001360 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1361 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1362 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1363 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1364 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1365 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001366 */
Robin Lee25e26452015-06-02 09:56:29 -07001367 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001368 if (mService != null) {
1369 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001370 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001371 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001372 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001373 }
1374 }
1375 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001376
Dianne Hackbornd6847842010-01-12 18:14:19 -08001377 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001378 * Retrieve the current minimum password quality for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001379 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001380 * a separate challenge are not taken into account.
1381 *
1382 * <p>This method can be called on the {@link DevicePolicyManager} instance
1383 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1384 * restrictions on the parent profile.
1385 *
Robin Lee25e26452015-06-02 09:56:29 -07001386 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001387 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001388 */
Robin Lee25e26452015-06-02 09:56:29 -07001389 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001390 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001391 }
1392
1393 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001394 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001395 if (mService != null) {
1396 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001397 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001398 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001399 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001400 }
1401 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001402 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001403 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001404
Dianne Hackbornd6847842010-01-12 18:14:19 -08001405 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001406 * Called by an application that is administering the device to set the minimum allowed password
1407 * length. After setting this, the user will not be able to enter a new password that is not at
1408 * least as restrictive as what has been set. Note that the current password will remain until
1409 * the user has set a new one, so the change does not take place immediately. To prompt the user
1410 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1411 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1412 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1413 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1414 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1415 * {@link #setPasswordQuality}.
1416 * <p>
1417 * The calling device admin must have requested
1418 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1419 * not, a security exception will be thrown.
1420 * <p>
1421 * This method can be called on the {@link DevicePolicyManager} instance returned by
1422 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1423 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001424 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001425 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001426 * @param length The new desired minimum password length. A value of 0 means there is no
1427 * restriction.
1428 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1429 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001430 */
Robin Lee25e26452015-06-02 09:56:29 -07001431 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001432 if (mService != null) {
1433 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001434 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001435 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001436 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001437 }
1438 }
1439 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001440
Dianne Hackbornd6847842010-01-12 18:14:19 -08001441 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001442 * Retrieve the current minimum password length for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001443 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001444 * a separate challenge are not taken into account.
1445 *
1446 * <p>This method can be called on the {@link DevicePolicyManager} instance
1447 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1448 * restrictions on the parent profile.
1449 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001450 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001451 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001452 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001453 */
Robin Lee25e26452015-06-02 09:56:29 -07001454 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001455 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001456 }
1457
1458 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001459 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001460 if (mService != null) {
1461 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001462 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001463 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001464 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001465 }
1466 }
1467 return 0;
1468 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001469
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001470 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001471 * Called by an application that is administering the device to set the minimum number of upper
1472 * case letters required in the password. After setting this, the user will not be able to enter
1473 * a new password that is not at least as restrictive as what has been set. Note that the
1474 * current password will remain until the user has set a new one, so the change does not take
1475 * place immediately. To prompt the user for a new password, use
1476 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1477 * setting this value. This constraint is only imposed if the administrator has also requested
1478 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001479 * <p>
1480 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001481 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1482 * not, a security exception will be thrown.
1483 * <p>
1484 * This method can be called on the {@link DevicePolicyManager} instance returned by
1485 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1486 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001487 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001488 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1489 * @param length The new desired minimum number of upper case letters required in the password.
1490 * A value of 0 means there is no restriction.
1491 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1492 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001493 */
Robin Lee25e26452015-06-02 09:56:29 -07001494 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001495 if (mService != null) {
1496 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001497 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001498 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001499 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001500 }
1501 }
1502 }
1503
1504 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001505 * Retrieve the current number of upper case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001506 * for a particular admin or all admins that set restrictions on this user and
Esteban Talaverac1c83592016-02-17 17:56:15 +00001507 * its participating profiles. Restrictions on profiles that have a separate challenge
1508 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001509 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001510 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001511 * and only applies when the password quality is
1512 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001513 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001514 * <p>This method can be called on the {@link DevicePolicyManager} instance
1515 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1516 * restrictions on the parent profile.
1517 *
Robin Lee25e26452015-06-02 09:56:29 -07001518 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001519 * aggregate all admins.
1520 * @return The minimum number of upper case letters required in the
1521 * password.
1522 */
Robin Lee25e26452015-06-02 09:56:29 -07001523 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001524 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001525 }
1526
1527 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001528 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001529 if (mService != null) {
1530 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001531 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001532 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001533 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001534 }
1535 }
1536 return 0;
1537 }
1538
1539 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001540 * Called by an application that is administering the device to set the minimum number of lower
1541 * case letters required in the password. After setting this, the user will not be able to enter
1542 * a new password that is not at least as restrictive as what has been set. Note that the
1543 * current password will remain until the user has set a new one, so the change does not take
1544 * place immediately. To prompt the user for a new password, use
1545 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1546 * setting this value. This constraint is only imposed if the administrator has also requested
1547 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001548 * <p>
1549 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001550 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1551 * not, a security exception will be thrown.
1552 * <p>
1553 * This method can be called on the {@link DevicePolicyManager} instance returned by
1554 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1555 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001556 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001557 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1558 * @param length The new desired minimum number of lower case letters required in the password.
1559 * A value of 0 means there is no restriction.
1560 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1561 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001562 */
Robin Lee25e26452015-06-02 09:56:29 -07001563 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001564 if (mService != null) {
1565 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001566 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001567 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001568 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001569 }
1570 }
1571 }
1572
1573 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001574 * Retrieve the current number of lower case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001575 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001576 * and its participating profiles. Restrictions on profiles that have
1577 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001578 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001579 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001580 * and only applies when the password quality is
1581 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001582 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001583 * <p>This method can be called on the {@link DevicePolicyManager} instance
1584 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1585 * restrictions on the parent profile.
1586 *
Robin Lee25e26452015-06-02 09:56:29 -07001587 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001588 * aggregate all admins.
1589 * @return The minimum number of lower case letters required in the
1590 * password.
1591 */
Robin Lee25e26452015-06-02 09:56:29 -07001592 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001593 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001594 }
1595
1596 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001597 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001598 if (mService != null) {
1599 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001600 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001601 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001602 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001603 }
1604 }
1605 return 0;
1606 }
1607
1608 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001609 * Called by an application that is administering the device to set the minimum number of
1610 * letters required in the password. After setting this, the user will not be able to enter a
1611 * new password that is not at least as restrictive as what has been set. Note that the current
1612 * password will remain until the user has set a new one, so the change does not take place
1613 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1614 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1615 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1616 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001617 * <p>
1618 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001619 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1620 * not, a security exception will be thrown.
1621 * <p>
1622 * This method can be called on the {@link DevicePolicyManager} instance returned by
1623 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1624 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001625 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001626 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1627 * @param length The new desired minimum number of letters required in the password. A value of
1628 * 0 means there is no restriction.
1629 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1630 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001631 */
Robin Lee25e26452015-06-02 09:56:29 -07001632 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001633 if (mService != null) {
1634 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001635 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001636 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001637 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001638 }
1639 }
1640 }
1641
1642 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001643 * Retrieve the current number of letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001644 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001645 * and its participating profiles. Restrictions on profiles that have
1646 * a separate challenge are not taken into account.
1647 * This is the same value as set by
1648 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001649 * and only applies when the password quality is
1650 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001651 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001652 * <p>This method can be called on the {@link DevicePolicyManager} instance
1653 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1654 * restrictions on the parent profile.
1655 *
Robin Lee25e26452015-06-02 09:56:29 -07001656 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001657 * aggregate all admins.
1658 * @return The minimum number of letters required in the password.
1659 */
Robin Lee25e26452015-06-02 09:56:29 -07001660 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001661 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001662 }
1663
1664 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001665 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001666 if (mService != null) {
1667 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001668 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001669 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001670 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001671 }
1672 }
1673 return 0;
1674 }
1675
1676 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001677 * Called by an application that is administering the device to set the minimum number of
1678 * numerical digits required in the password. After setting this, the user will not be able to
1679 * enter a new password that is not at least as restrictive as what has been set. Note that the
1680 * current password will remain until the user has set a new one, so the change does not take
1681 * place immediately. To prompt the user for a new password, use
1682 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1683 * setting this value. This constraint is only imposed if the administrator has also requested
1684 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001685 * <p>
1686 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001687 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1688 * not, a security exception will be thrown.
1689 * <p>
1690 * This method can be called on the {@link DevicePolicyManager} instance returned by
1691 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1692 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001693 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001694 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1695 * @param length The new desired minimum number of numerical digits required in the password. A
1696 * value of 0 means there is no restriction.
1697 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1698 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001699 */
Robin Lee25e26452015-06-02 09:56:29 -07001700 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001701 if (mService != null) {
1702 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001703 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001704 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001705 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001706 }
1707 }
1708 }
1709
1710 /**
1711 * Retrieve the current number of numerical digits required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001712 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001713 * and its participating profiles. Restrictions on profiles that have
1714 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001715 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001716 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001717 * and only applies when the password quality is
1718 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001719 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001720 * <p>This method can be called on the {@link DevicePolicyManager} instance
1721 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1722 * restrictions on the parent profile.
1723 *
Robin Lee25e26452015-06-02 09:56:29 -07001724 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001725 * aggregate all admins.
1726 * @return The minimum number of numerical digits required in the password.
1727 */
Robin Lee25e26452015-06-02 09:56:29 -07001728 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001729 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001730 }
1731
1732 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001733 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001734 if (mService != null) {
1735 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001736 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001737 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001738 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001739 }
1740 }
1741 return 0;
1742 }
1743
1744 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001745 * Called by an application that is administering the device to set the minimum number of
1746 * symbols required in the password. After setting this, the user will not be able to enter a
1747 * new password that is not at least as restrictive as what has been set. Note that the current
1748 * password will remain until the user has set a new one, so the change does not take place
1749 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1750 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1751 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1752 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001753 * <p>
1754 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001755 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1756 * not, a security exception will be thrown.
1757 * <p>
1758 * This method can be called on the {@link DevicePolicyManager} instance returned by
1759 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1760 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001761 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001762 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1763 * @param length The new desired minimum number of symbols required in the password. A value of
1764 * 0 means there is no restriction.
1765 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1766 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001767 */
Robin Lee25e26452015-06-02 09:56:29 -07001768 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001769 if (mService != null) {
1770 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001771 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001772 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001773 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001774 }
1775 }
1776 }
1777
1778 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001779 * Retrieve the current number of symbols required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001780 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001781 * and its participating profiles. Restrictions on profiles that have
1782 * a separate challenge are not taken into account. This is the same value as
1783 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001784 * and only applies when the password quality is
1785 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001786 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001787 * <p>This method can be called on the {@link DevicePolicyManager} instance
1788 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1789 * restrictions on the parent profile.
1790 *
Robin Lee25e26452015-06-02 09:56:29 -07001791 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001792 * aggregate all admins.
1793 * @return The minimum number of symbols required in the password.
1794 */
Robin Lee25e26452015-06-02 09:56:29 -07001795 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001796 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001797 }
1798
1799 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001800 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001801 if (mService != null) {
1802 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001803 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001804 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001805 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001806 }
1807 }
1808 return 0;
1809 }
1810
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001811 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001812 * Called by an application that is administering the device to set the minimum number of
1813 * non-letter characters (numerical digits or symbols) required in the password. After setting
1814 * this, the user will not be able to enter a new password that is not at least as restrictive
1815 * as what has been set. Note that the current password will remain until the user has set a new
1816 * one, so the change does not take place immediately. To prompt the user for a new password,
1817 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1818 * setting this value. This constraint is only imposed if the administrator has also requested
1819 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001820 * <p>
1821 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001822 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1823 * not, a security exception will be thrown.
1824 * <p>
1825 * This method can be called on the {@link DevicePolicyManager} instance returned by
1826 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1827 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001828 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001829 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1830 * @param length The new desired minimum number of letters required in the password. A value of
1831 * 0 means there is no restriction.
1832 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1833 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001834 */
Robin Lee25e26452015-06-02 09:56:29 -07001835 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001836 if (mService != null) {
1837 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001838 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001839 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001840 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001841 }
1842 }
1843 }
1844
1845 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001846 * Retrieve the current number of non-letter characters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001847 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001848 * and its participating profiles. Restrictions on profiles that have
1849 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001850 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001851 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001852 * and only applies when the password quality is
1853 * {@link #PASSWORD_QUALITY_COMPLEX}.
1854 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001855 * <p>This method can be called on the {@link DevicePolicyManager} instance
1856 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1857 * restrictions on the parent profile.
1858 *
Robin Lee25e26452015-06-02 09:56:29 -07001859 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001860 * aggregate all admins.
1861 * @return The minimum number of letters required in the password.
1862 */
Robin Lee25e26452015-06-02 09:56:29 -07001863 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001864 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001865 }
1866
1867 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001868 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001869 if (mService != null) {
1870 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001871 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001872 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001873 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001874 }
1875 }
1876 return 0;
1877 }
1878
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001879 /**
1880 * Called by an application that is administering the device to set the length of the password
1881 * history. After setting this, the user will not be able to enter a new password that is the
1882 * same as any password in the history. Note that the current password will remain until the
1883 * user has set a new one, so the change does not take place immediately. To prompt the user for
1884 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1885 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1886 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1887 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
1888 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
1889 * <p>
1890 * The calling device admin must have requested
1891 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1892 * not, a security exception will be thrown.
1893 * <p>
1894 * This method can be called on the {@link DevicePolicyManager} instance returned by
1895 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1896 * profile.
1897 *
1898 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1899 * @param length The new desired length of password history. A value of 0 means there is no
1900 * restriction.
1901 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1902 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1903 */
Robin Lee25e26452015-06-02 09:56:29 -07001904 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001905 if (mService != null) {
1906 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001907 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001908 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001909 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001910 }
1911 }
1912 }
1913
1914 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001915 * Called by a device admin to set the password expiration timeout. Calling this method will
1916 * restart the countdown for password expiration for the given admin, as will changing the
1917 * device password (for all admins).
1918 * <p>
1919 * The provided timeout is the time delta in ms and will be added to the current time. For
1920 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
1921 * 432000000 ms for timeout.
1922 * <p>
1923 * To disable password expiration, a value of 0 may be used for timeout.
1924 * <p>
1925 * The calling device admin must have requested
1926 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
1927 * not, a security exception will be thrown.
1928 * <p>
1929 * Note that setting the password will automatically reset the expiration time for all active
1930 * admins. Active admins do not need to explicitly call this method in that case.
1931 * <p>
1932 * This method can be called on the {@link DevicePolicyManager} instance returned by
1933 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1934 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001935 *
Jim Millera4e28d12010-11-08 16:15:47 -08001936 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001937 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
1938 * there is no restriction (unlimited).
1939 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1940 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08001941 */
Robin Lee25e26452015-06-02 09:56:29 -07001942 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001943 if (mService != null) {
1944 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001945 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001946 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001947 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001948 }
1949 }
1950 }
1951
1952 /**
Jim Miller6b857682011-02-16 16:27:41 -08001953 * Get the password expiration timeout for the given admin. The expiration timeout is the
1954 * recurring expiration timeout provided in the call to
1955 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001956 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1957 * have set restrictions on profiles that have a separate challenge are not taken into account.
1958 *
1959 * <p>This method can be called on the {@link DevicePolicyManager} instance
1960 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1961 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001962 *
Robin Lee25e26452015-06-02 09:56:29 -07001963 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001964 * @return The timeout for the given admin or the minimum of all timeouts
1965 */
Robin Lee25e26452015-06-02 09:56:29 -07001966 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001967 if (mService != null) {
1968 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001969 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001970 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001971 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001972 }
1973 }
1974 return 0;
1975 }
1976
1977 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001978 * Get the current password expiration time for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001979 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001980 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1981 * of all expiration times is returned - which will be the minimum of all of them.
1982 *
1983 * <p>This method can be called on the {@link DevicePolicyManager} instance
1984 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1985 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001986 *
Robin Lee25e26452015-06-02 09:56:29 -07001987 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001988 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001989 */
Robin Lee25e26452015-06-02 09:56:29 -07001990 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001991 if (mService != null) {
1992 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001993 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001994 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001995 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001996 }
1997 }
1998 return 0;
1999 }
2000
2001 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002002 * Retrieve the current password history length for a particular admin or all admins that
Rubin Xud3609d42016-07-13 18:32:57 +01002003 * set restrictions on this user and its participating profiles. Restrictions on profiles that
Esteban Talaverac1c83592016-02-17 17:56:15 +00002004 * have a separate challenge are not taken into account.
2005 *
2006 * <p>This method can be called on the {@link DevicePolicyManager} instance
2007 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2008 * restrictions on the parent profile.
2009 *
Robin Lee25e26452015-06-02 09:56:29 -07002010 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002011 * all admins.
2012 * @return The length of the password history
2013 */
Robin Lee25e26452015-06-02 09:56:29 -07002014 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002015 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002016 }
2017
2018 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002019 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002020 if (mService != null) {
2021 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002022 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002023 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002024 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002025 }
2026 }
2027 return 0;
2028 }
2029
Dianne Hackbornd6847842010-01-12 18:14:19 -08002030 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08002031 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002032 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08002033 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08002034 * @return Returns the maximum length that the user can enter.
2035 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002036 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002037 // Kind-of arbitrary.
2038 return 16;
2039 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002040
Dianne Hackborn254cb442010-01-27 19:23:59 -08002041 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002042 * Determine whether the current password the user has set is sufficient to meet the policy
2043 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
2044 * user and its participating profiles. Restrictions on profiles that have a separate challenge
2045 * are not taken into account.
2046 * <p>
2047 * The calling device admin must have requested
2048 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2049 * not, a security exception will be thrown.
2050 * <p>
2051 * This method can be called on the {@link DevicePolicyManager} instance returned by
2052 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
2053 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002054 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01002055 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002056 * @throws SecurityException if the calling application does not own an active administrator
2057 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002058 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002059 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002060 if (mService != null) {
2061 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002062 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002063 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002064 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002065 }
2066 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002067 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002068 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002069
Dianne Hackbornd6847842010-01-12 18:14:19 -08002070 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002071 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002072 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002073 * requested by the admins of the parent user and its profiles.
2074 *
2075 * @param userHandle the userId of the profile to check the password for.
2076 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002077 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002078 * @hide
2079 */
2080 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2081 if (mService != null) {
2082 try {
2083 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2084 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002085 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002086 }
2087 }
2088 return false;
2089 }
2090
2091 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002092 * Retrieve the number of times the user has failed at entering a password since that last
2093 * successful password entry.
2094 * <p>
2095 * This method can be called on the {@link DevicePolicyManager} instance returned by
2096 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2097 * password attemts for the parent user.
2098 * <p>
2099 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2100 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002101 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002102 * @return The number of times user has entered an incorrect password since the last correct
2103 * password entry.
2104 * @throws SecurityException if the calling application does not own an active administrator
2105 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002106 */
2107 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002108 return getCurrentFailedPasswordAttempts(myUserId());
2109 }
2110
2111 /**
2112 * Retrieve the number of times the given user has failed at entering a
2113 * password since that last successful password entry.
2114 *
2115 * <p>The calling device admin must have requested
2116 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2117 * not and it is not the system uid, a security exception will be thrown.
2118 *
2119 * @hide
2120 */
2121 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002122 if (mService != null) {
2123 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002124 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002125 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002126 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002127 }
2128 }
2129 return -1;
2130 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002131
2132 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002133 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002134 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002135 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002136 * @hide
2137 */
2138 public boolean getDoNotAskCredentialsOnBoot() {
2139 if (mService != null) {
2140 try {
2141 return mService.getDoNotAskCredentialsOnBoot();
2142 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002143 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002144 }
2145 }
2146 return false;
2147 }
2148
2149 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002150 * Setting this to a value greater than zero enables a built-in policy that will perform a
2151 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2152 * This built-in policy combines watching for failed passwords and wiping the device, and
2153 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002154 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002155 * <p>
2156 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2157 * revoking credentials, or reporting the failure to a server), you should implement
2158 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2159 * use this API, because if the maximum count is reached, the device or profile will be wiped
2160 * immediately, and your callback will not be invoked.
2161 * <p>
2162 * This method can be called on the {@link DevicePolicyManager} instance returned by
2163 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2164 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002165 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002166 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002167 * @param num The number of failed password attempts at which point the device or profile will
2168 * be wiped.
2169 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2170 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2171 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002172 */
Robin Lee25e26452015-06-02 09:56:29 -07002173 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002174 if (mService != null) {
2175 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002176 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002177 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002178 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002179 }
2180 }
2181 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002182
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002183 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002184 * Retrieve the current maximum number of login attempts that are allowed before the device
Rubin Xud3609d42016-07-13 18:32:57 +01002185 * or profile is wiped, for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002186 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2187 * not taken into account.
2188 *
2189 * <p>This method can be called on the {@link DevicePolicyManager} instance
2190 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2191 * the value for the parent profile.
2192 *
Robin Lee25e26452015-06-02 09:56:29 -07002193 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002194 * all admins.
2195 */
Robin Lee25e26452015-06-02 09:56:29 -07002196 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002197 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002198 }
2199
2200 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002201 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002202 if (mService != null) {
2203 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002204 return mService.getMaximumFailedPasswordsForWipe(
2205 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002206 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002207 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002208 }
2209 }
2210 return 0;
2211 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002212
Dianne Hackborn254cb442010-01-27 19:23:59 -08002213 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002214 * Returns the profile with the smallest maximum failed passwords for wipe,
2215 * for the given user. So for primary user, it might return the primary or
2216 * a managed profile. For a secondary user, it would be the same as the
2217 * user passed in.
2218 * @hide Used only by Keyguard
2219 */
2220 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2221 if (mService != null) {
2222 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002223 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2224 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002225 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002226 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002227 }
2228 }
2229 return UserHandle.USER_NULL;
2230 }
2231
2232 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002233 * Flag for {@link #resetPassword}: don't allow other admins to change
2234 * the password again until the user has entered it.
2235 */
2236 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002237
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002238 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002239 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2240 * If the flag is set, the device can be booted without asking for user password.
2241 * The absence of this flag does not change the current boot requirements. This flag
2242 * can be set by the device owner only. If the app is not the device owner, the flag
2243 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2244 * device to factory defaults.
2245 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002246 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002247
2248 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002249 * Force a new device unlock password (the password needed to access the entire device, not for
2250 * individual accounts) on the user. This takes effect immediately.
2251 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002252 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002253 * device admins that are not device owner and not profile owner.
2254 * The password can now only be changed if there is currently no password set. Device owner
Ricky Wai977ade22016-05-24 15:02:41 +01002255 * and profile owner can still do this when user is unlocked and does not have a managed
2256 * profile.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002257 * <p>
2258 * The given password must be sufficient for the current password quality and length constraints
2259 * as returned by {@link #getPasswordQuality(ComponentName)} and
2260 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2261 * it will be rejected and false returned. Note that the password may be a stronger quality
2262 * (containing alphanumeric characters when the requested quality is only numeric), in which
2263 * case the currently active quality will be increased to match.
2264 * <p>
2265 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002266 * current password constraints allow it. <em>Note: This will not work in
2267 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2268 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2269 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002270 * <p>
2271 * The calling device admin must have requested
2272 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2273 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002274 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002275 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002276 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002277 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2278 * @return Returns true if the password was applied, or false if it is not acceptable for the
2279 * current constraints or if the user has not been decrypted yet.
2280 * @throws SecurityException if the calling application does not own an active administrator
2281 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Ricky Wai977ade22016-05-24 15:02:41 +01002282 * @throws IllegalStateException if the calling user is locked or has a managed profile.
Andrew Scull3f81f4e2016-07-29 16:29:58 +01002283 * @throws IllegalArgumentException if the password does not meet system requirements.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002284 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002285 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002286 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002287 if (mService != null) {
2288 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002289 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002290 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002291 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002292 }
2293 }
2294 return false;
2295 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002296
Dianne Hackbornd6847842010-01-12 18:14:19 -08002297 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002298 * Called by an application that is administering the device to set the maximum time for user
2299 * activity until the device will lock. This limits the length that the user can set. It takes
2300 * effect immediately.
2301 * <p>
2302 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2303 * to be able to call this method; if it has not, a security exception will be thrown.
2304 * <p>
2305 * This method can be called on the {@link DevicePolicyManager} instance returned by
2306 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2307 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002308 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002309 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002310 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2311 * is no restriction.
2312 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2313 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002314 */
Robin Lee25e26452015-06-02 09:56:29 -07002315 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002316 if (mService != null) {
2317 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002318 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002319 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002320 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002321 }
2322 }
2323 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002324
Dianne Hackbornd6847842010-01-12 18:14:19 -08002325 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002326 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002327 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002328 * a separate challenge are not taken into account.
2329 *
2330 * <p>This method can be called on the {@link DevicePolicyManager} instance
2331 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2332 * restrictions on the parent profile.
2333 *
Robin Lee25e26452015-06-02 09:56:29 -07002334 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002335 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002336 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002337 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002338 */
Robin Lee25e26452015-06-02 09:56:29 -07002339 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002340 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002341 }
2342
2343 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002344 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002345 if (mService != null) {
2346 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002347 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002348 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002349 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002350 }
2351 }
2352 return 0;
2353 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002354
Dianne Hackbornd6847842010-01-12 18:14:19 -08002355 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002356 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2357 * do not have a separate timeout to lock for work challenge only.
2358 *
2359 * @hide
2360 */
2361 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2362 if (mService != null) {
2363 try {
2364 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2365 } catch (RemoteException e) {
2366 throw e.rethrowFromSystemServer();
2367 }
2368 }
2369 return 0;
2370 }
2371
2372 /**
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002373 * Called by a device/profile owner to set the timeout after which unlocking with secondary, non
2374 * strong auth (e.g. fingerprint, trust agents) times out, i.e. the user has to use a strong
2375 * authentication method like password, pin or pattern.
2376 *
2377 * <p>This timeout is used internally to reset the timer to require strong auth again after
2378 * specified timeout each time it has been successfully used.
2379 *
2380 * <p>Fingerprint can also be disabled altogether using {@link #KEYGUARD_DISABLE_FINGERPRINT}.
2381 *
2382 * <p>Trust agents can also be disabled altogether using {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
2383 *
2384 * <p>The calling device admin must be a device or profile owner. If it is not,
2385 * a {@link SecurityException} will be thrown.
2386 *
Michal Karpinski943aabd2016-10-06 11:09:25 +01002387 * <p>The calling device admin can verify the value it has set by calling
2388 * {@link #getRequiredStrongAuthTimeout(ComponentName)} and passing in its instance.
2389 *
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002390 * <p>This method can be called on the {@link DevicePolicyManager} instance returned by
2391 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2392 * profile.
2393 *
2394 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2395 * @param timeoutMs The new timeout, after which the user will have to unlock with strong
Michal Karpinski943aabd2016-10-06 11:09:25 +01002396 * authentication method. A value of 0 means the admin is not participating in
2397 * controlling the timeout.
2398 * The minimum and maximum timeouts are platform-defined and are typically 1 hour and
2399 * 72 hours, respectively. Though discouraged, the admin may choose to require strong
2400 * auth at all times using {@link #KEYGUARD_DISABLE_FINGERPRINT} and/or
2401 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002402 *
2403 * @throws SecurityException if {@code admin} is not a device or profile owner.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002404 *
2405 * @hide
2406 */
2407 public void setRequiredStrongAuthTimeout(@NonNull ComponentName admin,
2408 long timeoutMs) {
2409 if (mService != null) {
2410 try {
2411 mService.setRequiredStrongAuthTimeout(admin, timeoutMs, mParentInstance);
2412 } catch (RemoteException e) {
2413 throw e.rethrowFromSystemServer();
2414 }
2415 }
2416 }
2417
2418 /**
2419 * Determine for how long the user will be able to use secondary, non strong auth for
2420 * authentication, since last strong method authentication (password, pin or pattern) was used.
2421 * After the returned timeout the user is required to use strong authentication method.
2422 *
2423 * <p>This method can be called on the {@link DevicePolicyManager} instance
2424 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2425 * restrictions on the parent profile.
2426 *
2427 * @param admin The name of the admin component to check, or {@code null} to aggregate
2428 * accross all participating admins.
Michal Karpinski943aabd2016-10-06 11:09:25 +01002429 * @return The timeout or 0 if not configured for the provided admin.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002430 *
2431 * @hide
2432 */
2433 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin) {
2434 return getRequiredStrongAuthTimeout(admin, myUserId());
2435 }
2436
2437 /** @hide per-user version */
2438 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin, @UserIdInt int userId) {
2439 if (mService != null) {
2440 try {
2441 return mService.getRequiredStrongAuthTimeout(admin, userId, mParentInstance);
2442 } catch (RemoteException e) {
2443 throw e.rethrowFromSystemServer();
2444 }
2445 }
2446 return DEFAULT_STRONG_AUTH_TIMEOUT_MS;
2447 }
2448
2449 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002450 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2451 * this call.
2452 * <p>
2453 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2454 * to be able to call this method; if it has not, a security exception will be thrown.
2455 * <p>
2456 * This method can be called on the {@link DevicePolicyManager} instance returned by
2457 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002458 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002459 * @throws SecurityException if the calling application does not own an active administrator
2460 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002461 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002462 public void lockNow() {
2463 if (mService != null) {
2464 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002465 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002466 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002467 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002468 }
2469 }
2470 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002471
Dianne Hackbornd6847842010-01-12 18:14:19 -08002472 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002473 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002474 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002475 */
2476 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2477
2478 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002479 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2480 * data.
2481 *
Paul Crowley2934b262014-12-02 11:21:13 +00002482 * <p>This flag may only be set by device owner admins; if it is set by
2483 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002484 */
2485 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2486
2487 /**
Suprabh Shukla556b05a2016-08-10 15:49:24 -07002488 * Ask that all user data be wiped. If called as a secondary user, the user will be removed and
2489 * other users will remain unaffected. Calling from the primary user will cause the device to
2490 * reboot, erasing all device data - including all the secondary users and their data - while
2491 * booting up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002492 * <p>
2493 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2494 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002495 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002496 * @param flags Bit mask of additional options: currently supported flags are
2497 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2498 * @throws SecurityException if the calling application does not own an active administrator
2499 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002500 */
2501 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002502 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08002503 if (mService != null) {
2504 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002505 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002506 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002507 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002508 }
2509 }
2510 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002511
Dianne Hackbornd6847842010-01-12 18:14:19 -08002512 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002513 * Called by an application that is administering the device to set the
2514 * global proxy and exclusion list.
2515 * <p>
2516 * The calling device admin must have requested
2517 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2518 * this method; if it has not, a security exception will be thrown.
2519 * Only the first device admin can set the proxy. If a second admin attempts
2520 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002521 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002522 * be returned.
2523 * The method can be called repeatedly by the device admin alrady setting the
2524 * proxy to update the proxy and exclusion list.
2525 *
Robin Lee25e26452015-06-02 09:56:29 -07002526 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002527 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2528 * Pass Proxy.NO_PROXY to reset the proxy.
2529 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002530 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2531 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002532 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002533 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07002534 public @Nullable ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002535 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002536 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07002537 if (proxySpec == null) {
2538 throw new NullPointerException();
2539 }
2540 if (mService != null) {
2541 try {
2542 String hostSpec;
2543 String exclSpec;
2544 if (proxySpec.equals(Proxy.NO_PROXY)) {
2545 hostSpec = null;
2546 exclSpec = null;
2547 } else {
2548 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2549 throw new IllegalArgumentException();
2550 }
2551 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2552 String hostName = sa.getHostName();
2553 int port = sa.getPort();
2554 StringBuilder hostBuilder = new StringBuilder();
2555 hostSpec = hostBuilder.append(hostName)
2556 .append(":").append(Integer.toString(port)).toString();
2557 if (exclusionList == null) {
2558 exclSpec = "";
2559 } else {
2560 StringBuilder listBuilder = new StringBuilder();
2561 boolean firstDomain = true;
2562 for (String exclDomain : exclusionList) {
2563 if (!firstDomain) {
2564 listBuilder = listBuilder.append(",");
2565 } else {
2566 firstDomain = false;
2567 }
2568 listBuilder = listBuilder.append(exclDomain.trim());
2569 }
2570 exclSpec = listBuilder.toString();
2571 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002572 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2573 != android.net.Proxy.PROXY_VALID)
2574 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002575 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002576 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002577 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002578 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002579 }
2580 }
2581 return null;
2582 }
2583
2584 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002585 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2586 * HTTP proxies - they are generally network dependent. However if you're doing something
2587 * unusual like general internal filtering this may be useful. On a private network where the
2588 * proxy is not accessible, you may break HTTP using this.
2589 * <p>
2590 * This method requires the caller to be the device owner.
2591 * <p>
2592 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04002593 *
Jason Monk03bc9912014-05-13 09:44:57 -04002594 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002595 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2596 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2597 * {@code null} value will clear the global HTTP proxy.
2598 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04002599 */
Robin Lee25e26452015-06-02 09:56:29 -07002600 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2601 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002602 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04002603 if (mService != null) {
2604 try {
2605 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2606 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002607 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04002608 }
2609 }
2610 }
2611
2612 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002613 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002614 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2615 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002616 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002617 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07002618 public @Nullable ComponentName getGlobalProxyAdmin() {
Oscar Montemayor69238c62010-08-03 10:51:06 -07002619 if (mService != null) {
2620 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002621 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002622 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002623 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002624 }
2625 }
2626 return null;
2627 }
2628
2629 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002630 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002631 * indicating that encryption is not supported.
2632 */
2633 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2634
2635 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002636 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002637 * indicating that encryption is supported, but is not currently active.
2638 */
2639 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2640
2641 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002642 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002643 * indicating that encryption is not currently active, but is currently
2644 * being activated. This is only reported by devices that support
2645 * encryption of data and only when the storage is currently
2646 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2647 * to become encrypted will never return this value.
2648 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002649 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002650
2651 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002652 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002653 * indicating that encryption is active.
Amith Yamasani75db1252016-07-11 14:41:01 -07002654 * <p>
2655 * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002656 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002657 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002658
2659 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002660 * Result code for {@link #getStorageEncryptionStatus}:
2661 * indicating that encryption is active, but an encryption key has not
2662 * been set by the user.
2663 */
2664 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2665
2666 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08002667 * Result code for {@link #getStorageEncryptionStatus}:
Amith Yamasani75db1252016-07-11 14:41:01 -07002668 * indicating that encryption is active and the encryption key is tied to the user or profile.
2669 * <p>
2670 * This value is only returned to apps targeting API level 24 and above. For apps targeting
2671 * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
2672 * encryption key is specific to the user or profile.
Makoto Onukid4c9e542016-02-25 18:17:30 -08002673 */
2674 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2675
2676 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002677 * Activity action: begin the process of encrypting data on the device. This activity should
2678 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2679 * After resuming from this activity, use {@link #getStorageEncryption}
2680 * to check encryption status. However, on some devices this activity may never return, as
2681 * it may trigger a reboot and in some cases a complete data wipe of the device.
2682 */
2683 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2684 public static final String ACTION_START_ENCRYPTION
2685 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002686 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002687 * Widgets are enabled in keyguard
2688 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002689 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002690
2691 /**
Jim Miller50e62182014-04-23 17:25:00 -07002692 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002693 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002694 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2695
2696 /**
2697 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2698 */
2699 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2700
2701 /**
Jim Miller50e62182014-04-23 17:25:00 -07002702 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2703 */
2704 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2705
2706 /**
2707 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2708 */
2709 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2710
2711 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002712 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002713 * (e.g. PIN/Pattern/Password).
2714 */
2715 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2716
2717 /**
Jim Miller06e34502014-07-17 14:46:05 -07002718 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2719 */
2720 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2721
2722 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08002723 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
2724 */
2725 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
2726
2727 /**
Jim Miller35207742012-11-02 15:33:20 -07002728 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002729 */
2730 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002731
2732 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002733 * Called by an application that is administering the device to request that the storage system
2734 * be encrypted.
2735 * <p>
2736 * When multiple device administrators attempt to control device encryption, the most secure,
2737 * supported setting will always be used. If any device administrator requests device
2738 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2739 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002740 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002741 * <p>
2742 * This policy controls encryption of the secure (application data) storage area. Data written
2743 * to other storage areas may or may not be encrypted, and this policy does not require or
2744 * control the encryption of any other storage areas. There is one exception: If
2745 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2746 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2747 * written to disk within the encrypted storage area.
2748 * <p>
2749 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2750 * to create a device PIN or Password. In this case, the storage is encrypted, but the
2751 * encryption key may not be fully secured. For maximum security, the administrator should also
2752 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002753 *
2754 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2755 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002756 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002757 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2758 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2759 * {@link #getStorageEncryptionStatus()} to query the actual device state.
2760 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2761 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002762 */
Robin Lee25e26452015-06-02 09:56:29 -07002763 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002764 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002765 if (mService != null) {
2766 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002767 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002768 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002769 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002770 }
2771 }
2772 return ENCRYPTION_STATUS_UNSUPPORTED;
2773 }
2774
2775 /**
2776 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002777 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002778 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002779 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2780 * this will return the requested encryption setting as an aggregate of all active
2781 * administrators.
2782 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002783 */
Robin Lee25e26452015-06-02 09:56:29 -07002784 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002785 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002786 if (mService != null) {
2787 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002788 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002789 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002790 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002791 }
2792 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002793 return false;
2794 }
2795
2796 /**
2797 * Called by an application that is administering the device to
2798 * determine the current encryption status of the device.
Amith Yamasani75db1252016-07-11 14:41:01 -07002799 * <p>
Andy Stadler22dbfda2011-01-17 12:47:31 -08002800 * Depending on the returned status code, the caller may proceed in different
2801 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2802 * storage system does not support encryption. If the
2803 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2804 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002805 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2806 * storage system has enabled encryption but no password is set so further action
Amith Yamasani75db1252016-07-11 14:41:01 -07002807 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
2808 * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
2809 * no further action is required.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002810 *
Robin Lee7e678712014-07-24 16:41:31 +01002811 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002812 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002813 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
Amith Yamasani75db1252016-07-11 14:41:01 -07002814 * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002815 */
2816 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002817 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002818 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002819 }
2820
2821 /** @hide per-user version */
2822 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002823 if (mService != null) {
2824 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08002825 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002826 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002827 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08002828 }
2829 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002830 return ENCRYPTION_STATUS_UNSUPPORTED;
2831 }
2832
2833 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00002834 * Mark a CA certificate as approved by the device user. This means that they have been notified
2835 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2836 * keep the certificate on the device.
2837 *
2838 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2839 * this certificate.
2840 *
2841 * @hide
2842 */
2843 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2844 if (mService != null) {
2845 try {
2846 return mService.approveCaCert(alias, userHandle, approval);
2847 } catch (RemoteException e) {
2848 throw e.rethrowFromSystemServer();
2849 }
2850 }
2851 return false;
2852 }
2853
2854 /**
2855 * Check whether a CA certificate has been approved by the device user.
2856 *
2857 * @hide
2858 */
2859 public boolean isCaCertApproved(String alias, int userHandle) {
2860 if (mService != null) {
2861 try {
2862 return mService.isCaCertApproved(alias, userHandle);
2863 } catch (RemoteException e) {
2864 throw e.rethrowFromSystemServer();
2865 }
2866 }
2867 return false;
2868 }
2869
2870 /**
Robin Lee7e678712014-07-24 16:41:31 +01002871 * Installs the given certificate as a user CA.
2872 *
Robin Lee25e26452015-06-02 09:56:29 -07002873 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2874 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002875 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002876 *
2877 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002878 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002879 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2880 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002881 */
Robin Lee25e26452015-06-02 09:56:29 -07002882 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002883 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002884 if (mService != null) {
2885 try {
Robin Lee7e678712014-07-24 16:41:31 +01002886 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002887 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002888 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002889 }
2890 }
2891 return false;
2892 }
2893
2894 /**
Robin Lee7e678712014-07-24 16:41:31 +01002895 * Uninstalls the given certificate from trusted user CAs, if present.
2896 *
Robin Lee25e26452015-06-02 09:56:29 -07002897 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2898 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002899 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002900 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2901 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002902 */
Robin Lee25e26452015-06-02 09:56:29 -07002903 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002904 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002905 if (mService != null) {
2906 try {
Robin Lee306fe082014-06-19 14:04:24 +00002907 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002908 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002909 } catch (CertificateException e) {
2910 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002911 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002912 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002913 }
2914 }
2915 }
2916
2917 /**
Robin Lee7e678712014-07-24 16:41:31 +01002918 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2919 * If a user has installed any certificates by other means than device policy these will be
2920 * included too.
2921 *
Robin Lee25e26452015-06-02 09:56:29 -07002922 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2923 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002924 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002925 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2926 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002927 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07002928 public @NonNull List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
2929 final List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01002930 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002931 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002932 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002933 mService.enforceCanManageCaCerts(admin);
2934 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2935 for (String alias : certStore.userAliases()) {
2936 try {
2937 certs.add(certStore.getCertificate(alias).getEncoded());
2938 } catch (CertificateException ce) {
2939 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2940 }
2941 }
2942 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002943 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002944 }
2945 }
2946 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002947 }
2948
2949 /**
Robin Lee7e678712014-07-24 16:41:31 +01002950 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2951 * means other than device policy will also be removed, except for system CA certificates.
2952 *
Robin Lee25e26452015-06-02 09:56:29 -07002953 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2954 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002955 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2956 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01002957 */
Robin Lee25e26452015-06-02 09:56:29 -07002958 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002959 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01002960 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002961 try {
2962 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2963 .toArray(new String[0]));
2964 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002965 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002966 }
2967 }
2968 }
2969
2970 /**
2971 * Returns whether this certificate is installed as a trusted CA.
2972 *
Robin Lee25e26452015-06-02 09:56:29 -07002973 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2974 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002975 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002976 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2977 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002978 */
Robin Lee25e26452015-06-02 09:56:29 -07002979 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002980 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002981 if (mService != null) {
2982 try {
2983 mService.enforceCanManageCaCerts(admin);
2984 return getCaCertAlias(certBuffer) != null;
2985 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002986 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002987 } catch (CertificateException ce) {
2988 Log.w(TAG, "Could not parse certificate", ce);
2989 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002990 }
2991 return false;
2992 }
2993
2994 /**
Robin Leece3399f2016-02-24 12:08:32 +00002995 * Called by a device or profile owner, or delegated certificate installer, to install a
2996 * certificate and corresponding private key. All apps within the profile will be able to access
2997 * the certificate and use the private key, given direct user approval.
2998 *
2999 * <p>Access to the installed credentials will not be granted to the caller of this API without
3000 * direct user approval. This is for security - should a certificate installer become
3001 * compromised, certificates it had already installed will be protected.
3002 *
3003 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00003004 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003005 *
Robin Lee25e26452015-06-02 09:56:29 -07003006 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3007 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003008 * @param privKey The private key to install.
3009 * @param cert The certificate to install.
3010 * @param alias The private key alias under which to install the certificate. If a certificate
3011 * with that alias already exists, it will be overwritten.
3012 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003013 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3014 * owner.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003015 */
Robin Leefbc65642015-08-03 16:21:22 +01003016 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
3017 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00003018 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00003019 }
3020
3021 /**
3022 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00003023 * certificate chain and corresponding private key for the leaf certificate. All apps within the
3024 * profile will be able to access the certificate chain and use the private key, given direct
3025 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00003026 *
Robin Leea1b290e2016-03-09 14:38:36 +00003027 * <p>The caller of this API may grant itself access to the certificate and private key
3028 * immediately, without user approval. It is a best practice not to request this unless strictly
3029 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00003030 *
3031 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003032 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00003033 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00003034 * @param certs The certificate chain to install. The chain should start with the leaf
3035 * certificate and include the chain of trust in order. This will be returned by
3036 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00003037 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00003038 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00003039 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00003040 * credentials immediately. Otherwise, access to the credentials will be gated by user
3041 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00003042 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003043 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3044 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00003045 * @see android.security.KeyChain#getCertificateChain
Robin Leece3399f2016-02-24 12:08:32 +00003046 */
3047 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00003048 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003049 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003050 try {
Rubin Xub4365912016-03-23 12:13:22 +00003051 final byte[] pemCert = Credentials.convertToPem(certs[0]);
3052 byte[] pemChain = null;
3053 if (certs.length > 1) {
3054 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
3055 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01003056 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
3057 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Rubin Xub4365912016-03-23 12:13:22 +00003058 return mService.installKeyPair(admin, pkcs8Key, pemCert, pemChain, alias,
3059 requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003060 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003061 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01003062 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
3063 Log.w(TAG, "Failed to obtain private key material", e);
3064 } catch (CertificateException | IOException e) {
3065 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003066 }
3067 return false;
3068 }
3069
3070 /**
Robin Leea1b290e2016-03-09 14:38:36 +00003071 * Called by a device or profile owner, or delegated certificate installer, to remove a
3072 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01003073 *
3074 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003075 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01003076 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00003077 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003078 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3079 * owner.
Robin Leefbc65642015-08-03 16:21:22 +01003080 */
3081 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003082 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01003083 try {
3084 return mService.removeKeyPair(admin, alias);
3085 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003086 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01003087 }
Robin Leefbc65642015-08-03 16:21:22 +01003088 }
3089
3090 /**
Robin Lee25e26452015-06-02 09:56:29 -07003091 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00003092 * doesn't exist.
3093 */
3094 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
3095 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
3096 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
3097 new ByteArrayInputStream(certBuffer));
3098 return new TrustedCertificateStore().getCertificateAlias(cert);
3099 }
3100
3101 /**
Rubin Xuec32b562015-03-03 17:34:05 +00003102 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01003103 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00003104 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01003105 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00003106 * <p>
3107 * Delegated certificate installer is a per-user state. The delegated access is persistent until
3108 * it is later cleared by calling this method with a null value or uninstallling the certificate
3109 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003110 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00003111 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
3112 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003113 * supplied certificate installer package must be installed when calling this API, otherwise an
3114 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00003115 *
Robin Lee25e26452015-06-02 09:56:29 -07003116 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00003117 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003118 * access. If {@code null} is given the current package will be cleared.
3119 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00003120 */
Robin Lee25e26452015-06-02 09:56:29 -07003121 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
3122 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003123 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003124 if (mService != null) {
3125 try {
Robin Lee25e26452015-06-02 09:56:29 -07003126 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00003127 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003128 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003129 }
3130 }
3131 }
3132
3133 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003134 * Called by a profile owner or device owner to retrieve the certificate installer for the user.
3135 * null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00003136 *
Robin Lee25e26452015-06-02 09:56:29 -07003137 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003138 * @return The package name of the current delegated certificate installer, or {@code null} if
3139 * none is set.
3140 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00003141 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003142 public @Nullable String getCertInstallerPackage(@NonNull ComponentName admin)
3143 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003144 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003145 if (mService != null) {
3146 try {
Robin Lee25e26452015-06-02 09:56:29 -07003147 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00003148 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003149 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003150 }
3151 }
3152 return null;
3153 }
3154
3155 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003156 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003157 * specific application for the current user.
3158 *
3159 * @deprecated this version only exists for compability with previous developer preview builds.
3160 * TODO: delete once there are no longer any live references.
3161 * @hide
3162 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003163 @Deprecated
Robin Leedc679712016-05-03 13:23:03 +01003164 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3165 throws NameNotFoundException, UnsupportedOperationException {
3166 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3167 }
3168
3169 /**
3170 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003171 * specific application for the current user. This connection is automatically granted and
3172 * persisted after a reboot.
3173 * <p>
3174 * The designated package should declare a {@link android.net.VpnService} in its manifest
3175 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3176 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003177 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003178 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003179 * remove an existing always-on VPN configuration.
3180 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3181 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3182 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003183 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003184 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3185 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3186 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003187 */
Robin Leedc679712016-05-03 13:23:03 +01003188 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3189 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003190 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003191 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003192 if (mService != null) {
3193 try {
Robin Leedc679712016-05-03 13:23:03 +01003194 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003195 throw new NameNotFoundException(vpnPackage);
3196 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003197 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003198 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003199 }
3200 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003201 }
3202
3203 /**
3204 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003205 * always-on VPN connection for the current user. If there is no such package, or the always-on
3206 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003207 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003208 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3209 * is set.
3210 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003211 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003212 public @Nullable String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003213 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003214 if (mService != null) {
3215 try {
3216 return mService.getAlwaysOnVpnPackage(admin);
3217 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003218 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003219 }
3220 }
3221 return null;
3222 }
3223
3224 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003225 * Called by an application that is administering the device to disable all cameras on the
3226 * device, for this user. After setting this, no applications running as this user will be able
3227 * to access any cameras on the device.
3228 * <p>
3229 * If the caller is device owner, then the restriction will be applied to all users.
3230 * <p>
3231 * The calling device admin must have requested
3232 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3233 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003234 *
3235 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3236 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003237 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3238 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003239 */
Robin Lee25e26452015-06-02 09:56:29 -07003240 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003241 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07003242 if (mService != null) {
3243 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003244 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003245 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003246 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003247 }
3248 }
3249 }
3250
3251 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003252 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003253 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003254 * @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 -07003255 * have disabled the camera
3256 */
Robin Lee25e26452015-06-02 09:56:29 -07003257 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003258 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003259 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003260 }
3261
3262 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003263 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003264 if (mService != null) {
3265 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003266 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003267 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003268 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003269 }
3270 }
3271 return false;
3272 }
3273
3274 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003275 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003276 * <p>
3277 * There must be only one user on the device, managed by the device owner. Otherwise a
3278 * {@link SecurityException} will be thrown.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003279 *
3280 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003281 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3282 * wasn't triggered because a previous bugreport operation is still active (either the
3283 * bugreport is still running or waiting for the user to share or decline)
3284 * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3285 * than the one managed by the device owner.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003286 */
3287 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003288 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003289 if (mService != null) {
3290 try {
3291 return mService.requestBugreport(admin);
3292 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003293 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003294 }
3295 }
3296 return false;
3297 }
3298
3299 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07003300 * Determine whether or not creating a guest user has been disabled for the device
3301 *
3302 * @hide
3303 */
3304 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3305 // Currently guest users can always be created if multi-user is enabled
3306 // TODO introduce a policy for guest user creation
3307 return false;
3308 }
3309
3310 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01003311 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3312 * screen capture also prevents the content from being shown on display devices that do not have
3313 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3314 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003315 * <p>
3316 * The calling device admin must be a device or profile owner. If it is not, a security
3317 * exception will be thrown.
3318 * <p>
3319 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3320 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01003321 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003322 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003323 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003324 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003325 */
Robin Lee25e26452015-06-02 09:56:29 -07003326 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003327 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003328 if (mService != null) {
3329 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003330 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003331 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003332 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003333 }
3334 }
3335 }
3336
3337 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003338 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003339 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003340 * @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 +01003341 * have disabled screen capture.
3342 */
Robin Lee25e26452015-06-02 09:56:29 -07003343 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003344 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003345 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003346 }
3347
3348 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003349 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003350 if (mService != null) {
3351 try {
3352 return mService.getScreenCaptureDisabled(admin, userHandle);
3353 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003354 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003355 }
3356 }
3357 return false;
3358 }
3359
3360 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003361 * Called by a device owner to set whether auto time is required. If auto time is required the
3362 * user cannot set the date and time, but has to use network date and time.
3363 * <p>
3364 * Note: if auto time is required the user can still manually set the time zone.
3365 * <p>
3366 * The calling device admin must be a device owner. If it is not, a security exception will be
3367 * thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003368 *
3369 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3370 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003371 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003372 */
Robin Lee25e26452015-06-02 09:56:29 -07003373 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003374 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003375 if (mService != null) {
3376 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003377 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003378 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003379 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003380 }
3381 }
3382 }
3383
3384 /**
3385 * @return true if auto time is required.
3386 */
3387 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003388 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003389 if (mService != null) {
3390 try {
3391 return mService.getAutoTimeRequired();
3392 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003393 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003394 }
3395 }
3396 return false;
3397 }
3398
3399 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003400 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003401 * <p>
3402 * The system user is exempt from this policy - it is never ephemeral.
3403 * <p>
3404 * The calling device admin must be the device owner. If it is not, a security exception will be
3405 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003406 *
3407 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3408 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003409 * subsequently created users will be ephemeral.
3410 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003411 * @hide
3412 */
3413 public void setForceEphemeralUsers(
3414 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003415 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003416 if (mService != null) {
3417 try {
3418 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3419 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003420 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003421 }
3422 }
3423 }
3424
3425 /**
3426 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003427 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003428 * @hide
3429 */
3430 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003431 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003432 if (mService != null) {
3433 try {
3434 return mService.getForceEphemeralUsers(admin);
3435 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003436 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003437 }
3438 }
3439 return false;
3440 }
3441
3442 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003443 * Called by an application that is administering the device to disable keyguard customizations,
3444 * such as widgets. After setting this, keyguard features will be disabled according to the
3445 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003446 * <p>
3447 * The calling device admin must have requested
3448 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3449 * if it has not, a security exception will be thrown.
3450 * <p>
3451 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3452 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3453 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003454 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003455 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003456 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00003457 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003458 * there is one, or the parent user otherwise.
3459 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3460 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003461 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003462 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3463 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003464 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3465 * profile.
3466 * <p>
3467 * Requests to disable other features on a managed profile will be ignored.
3468 * <p>
3469 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003470 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003471 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003472 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003473 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003474 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3475 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3476 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3477 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3478 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3479 * @throws SecurityException if {@code admin} is not an active administrator or does not user
3480 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07003481 */
Robin Lee25e26452015-06-02 09:56:29 -07003482 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003483 if (mService != null) {
3484 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003485 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003486 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003487 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003488 }
3489 }
3490 }
3491
3492 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003493 * Determine whether or not features have been disabled in keyguard either by the calling
Rubin Xud3609d42016-07-13 18:32:57 +01003494 * admin, if specified, or all admins that set restrictions on this user and its participating
Esteban Talaverac1c83592016-02-17 17:56:15 +00003495 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3496 *
3497 * <p>This method can be called on the {@link DevicePolicyManager} instance
3498 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3499 * restrictions on the parent profile.
3500 *
Esteban Talavera62399912016-01-11 15:37:55 +00003501 * @param admin The name of the admin component to check, or {@code null} to check whether any
3502 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003503 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3504 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003505 */
Robin Lee25e26452015-06-02 09:56:29 -07003506 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003507 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003508 }
3509
3510 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003511 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003512 if (mService != null) {
3513 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003514 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003515 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003516 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003517 }
3518 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003519 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003520 }
3521
3522 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003523 * @hide
3524 */
Robin Lee25e26452015-06-02 09:56:29 -07003525 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3526 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003527 if (mService != null) {
3528 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003529 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003530 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003531 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003532 }
3533 }
3534 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003535
Dianne Hackbornd6847842010-01-12 18:14:19 -08003536 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003537 * @hide
3538 */
Robin Lee25e26452015-06-02 09:56:29 -07003539 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003540 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003541 }
3542
3543 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003544 * @hide
3545 */
Robin Lee25e26452015-06-02 09:56:29 -07003546 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003547 if (mService != null) {
3548 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003549 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003550 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003551 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003552 }
3553 }
3554 }
3555
3556 /**
3557 * @hide
3558 */
Andrew Scull5f9e6f32016-08-02 14:22:17 +01003559 public void setActivePasswordState(PasswordMetrics metrics, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003560 if (mService != null) {
3561 try {
Andrew Scull5f9e6f32016-08-02 14:22:17 +01003562 mService.setActivePasswordState(metrics, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003563 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003564 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003565 }
3566 }
3567 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003568
Dianne Hackbornd6847842010-01-12 18:14:19 -08003569 /**
3570 * @hide
3571 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003572 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003573 if (mService != null) {
3574 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003575 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003576 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003577 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003578 }
3579 }
3580 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003581
Dianne Hackbornd6847842010-01-12 18:14:19 -08003582 /**
3583 * @hide
3584 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003585 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003586 if (mService != null) {
3587 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003588 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003589 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003590 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003591 }
3592 }
3593 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003594
3595 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003596 * @hide
3597 */
3598 public void reportFailedFingerprintAttempt(int userHandle) {
3599 if (mService != null) {
3600 try {
3601 mService.reportFailedFingerprintAttempt(userHandle);
3602 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003603 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003604 }
3605 }
3606 }
3607
3608 /**
3609 * @hide
3610 */
3611 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3612 if (mService != null) {
3613 try {
3614 mService.reportSuccessfulFingerprintAttempt(userHandle);
3615 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003616 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003617 }
3618 }
3619 }
3620
3621 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003622 * Should be called when keyguard has been dismissed.
3623 * @hide
3624 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003625 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003626 if (mService != null) {
3627 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003628 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003629 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003630 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003631 }
3632 }
3633 }
3634
3635 /**
3636 * Should be called when keyguard view has been shown to the user.
3637 * @hide
3638 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003639 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003640 if (mService != null) {
3641 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003642 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003643 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003644 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003645 }
3646 }
3647 }
3648
3649 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003650 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003651 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003652 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3653 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003654 * @return whether the package was successfully registered as the device owner.
3655 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003656 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003657 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003658 public boolean setDeviceOwner(ComponentName who) {
3659 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003660 }
3661
3662 /**
3663 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003664 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003665 public boolean setDeviceOwner(ComponentName who, int userId) {
3666 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003667 }
3668
3669 /**
3670 * @hide
3671 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003672 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3673 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003674 }
3675
3676 /**
3677 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003678 * Sets the given package as the device owner. The package must already be installed. There
3679 * must not already be a device owner.
3680 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3681 * this method.
3682 * Calling this after the setup phase of the primary user has completed is allowed only if
3683 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003684 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003685 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003686 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003687 * @return whether the package was successfully registered as the device owner.
3688 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003689 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003690 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003691 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003692 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003693 if (mService != null) {
3694 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003695 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003696 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003697 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003698 }
3699 }
3700 return false;
3701 }
3702
3703 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003704 * Used to determine if a particular package has been registered as a Device Owner app.
3705 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003706 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003707 * package is currently registered as the device owner app, pass in the package name from
3708 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003709 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003710 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3711 * the setup process.
3712 * @param packageName the package name of the app, to compare with the registered device owner
3713 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003714 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003715 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003716 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003717 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003718 return isDeviceOwnerAppOnCallingUser(packageName);
3719 }
3720
3721 /**
3722 * @return true if a package is registered as device owner, only when it's running on the
3723 * calling user.
3724 *
3725 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3726 * @hide
3727 */
3728 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3729 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3730 }
3731
3732 /**
3733 * @return true if a package is registered as device owner, even if it's running on a different
3734 * user.
3735 *
3736 * <p>Requires the MANAGE_USERS permission.
3737 *
3738 * @hide
3739 */
3740 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3741 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3742 }
3743
3744 /**
3745 * @return device owner component name, only when it's running on the calling user.
3746 *
3747 * @hide
3748 */
3749 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3750 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3751 }
3752
3753 /**
3754 * @return device owner component name, even if it's running on a different user.
3755 *
3756 * <p>Requires the MANAGE_USERS permission.
3757 *
3758 * @hide
3759 */
3760 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3761 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3762 }
3763
3764 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003765 if (packageName == null) {
3766 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003767 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003768 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003769 if (deviceOwner == null) {
3770 return false;
3771 }
3772 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003773 }
3774
Makoto Onukic8a5a552015-11-19 14:29:12 -08003775 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3776 if (mService != null) {
3777 try {
3778 return mService.getDeviceOwnerComponent(callingUserOnly);
3779 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003780 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003781 }
3782 }
3783 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003784 }
3785
Jason Monkb0dced82014-06-06 14:36:20 -04003786 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003787 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3788 * no device owner.
3789 *
3790 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003791 *
3792 * @hide
3793 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003794 public int getDeviceOwnerUserId() {
3795 if (mService != null) {
3796 try {
3797 return mService.getDeviceOwnerUserId();
3798 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003799 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003800 }
3801 }
3802 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003803 }
3804
3805 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003806 * Clears the current device owner. The caller must be the device owner. This function should be
3807 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3808 * a part of device setup before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003809 *
3810 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003811 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3812 * does not own the current device owner component.
Jason Monkb0dced82014-06-06 14:36:20 -04003813 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003814 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003815 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04003816 if (mService != null) {
3817 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003818 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003819 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003820 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04003821 }
3822 }
3823 }
3824
Makoto Onukia52562c2015-10-01 16:12:31 -07003825 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003826 * Returns the device owner package name, only if it's running on the calling user.
3827 *
3828 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003829 *
3830 * @hide
3831 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003832 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07003833 public @Nullable String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003834 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003835 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3836 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003837 }
3838
3839 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003840 * @return true if the device is managed by any device owner.
3841 *
3842 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003843 *
3844 * @hide
3845 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003846 public boolean isDeviceManaged() {
3847 return getDeviceOwnerComponentOnAnyUser() != null;
3848 }
3849
3850 /**
3851 * Returns the device owner name. Note this method *will* return the device owner
3852 * name when it's running on a different user.
3853 *
3854 * <p>Requires the MANAGE_USERS permission.
3855 *
3856 * @hide
3857 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003858 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003859 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003860 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07003861 if (mService != null) {
3862 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003863 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003864 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003865 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003866 }
3867 }
3868 return null;
3869 }
Adam Connors776c5552014-01-09 10:42:56 +00003870
3871 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003872 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003873 * @deprecated Do not use
3874 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003875 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003876 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003877 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07003878 public @Nullable String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003879 return null;
3880 }
3881
3882 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003883 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003884 * @deprecated Do not use
3885 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003886 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003887 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003888 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07003889 public @Nullable ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003890 return null;
3891 }
3892
Julia Reynolds20118f12015-02-11 12:34:08 -05003893 /**
Adam Connors776c5552014-01-09 10:42:56 +00003894 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003895 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303896 * Sets the given component as an active admin and registers the package as the profile
3897 * owner for this user. The package must already be installed and there shouldn't be
3898 * an existing profile owner registered for this user. Also, this method must be called
3899 * before the user setup has been completed.
3900 * <p>
3901 * This method can only be called by system apps that hold MANAGE_USERS permission and
3902 * MANAGE_DEVICE_ADMINS permission.
3903 * @param admin The component to register as an active admin and profile owner.
3904 * @param ownerName The user-visible name of the entity that is managing this user.
3905 * @return whether the admin was successfully registered as the profile owner.
3906 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3907 * the user has already been set up.
3908 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003909 @Deprecated
Justin Morey80440cc2014-07-24 09:16:35 -05003910 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003911 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303912 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003913 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303914 if (mService != null) {
3915 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003916 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303917 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003918 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303919 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003920 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303921 }
3922 }
3923 return false;
3924 }
3925
3926 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003927 * Clears the active profile owner and removes all user restrictions. The caller must be from
3928 * the same package as the active profile owner for this user, otherwise a SecurityException
3929 * will be thrown.
3930 * <p>
3931 * This doesn't work for managed profile owners.
Makoto Onuki5bf68022016-01-27 13:49:19 -08003932 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003933 * @param admin The component to remove as the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003934 * @throws SecurityException if {@code admin} is not an active profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003935 */
Robin Lee25e26452015-06-02 09:56:29 -07003936 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003937 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003938 if (mService != null) {
3939 try {
3940 mService.clearProfileOwner(admin);
3941 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003942 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003943 }
3944 }
3945 }
3946
3947 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003948 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003949 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003950 */
3951 public boolean hasUserSetupCompleted() {
3952 if (mService != null) {
3953 try {
3954 return mService.hasUserSetupCompleted();
3955 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003956 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003957 }
3958 }
3959 return true;
3960 }
3961
3962 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003963 * @hide
3964 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003965 * already be installed. There must not already be a profile owner for this user.
3966 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3967 * this method.
3968 * Calling this after the setup phase of the specified user has completed is allowed only if:
3969 * - the caller is SYSTEM_UID.
3970 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003971 * @param admin the component name to be registered as profile owner.
3972 * @param ownerName the human readable name of the organisation associated with this DPM.
3973 * @param userHandle the userId to set the profile owner for.
3974 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003975 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3976 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003977 */
Robin Lee25e26452015-06-02 09:56:29 -07003978 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003979 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003980 if (mService != null) {
3981 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003982 if (ownerName == null) {
3983 ownerName = "";
3984 }
3985 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003986 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003987 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003988 }
3989 }
3990 return false;
3991 }
3992
3993 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003994 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003995 * <p>
3996 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003997 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003998 * <p>
3999 * If the device owner information contains only whitespaces then the message on the lock screen
4000 * will be blank and the user will not be allowed to change it.
4001 * <p>
4002 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00004003 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
4004 * and set a new version of this string accordingly.
4005 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004006 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004007 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004008 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004009 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004010 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004011 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004012 if (mService != null) {
4013 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004014 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004015 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004016 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004017 }
4018 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004019 }
4020
4021 /**
4022 * @return The device owner information. If it is not set returns {@code null}.
4023 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004024 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004025 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004026 if (mService != null) {
4027 try {
4028 return mService.getDeviceOwnerLockScreenInfo();
4029 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004030 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004031 }
4032 }
4033 return null;
4034 }
4035
4036 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004037 * Called by device or profile owners to suspend packages for this user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004038 * <p>
4039 * A suspended package will not be able to start activities. Its notifications will be hidden,
4040 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
4041 * device.
4042 * <p>
4043 * The package must already be installed. If the package is uninstalled while suspended the
4044 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00004045 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004046 *
4047 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004048 * @param packageNames The package names to suspend or unsuspend.
4049 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004050 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004051 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004052 * this method.
4053 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004054 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004055 public @NonNull String[] setPackagesSuspended(@NonNull ComponentName admin,
4056 @NonNull String[] packageNames, boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004057 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004058 if (mService != null) {
4059 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004060 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004061 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004062 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004063 }
4064 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004065 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004066 }
4067
4068 /**
4069 * Called by device or profile owners to determine if a package is suspended.
4070 *
4071 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4072 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00004073 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004074 * suspended, could not be found or an error occurred.
4075 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004076 * @throws NameNotFoundException if the package could not be found.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004077 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004078 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
4079 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004080 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004081 if (mService != null) {
4082 try {
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004083 return mService.isPackageSuspended(admin, packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004084 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004085 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004086 } catch (IllegalArgumentException ex) {
4087 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004088 }
4089 }
4090 return false;
4091 }
4092
4093 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004094 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
4095 * be used. Only the profile owner can call this.
4096 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01004097 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004098 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004099 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004100 */
Robin Lee25e26452015-06-02 09:56:29 -07004101 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004102 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004103 if (mService != null) {
4104 try {
4105 mService.setProfileEnabled(admin);
4106 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004107 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004108 }
4109 }
4110 }
4111
4112 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004113 * Sets the name of the profile. In the device owner case it sets the name of the user which it
4114 * is called from. Only a profile owner or device owner can call this. If this is never called
4115 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004116 *
4117 * @see #isProfileOwnerApp
4118 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07004119 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004120 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004121 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004122 */
Robin Lee25e26452015-06-02 09:56:29 -07004123 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004124 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01004125 if (mService != null) {
4126 try {
Robin Lee25e26452015-06-02 09:56:29 -07004127 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004128 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004129 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004130 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004131 }
4132 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004133
4134 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004135 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08004136 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004137 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00004138 *
4139 * @param packageName The package name of the app to compare with the registered profile owner.
4140 * @return Whether or not the package is registered as the profile owner.
4141 */
4142 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004143 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00004144 if (mService != null) {
4145 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08004146 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01004147 return profileOwner != null
4148 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004149 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004150 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004151 }
4152 }
4153 return false;
4154 }
4155
4156 /**
4157 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004158 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004159 * owner has been set for that user.
4160 * @throws IllegalArgumentException if the userId is invalid.
4161 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004162 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004163 public @Nullable ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004164 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004165 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4166 }
4167
4168 /**
4169 * @see #getProfileOwner()
4170 * @hide
4171 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004172 public @Nullable ComponentName getProfileOwnerAsUser(final int userId)
4173 throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004174 if (mService != null) {
4175 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004176 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00004177 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004178 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004179 }
4180 }
4181 return null;
4182 }
4183
4184 /**
4185 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004186 * @return the human readable name of the organisation associated with this DPM or {@code null}
4187 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00004188 * @throws IllegalArgumentException if the userId is invalid.
4189 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004190 public @Nullable String getProfileOwnerName() throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004191 if (mService != null) {
4192 try {
4193 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4194 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004195 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004196 }
4197 }
4198 return null;
4199 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004200
4201 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07004202 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08004203 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07004204 * @return the human readable name of the organisation associated with this profile owner or
4205 * null if one is not set.
4206 * @throws IllegalArgumentException if the userId is invalid.
4207 */
4208 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004209 public @Nullable String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004210 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07004211 if (mService != null) {
4212 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02004213 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07004214 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004215 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07004216 }
4217 }
4218 return null;
4219 }
4220
4221 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004222 * Called by a profile owner or device owner to add a default intent handler activity for
4223 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004224 * handler even if the set of potential event handlers for the intent filter changes and if the
4225 * intent preferences are reset.
4226 * <p>
4227 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
4228 * When the activity is (re)installed, it is automatically reset as default intent handler for
4229 * the filter.
4230 * <p>
4231 * The calling device admin must be a profile owner or device owner. If it is not, a security
4232 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004233 *
4234 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4235 * @param filter The IntentFilter for which a default handler is added.
4236 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004237 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004238 */
Robin Lee25e26452015-06-02 09:56:29 -07004239 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
4240 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004241 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004242 if (mService != null) {
4243 try {
4244 mService.addPersistentPreferredActivity(admin, filter, activity);
4245 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004246 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004247 }
4248 }
4249 }
4250
4251 /**
4252 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00004253 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004254 * <p>
4255 * The calling device admin must be a profile owner. If it is not, a security exception will be
4256 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004257 *
4258 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4259 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004260 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004261 */
Robin Lee25e26452015-06-02 09:56:29 -07004262 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004263 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004264 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004265 if (mService != null) {
4266 try {
4267 mService.clearPackagePersistentPreferredActivities(admin, packageName);
4268 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004269 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004270 }
4271 }
4272 }
Robin Lee66e5d962014-04-09 16:44:21 +01004273
4274 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004275 * Called by a profile owner or device owner to grant permission to a package to manage
4276 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4277 * {@link #getApplicationRestrictions}.
4278 * <p>
4279 * This permission is persistent until it is later cleared by calling this method with a
4280 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00004281 * <p>
4282 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00004283 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004284 *
4285 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4286 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004287 * APIs. If {@code null} is given the current package will be cleared.
4288 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00004289 * @throws NameNotFoundException if {@code packageName} is not found
Esteban Talaverabf60f722015-12-10 16:26:44 +00004290 */
4291 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00004292 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004293 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004294 if (mService != null) {
4295 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00004296 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4297 throw new NameNotFoundException(packageName);
4298 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00004299 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004300 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004301 }
4302 }
4303 }
4304
4305 /**
4306 * Called by a profile owner or device owner to retrieve the application restrictions managing
4307 * package for the current user, or {@code null} if none is set.
4308 *
4309 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4310 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004311 * {@code null} if none is set.
4312 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004313 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004314 public @Nullable String getApplicationRestrictionsManagingPackage(
4315 @NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004316 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004317 if (mService != null) {
4318 try {
4319 return mService.getApplicationRestrictionsManagingPackage(admin);
4320 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004321 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004322 }
4323 }
4324 return null;
4325 }
4326
4327 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00004328 * Called by any application to find out whether it has been granted permission via
4329 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4330 * for the calling user.
4331 *
4332 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4333 * that method.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004334 */
4335 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004336 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004337 if (mService != null) {
4338 try {
4339 return mService.isCallerApplicationRestrictionsManagingPackage();
4340 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004341 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004342 }
4343 }
4344 return false;
4345 }
4346
4347 /**
4348 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004349 * <p>
4350 * The caller must be a profile or device owner on that user, or the package allowed to manage
4351 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4352 * security exception will be thrown.
4353 * <p>
4354 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01004355 * <ul>
4356 * <li>{@code boolean}
4357 * <li>{@code int}
4358 * <li>{@code String} or {@code String[]}
4359 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4360 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004361 * <p>
4362 * If the restrictions are not available yet, but may be applied in the near future, the caller
4363 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004364 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004365 * <p>
4366 * The application restrictions are only made visible to the target application via
4367 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4368 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00004369 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01004370 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07004371 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
4372 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004373 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004374 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004375 * @param packageName The name of the package to update restricted settings for.
4376 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004377 * set of active restrictions.
4378 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004379 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004380 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01004381 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07004382 @WorkerThread
Esteban Talaverabf60f722015-12-10 16:26:44 +00004383 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01004384 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004385 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004386 if (mService != null) {
4387 try {
4388 mService.setApplicationRestrictions(admin, packageName, settings);
4389 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004390 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004391 }
4392 }
4393 }
4394
4395 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004396 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4397 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4398 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07004399 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004400 * <p>
4401 * The calling device admin must have requested
4402 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4403 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01004404 * <p>
4405 * This method can be called on the {@link DevicePolicyManager} instance returned by
4406 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
4407 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004408 *
4409 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004410 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004411 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4412 * strictly disabled according to the state of the
4413 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4414 * <p>
4415 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4416 * admins, then it's up to the TrustAgent itself to aggregate the values from all
4417 * device admins.
4418 * <p>
4419 * Consult documentation for the specific TrustAgent to determine legal options
4420 * parameters.
4421 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4422 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07004423 */
Robin Lee25e26452015-06-02 09:56:29 -07004424 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4425 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004426 if (mService != null) {
4427 try {
Tony Mak089d8402016-04-05 17:42:55 +01004428 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004429 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004430 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004431 }
4432 }
4433 }
4434
4435 /**
Jim Millere303bf42014-08-26 17:12:29 -07004436 * Gets configuration for the given trust agent based on aggregating all calls to
4437 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4438 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01004439 * <p>
4440 * This method can be called on the {@link DevicePolicyManager} instance returned by
4441 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
4442 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004443 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004444 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4445 * this function returns a list of configurations for all admins that declare
4446 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4447 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4448 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4449 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004450 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004451 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004452 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004453 public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
4454 @Nullable ComponentName admin, @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004455 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004456 }
4457
4458 /** @hide per-user version */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004459 public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
4460 @Nullable ComponentName admin, @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004461 if (mService != null) {
4462 try {
Tony Mak089d8402016-04-05 17:42:55 +01004463 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
4464 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004465 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004466 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004467 }
4468 }
Jim Millere303bf42014-08-26 17:12:29 -07004469 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004470 }
4471
4472 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004473 * Called by a profile owner of a managed profile to set whether caller-Id information from the
4474 * managed profile will be shown in the parent profile, for incoming calls.
4475 * <p>
4476 * The calling device admin must be a profile owner. If it is not, a security exception will be
4477 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004478 *
Robin Lee25e26452015-06-02 09:56:29 -07004479 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004480 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004481 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004482 */
Robin Lee25e26452015-06-02 09:56:29 -07004483 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004484 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004485 if (mService != null) {
4486 try {
Robin Lee25e26452015-06-02 09:56:29 -07004487 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004488 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004489 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004490 }
4491 }
4492 }
4493
4494 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004495 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4496 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004497 * <p>
4498 * The calling device admin must be a profile owner. If it is not, a security exception will be
4499 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004500 *
Robin Lee25e26452015-06-02 09:56:29 -07004501 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004502 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004503 */
Robin Lee25e26452015-06-02 09:56:29 -07004504 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004505 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004506 if (mService != null) {
4507 try {
Robin Lee25e26452015-06-02 09:56:29 -07004508 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004509 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004510 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004511 }
4512 }
4513 return false;
4514 }
4515
4516 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004517 * Determine whether or not caller-Id information has been disabled.
4518 *
4519 * @param userHandle The user for whom to check the caller-id permission
4520 * @hide
4521 */
4522 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4523 if (mService != null) {
4524 try {
4525 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4526 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004527 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07004528 }
4529 }
4530 return false;
4531 }
4532
4533 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004534 * Called by a profile owner of a managed profile to set whether contacts search from the
4535 * managed profile will be shown in the parent profile, for incoming calls.
4536 * <p>
4537 * The calling device admin must be a profile owner. If it is not, a security exception will be
4538 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004539 *
4540 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4541 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004542 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004543 */
4544 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4545 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004546 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004547 if (mService != null) {
4548 try {
4549 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4550 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004551 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004552 }
4553 }
4554 }
4555
4556 /**
4557 * Called by a profile owner of a managed profile to determine whether or not contacts search
4558 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004559 * <p>
4560 * The calling device admin must be a profile owner. If it is not, a security exception will be
4561 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004562 *
4563 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004564 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004565 */
4566 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004567 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004568 if (mService != null) {
4569 try {
4570 return mService.getCrossProfileContactsSearchDisabled(admin);
4571 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004572 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004573 }
4574 }
4575 return false;
4576 }
4577
4578
4579 /**
4580 * Determine whether or not contacts search has been disabled.
4581 *
4582 * @param userHandle The user for whom to check the contacts search permission
4583 * @hide
4584 */
4585 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4586 if (mService != null) {
4587 try {
4588 return mService
4589 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4590 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004591 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004592 }
4593 }
4594 return false;
4595 }
4596
4597 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004598 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004599 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004600 * @hide
4601 */
4602 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004603 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004604 if (mService != null) {
4605 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004606 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4607 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004608 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004609 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07004610 }
4611 }
4612 }
4613
4614 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004615 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004616 * @hide
4617 */
4618 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4619 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004620 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004621 originalIntent);
4622 }
4623
4624 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004625 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4626 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004627 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004628 * The calling device admin must be a profile owner. If it is not, a security exception will be
4629 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004630 * <p>
4631 * This API works on managed profile only.
4632 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004633 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4634 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4635 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004636 */
Robin Lee25e26452015-06-02 09:56:29 -07004637 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004638 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004639 if (mService != null) {
4640 try {
Robin Lee25e26452015-06-02 09:56:29 -07004641 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004642 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004643 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004644 }
4645 }
4646 }
4647
4648 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004649 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4650 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004651 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004652 * The calling device admin must be a profile owner. If it is not, a security exception will be
4653 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004654 * <p>
4655 * This API works on managed profile only.
4656 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004657 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4658 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004659 */
Robin Lee25e26452015-06-02 09:56:29 -07004660 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004661 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004662 if (mService != null) {
4663 try {
Robin Lee25e26452015-06-02 09:56:29 -07004664 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004665 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004666 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004667 }
4668 }
4669 return true;
4670 }
4671
4672 /**
4673 * Determine whether or not Bluetooth devices cannot access contacts.
4674 * <p>
4675 * This API works on managed profile UserHandle only.
4676 *
4677 * @param userHandle The user for whom to check the caller-id permission
4678 * @hide
4679 */
4680 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4681 if (mService != null) {
4682 try {
4683 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4684 .getIdentifier());
4685 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004686 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004687 }
4688 }
4689 return true;
4690 }
4691
4692 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004693 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004694 * profile can also be resolved in the parent, or vice versa. Only activity intents are
4695 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004696 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004697 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004698 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004699 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004700 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004701 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4702 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004703 */
Robin Lee25e26452015-06-02 09:56:29 -07004704 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004705 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004706 if (mService != null) {
4707 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004708 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004709 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004710 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004711 }
4712 }
4713 }
4714
4715 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004716 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4717 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004718 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004719 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004720 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004721 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004722 */
Robin Lee25e26452015-06-02 09:56:29 -07004723 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004724 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004725 if (mService != null) {
4726 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004727 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004728 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004729 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004730 }
4731 }
4732 }
4733
4734 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004735 * Called by a profile or device owner to set the permitted accessibility services. When set by
4736 * a device owner or profile owner the restriction applies to all profiles of the user the
4737 * device owner or profile owner is an admin for. By default the user can use any accessiblity
4738 * service. When zero or more packages have been added, accessiblity services that are not in
4739 * the list and not part of the system can not be enabled by the user.
4740 * <p>
4741 * Calling with a null value for the list disables the restriction so that all services can be
4742 * used, calling with an empty list only allows the builtin system's services.
4743 * <p>
4744 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004745 *
4746 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4747 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004748 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4749 * accessibility services enabled, that are not in the list.
4750 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004751 */
Robin Lee25e26452015-06-02 09:56:29 -07004752 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004753 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004754 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004755 if (mService != null) {
4756 try {
4757 return mService.setPermittedAccessibilityServices(admin, packageNames);
4758 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004759 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004760 }
4761 }
4762 return false;
4763 }
4764
4765 /**
4766 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004767 * <p>
4768 * An empty list means no accessibility services except system services are allowed. Null means
4769 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004770 *
4771 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4772 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004773 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004774 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004775 public @Nullable List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004776 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004777 if (mService != null) {
4778 try {
4779 return mService.getPermittedAccessibilityServices(admin);
4780 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004781 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004782 }
4783 }
4784 return null;
4785 }
4786
4787 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004788 * Called by the system to check if a specific accessibility service is disabled by admin.
4789 *
4790 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4791 * @param packageName Accessibility service package name that needs to be checked.
4792 * @param userHandle user id the admin is running as.
4793 * @return true if the accessibility service is permitted, otherwise false.
4794 *
4795 * @hide
4796 */
4797 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4798 @NonNull String packageName, int userHandle) {
4799 if (mService != null) {
4800 try {
4801 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4802 userHandle);
4803 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004804 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004805 }
4806 }
4807 return false;
4808 }
4809
4810 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004811 * Returns the list of accessibility services permitted by the device or profiles
4812 * owners of this user.
4813 *
4814 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4815 * it will contain the intersection of the permitted lists for any device or profile
4816 * owners that apply to this user. It will also include any system accessibility services.
4817 *
4818 * @param userId which user to check for.
4819 * @return List of accessiblity service package names.
4820 * @hide
4821 */
4822 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004823 public @Nullable List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004824 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004825 if (mService != null) {
4826 try {
4827 return mService.getPermittedAccessibilityServicesForUser(userId);
4828 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004829 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004830 }
4831 }
4832 return null;
4833 }
4834
4835 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004836 * Called by a profile or device owner to set the permitted input methods services. When set by
4837 * a device owner or profile owner the restriction applies to all profiles of the user the
4838 * device owner or profile owner is an admin for. By default the user can use any input method.
4839 * When zero or more packages have been added, input method that are not in the list and not
4840 * part of the system can not be enabled by the user. This method will fail if it is called for
4841 * a admin that is not for the foreground user or a profile of the foreground user.
4842 * <p>
4843 * Calling with a null value for the list disables the restriction so that all input methods can
4844 * be used, calling with an empty list disables all but the system's own input methods.
4845 * <p>
4846 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004847 *
4848 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4849 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004850 * @return true if setting the restriction succeeded. It will fail if there are one or more
4851 * non-system input methods currently enabled that are not in the packageNames list.
4852 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004853 */
Robin Lee25e26452015-06-02 09:56:29 -07004854 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004855 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004856 if (mService != null) {
4857 try {
4858 return mService.setPermittedInputMethods(admin, packageNames);
4859 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004860 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004861 }
4862 }
4863 return false;
4864 }
4865
4866
4867 /**
4868 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004869 * <p>
4870 * An empty list means no input methods except system input methods are allowed. Null means all
4871 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004872 *
4873 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4874 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004875 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004876 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004877 public @Nullable List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004878 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004879 if (mService != null) {
4880 try {
4881 return mService.getPermittedInputMethods(admin);
4882 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004883 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004884 }
4885 }
4886 return null;
4887 }
4888
4889 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004890 * Called by the system to check if a specific input method is disabled by admin.
4891 *
4892 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4893 * @param packageName Input method package name that needs to be checked.
4894 * @param userHandle user id the admin is running as.
4895 * @return true if the input method is permitted, otherwise false.
4896 *
4897 * @hide
4898 */
4899 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4900 @NonNull String packageName, int userHandle) {
4901 if (mService != null) {
4902 try {
4903 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4904 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004905 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004906 }
4907 }
4908 return false;
4909 }
4910
4911 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004912 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004913 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004914 *
4915 * <p>Null means all input methods are allowed, if a non-null list is returned
4916 * it will contain the intersection of the permitted lists for any device or profile
4917 * owners that apply to this user. It will also include any system input methods.
4918 *
4919 * @return List of input method package names.
4920 * @hide
4921 */
4922 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004923 public @Nullable List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004924 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004925 if (mService != null) {
4926 try {
4927 return mService.getPermittedInputMethodsForCurrentUser();
4928 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004929 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004930 }
4931 }
4932 return null;
4933 }
4934
4935 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004936 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4937 * currently installed it.
4938 *
4939 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4940 *
4941 * @return List of package names to keep cached.
4942 * @hide
4943 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004944 public @Nullable List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004945 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004946 if (mService != null) {
4947 try {
4948 return mService.getKeepUninstalledPackages(admin);
4949 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004950 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004951 }
4952 }
4953 return null;
4954 }
4955
4956 /**
4957 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4958 * currently installed it.
4959 *
4960 * <p>Please note that setting this policy does not imply that specified apps will be
4961 * automatically pre-cached.</p>
4962 *
4963 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4964 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004965 * @throws SecurityException if {@code admin} is not a device owner.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004966 * @hide
4967 */
4968 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4969 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004970 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004971 if (mService != null) {
4972 try {
4973 mService.setKeepUninstalledPackages(admin, packageNames);
4974 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004975 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004976 }
4977 }
4978 }
4979
4980 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004981 * Called by a device owner to create a user with the specified name. The UserHandle returned
4982 * by this method should not be persisted as user handles are recycled as users are removed and
4983 * created. If you need to persist an identifier for this user, use
4984 * {@link UserManager#getSerialNumberForUser}.
4985 *
4986 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4987 * @param name the user's name
4988 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004989 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4990 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004991 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004992 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004993 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004994 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004995 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07004996 public @Nullable UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004997 return null;
4998 }
4999
5000 /**
Jason Monk03978a42014-06-10 15:05:30 -04005001 * Called by a device owner to create a user with the specified name. The UserHandle returned
5002 * by this method should not be persisted as user handles are recycled as users are removed and
5003 * created. If you need to persist an identifier for this user, use
5004 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
5005 * immediately.
5006 *
5007 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
5008 * as registered as an active admin on the new user. The profile owner package will be
5009 * installed on the new user if it already is installed on the device.
5010 *
5011 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
5012 * profileOwnerComponent when onEnable is called.
5013 *
5014 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5015 * @param name the user's name
5016 * @param ownerName the human readable name of the organisation associated with this DPM.
5017 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
5018 * the user.
5019 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
5020 * on the new user.
5021 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07005022 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5023 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01005024 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005025 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01005026 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04005027 */
Kenny Guy14f48e52015-06-29 15:12:36 +01005028 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07005029 public @Nullable UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
Robin Lee25e26452015-06-02 09:56:29 -07005030 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04005031 return null;
5032 }
5033
5034 /**
phweissa92e1212016-01-25 17:14:10 +01005035 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01005036 */
5037 public static final int SKIP_SETUP_WIZARD = 0x0001;
5038
5039 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01005040 * Flag used by {@link #createAndManageUser} to specify that the user should be created
5041 * ephemeral.
5042 * @hide
5043 */
5044 public static final int MAKE_USER_EPHEMERAL = 0x0002;
5045
5046 /**
phweissa92e1212016-01-25 17:14:10 +01005047 * Called by a device owner to create a user with the specified name and a given component of
5048 * the calling package as profile owner. The UserHandle returned by this method should not be
5049 * persisted as user handles are recycled as users are removed and created. If you need to
5050 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
5051 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005052 * <p>
5053 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
5054 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
5055 * be registered as an active admin on the new user. The profile owner package will be installed
5056 * on the new user.
5057 * <p>
5058 * If the adminExtras are not null, they will be stored on the device until the user is started
5059 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01005060 *
5061 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5062 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01005063 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005064 * same package as admin, otherwise no user is created and an
5065 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01005066 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005067 * user.
phweissa92e1212016-01-25 17:14:10 +01005068 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01005069 * @see UserHandle
5070 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5071 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005072 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01005073 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005074 public @Nullable UserHandle createAndManageUser(@NonNull ComponentName admin,
5075 @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01005076 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
5077 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005078 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01005079 try {
phweissa92e1212016-01-25 17:14:10 +01005080 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01005081 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005082 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01005083 }
phweiss343fb332016-01-25 14:48:59 +01005084 }
5085
5086 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005087 * Called by a device owner to remove a user and all associated data. The primary user can not
5088 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04005089 *
5090 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5091 * @param userHandle the user to remove.
5092 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005093 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04005094 */
Robin Lee25e26452015-06-02 09:56:29 -07005095 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005096 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04005097 try {
5098 return mService.removeUser(admin, userHandle);
5099 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005100 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04005101 }
5102 }
5103
5104 /**
Jason Monk582d9112014-07-09 19:57:08 -04005105 * Called by a device owner to switch the specified user to the foreground.
5106 *
5107 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5108 * @param userHandle the user to switch to; null will switch to primary.
5109 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005110 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04005111 * @see Intent#ACTION_USER_FOREGROUND
5112 */
Robin Lee25e26452015-06-02 09:56:29 -07005113 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005114 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04005115 try {
5116 return mService.switchUser(admin, userHandle);
5117 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005118 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04005119 }
5120 }
5121
5122 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00005123 * Retrieves the application restrictions for a given target application running in the calling
5124 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005125 * <p>
5126 * The caller must be a profile or device owner on that user, or the package allowed to manage
5127 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
5128 * security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01005129 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005130 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
5131 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00005132 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005133 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01005134 * @param packageName The name of the package to fetch restricted settings of.
5135 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005136 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
5137 * {@link Bundle} if no restrictions have been set.
5138 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005139 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01005140 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005141 @WorkerThread
Makoto Onuki408e8e42016-10-25 12:10:27 -07005142 public @NonNull Bundle getApplicationRestrictions(
5143 @Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005144 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01005145 if (mService != null) {
5146 try {
5147 return mService.getApplicationRestrictions(admin, packageName);
5148 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005149 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01005150 }
5151 }
5152 return null;
5153 }
Amith Yamasanibe465322014-04-24 13:45:17 -07005154
5155 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005156 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005157 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005158 * The calling device admin must be a profile or device owner; if it is not, a security
5159 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005160 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005161 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5162 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5163 * for the list of keys.
5164 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005165 */
Robin Lee25e26452015-06-02 09:56:29 -07005166 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005167 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005168 if (mService != null) {
5169 try {
5170 mService.setUserRestriction(admin, key, true);
5171 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005172 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005173 }
5174 }
5175 }
5176
5177 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005178 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005179 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005180 * The calling device admin must be a profile or device owner; if it is not, a security
5181 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005182 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005183 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5184 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5185 * for the list of keys.
5186 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005187 */
Robin Lee25e26452015-06-02 09:56:29 -07005188 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005189 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005190 if (mService != null) {
5191 try {
5192 mService.setUserRestriction(admin, key, false);
5193 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005194 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005195 }
5196 }
5197 }
Adam Connors010cfd42014-04-16 12:48:13 +01005198
5199 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005200 * Called by a profile or device owner to get user restrictions set with
5201 * {@link #addUserRestriction(ComponentName, String)}.
5202 * <p>
5203 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005204 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005205 * {@link UserManager#getUserRestrictions()}.
5206 *
5207 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005208 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005209 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005210 public @NonNull Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005211 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005212 Bundle ret = null;
5213 if (mService != null) {
5214 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07005215 ret = mService.getUserRestrictions(admin);
5216 } catch (RemoteException e) {
5217 throw e.rethrowFromSystemServer();
5218 }
5219 }
5220 return ret == null ? new Bundle() : ret;
5221 }
5222
5223 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005224 * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
5225 * unavailable for use, but the data and actual package file remain.
Julia Reynolds966881e2014-05-14 12:23:08 -04005226 *
5227 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005228 * @param packageName The name of the package to hide or unhide.
5229 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005230 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005231 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005232 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005233 */
Robin Lee25e26452015-06-02 09:56:29 -07005234 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005235 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005236 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005237 if (mService != null) {
5238 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005239 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04005240 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005241 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005242 }
5243 }
5244 return false;
5245 }
5246
5247 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005248 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04005249 *
5250 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005251 * @param packageName The name of the package to retrieve the hidden status of.
5252 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005253 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005254 */
Robin Lee25e26452015-06-02 09:56:29 -07005255 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005256 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005257 if (mService != null) {
5258 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005259 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04005260 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005261 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005262 }
5263 }
5264 return false;
5265 }
5266
5267 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005268 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005269 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005270 *
5271 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08005272 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005273 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005274 */
Robin Lee25e26452015-06-02 09:56:29 -07005275 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005276 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005277 if (mService != null) {
5278 try {
5279 mService.enableSystemApp(admin, packageName);
5280 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005281 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005282 }
5283 }
5284 }
5285
5286 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005287 * Called by profile or device owners to re-enable system apps by intent that were disabled by
5288 * default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005289 *
5290 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5291 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005292 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00005293 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005294 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005295 */
Robin Lee25e26452015-06-02 09:56:29 -07005296 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005297 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005298 if (mService != null) {
5299 try {
5300 return mService.enableSystemAppWithIntent(admin, intent);
5301 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005302 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005303 }
5304 }
5305 return 0;
5306 }
5307
5308 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00005309 * Called by a device owner or profile owner to disable account management for a specific type
5310 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005311 * <p>
5312 * The calling device admin must be a device owner or profile owner. If it is not, a security
5313 * exception will be thrown.
5314 * <p>
5315 * When account management is disabled for an account type, adding or removing an account of
5316 * that type will not be possible.
5317 * <p>
5318 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00005319 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5320 * management for a specific type is disabled.
5321 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01005322 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5323 * @param accountType For which account management is disabled or enabled.
5324 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005325 * enabled (false).
5326 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01005327 */
Robin Lee25e26452015-06-02 09:56:29 -07005328 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01005329 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005330 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01005331 if (mService != null) {
5332 try {
5333 mService.setAccountManagementDisabled(admin, accountType, disabled);
5334 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005335 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01005336 }
5337 }
5338 }
5339
5340 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005341 * Gets the array of accounts for which account management is disabled by the profile owner.
5342 *
5343 * <p> Account management can be disabled/enabled by calling
5344 * {@link #setAccountManagementDisabled}.
5345 *
5346 * @return a list of account types for which account management has been disabled.
5347 *
5348 * @see #setAccountManagementDisabled
5349 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005350 public @Nullable String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005351 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005352 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005353 }
5354
5355 /**
5356 * @see #getAccountTypesWithManagementDisabled()
5357 * @hide
5358 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005359 public @Nullable String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005360 if (mService != null) {
5361 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005362 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005363 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005364 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005365 }
5366 }
5367
5368 return null;
5369 }
justinzhang511e0d82014-03-24 16:09:24 -04005370
5371 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005372 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005373 * <p>
5374 * Any packages that shares uid with an allowed package will also be allowed to activate lock
5375 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5376 * package list results in locked tasks belonging to those packages to be finished. This
5377 * function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005378 *
Jason Monkd7b86212014-06-16 13:15:38 -04005379 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04005380 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005381 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005382 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00005383 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5384 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04005385 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04005386 */
Robin Lee25e26452015-06-02 09:56:29 -07005387 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04005388 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005389 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005390 if (mService != null) {
5391 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005392 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04005393 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005394 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005395 }
5396 }
5397 }
5398
5399 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005400 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04005401 *
5402 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04005403 * @hide
5404 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005405 public @NonNull String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005406 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005407 if (mService != null) {
5408 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005409 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04005410 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005411 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005412 }
5413 }
5414 return null;
5415 }
5416
5417 /**
5418 * This function lets the caller know whether the given component is allowed to start the
5419 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04005420 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04005421 */
Jason Monkd7b86212014-06-16 13:15:38 -04005422 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005423 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04005424 if (mService != null) {
5425 try {
Jason Monkd7b86212014-06-16 13:15:38 -04005426 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04005427 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005428 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005429 }
5430 }
5431 return false;
5432 }
Julia Reynoldsda551652014-05-14 17:15:16 -04005433
5434 /**
5435 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5436 * 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 -07005437 * <p>
5438 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005439 * <ul>
5440 * <li>{@link Settings.Global#ADB_ENABLED}</li>
5441 * <li>{@link Settings.Global#AUTO_TIME}</li>
5442 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005443 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005444 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005445 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005446 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5447 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5448 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5449 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5450 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005451 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005452 * <p>
5453 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005454 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005455 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5456 * {@link android.bluetooth.BluetoothAdapter#enable()} and
5457 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005458 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005459 * <li>{@link Settings.Global#MODE_RINGER}. Use
5460 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005461 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005462 * <li>{@link Settings.Global#WIFI_ON}. Use
5463 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005464 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005465 *
5466 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5467 * @param setting The name of the setting to update.
5468 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005469 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005470 */
Robin Lee25e26452015-06-02 09:56:29 -07005471 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005472 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005473 if (mService != null) {
5474 try {
5475 mService.setGlobalSetting(admin, setting, value);
5476 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005477 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005478 }
5479 }
5480 }
5481
5482 /**
5483 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5484 * that the value of the setting is in the correct form for the setting type should be performed
5485 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005486 * <p>
5487 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005488 * <ul>
5489 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005490 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005491 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5492 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005493 * <p>
5494 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04005495 * <ul>
5496 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5497 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005498 *
Julia Reynoldsda551652014-05-14 17:15:16 -04005499 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5500 * @param setting The name of the setting to update.
5501 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005502 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005503 */
Robin Lee25e26452015-06-02 09:56:29 -07005504 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005505 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005506 if (mService != null) {
5507 try {
5508 mService.setSecureSetting(admin, setting, value);
5509 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005510 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005511 }
5512 }
5513 }
5514
Amith Yamasanif20d6402014-05-24 15:34:37 -07005515 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005516 * Designates a specific service component as the provider for making permission requests of a
5517 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005518 * <p/>
5519 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005520 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07005521 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005522 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005523 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5524 * provider previously assigned.
5525 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005526 */
Robin Lee25e26452015-06-02 09:56:29 -07005527 public void setRestrictionsProvider(@NonNull ComponentName admin,
5528 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005529 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07005530 if (mService != null) {
5531 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005532 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005533 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005534 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07005535 }
5536 }
5537 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005538
5539 /**
5540 * Called by profile or device owners to set the master volume mute on or off.
Nicolas Prevotaef3ce22016-09-22 12:00:25 +01005541 * This has no effect when set on a managed profile.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005542 *
5543 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5544 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005545 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005546 */
Robin Lee25e26452015-06-02 09:56:29 -07005547 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005548 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005549 if (mService != null) {
5550 try {
5551 mService.setMasterVolumeMuted(admin, on);
5552 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005553 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005554 }
5555 }
5556 }
5557
5558 /**
5559 * Called by profile or device owners to check whether the master volume mute is on or off.
5560 *
5561 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5562 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005563 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005564 */
Robin Lee25e26452015-06-02 09:56:29 -07005565 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005566 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005567 if (mService != null) {
5568 try {
5569 return mService.isMasterVolumeMuted(admin);
5570 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005571 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005572 }
5573 }
5574 return false;
5575 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005576
5577 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005578 * Called by profile or device owners to change whether a user can uninstall a package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005579 *
5580 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5581 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005582 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005583 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005584 */
Robin Lee25e26452015-06-02 09:56:29 -07005585 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005586 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005587 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005588 if (mService != null) {
5589 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005590 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005591 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005592 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005593 }
5594 }
5595 }
5596
5597 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005598 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005599 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005600 * <p>
5601 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005602 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5603 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5604 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005605 *
Robin Lee25e26452015-06-02 09:56:29 -07005606 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005607 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005608 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005609 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005610 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005611 */
Robin Lee25e26452015-06-02 09:56:29 -07005612 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005613 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005614 if (mService != null) {
5615 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005616 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005617 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005618 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005619 }
5620 }
5621 return false;
5622 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005623
5624 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005625 * Called by the profile owner of a managed profile to enable widget providers from a given
5626 * package to be available in the parent profile. As a result the user will be able to add
5627 * widgets from the white-listed package running under the profile to a widget host which runs
5628 * under the parent profile, for example the home screen. Note that a package may have zero or
5629 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07005630 * <p>
5631 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005632 *
5633 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5634 * @param packageName The package from which widget providers are white-listed.
5635 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005636 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005637 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5638 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5639 */
Robin Lee25e26452015-06-02 09:56:29 -07005640 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005641 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005642 if (mService != null) {
5643 try {
5644 return mService.addCrossProfileWidgetProvider(admin, packageName);
5645 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005646 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005647 }
5648 }
5649 return false;
5650 }
5651
5652 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005653 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005654 * package to be available in the parent profile. For this method to take effect the package
5655 * should have been added via
5656 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07005657 * <p>
5658 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005659 *
5660 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005661 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005662 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005663 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005664 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5665 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5666 */
Esteban Talavera62399912016-01-11 15:37:55 +00005667 public boolean removeCrossProfileWidgetProvider(
5668 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005669 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005670 if (mService != null) {
5671 try {
5672 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5673 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005674 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005675 }
5676 }
5677 return false;
5678 }
5679
5680 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005681 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005682 * available in the parent profile.
5683 *
5684 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5685 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07005686 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5687 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005688 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005689 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005690 public @NonNull List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005691 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07005692 if (mService != null) {
5693 try {
5694 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5695 if (providers != null) {
5696 return providers;
5697 }
5698 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005699 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005700 }
5701 }
5702 return Collections.emptyList();
5703 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005704
5705 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005706 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005707 *
5708 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5709 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005710 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005711 */
Robin Lee25e26452015-06-02 09:56:29 -07005712 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005713 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005714 try {
5715 mService.setUserIcon(admin, icon);
5716 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005717 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005718 }
5719 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005720
5721 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005722 * Called by device owners to set a local system update policy. When a new policy is set,
5723 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005724 *
Robin Lee25e26452015-06-02 09:56:29 -07005725 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005726 * components in the device owner package can set system update policies and the most
5727 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07005728 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005729 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005730 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005731 */
Robin Lee25e26452015-06-02 09:56:29 -07005732 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005733 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005734 if (mService != null) {
5735 try {
Robin Lee25e26452015-06-02 09:56:29 -07005736 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005737 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005738 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005739 }
5740 }
5741 }
5742
5743 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005744 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005745 *
Robin Lee25e26452015-06-02 09:56:29 -07005746 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005747 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005748 public @Nullable SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005749 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005750 if (mService != null) {
5751 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005752 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005753 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005754 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005755 }
5756 }
5757 return null;
5758 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005759
5760 /**
5761 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005762 * <p>
5763 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5764 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5765 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5766 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01005767 *
5768 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005769 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005770 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005771 * place. {@code true} otherwise.
5772 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01005773 */
Robin Lee25e26452015-06-02 09:56:29 -07005774 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005775 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01005776 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005777 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005778 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005779 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01005780 }
5781 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005782
5783 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005784 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005785 * notifications, quick settings and other screen overlays that allow escaping from a single use
5786 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005787 *
5788 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005789 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005790 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5791 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005792 */
Robin Lee25e26452015-06-02 09:56:29 -07005793 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005794 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00005795 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005796 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005797 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005798 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00005799 }
5800 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005801
5802 /**
5803 * Callable by the system update service to notify device owners about pending updates.
5804 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5805 * permission.
5806 *
5807 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5808 * when the current pending update was first available. -1 if no update is available.
5809 * @hide
5810 */
5811 @SystemApi
5812 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005813 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01005814 if (mService != null) {
5815 try {
5816 mService.notifyPendingSystemUpdate(updateReceivedTime);
5817 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005818 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01005819 }
5820 }
5821 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005822
5823 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005824 * Called by profile or device owners to set the default response for future runtime permission
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005825 * requests by applications. The policy can allow for normal operation which prompts the user to
5826 * grant a permission, or can allow automatic granting or denying of runtime permission requests
5827 * by an application. This also applies to new permissions declared by app updates. When a
5828 * permission is denied or granted this way, the effect is equivalent to setting the permission
5829 * grant state via {@link #setPermissionGrantState}.
5830 * <p/>
5831 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005832 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005833 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005834 * @param admin Which profile or device owner this request is associated with.
5835 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005836 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5837 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005838 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005839 */
Robin Lee25e26452015-06-02 09:56:29 -07005840 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005841 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005842 try {
5843 mService.setPermissionPolicy(admin, policy);
5844 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005845 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005846 }
5847 }
5848
5849 /**
5850 * Returns the current runtime permission policy set by the device or profile owner. The
5851 * default is {@link #PERMISSION_POLICY_PROMPT}.
5852 * @param admin Which profile or device owner this request is associated with.
5853 * @return the current policy for future permission requests.
5854 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005855 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005856 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005857 try {
5858 return mService.getPermissionPolicy(admin);
5859 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005860 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005861 }
5862 }
5863
5864 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005865 * Sets the grant state of a runtime permission for a specific application. The state can be
5866 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5867 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5868 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5869 * the permission is granted and the user cannot manage it through the UI. This might affect all
5870 * permissions in a group that the runtime permission belongs to. This method can only be called
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005871 * by a profile or device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005872 * <p/>
5873 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5874 * the permission. It retains the previous grant, if any.
5875 * <p/>
5876 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005877 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005878 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005879 * @param admin Which profile or device owner this request is associated with.
5880 * @param packageName The application to grant or revoke a permission to.
5881 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005882 * @param grantState The permission grant state which is one of
5883 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5884 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005885 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005886 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005887 * @see #PERMISSION_GRANT_STATE_DENIED
5888 * @see #PERMISSION_GRANT_STATE_DEFAULT
5889 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005890 */
Robin Lee25e26452015-06-02 09:56:29 -07005891 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005892 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005893 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005894 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005895 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005896 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005897 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005898 }
5899 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005900
5901 /**
5902 * Returns the current grant state of a runtime permission for a specific application.
5903 *
5904 * @param admin Which profile or device owner this request is associated with.
5905 * @param packageName The application to check the grant state for.
5906 * @param permission The permission to check for.
5907 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005908 * has not set a grant state, the return value is
5909 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5910 * permission is currently granted for the package.
5911 * <p/>
5912 * If a grant state was set by the profile or device owner, then the return value will
5913 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5914 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5915 * currently denied or granted.
5916 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07005917 * @see #setPermissionGrantState(ComponentName, String, String, int)
5918 * @see PackageManager#checkPermission(String, String)
5919 */
Robin Lee25e26452015-06-02 09:56:29 -07005920 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005921 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005922 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07005923 try {
5924 return mService.getPermissionGrantState(admin, packageName, permission);
5925 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005926 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07005927 }
5928 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005929
5930 /**
5931 * Returns if provisioning a managed profile or device is possible or not.
5932 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5933 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005934 * @return if provisioning a managed profile or device is possible or not.
5935 * @throws IllegalArgumentException if the supplied action is not valid.
5936 */
5937 public boolean isProvisioningAllowed(String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005938 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005939 try {
5940 return mService.isProvisioningAllowed(action);
5941 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005942 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005943 }
5944 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005945
5946 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005947 * Return if this user is a managed profile of another user. An admin can become the profile
5948 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01005949 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005950 * @param admin Which profile owner this request is associated with.
5951 * @return if this user is a managed profile of another user.
5952 */
5953 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005954 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005955 try {
5956 return mService.isManagedProfile(admin);
5957 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005958 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005959 }
5960 }
5961
5962 /**
5963 * @hide
5964 * Return if this user is a system-only user. An admin can manage a device from a system only
5965 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5966 * @param admin Which device owner this request is associated with.
5967 * @return if this user is a system-only user.
5968 */
5969 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5970 try {
5971 return mService.isSystemOnlyUser(admin);
5972 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005973 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005974 }
5975 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005976
5977 /**
5978 * Called by device owner to get the MAC address of the Wi-Fi device.
5979 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005980 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005981 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5982 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5983 * <p>
5984 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5985 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005986 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005987 public @Nullable String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005988 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005989 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005990 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005991 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005992 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005993 }
5994 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005995
5996 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005997 * Called by device owner to reboot the device. If there is an ongoing call on the device,
5998 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005999 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00006000 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006001 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00006002 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006003 */
6004 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006005 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006006 try {
6007 mService.reboot(admin);
6008 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006009 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006010 }
6011 }
Kenny Guy06de4e72015-12-22 12:07:39 +00006012
6013 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006014 * Called by a device admin to set the short support message. This will be displayed to the user
6015 * in settings screens where funtionality has been disabled by the admin. The message should be
6016 * limited to a short statement such as "This setting is disabled by your administrator. Contact
6017 * someone@example.com for support." If the message is longer than 200 characters it may be
6018 * truncated.
6019 * <p>
6020 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006021 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6022 * and set a new version of this string accordingly.
6023 *
Kenny Guy06de4e72015-12-22 12:07:39 +00006024 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00006025 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006026 * @param message Short message to be displayed to the user in settings or null to clear the
6027 * existing message.
6028 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00006029 */
6030 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006031 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006032 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00006033 if (mService != null) {
6034 try {
6035 mService.setShortSupportMessage(admin, message);
6036 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006037 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006038 }
6039 }
6040 }
6041
6042 /**
6043 * Called by a device admin to get the short support message.
6044 *
6045 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006046 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
6047 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006048 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00006049 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006050 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006051 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00006052 if (mService != null) {
6053 try {
6054 return mService.getShortSupportMessage(admin);
6055 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006056 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006057 }
6058 }
6059 return null;
6060 }
6061
6062 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006063 * Called by a device admin to set the long support message. This will be displayed to the user
6064 * in the device administators settings screen.
6065 * <p>
6066 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006067 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6068 * and set a new version of this string accordingly.
6069 *
Kenny Guy06de4e72015-12-22 12:07:39 +00006070 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00006071 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006072 * @param message Long message to be displayed to the user in settings or null to clear the
6073 * existing message.
6074 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00006075 */
6076 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006077 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006078 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00006079 if (mService != null) {
6080 try {
6081 mService.setLongSupportMessage(admin, message);
6082 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006083 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006084 }
6085 }
6086 }
6087
6088 /**
6089 * Called by a device admin to get the long support message.
6090 *
6091 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006092 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
6093 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006094 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00006095 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006096 public @Nullable CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006097 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00006098 if (mService != null) {
6099 try {
6100 return mService.getLongSupportMessage(admin);
6101 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006102 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006103 }
6104 }
6105 return null;
6106 }
6107
6108 /**
6109 * Called by the system to get the short support message.
6110 *
6111 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6112 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006113 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00006114 *
6115 * @hide
6116 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006117 public @Nullable CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006118 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00006119 if (mService != null) {
6120 try {
6121 return mService.getShortSupportMessageForUser(admin, userHandle);
6122 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006123 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006124 }
6125 }
6126 return null;
6127 }
6128
6129
6130 /**
6131 * Called by the system to get the long support message.
6132 *
6133 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6134 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006135 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00006136 *
6137 * @hide
6138 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006139 public @Nullable CharSequence getLongSupportMessageForUser(
6140 @NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00006141 if (mService != null) {
6142 try {
6143 return mService.getLongSupportMessageForUser(admin, userHandle);
6144 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006145 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006146 }
6147 }
6148 return null;
6149 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006150
6151 /**
Esteban Talavera62399912016-01-11 15:37:55 +00006152 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
6153 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01006154 *
6155 * <p>The following methods are supported for the parent instance, all other methods will
6156 * throw a SecurityException when called on the parent instance:
6157 * <ul>
6158 * <li>{@link #getPasswordQuality}</li>
6159 * <li>{@link #setPasswordQuality}</li>
6160 * <li>{@link #getPasswordMinimumLength}</li>
6161 * <li>{@link #setPasswordMinimumLength}</li>
6162 * <li>{@link #getPasswordMinimumUpperCase}</li>
6163 * <li>{@link #setPasswordMinimumUpperCase}</li>
6164 * <li>{@link #getPasswordMinimumLowerCase}</li>
6165 * <li>{@link #setPasswordMinimumLowerCase}</li>
6166 * <li>{@link #getPasswordMinimumLetters}</li>
6167 * <li>{@link #setPasswordMinimumLetters}</li>
6168 * <li>{@link #getPasswordMinimumNumeric}</li>
6169 * <li>{@link #setPasswordMinimumNumeric}</li>
6170 * <li>{@link #getPasswordMinimumSymbols}</li>
6171 * <li>{@link #setPasswordMinimumSymbols}</li>
6172 * <li>{@link #getPasswordMinimumNonLetter}</li>
6173 * <li>{@link #setPasswordMinimumNonLetter}</li>
6174 * <li>{@link #getPasswordHistoryLength}</li>
6175 * <li>{@link #setPasswordHistoryLength}</li>
6176 * <li>{@link #getPasswordExpirationTimeout}</li>
6177 * <li>{@link #setPasswordExpirationTimeout}</li>
6178 * <li>{@link #getPasswordExpiration}</li>
Charles He8c760562016-10-25 16:36:53 +01006179 * <li>{@link #getPasswordMaximumLength}</li>
Benjamin Franz66b45f02016-04-05 19:12:39 +01006180 * <li>{@link #isActivePasswordSufficient}</li>
6181 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
6182 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
6183 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
6184 * <li>{@link #getMaximumTimeToLock}</li>
6185 * <li>{@link #setMaximumTimeToLock}</li>
6186 * <li>{@link #lockNow}</li>
6187 * <li>{@link #getKeyguardDisabledFeatures}</li>
6188 * <li>{@link #setKeyguardDisabledFeatures}</li>
6189 * <li>{@link #getTrustAgentConfiguration}</li>
6190 * <li>{@link #setTrustAgentConfiguration}</li>
6191 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006192 *
6193 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006194 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006195 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006196 public @NonNull DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006197 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006198 try {
6199 if (!mService.isManagedProfile(admin)) {
6200 throw new SecurityException("The current user does not have a parent profile.");
6201 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06006202 return new DevicePolicyManager(mContext, mService, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006203 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006204 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006205 }
6206 }
6207
6208 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006209 * Called by device owner to control the security logging feature. Logging can only be
6210 * enabled on single user devices where the sole user is managed by the device owner.
6211 *
6212 * <p> Security logs contain various information intended for security auditing purposes.
6213 * See {@link SecurityEvent} for details.
6214 *
6215 * <p>There must be only one user on the device, managed by the device owner.
6216 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006217 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006218 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006219 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006220 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00006221 * @see #retrieveSecurityLogs
6222 */
6223 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006224 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00006225 try {
6226 mService.setSecurityLoggingEnabled(admin, enabled);
6227 } catch (RemoteException re) {
6228 throw re.rethrowFromSystemServer();
6229 }
6230 }
6231
6232 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006233 * Return whether security logging is enabled or not by the device owner.
6234 *
6235 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
6236 * thrown.
6237 *
6238 * @param admin Which device owner this request is associated with.
6239 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
6240 * @throws SecurityException if {@code admin} is not a device owner.
6241 */
6242 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006243 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006244 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006245 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006246 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006247 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006248 }
6249 }
6250
6251 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006252 * Called by device owner to retrieve all new security logging entries since the last call to
6253 * this API after device boots.
6254 *
6255 * <p> Access to the logs is rate limited and it will only return new logs after the device
6256 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
6257 *
6258 * <p>There must be only one user on the device, managed by the device owner.
6259 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006260 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006261 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006262 * @return the new batch of security logs which is a list of {@link SecurityEvent},
6263 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006264 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006265 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006266 public @Nullable List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006267 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006268 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006269 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006270 if (list != null) {
6271 return list.getList();
6272 } else {
6273 // Rate limit exceeded.
6274 return null;
6275 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006276 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006277 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006278 }
6279 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00006280
6281 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006282 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
6283 * profile.
6284 *
6285 * @hide
6286 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006287 public @NonNull DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006288 mContext.checkSelfPermission(
6289 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
6290 if (!uInfo.isManagedProfile()) {
6291 throw new SecurityException("The user " + uInfo.id
6292 + " does not have a parent profile.");
6293 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06006294 return new DevicePolicyManager(mContext, mService, true);
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006295 }
6296
6297 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006298 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006299 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006300 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
6301 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
6302 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
6303 * about data corruption when parsing. </strong>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006304 * <p>
6305 * There must be only one user on the device, managed by the device owner. Otherwise a
6306 * {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006307 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006308 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006309 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
6310 * is not supported on the device.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006311 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006312 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006313 public @Nullable List<SecurityEvent> retrievePreRebootSecurityLogs(
6314 @NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006315 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006316 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006317 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006318 if (list != null) {
6319 return list.getList();
6320 } else {
6321 return null;
6322 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006323 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006324 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006325 }
6326 }
6327
6328 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006329 * Called by a profile owner of a managed profile to set the color used for customization. This
6330 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01006331 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006332 * <p>
6333 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00006334 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
6335 *
6336 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006337 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006338 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006339 */
6340 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006341 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006342 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006343 // always enforce alpha channel to have 100% opacity
6344 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00006345 mService.setOrganizationColor(admin, color);
6346 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006347 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006348 }
6349 }
6350
6351 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006352 * @hide
6353 *
6354 * Sets the color used for customization.
6355 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01006356 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006357 * @param userId which user to set the color to.
6358 * @RequiresPermission(allOf = {
6359 * Manifest.permission.MANAGE_USERS,
6360 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
6361 */
6362 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
6363 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006364 // always enforce alpha channel to have 100% opacity
6365 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006366 mService.setOrganizationColorForUser(color, userId);
6367 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006368 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006369 }
6370 }
6371
6372 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00006373 * Called by a profile owner of a managed profile to retrieve the color used for customization.
6374 * This color is used as background color of the confirm credentials screen for that user.
6375 *
6376 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006377 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006378 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006379 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006380 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006381 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006382 try {
6383 return mService.getOrganizationColor(admin);
6384 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006385 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006386 }
6387 }
6388
6389 /**
6390 * @hide
6391 * Retrieve the customization color for a given user.
6392 *
6393 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006394 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006395 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006396 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00006397 try {
6398 return mService.getOrganizationColorForUser(userHandle);
6399 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006400 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006401 }
6402 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006403
6404 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006405 * Called by a profile owner of a managed profile to set the name of the organization under
6406 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006407 * <p>
6408 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006409 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6410 * and set a new version of this string accordingly.
6411 *
6412 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6413 * @param title The organization name or {@code null} to clear a previously set name.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006414 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006415 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006416 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006417 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006418 try {
6419 mService.setOrganizationName(admin, title);
6420 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006421 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006422 }
6423 }
6424
6425 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006426 * Called by a profile owner of a managed profile to retrieve the name of the organization under
6427 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006428 *
6429 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6430 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006431 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006432 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006433 public @Nullable CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006434 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006435 try {
6436 return mService.getOrganizationName(admin);
6437 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006438 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006439 }
6440 }
6441
6442 /**
6443 * Retrieve the default title message used in the confirm credentials screen for a given user.
6444 *
6445 * @param userHandle The user id of the user we're interested in.
6446 * @return The organization name or {@code null} if none is set.
6447 *
6448 * @hide
6449 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006450 public @Nullable CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006451 try {
6452 return mService.getOrganizationNameForUser(userHandle);
6453 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006454 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006455 }
6456 }
6457
6458 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00006459 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6460 * return {@link #STATE_USER_UNMANAGED}
6461 * @hide
6462 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00006463 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00006464 @UserProvisioningState
6465 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006466 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00006467 if (mService != null) {
6468 try {
6469 return mService.getUserProvisioningState();
6470 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006471 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006472 }
6473 }
6474 return STATE_USER_UNMANAGED;
6475 }
6476
6477 /**
6478 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6479 *
6480 * @param state to store
6481 * @param userHandle for user
6482 * @hide
6483 */
6484 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6485 if (mService != null) {
6486 try {
6487 mService.setUserProvisioningState(state, userHandle);
6488 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006489 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006490 }
6491 }
6492 }
6493
6494 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006495 * @hide
6496 * Indicates the entity that controls the device or profile owner. A user/profile is considered
6497 * affiliated if it is managed by the same entity as the device.
6498 *
6499 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6500 * user/profile is considered affiliated if the following conditions are both met:
6501 * <ul>
6502 * <li>The device owner and the user's/profile's profile owner have called this method,
6503 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6504 * and a profile owner intersect, they must have come from the same source, which means that
6505 * the device owner and profile owner are controlled by the same entity.</li>
6506 * <li>The device owner's and profile owner's package names are the same.</li>
6507 * </ul>
6508 *
6509 * @param admin Which profile or device owner this request is associated with.
6510 * @param ids A set of opaque affiliation ids.
6511 */
6512 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006513 throwIfParentInstance("setAffiliationIds");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006514 try {
6515 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6516 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006517 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006518 }
6519 }
6520
6521 /**
6522 * @hide
6523 * Returns whether this user/profile is affiliated with the device. See
6524 * {@link #setAffiliationIds} for the definition of affiliation.
6525 *
6526 * @return whether this user/profile is affiliated with the device.
6527 */
6528 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006529 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006530 try {
6531 return mService != null && mService.isAffiliatedUser();
6532 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006533 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006534 }
6535 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006536
6537 /**
6538 * @hide
6539 * Returns whether the uninstall for {@code packageName} for the current user is in queue
6540 * to be started
6541 * @param packageName the package to check for
6542 * @return whether the uninstall intent for {@code packageName} is pending
6543 */
6544 public boolean isUninstallInQueue(String packageName) {
6545 try {
6546 return mService.isUninstallInQueue(packageName);
6547 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006548 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006549 }
6550 }
6551
6552 /**
6553 * @hide
6554 * @param packageName the package containing active DAs to be uninstalled
6555 */
6556 public void uninstallPackageWithActiveAdmins(String packageName) {
6557 try {
6558 mService.uninstallPackageWithActiveAdmins(packageName);
6559 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006560 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006561 }
6562 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01006563
Kenny Guy38dcca52016-04-19 13:09:18 +01006564 /**
6565 * @hide
6566 * Remove a test admin synchronously without sending it a broadcast about being removed.
6567 * If the admin is a profile owner or device owner it will still be removed.
6568 *
6569 * @param userHandle user id to remove the admin for.
6570 * @param admin The administration compononent to remove.
6571 * @throws SecurityException if the caller is not shell / root or the admin package
6572 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
6573 */
6574 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
6575 try {
6576 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
6577 } catch (RemoteException re) {
6578 throw re.rethrowFromSystemServer();
6579 }
6580 }
6581
Mahaver Chopra790d1982016-07-07 16:06:49 +01006582 /**
6583 * @hide
6584 * @return whether {@link android.provider.Settings.Global#DEVICE_PROVISIONED} has ever been set
6585 * to 1.
6586 */
6587 public boolean isDeviceProvisioned() {
6588 try {
6589 return mService.isDeviceProvisioned();
6590 } catch (RemoteException re) {
6591 throw re.rethrowFromSystemServer();
6592 }
6593 }
6594
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01006595 /**
6596 * @hide
6597 * Writes that the provisioning configuration has been applied.
6598 */
6599 public void setDeviceProvisioningConfigApplied() {
6600 try {
6601 mService.setDeviceProvisioningConfigApplied();
6602 } catch (RemoteException re) {
6603 throw re.rethrowFromSystemServer();
6604 }
6605 }
6606
6607 /**
6608 * @hide
6609 * @return whether the provisioning configuration has been applied.
6610 */
6611 public boolean isDeviceProvisioningConfigApplied() {
6612 try {
6613 return mService.isDeviceProvisioningConfigApplied();
6614 } catch (RemoteException re) {
6615 throw re.rethrowFromSystemServer();
6616 }
6617 }
6618
Victor Chang9bfc65f2016-08-15 12:27:09 +01006619 /**
6620 * @hide
Victor Chang3577ed22016-08-25 18:49:26 +01006621 * Force update user setup completed status. This API has no effect on user build.
6622 * @throws {@link SecurityException} if the caller has no
6623 * {@link android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS} or the caller is
6624 * not {@link UserHandle.SYSTEM_USER}
Victor Chang9bfc65f2016-08-15 12:27:09 +01006625 */
6626 public void forceUpdateUserSetupComplete() {
6627 try {
6628 mService.forceUpdateUserSetupComplete();
6629 } catch (RemoteException re) {
6630 throw re.rethrowFromSystemServer();
6631 }
6632 }
6633
Benjamin Franzbc33c822016-04-15 08:57:52 +01006634 private void throwIfParentInstance(String functionName) {
6635 if (mParentInstance) {
6636 throw new SecurityException(functionName + " cannot be called on the parent instance");
6637 }
6638 }
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02006639
6640 /**
6641 * @hide
6642 * Enable backup service.
6643 * <p>This includes all backup and restore mechanisms.
6644 * Setting this to {@code false} will make backup service no-op or return empty results.
6645 *
6646 * <p>There must be only one user on the device, managed by the device owner.
6647 * Otherwise a {@link SecurityException} will be thrown.
6648 *
6649 * <p>Backup service is off by default when device owner is present.
6650 */
6651 public void setBackupServiceEnabled(@NonNull ComponentName admin, boolean enabled) {
6652 try {
6653 mService.setBackupServiceEnabled(admin, enabled);
6654 } catch (RemoteException re) {
6655 throw re.rethrowFromSystemServer();
6656 }
6657 }
6658
6659 /**
6660 * @hide
6661 * @return {@code true} if backup service is enabled, {@code false} otherwise.
6662 */
6663 public boolean isBackupServiceEnabled(@NonNull ComponentName admin) {
6664 try {
6665 return mService.isBackupServiceEnabled(admin);
6666 } catch (RemoteException re) {
6667 throw re.rethrowFromSystemServer();
6668 }
6669 }
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01006670
6671 /**
6672 * Called by a device owner to control the network logging feature. Logging can only be
6673 * enabled on single user devices where the sole user is managed by the device owner. If a new
6674 * user is added on the device, logging is disabled.
6675 *
6676 * <p> Network logs contain DNS lookup and connect() library call events.
6677 *
6678 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6679 * @param enabled whether network logging should be enabled or not.
6680 * @throws {@link SecurityException} if {@code admin} is not a device owner.
6681 * @throws {@link RemoteException} if network logging could not be enabled or disabled due to
6682 * the logging service not being available
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01006683 * @see #retrieveNetworkLogs
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01006684 *
6685 * @hide
6686 */
6687 public void setNetworkLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
6688 throwIfParentInstance("setNetworkLoggingEnabled");
6689 try {
6690 mService.setNetworkLoggingEnabled(admin, enabled);
6691 } catch (RemoteException re) {
6692 throw re.rethrowFromSystemServer();
6693 }
6694 }
6695
6696 /**
6697 * Return whether network logging is enabled by a device owner.
6698 *
6699 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6700 * @return {@code true} if network logging is enabled by device owner, {@code false} otherwise.
6701 * @throws {@link SecurityException} if {@code admin} is not a device owner.
6702 *
6703 * @hide
6704 */
6705 public boolean isNetworkLoggingEnabled(@NonNull ComponentName admin) {
6706 throwIfParentInstance("isNetworkLoggingEnabled");
6707 try {
6708 return mService.isNetworkLoggingEnabled(admin);
6709 } catch (RemoteException re) {
6710 throw re.rethrowFromSystemServer();
6711 }
6712 }
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01006713
6714 /**
6715 * Called by device owner to retrieve a new batch of network logging events.
6716 *
6717 * <p> {@link NetworkEvent} can be one of {@link DnsEvent} or {@link ConnectEvent}.
6718 *
6719 * <p> The list of network events is sorted chronologically, and contains at most 1200 events.
6720 *
6721 * <p> Access to the logs is rate limited and this method will only return a new batch of logs
6722 * after the device device owner has been notified via
6723 * {@link DeviceAdminReceiver#onNetworkLogsAvailable}.
6724 *
6725 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6726 * @return A new batch of network logs which is a list of {@link NetworkEvent}. Returns
6727 * {@code null} if there's no batch currently awaiting for retrieval or if logging is disabled.
6728 * @throws {@link SecurityException} if {@code admin} is not a device owner.
6729 *
6730 * @hide
6731 */
6732 public List<NetworkEvent> retrieveNetworkLogs(@NonNull ComponentName admin) {
6733 throwIfParentInstance("retrieveNetworkLogs");
6734 try {
6735 return mService.retrieveNetworkLogs(admin);
6736 } catch (RemoteException re) {
6737 throw re.rethrowFromSystemServer();
6738 }
6739 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006740}