blob: cfc451996fe0b5d1d231113ebf5939a298a45a77 [file] [log] [blame]
Dianne Hackbornd6847842010-01-12 18:14:19 -08001/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Dianne Hackborn87bba1e2010-02-26 17:25:54 -080017package android.app.admin;
Dianne Hackbornd6847842010-01-12 18:14:19 -080018
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000019import android.annotation.ColorInt;
Alan Treadwayafad8782016-01-19 15:15:08 +000020import android.annotation.IntDef;
Robin Lee25e26452015-06-02 09:56:29 -070021import android.annotation.NonNull;
22import android.annotation.Nullable;
Dianne Hackbornd6847842010-01-12 18:14:19 -080023import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
Justin Moreyb5deda72014-07-24 10:53:40 -050025import android.annotation.SystemApi;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000026import android.annotation.UserIdInt;
Fyodor Kupolov4e9af062016-07-18 16:59:11 -070027import android.annotation.WorkerThread;
Jason Monkd7b86212014-06-16 13:15:38 -040028import android.app.Activity;
Michal Karpinski6235a942016-03-15 12:07:23 +000029import android.app.admin.SecurityLog.SecurityEvent;
Dianne Hackbornd6847842010-01-12 18:14:19 -080030import android.content.ComponentName;
31import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010032import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000033import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080034import android.content.pm.PackageManager;
Victor Changcd14c0a2016-03-16 19:10:15 +000035import android.content.pm.PackageManager.NameNotFoundException;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000036import android.content.pm.ParceledListSlice;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000037import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050038import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040039import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000040import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010041import android.os.Bundle;
Jim Millere303bf42014-08-26 17:12:29 -070042import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000043import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080044import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080045import android.os.RemoteException;
46import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070047import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040048import android.os.UserManager;
Jeff Sharkey49ca5292016-05-10 12:54:45 -060049import android.os.ServiceManager.ServiceNotFoundException;
Ricky Wai494b95d2015-11-20 16:07:15 +000050import android.provider.ContactsContract.Directory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000051import android.provider.Settings;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010052import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070053import android.service.restrictions.RestrictionsReceiver;
Mahaver Chopra1216ae52016-03-11 15:39:48 +000054import android.telephony.TelephonyManager;
Dianne Hackbornd6847842010-01-12 18:14:19 -080055import android.util.Log;
56
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070057import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040058import com.android.org.conscrypt.TrustedCertificateStore;
59
60import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080061import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000062import java.lang.annotation.Retention;
63import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070064import java.net.InetSocketAddress;
65import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010066import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000067import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010068import java.security.PrivateKey;
69import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040070import java.security.cert.CertificateException;
71import java.security.cert.CertificateFactory;
72import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010073import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000074import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070075import java.util.ArrayList;
Rubin Xub4365912016-03-23 12:13:22 +000076import java.util.Arrays;
Svetoslav976e8bd2014-07-16 15:12:03 -070077import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080078import java.util.List;
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +010079import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080080
81/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000082 * Public interface for managing policies enforced on a device. Most clients of this class must be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070083 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
84 * administrator</a>. Additionally, a device administrator may be registered as either a profile or
85 * device owner. A given method is accessible to all device administrators unless the documentation
86 * for that method specifies that it is restricted to either device or profile owners. Any
87 * application calling an api may only pass as an argument a device administrator component it
88 * owns. Otherwise, a {@link SecurityException} will be thrown.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080089 * <div class="special reference">
90 * <h3>Developer Guides</h3>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070091 * <p>
92 * For more information about managing policies for device administration, read the <a href=
93 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
94 * guide. </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080095 */
96public class DevicePolicyManager {
97 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -080098
99 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -0800100 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +0000101 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700102
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600103 /** @hide */
104 public DevicePolicyManager(Context context, IDevicePolicyManager service) {
105 this(context, service, false);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800106 }
107
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800108 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700109 @VisibleForTesting
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600110 protected DevicePolicyManager(Context context, IDevicePolicyManager service,
111 boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700112 mContext = context;
113 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000114 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700115 }
116
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700117 /** @hide test will override it. */
118 @VisibleForTesting
119 protected int myUserId() {
120 return UserHandle.myUserId();
121 }
122
Dianne Hackbornd6847842010-01-12 18:14:19 -0800123 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000124 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000125 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100126 * <p>A managed profile allows data separation for example for the usage of a
127 * device as a personal and corporate device. The user which provisioning is started from and
128 * the managed profile share a launcher.
129 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800130 * <p>This intent will typically be sent by a mobile device management application (MDM).
131 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
132 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100133 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000134 * <p>It is possible to check if provisioning is allowed or not by querying the method
135 * {@link #isProvisioningAllowed(String)}.
136 *
137 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000138 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700139 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000140 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
141 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000142 *
Benjamin Franzea956242016-03-21 15:45:56 +0000143 * <p>The intent may also contain the following extras:
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000144 * <ul>
Benjamin Franzea956242016-03-21 15:45:56 +0000145 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
146 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
147 * {@link android.os.Build.VERSION_CODES#N}</li>
148 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
149 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
150 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000151 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000152 *
Benjamin Franzea956242016-03-21 15:45:56 +0000153 * <p>When managed provisioning has completed, broadcasts are sent to the application specified
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000154 * in the provisioning intent. The
155 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
156 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
157 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100158 *
Benjamin Franzea956242016-03-21 15:45:56 +0000159 * <p>If provisioning fails, the managedProfile is removed so the device returns to its
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100160 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100161 *
162 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
163 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
164 * the provisioning flow was successful, although this doesn't guarantee the full flow will
165 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
166 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000167 */
168 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
169 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100170 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000171
172 /**
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000173 * Activity action: Starts the provisioning flow which sets up a managed user.
174 *
175 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800176 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000177 * owner who has full control over the user. Provisioning can only happen before user setup has
178 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
179 * allowed.
180 *
Benjamin Franzea956242016-03-21 15:45:56 +0000181 * <p>The intent contains the following extras:
182 * <ul>
183 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
184 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
185 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
186 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
187 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
188 * </ul>
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000189 *
Benjamin Franzea956242016-03-21 15:45:56 +0000190 * <p>If provisioning fails, the device returns to its previous state.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000191 *
192 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
193 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
194 * the provisioning flow was successful, although this doesn't guarantee the full flow will
195 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
196 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Benjamin Franzea956242016-03-21 15:45:56 +0000197 *
198 * @hide
Mahaver Chopra5e732562015-11-05 11:55:12 +0000199 */
200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
201 public static final String ACTION_PROVISION_MANAGED_USER
202 = "android.app.action.PROVISION_MANAGED_USER";
203
204 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100205 * Activity action: Starts the provisioning flow which sets up a managed device.
206 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
207 *
208 * <p> During device owner provisioning a device admin app is set as the owner of the device.
209 * A device owner has full control over the device. The device owner can not be modified by the
210 * user.
211 *
212 * <p> A typical use case would be a device that is owned by a company, but used by either an
213 * employee or client.
214 *
215 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000216 * It is possible to check if provisioning is allowed or not by querying the method
217 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100218 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000219 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100220 * <ul>
221 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
222 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
223 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100224 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000225 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000226 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100227 * </ul>
228 *
Benjamin Franzea956242016-03-21 15:45:56 +0000229 * <p>When device owner provisioning has completed, an intent of the type
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100230 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
231 * device owner.
232 *
Benjamin Franzea956242016-03-21 15:45:56 +0000233 * <p>If provisioning fails, the device is factory reset.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100234 *
Alan Treadway4582f812015-07-28 11:49:35 +0100235 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
236 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
237 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
238 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100239 */
240 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
241 public static final String ACTION_PROVISION_MANAGED_DEVICE
242 = "android.app.action.PROVISION_MANAGED_DEVICE";
243
244 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000245 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000246 *
247 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
248 * the device. A device owner has full control over the device. The device owner can not be
249 * modified by the user and the only way of resetting the device is via factory reset.
250 *
251 * <p>A typical use case would be a device that is owned by a company, but used by either an
252 * employee or client.
253 *
254 * <p>The provisioning message should be sent to an unprovisioned device.
255 *
256 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
257 * by a privileged app with the permission
258 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
259 *
260 * <p>The provisioning intent contains the following properties:
261 * <ul>
262 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
263 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
264 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
265 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
266 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
267 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
268 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
269 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
270 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
271 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
272 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
273 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
274 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
275 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
276 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
277 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
278 *
279 * @hide
280 */
281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
282 @SystemApi
283 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
284 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
285
286 /**
287 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000288 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
289 *
290 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
291 * management state that is distinct from that reached by
292 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
293 * user, and only has control over device-wide policies, not individual users and their data.
294 * The primary benefit is that multiple non-system users are supported when provisioning using
295 * this form of device management.
296 *
Benjamin Franzea956242016-03-21 15:45:56 +0000297 * <p>During device owner provisioning a device admin app is set as the owner of the device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000298 * A device owner has full control over the device. The device owner can not be modified by the
299 * user.
300 *
Benjamin Franzea956242016-03-21 15:45:56 +0000301 * <p>A typical use case would be a device that is owned by a company, but used by either an
Alan Treadway46dd4492015-11-09 13:57:19 +0000302 * employee or client.
303 *
Benjamin Franzea956242016-03-21 15:45:56 +0000304 * <p>An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000305 * It is possible to check if provisioning is allowed or not by querying the method
306 * {@link #isProvisioningAllowed(String)}.
307 *
308 * <p>The intent contains the following extras:
309 * <ul>
310 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
311 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
312 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
313 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Benjamin Franzea956242016-03-21 15:45:56 +0000314 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
315 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Alan Treadway46dd4492015-11-09 13:57:19 +0000316 * </ul>
317 *
Benjamin Franzea956242016-03-21 15:45:56 +0000318 * <p>When device owner provisioning has completed, an intent of the type
Alan Treadway46dd4492015-11-09 13:57:19 +0000319 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
320 * device owner.
321 *
Benjamin Franzea956242016-03-21 15:45:56 +0000322 * <p>If provisioning fails, the device is factory reset.
Alan Treadway46dd4492015-11-09 13:57:19 +0000323 *
324 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
325 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
326 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
327 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
328 *
329 * @hide
330 */
331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
332 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
333 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
334
335 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000336 * Activity action: Finalizes management provisioning, should be used after user-setup
337 * has been completed and {@link #getUserProvisioningState()} returns one of:
338 * <ul>
339 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
340 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
341 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
342 * </ul>
343 *
344 * @hide
345 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000346 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000347 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
348 public static final String ACTION_PROVISION_FINALIZATION
349 = "android.app.action.PROVISION_FINALIZATION";
350
351 /**
Michal Karpinskiba244092016-02-25 17:28:24 +0000352 * Action: Bugreport sharing with device owner has been accepted by the user.
353 *
354 * @hide
355 */
356 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
357 "com.android.server.action.BUGREPORT_SHARING_ACCEPTED";
358
359 /**
360 * Action: Bugreport sharing with device owner has been declined by the user.
361 *
362 * @hide
363 */
364 public static final String ACTION_BUGREPORT_SHARING_DECLINED =
365 "com.android.server.action.BUGREPORT_SHARING_DECLINED";
366
367 /**
368 * Action: Bugreport has been collected and is dispatched to {@link DevicePolicyManagerService}.
369 *
370 * @hide
371 */
372 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
373 "android.intent.action.REMOTE_BUGREPORT_DISPATCH";
374
375 /**
376 * Extra for shared bugreport's SHA-256 hash.
377 *
378 * @hide
379 */
380 public static final String EXTRA_REMOTE_BUGREPORT_HASH =
381 "android.intent.extra.REMOTE_BUGREPORT_HASH";
382
383 /**
384 * Extra for remote bugreport notification shown type.
385 *
386 * @hide
387 */
388 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
389 "android.app.extra.bugreport_notification_type";
390
391 /**
392 * Notification type for a started remote bugreport flow.
393 *
394 * @hide
395 */
396 public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
397
398 /**
399 * Notification type for a bugreport that has already been accepted to be shared, but is still
400 * being taken.
401 *
402 * @hide
403 */
404 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
405
406 /**
407 * Notification type for a bugreport that has been taken and can be shared or declined.
408 *
409 * @hide
410 */
411 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
412
413 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100414 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100415 * allows a mobile device management application or NFC programmer application which starts
416 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100417 * <p>
418 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
419 * sends the intent to pass data to itself on the newly created profile.
420 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
421 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100422 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
423 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
424 * message should contain a stringified {@link java.util.Properties} instance, whose string
425 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
426 * management application after provisioning.
427 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100428 * <p>
429 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700430 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
431 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100432 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100433 */
434 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100435 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100436
437 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100438 * A String extra holding the package name of the mobile device management application that
439 * will be set as the profile owner or device owner.
440 *
441 * <p>If an application starts provisioning directly via an intent with action
442 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
443 * application that started provisioning. The package will be set as profile owner in that case.
444 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000445 * <p>This package is set as device owner when device owner provisioning is started by an NFC
446 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000447 *
448 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700449 * This receiver will be set as the profile or device owner and active admin.
Benjamin Franzea956242016-03-21 15:45:56 +0000450 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000451 * @see DeviceAdminReceiver
452 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100453 * supported, but only if there is only one device admin receiver in the package that requires
454 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000455 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000456 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000457 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100458 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000459
460 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000461 * A ComponentName extra indicating the device admin receiver of the mobile device management
462 * application that will be set as the profile owner or device owner and active admin.
463 *
464 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100465 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
466 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
467 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000468 *
469 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100470 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
471 * message containing an NFC record with MIME type
Benjamin Franzea956242016-03-21 15:45:56 +0000472 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000473 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000474 *
475 * @see DeviceAdminReceiver
476 */
477 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
478 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
479
480 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000481 * An {@link android.accounts.Account} extra holding the account to migrate during managed
482 * profile provisioning. If the account supplied is present in the primary user, it will be
483 * copied, along with its credentials to the managed profile and removed from the primary user.
484 *
485 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
486 */
487
488 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
489 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
490
491 /**
Jessica Hummele3da7902014-08-20 15:20:11 +0100492 * A String extra that, holds the email address of the account which a managed profile is
493 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
494 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100495 *
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100496 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
497 *
Jessica Hummele3da7902014-08-20 15:20:11 +0100498 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
499 * contains this extra, it is forwarded in the
500 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
501 * device management application that was set as the profile owner during provisioning.
502 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100503 */
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100504 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
505 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100506
507 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000508 * A integer extra indicating the predominant color to show during the provisioning.
509 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000510 *
511 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
512 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
513 */
514 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
515 "android.app.extra.PROVISIONING_MAIN_COLOR";
516
517 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000518 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700519 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000520 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100521 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
522 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000523 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000524 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
525 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000526
527 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100528 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
529 * will be set to.
530 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000531 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
532 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100533 */
534 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100535 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100536
537 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100538 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
539 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100540 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000541 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
542 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100543 */
544 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100545 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100546
547 /**
548 * A String extra holding the {@link java.util.Locale} that the device will be set to.
549 * Format: xx_yy, where xx is the language code, and yy the country code.
550 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000551 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
552 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100553 */
554 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100555 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100556
557 /**
558 * A String extra holding the ssid of the wifi network that should be used during nfc device
559 * owner provisioning for downloading the mobile device management application.
560 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000561 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
562 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100563 */
564 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100565 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100566
567 /**
568 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
569 * is hidden or not.
570 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000571 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
572 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100573 */
574 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100575 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100576
577 /**
578 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100579 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
580 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100581 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000582 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
583 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100584 */
585 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100586 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100587
588 /**
589 * A String extra holding the password of the wifi network in
590 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
591 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000592 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
593 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100594 */
595 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100596 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100597
598 /**
599 * A String extra holding the proxy host for the wifi network in
600 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
601 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000602 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
603 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100604 */
605 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100606 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100607
608 /**
609 * An int extra holding the proxy port for the wifi network in
610 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
611 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000612 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
613 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100614 */
615 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100616 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100617
618 /**
619 * A String extra holding the proxy bypass for the wifi network in
620 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
621 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000622 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
623 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100624 */
625 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100626 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100627
628 /**
629 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
630 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
631 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000632 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
633 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100634 */
635 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100636 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100637
638 /**
639 * A String extra holding a url that specifies the download location of the device admin
640 * package. When not provided it is assumed that the device admin package is already installed.
641 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000642 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
643 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100644 */
645 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100646 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100647
648 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400649 * An int extra holding a minimum required version code for the device admin package. If the
650 * device admin is already installed on the device, it will only be re-downloaded from
651 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
652 * installed package is less than this version code.
653 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400654 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400655 * provisioning via an NFC bump.
656 */
657 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
658 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
659
660 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100661 * A String extra holding a http cookie header which should be used in the http request to the
662 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
663 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000664 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
665 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100666 */
667 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100668 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100669
670 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100671 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
672 * the file at download location specified in
673 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100674 *
Benjamin Franzea956242016-03-21 15:45:56 +0000675 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
676 * present. The provided checksum must match the checksum of the file at the download
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100677 * location. If the checksum doesn't match an error will be shown to the user and the user will
678 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100679 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000680 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
681 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100682 *
683 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
684 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700685 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100686 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100687 */
688 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100689 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100690
691 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100692 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100693 * android package archive at the download location specified in {@link
694 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
695 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100696 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100697 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
698 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
699 *
Benjamin Franzea956242016-03-21 15:45:56 +0000700 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
701 * present. The provided checksum must match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100702 * the download location. If the checksum does not match an error will be shown to the user and
703 * the user will be asked to factory reset the device.
704 *
705 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
706 * provisioning via an NFC bump.
707 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100708 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
709 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100710
711 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000712 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
713 * has completed successfully.
714 *
715 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700716 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000717 *
Ying Wang7f38aab2015-02-20 11:50:09 -0800718 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000719 * corresponds to the account requested to be migrated at provisioning time, if any.
720 */
721 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
722 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
723 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
724
725 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000726 * A boolean extra indicating whether device encryption can be skipped as part of device owner
727 * or managed profile provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500728 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400729 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100730 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Benjamin Franzea956242016-03-21 15:45:56 +0000731 *
732 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
733 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500734 */
735 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
736 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
737
738 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000739 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
740 * provisioning. If this extra is not passed, a default image will be shown.
741 * <h5>The following URI schemes are accepted:</h5>
742 * <ul>
743 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
744 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
745 * </ul>
746 *
747 * <p> It is the responsability of the caller to provide an image with a reasonable
748 * pixed density for the device.
749 *
750 * <p> If a content: URI is passed, the intent should have the flag
751 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
752 * {@link android.content.ClipData} of the intent too.
753 *
754 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
755 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
756 */
757 public static final String EXTRA_PROVISIONING_LOGO_URI =
758 "android.app.extra.PROVISIONING_LOGO_URI";
759
760 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000761 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
762 * during setup-wizard.
763 *
764 * <p>If unspecified, defaults to {@code true} to match the behavior in
765 * {@link android.os.Build.VERSION_CODES#M} and earlier.
766 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000767 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
768 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000769 *
770 * @hide
771 */
772 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
773 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
774
775 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000776 * This MIME type is used for starting the device owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100777 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400778 * <p>During device owner provisioning a device admin app is set as the owner of the device.
779 * A device owner has full control over the device. The device owner can not be modified by the
780 * user and the only way of resetting the device is if the device owner app calls a factory
781 * reset.
782 *
783 * <p> A typical use case would be a device that is owned by a company, but used by either an
784 * employee or client.
785 *
Benjamin Franzea956242016-03-21 15:45:56 +0000786 * <p> The NFC message must be sent to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100787 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000788 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100789 * contains the following properties:
790 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400791 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
792 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100793 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400794 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100795 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
796 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
797 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
798 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
799 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
800 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
801 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
802 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
803 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
804 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100805 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
806 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
807 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100808 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000809 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700810 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400811 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
812 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
813 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400814 */
815 public static final String MIME_TYPE_PROVISIONING_NFC
816 = "application/com.android.managedprovisioning";
817
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100818 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800819 * Activity action: ask the user to add a new device administrator to the system.
820 * The desired policy is the ComponentName of the policy in the
821 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
822 * bring the user through adding the device administrator to the system (or
823 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700824 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800825 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
826 * field to provide the user with additional explanation (in addition
827 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800828 *
829 * <p>If your administrator is already active, this will ordinarily return immediately (without
830 * user intervention). However, if your administrator has been updated and is requesting
831 * additional uses-policy flags, the user will be presented with the new list. New policies
832 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800833 */
834 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
835 public static final String ACTION_ADD_DEVICE_ADMIN
836 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700837
Dianne Hackbornd6847842010-01-12 18:14:19 -0800838 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700839 * @hide
840 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -0700841 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700842 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700843 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
844 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700845 * to remotely control restrictions on the user.
846 *
Makoto Onukic8a5a552015-11-19 14:29:12 -0800847 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700848 * result of whether or not the user approved the action. If approved, the result will
849 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
850 * as a profile owner.
851 *
852 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
853 * field to provide the user with additional explanation (in addition
854 * to your component's description) about what is being added.
855 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700856 * <p>If there is already a profile owner active or the caller is not a system app, the
857 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700858 */
859 @SystemApi
860 public static final String ACTION_SET_PROFILE_OWNER
861 = "android.app.action.SET_PROFILE_OWNER";
862
863 /**
864 * @hide
865 * Name of the profile owner admin that controls the user.
866 */
867 @SystemApi
868 public static final String EXTRA_PROFILE_OWNER_NAME
869 = "android.app.extra.PROFILE_OWNER_NAME";
870
871 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100872 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -0700873 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700874 *
Jim Miller284b62e2010-06-08 14:27:42 -0700875 * @hide
876 */
877 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
878 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
879
880 /**
Tony Mak1970f972016-08-30 17:41:48 +0100881 * Broadcast action: sent when the device owner is set, changed or cleared.
Nicolas Prevot00799002015-07-27 18:15:20 +0100882 *
883 * This broadcast is sent only to the primary user.
884 * @see #ACTION_PROVISION_MANAGED_DEVICE
885 */
886 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
887 public static final String ACTION_DEVICE_OWNER_CHANGED
888 = "android.app.action.DEVICE_OWNER_CHANGED";
889
890 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800891 * The ComponentName of the administrator component.
892 *
893 * @see #ACTION_ADD_DEVICE_ADMIN
894 */
895 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700896
Dianne Hackbornd6847842010-01-12 18:14:19 -0800897 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800898 * An optional CharSequence providing additional explanation for why the
899 * admin is being added.
900 *
901 * @see #ACTION_ADD_DEVICE_ADMIN
902 */
903 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700904
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800905 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700906 * Activity action: have the user enter a new password. This activity should
907 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
908 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
909 * enter a new password that meets the current requirements. You can use
910 * {@link #isActivePasswordSufficient()} to determine whether you need to
911 * have the user select a new password in order to meet the current
912 * constraints. Upon being resumed from this activity, you can check the new
913 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +0000914 *
915 * If the intent is launched from within a managed profile with a profile
916 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
917 * this will trigger entering a new password for the parent of the profile.
918 * For all other cases it will trigger entering a new password for the user
919 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +0000920 *
921 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -0800922 */
923 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
924 public static final String ACTION_SET_NEW_PASSWORD
925 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700926
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000927 /**
Benjamin Franzc9921092016-01-08 17:17:44 +0000928 * Activity action: have the user enter a new password for the parent profile.
929 * If the intent is launched from within a managed profile, this will trigger
930 * entering a new password for the parent of the profile. In all other cases
931 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
932 */
933 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
934 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
935 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
936
937 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000938 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
939 * the parent profile to access intents sent from the managed profile.
940 * That is, when an app in the managed profile calls
941 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
942 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000943 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100944 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000945
946 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000947 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
948 * the managed profile to access intents sent from the parent profile.
949 * That is, when an app in the parent profile calls
950 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
951 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000952 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100953 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700954
Dianne Hackbornd6847842010-01-12 18:14:19 -0800955 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +0100956 * Broadcast action: notify that a new local system update policy has been set by the device
957 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +0000958 */
959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +0100960 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
961 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +0000962
Amith Yamasanid49489b2015-04-28 14:00:26 -0700963 /**
964 * Permission policy to prompt user for new permission requests for runtime permissions.
965 * Already granted or denied permissions are not affected by this.
966 */
967 public static final int PERMISSION_POLICY_PROMPT = 0;
968
969 /**
970 * Permission policy to always grant new permission requests for runtime permissions.
971 * Already granted or denied permissions are not affected by this.
972 */
973 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
974
975 /**
976 * Permission policy to always deny new permission requests for runtime permissions.
977 * Already granted or denied permissions are not affected by this.
978 */
979 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
980
Svet Ganovd8ecc5a2015-05-20 10:45:43 -0700981 /**
982 * Runtime permission state: The user can manage the permission
983 * through the UI.
984 */
985 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
986
987 /**
988 * Runtime permission state: The permission is granted to the app
989 * and the user cannot manage the permission through the UI.
990 */
991 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
992
993 /**
994 * Runtime permission state: The permission is denied to the app
995 * and the user cannot manage the permission through the UI.
996 */
997 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +0000998
999 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00001000 * No management for current user in-effect. This is the default.
1001 * @hide
1002 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001003 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001004 public static final int STATE_USER_UNMANAGED = 0;
1005
1006 /**
1007 * Management partially setup, user setup needs to be completed.
1008 * @hide
1009 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001010 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001011 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1012
1013 /**
1014 * Management partially setup, user setup completed.
1015 * @hide
1016 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001017 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001018 public static final int STATE_USER_SETUP_COMPLETE = 2;
1019
1020 /**
1021 * Management setup and active on current user.
1022 * @hide
1023 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001024 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001025 public static final int STATE_USER_SETUP_FINALIZED = 3;
1026
1027 /**
1028 * Management partially setup on a managed profile.
1029 * @hide
1030 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001031 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001032 public static final int STATE_USER_PROFILE_COMPLETE = 4;
1033
1034 /**
1035 * @hide
1036 */
1037 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
1038 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
1039 @Retention(RetentionPolicy.SOURCE)
1040 public @interface UserProvisioningState {}
1041
1042 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001043 * Return true if the given administrator component is currently active (enabled) in the system.
1044 *
1045 * @param admin The administrator component to check for.
1046 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1047 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001048 */
Robin Lee25e26452015-06-02 09:56:29 -07001049 public boolean isAdminActive(@NonNull ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001050 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001051 }
1052
1053 /**
1054 * @see #isAdminActive(ComponentName)
1055 * @hide
1056 */
Robin Lee25e26452015-06-02 09:56:29 -07001057 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001058 if (mService != null) {
1059 try {
Robin Lee25e26452015-06-02 09:56:29 -07001060 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001061 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001062 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001063 }
1064 }
1065 return false;
1066 }
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001067 /**
1068 * Return true if the given administrator component is currently being removed
1069 * for the user.
1070 * @hide
1071 */
Robin Lee25e26452015-06-02 09:56:29 -07001072 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001073 if (mService != null) {
1074 try {
Robin Lee25e26452015-06-02 09:56:29 -07001075 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001076 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001077 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001078 }
1079 }
1080 return false;
1081 }
1082
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001083
Dianne Hackbornd6847842010-01-12 18:14:19 -08001084 /**
Robin Lee25e26452015-06-02 09:56:29 -07001085 * Return a list of all currently active device administrators' component
1086 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001087 * returned.
1088 */
1089 public List<ComponentName> getActiveAdmins() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001090 throwIfParentInstance("getActiveAdmins");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001091 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001092 }
1093
1094 /**
1095 * @see #getActiveAdmins()
1096 * @hide
1097 */
1098 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001099 if (mService != null) {
1100 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001101 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001102 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001103 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001104 }
1105 }
1106 return null;
1107 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001108
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001109 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001110 * Used by package administration code to determine if a package can be stopped
1111 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001112 * @hide
1113 */
1114 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001115 return packageHasActiveAdmins(packageName, myUserId());
1116 }
1117
1118 /**
1119 * Used by package administration code to determine if a package can be stopped
1120 * or uninstalled.
1121 * @hide
1122 */
1123 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001124 if (mService != null) {
1125 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001126 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001127 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001128 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001129 }
1130 }
1131 return false;
1132 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001133
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001134 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001135 * Remove a current administration component. This can only be called
1136 * by the application that owns the administration component; if you
1137 * try to remove someone else's component, a security exception will be
1138 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001139 *
1140 * <p>Note that the operation is not synchronous and the admin might still be active (as
1141 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001142 *
1143 * @param admin The administration compononent to remove.
1144 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001145 */
Robin Lee25e26452015-06-02 09:56:29 -07001146 public void removeActiveAdmin(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001147 throwIfParentInstance("removeActiveAdmin");
Dianne Hackbornd6847842010-01-12 18:14:19 -08001148 if (mService != null) {
1149 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001150 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001151 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001152 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001153 }
1154 }
1155 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001156
Dianne Hackbornd6847842010-01-12 18:14:19 -08001157 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001158 * Returns true if an administrator has been granted a particular device policy. This can be
1159 * used to check whether the administrator was activated under an earlier set of policies, but
1160 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001161 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001162 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1163 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001164 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001165 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001166 */
Robin Lee25e26452015-06-02 09:56:29 -07001167 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001168 throwIfParentInstance("hasGrantedPolicy");
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001169 if (mService != null) {
1170 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001171 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001172 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001173 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001174 }
1175 }
1176 return false;
1177 }
1178
1179 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001180 * Returns true if the Profile Challenge is available to use for the given profile user.
1181 *
1182 * @hide
1183 */
1184 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1185 if (mService != null) {
1186 try {
1187 return mService.isSeparateProfileChallengeAllowed(userHandle);
1188 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001189 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001190 }
1191 }
1192 return false;
1193 }
1194
1195 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001196 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1197 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001198 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001199 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001200 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001201
Dianne Hackbornd6847842010-01-12 18:14:19 -08001202 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001203 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1204 * recognition technology. This implies technologies that can recognize the identity of
1205 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1206 * Note that quality constants are ordered so that higher values are more restrictive.
1207 */
1208 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1209
1210 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001211 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001212 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001213 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001214 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001215 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001216
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001217 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001218 * Constant for {@link #setPasswordQuality}: the user must have entered a
1219 * password containing at least numeric characters. Note that quality
1220 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001221 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001222 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001223
Dianne Hackbornd6847842010-01-12 18:14:19 -08001224 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001225 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001226 * password containing at least numeric characters with no repeating (4444)
1227 * or ordered (1234, 4321, 2468) sequences. Note that quality
1228 * constants are ordered so that higher values are more restrictive.
1229 */
1230 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1231
1232 /**
1233 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001234 * password containing at least alphabetic (or other symbol) characters.
1235 * Note that quality constants are ordered so that higher values are more
1236 * restrictive.
1237 */
1238 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001239
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001240 /**
1241 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001242 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001243 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001244 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001245 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001246 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001247
Dianne Hackbornd6847842010-01-12 18:14:19 -08001248 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001249 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001250 * password containing at least a letter, a numerical digit and a special
1251 * symbol, by default. With this password quality, passwords can be
1252 * restricted to contain various sets of characters, like at least an
1253 * uppercase letter, etc. These are specified using various methods,
1254 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1255 * that quality constants are ordered so that higher values are more
1256 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001257 */
1258 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1259
1260 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001261 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1262 * modify password. In case this password quality is set, the password is
1263 * managed by a profile owner. The profile owner can set any password,
1264 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1265 * that quality constants are ordered so that higher values are more
1266 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1267 * the highest.
1268 * @hide
1269 */
1270 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1271
1272 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001273 * Called by an application that is administering the device to set the password restrictions it
1274 * is imposing. After setting this, the user will not be able to enter a new password that is
1275 * not at least as restrictive as what has been set. Note that the current password will remain
1276 * until the user has set a new one, so the change does not take place immediately. To prompt
1277 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001278 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001279 * <p>
1280 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1281 * requested quality constant (between the policy set here, the user's preference, and any other
1282 * considerations) is the one that is in effect.
1283 * <p>
1284 * The calling device admin must have requested
1285 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1286 * not, a security exception will be thrown.
1287 * <p>
1288 * This method can be called on the {@link DevicePolicyManager} instance returned by
1289 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1290 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001291 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001292 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001293 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1294 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1295 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1296 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1297 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1298 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001299 */
Robin Lee25e26452015-06-02 09:56:29 -07001300 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001301 if (mService != null) {
1302 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001303 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001304 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001305 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001306 }
1307 }
1308 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001309
Dianne Hackbornd6847842010-01-12 18:14:19 -08001310 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001311 * Retrieve the current minimum password quality for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001312 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001313 * a separate challenge are not taken into account.
1314 *
1315 * <p>This method can be called on the {@link DevicePolicyManager} instance
1316 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1317 * restrictions on the parent profile.
1318 *
Robin Lee25e26452015-06-02 09:56:29 -07001319 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001320 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001321 */
Robin Lee25e26452015-06-02 09:56:29 -07001322 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001323 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001324 }
1325
1326 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001327 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001328 if (mService != null) {
1329 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001330 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001331 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001332 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001333 }
1334 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001335 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001336 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001337
Dianne Hackbornd6847842010-01-12 18:14:19 -08001338 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001339 * Called by an application that is administering the device to set the minimum allowed password
1340 * length. After setting this, the user will not be able to enter a new password that is not at
1341 * least as restrictive as what has been set. Note that the current password will remain until
1342 * the user has set a new one, so the change does not take place immediately. To prompt the user
1343 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1344 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1345 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1346 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1347 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1348 * {@link #setPasswordQuality}.
1349 * <p>
1350 * The calling device admin must have requested
1351 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1352 * not, a security exception will be thrown.
1353 * <p>
1354 * This method can be called on the {@link DevicePolicyManager} instance returned by
1355 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1356 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001357 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001358 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001359 * @param length The new desired minimum password length. A value of 0 means there is no
1360 * restriction.
1361 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1362 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001363 */
Robin Lee25e26452015-06-02 09:56:29 -07001364 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001365 if (mService != null) {
1366 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001367 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001368 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001369 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001370 }
1371 }
1372 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001373
Dianne Hackbornd6847842010-01-12 18:14:19 -08001374 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001375 * Retrieve the current minimum password length for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001376 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001377 * a separate challenge are not taken into account.
1378 *
1379 * <p>This method can be called on the {@link DevicePolicyManager} instance
1380 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1381 * restrictions on the parent profile.
1382 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001383 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001384 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001385 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001386 */
Robin Lee25e26452015-06-02 09:56:29 -07001387 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001388 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001389 }
1390
1391 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001392 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001393 if (mService != null) {
1394 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001395 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001396 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001397 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001398 }
1399 }
1400 return 0;
1401 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001402
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001403 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001404 * Called by an application that is administering the device to set the minimum number of upper
1405 * case letters required in the password. After setting this, the user will not be able to enter
1406 * a new password that is not at least as restrictive as what has been set. Note that the
1407 * current password will remain until the user has set a new one, so the change does not take
1408 * place immediately. To prompt the user for a new password, use
1409 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1410 * setting this value. This constraint is only imposed if the administrator has also requested
1411 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001412 * <p>
1413 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001414 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1415 * not, a security exception will be thrown.
1416 * <p>
1417 * This method can be called on the {@link DevicePolicyManager} instance returned by
1418 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1419 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001420 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001421 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1422 * @param length The new desired minimum number of upper case letters required in the password.
1423 * A value of 0 means there is no restriction.
1424 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1425 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001426 */
Robin Lee25e26452015-06-02 09:56:29 -07001427 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001428 if (mService != null) {
1429 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001430 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001431 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001432 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001433 }
1434 }
1435 }
1436
1437 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001438 * Retrieve the current number of upper case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001439 * for a particular admin or all admins that set restrictions on this user and
Esteban Talaverac1c83592016-02-17 17:56:15 +00001440 * its participating profiles. Restrictions on profiles that have a separate challenge
1441 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001442 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001443 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001444 * and only applies when the password quality is
1445 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001446 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001447 * <p>This method can be called on the {@link DevicePolicyManager} instance
1448 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1449 * restrictions on the parent profile.
1450 *
Robin Lee25e26452015-06-02 09:56:29 -07001451 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001452 * aggregate all admins.
1453 * @return The minimum number of upper case letters required in the
1454 * password.
1455 */
Robin Lee25e26452015-06-02 09:56:29 -07001456 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001457 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001458 }
1459
1460 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001461 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001462 if (mService != null) {
1463 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001464 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001465 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001466 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001467 }
1468 }
1469 return 0;
1470 }
1471
1472 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001473 * Called by an application that is administering the device to set the minimum number of lower
1474 * case letters required in the password. After setting this, the user will not be able to enter
1475 * a new password that is not at least as restrictive as what has been set. Note that the
1476 * current password will remain until the user has set a new one, so the change does not take
1477 * place immediately. To prompt the user for a new password, use
1478 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1479 * setting this value. This constraint is only imposed if the administrator has also requested
1480 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001481 * <p>
1482 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001483 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1484 * not, a security exception will be thrown.
1485 * <p>
1486 * This method can be called on the {@link DevicePolicyManager} instance returned by
1487 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1488 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001489 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001490 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1491 * @param length The new desired minimum number of lower case letters required in the password.
1492 * A value of 0 means there is no restriction.
1493 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1494 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001495 */
Robin Lee25e26452015-06-02 09:56:29 -07001496 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001497 if (mService != null) {
1498 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001499 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001500 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001501 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001502 }
1503 }
1504 }
1505
1506 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001507 * Retrieve the current number of lower case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001508 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001509 * and its participating profiles. Restrictions on profiles that have
1510 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001511 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001512 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001513 * and only applies when the password quality is
1514 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001515 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001516 * <p>This method can be called on the {@link DevicePolicyManager} instance
1517 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1518 * restrictions on the parent profile.
1519 *
Robin Lee25e26452015-06-02 09:56:29 -07001520 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001521 * aggregate all admins.
1522 * @return The minimum number of lower case letters required in the
1523 * password.
1524 */
Robin Lee25e26452015-06-02 09:56:29 -07001525 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001526 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001527 }
1528
1529 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001530 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001531 if (mService != null) {
1532 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001533 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001534 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001535 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001536 }
1537 }
1538 return 0;
1539 }
1540
1541 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001542 * Called by an application that is administering the device to set the minimum number of
1543 * letters required in the password. After setting this, the user will not be able to enter a
1544 * new password that is not at least as restrictive as what has been set. Note that the current
1545 * password will remain until the user has set a new one, so the change does not take place
1546 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1547 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1548 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1549 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001550 * <p>
1551 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001552 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1553 * not, a security exception will be thrown.
1554 * <p>
1555 * This method can be called on the {@link DevicePolicyManager} instance returned by
1556 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1557 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001558 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001559 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1560 * @param length The new desired minimum number of letters required in the password. A value of
1561 * 0 means there is no restriction.
1562 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1563 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001564 */
Robin Lee25e26452015-06-02 09:56:29 -07001565 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001566 if (mService != null) {
1567 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001568 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001569 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001570 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001571 }
1572 }
1573 }
1574
1575 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001576 * Retrieve the current number of letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001577 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001578 * and its participating profiles. Restrictions on profiles that have
1579 * a separate challenge are not taken into account.
1580 * This is the same value as set by
1581 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001582 * and only applies when the password quality is
1583 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001584 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001585 * <p>This method can be called on the {@link DevicePolicyManager} instance
1586 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1587 * restrictions on the parent profile.
1588 *
Robin Lee25e26452015-06-02 09:56:29 -07001589 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001590 * aggregate all admins.
1591 * @return The minimum number of letters required in the password.
1592 */
Robin Lee25e26452015-06-02 09:56:29 -07001593 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001594 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001595 }
1596
1597 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001598 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001599 if (mService != null) {
1600 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001601 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001602 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001603 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001604 }
1605 }
1606 return 0;
1607 }
1608
1609 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001610 * Called by an application that is administering the device to set the minimum number of
1611 * numerical digits required in the password. After setting this, the user will not be able to
1612 * enter a new password that is not at least as restrictive as what has been set. Note that the
1613 * current password will remain until the user has set a new one, so the change does not take
1614 * place immediately. To prompt the user for a new password, use
1615 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1616 * setting this value. This constraint is only imposed if the administrator has also requested
1617 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001618 * <p>
1619 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001620 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1621 * not, a security exception will be thrown.
1622 * <p>
1623 * This method can be called on the {@link DevicePolicyManager} instance returned by
1624 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1625 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001626 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001627 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1628 * @param length The new desired minimum number of numerical digits required in the password. A
1629 * value of 0 means there is no restriction.
1630 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1631 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001632 */
Robin Lee25e26452015-06-02 09:56:29 -07001633 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001634 if (mService != null) {
1635 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001636 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001637 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001638 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001639 }
1640 }
1641 }
1642
1643 /**
1644 * Retrieve the current number of numerical digits required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001645 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001646 * and its participating profiles. Restrictions on profiles that have
1647 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001648 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001649 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001650 * and only applies when the password quality is
1651 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001652 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001653 * <p>This method can be called on the {@link DevicePolicyManager} instance
1654 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1655 * restrictions on the parent profile.
1656 *
Robin Lee25e26452015-06-02 09:56:29 -07001657 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001658 * aggregate all admins.
1659 * @return The minimum number of numerical digits required in the password.
1660 */
Robin Lee25e26452015-06-02 09:56:29 -07001661 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001662 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001663 }
1664
1665 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001666 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001667 if (mService != null) {
1668 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001669 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001670 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001671 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001672 }
1673 }
1674 return 0;
1675 }
1676
1677 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001678 * Called by an application that is administering the device to set the minimum number of
1679 * symbols required in the password. After setting this, the user will not be able to enter a
1680 * new password that is not at least as restrictive as what has been set. Note that the current
1681 * password will remain until the user has set a new one, so the change does not take place
1682 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1683 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1684 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1685 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001686 * <p>
1687 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001688 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1689 * not, a security exception will be thrown.
1690 * <p>
1691 * This method can be called on the {@link DevicePolicyManager} instance returned by
1692 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1693 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001694 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001695 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1696 * @param length The new desired minimum number of symbols required in the password. A value of
1697 * 0 means there is no restriction.
1698 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1699 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001700 */
Robin Lee25e26452015-06-02 09:56:29 -07001701 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001702 if (mService != null) {
1703 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001704 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001705 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001706 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001707 }
1708 }
1709 }
1710
1711 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001712 * Retrieve the current number of symbols required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001713 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001714 * and its participating profiles. Restrictions on profiles that have
1715 * a separate challenge are not taken into account. This is the same value as
1716 * set by {@link #setPasswordMinimumSymbols(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 symbols required in the password.
1727 */
Robin Lee25e26452015-06-02 09:56:29 -07001728 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001729 return getPasswordMinimumSymbols(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 getPasswordMinimumSymbols(@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.getPasswordMinimumSymbols(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
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001744 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001745 * Called by an application that is administering the device to set the minimum number of
1746 * non-letter characters (numerical digits or symbols) required in the password. After setting
1747 * this, the user will not be able to enter a new password that is not at least as restrictive
1748 * as what has been set. Note that the current password will remain until the user has set a new
1749 * one, so the change does not take place immediately. To prompt the user for a new password,
1750 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1751 * setting this value. This constraint is only imposed if the administrator has also requested
1752 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -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 Lopyrevc8577402010-06-04 17:15:02 -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 letters 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 Lopyrevc8577402010-06-04 17:15:02 -07001767 */
Robin Lee25e26452015-06-02 09:56:29 -07001768 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001769 if (mService != null) {
1770 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001771 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001772 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001773 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001774 }
1775 }
1776 }
1777
1778 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001779 * Retrieve the current number of non-letter characters 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.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001783 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001784 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001785 * and only applies when the password quality is
1786 * {@link #PASSWORD_QUALITY_COMPLEX}.
1787 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001788 * <p>This method can be called on the {@link DevicePolicyManager} instance
1789 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1790 * restrictions on the parent profile.
1791 *
Robin Lee25e26452015-06-02 09:56:29 -07001792 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001793 * aggregate all admins.
1794 * @return The minimum number of letters required in the password.
1795 */
Robin Lee25e26452015-06-02 09:56:29 -07001796 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001797 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001798 }
1799
1800 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001801 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001802 if (mService != null) {
1803 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001804 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001805 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001806 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001807 }
1808 }
1809 return 0;
1810 }
1811
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001812 /**
1813 * Called by an application that is administering the device to set the length of the password
1814 * history. After setting this, the user will not be able to enter a new password that is the
1815 * same as any password in the history. Note that the current password will remain until the
1816 * user has set a new one, so the change does not take place immediately. To prompt the user for
1817 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1818 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1819 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1820 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
1821 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
1822 * <p>
1823 * The calling device admin must have requested
1824 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1825 * not, a security exception will be thrown.
1826 * <p>
1827 * This method can be called on the {@link DevicePolicyManager} instance returned by
1828 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1829 * profile.
1830 *
1831 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1832 * @param length The new desired length of password history. A value of 0 means there is no
1833 * restriction.
1834 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1835 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1836 */
Robin Lee25e26452015-06-02 09:56:29 -07001837 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001838 if (mService != null) {
1839 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001840 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001841 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001842 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001843 }
1844 }
1845 }
1846
1847 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001848 * Called by a device admin to set the password expiration timeout. Calling this method will
1849 * restart the countdown for password expiration for the given admin, as will changing the
1850 * device password (for all admins).
1851 * <p>
1852 * The provided timeout is the time delta in ms and will be added to the current time. For
1853 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
1854 * 432000000 ms for timeout.
1855 * <p>
1856 * To disable password expiration, a value of 0 may be used for timeout.
1857 * <p>
1858 * The calling device admin must have requested
1859 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
1860 * not, a security exception will be thrown.
1861 * <p>
1862 * Note that setting the password will automatically reset the expiration time for all active
1863 * admins. Active admins do not need to explicitly call this method in that case.
1864 * <p>
1865 * This method can be called on the {@link DevicePolicyManager} instance returned by
1866 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1867 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001868 *
Jim Millera4e28d12010-11-08 16:15:47 -08001869 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001870 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
1871 * there is no restriction (unlimited).
1872 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1873 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08001874 */
Robin Lee25e26452015-06-02 09:56:29 -07001875 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001876 if (mService != null) {
1877 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001878 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001879 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001880 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001881 }
1882 }
1883 }
1884
1885 /**
Jim Miller6b857682011-02-16 16:27:41 -08001886 * Get the password expiration timeout for the given admin. The expiration timeout is the
1887 * recurring expiration timeout provided in the call to
1888 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001889 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1890 * have set restrictions on profiles that have a separate challenge are not taken into account.
1891 *
1892 * <p>This method can be called on the {@link DevicePolicyManager} instance
1893 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1894 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001895 *
Robin Lee25e26452015-06-02 09:56:29 -07001896 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001897 * @return The timeout for the given admin or the minimum of all timeouts
1898 */
Robin Lee25e26452015-06-02 09:56:29 -07001899 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001900 if (mService != null) {
1901 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001902 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001903 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001904 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001905 }
1906 }
1907 return 0;
1908 }
1909
1910 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001911 * Get the current password expiration time for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001912 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001913 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1914 * of all expiration times is returned - which will be the minimum of all of them.
1915 *
1916 * <p>This method can be called on the {@link DevicePolicyManager} instance
1917 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1918 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001919 *
Robin Lee25e26452015-06-02 09:56:29 -07001920 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001921 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001922 */
Robin Lee25e26452015-06-02 09:56:29 -07001923 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001924 if (mService != null) {
1925 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001926 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001927 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001928 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001929 }
1930 }
1931 return 0;
1932 }
1933
1934 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001935 * Retrieve the current password history length for a particular admin or all admins that
Rubin Xud3609d42016-07-13 18:32:57 +01001936 * set restrictions on this user and its participating profiles. Restrictions on profiles that
Esteban Talaverac1c83592016-02-17 17:56:15 +00001937 * have a separate challenge are not taken into account.
1938 *
1939 * <p>This method can be called on the {@link DevicePolicyManager} instance
1940 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1941 * restrictions on the parent profile.
1942 *
Robin Lee25e26452015-06-02 09:56:29 -07001943 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001944 * all admins.
1945 * @return The length of the password history
1946 */
Robin Lee25e26452015-06-02 09:56:29 -07001947 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001948 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001949 }
1950
1951 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001952 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001953 if (mService != null) {
1954 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001955 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001956 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001957 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001958 }
1959 }
1960 return 0;
1961 }
1962
Dianne Hackbornd6847842010-01-12 18:14:19 -08001963 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001964 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001965 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001966 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001967 * @return Returns the maximum length that the user can enter.
1968 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001969 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001970 // Kind-of arbitrary.
1971 return 16;
1972 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001973
Dianne Hackborn254cb442010-01-27 19:23:59 -08001974 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001975 * Determine whether the current password the user has set is sufficient to meet the policy
1976 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
1977 * user and its participating profiles. Restrictions on profiles that have a separate challenge
1978 * are not taken into account.
1979 * <p>
1980 * The calling device admin must have requested
1981 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1982 * not, a security exception will be thrown.
1983 * <p>
1984 * This method can be called on the {@link DevicePolicyManager} instance returned by
1985 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
1986 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001987 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001988 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001989 * @throws SecurityException if the calling application does not own an active administrator
1990 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001991 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001992 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001993 if (mService != null) {
1994 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001995 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001996 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001997 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001998 }
1999 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002000 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002001 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002002
Dianne Hackbornd6847842010-01-12 18:14:19 -08002003 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002004 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002005 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002006 * requested by the admins of the parent user and its profiles.
2007 *
2008 * @param userHandle the userId of the profile to check the password for.
2009 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002010 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002011 * @hide
2012 */
2013 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2014 if (mService != null) {
2015 try {
2016 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2017 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002018 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002019 }
2020 }
2021 return false;
2022 }
2023
2024 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002025 * Retrieve the number of times the user has failed at entering a password since that last
2026 * successful password entry.
2027 * <p>
2028 * This method can be called on the {@link DevicePolicyManager} instance returned by
2029 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2030 * password attemts for the parent user.
2031 * <p>
2032 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2033 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002034 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002035 * @return The number of times user has entered an incorrect password since the last correct
2036 * password entry.
2037 * @throws SecurityException if the calling application does not own an active administrator
2038 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002039 */
2040 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002041 return getCurrentFailedPasswordAttempts(myUserId());
2042 }
2043
2044 /**
2045 * Retrieve the number of times the given user has failed at entering a
2046 * password since that last successful password entry.
2047 *
2048 * <p>The calling device admin must have requested
2049 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2050 * not and it is not the system uid, a security exception will be thrown.
2051 *
2052 * @hide
2053 */
2054 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002055 if (mService != null) {
2056 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002057 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002058 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002059 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002060 }
2061 }
2062 return -1;
2063 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002064
2065 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002066 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002067 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002068 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002069 * @hide
2070 */
2071 public boolean getDoNotAskCredentialsOnBoot() {
2072 if (mService != null) {
2073 try {
2074 return mService.getDoNotAskCredentialsOnBoot();
2075 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002076 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002077 }
2078 }
2079 return false;
2080 }
2081
2082 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002083 * Setting this to a value greater than zero enables a built-in policy that will perform a
2084 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2085 * This built-in policy combines watching for failed passwords and wiping the device, and
2086 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002087 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002088 * <p>
2089 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2090 * revoking credentials, or reporting the failure to a server), you should implement
2091 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2092 * use this API, because if the maximum count is reached, the device or profile will be wiped
2093 * immediately, and your callback will not be invoked.
2094 * <p>
2095 * This method can be called on the {@link DevicePolicyManager} instance returned by
2096 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2097 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002098 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002099 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002100 * @param num The number of failed password attempts at which point the device or profile will
2101 * be wiped.
2102 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2103 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2104 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002105 */
Robin Lee25e26452015-06-02 09:56:29 -07002106 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002107 if (mService != null) {
2108 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002109 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002110 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002111 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002112 }
2113 }
2114 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002115
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002116 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002117 * Retrieve the current maximum number of login attempts that are allowed before the device
Rubin Xud3609d42016-07-13 18:32:57 +01002118 * or profile is wiped, for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002119 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2120 * not taken into account.
2121 *
2122 * <p>This method can be called on the {@link DevicePolicyManager} instance
2123 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2124 * the value for the parent profile.
2125 *
Robin Lee25e26452015-06-02 09:56:29 -07002126 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002127 * all admins.
2128 */
Robin Lee25e26452015-06-02 09:56:29 -07002129 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002130 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002131 }
2132
2133 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002134 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002135 if (mService != null) {
2136 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002137 return mService.getMaximumFailedPasswordsForWipe(
2138 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002139 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002140 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002141 }
2142 }
2143 return 0;
2144 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002145
Dianne Hackborn254cb442010-01-27 19:23:59 -08002146 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002147 * Returns the profile with the smallest maximum failed passwords for wipe,
2148 * for the given user. So for primary user, it might return the primary or
2149 * a managed profile. For a secondary user, it would be the same as the
2150 * user passed in.
2151 * @hide Used only by Keyguard
2152 */
2153 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2154 if (mService != null) {
2155 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002156 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2157 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002158 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002159 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002160 }
2161 }
2162 return UserHandle.USER_NULL;
2163 }
2164
2165 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002166 * Flag for {@link #resetPassword}: don't allow other admins to change
2167 * the password again until the user has entered it.
2168 */
2169 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002170
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002171 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002172 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2173 * If the flag is set, the device can be booted without asking for user password.
2174 * The absence of this flag does not change the current boot requirements. This flag
2175 * can be set by the device owner only. If the app is not the device owner, the flag
2176 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2177 * device to factory defaults.
2178 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002179 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002180
2181 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002182 * Force a new device unlock password (the password needed to access the entire device, not for
2183 * individual accounts) on the user. This takes effect immediately.
2184 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002185 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002186 * device admins that are not device owner and not profile owner.
2187 * The password can now only be changed if there is currently no password set. Device owner
Ricky Wai977ade22016-05-24 15:02:41 +01002188 * and profile owner can still do this when user is unlocked and does not have a managed
2189 * profile.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002190 * <p>
2191 * The given password must be sufficient for the current password quality and length constraints
2192 * as returned by {@link #getPasswordQuality(ComponentName)} and
2193 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2194 * it will be rejected and false returned. Note that the password may be a stronger quality
2195 * (containing alphanumeric characters when the requested quality is only numeric), in which
2196 * case the currently active quality will be increased to match.
2197 * <p>
2198 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002199 * current password constraints allow it. <em>Note: This will not work in
2200 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2201 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2202 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002203 * <p>
2204 * The calling device admin must have requested
2205 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2206 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002207 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002208 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002209 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002210 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2211 * @return Returns true if the password was applied, or false if it is not acceptable for the
2212 * current constraints or if the user has not been decrypted yet.
2213 * @throws SecurityException if the calling application does not own an active administrator
2214 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Ricky Wai977ade22016-05-24 15:02:41 +01002215 * @throws IllegalStateException if the calling user is locked or has a managed profile.
Andrew Scull3f81f4e2016-07-29 16:29:58 +01002216 * @throws IllegalArgumentException if the password does not meet system requirements.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002217 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002218 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002219 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002220 if (mService != null) {
2221 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002222 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002223 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002224 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002225 }
2226 }
2227 return false;
2228 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002229
Dianne Hackbornd6847842010-01-12 18:14:19 -08002230 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002231 * Called by an application that is administering the device to set the maximum time for user
2232 * activity until the device will lock. This limits the length that the user can set. It takes
2233 * effect immediately.
2234 * <p>
2235 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2236 * to be able to call this method; if it has not, a security exception will be thrown.
2237 * <p>
2238 * This method can be called on the {@link DevicePolicyManager} instance returned by
2239 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2240 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002241 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002242 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002243 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2244 * is no restriction.
2245 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2246 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002247 */
Robin Lee25e26452015-06-02 09:56:29 -07002248 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002249 if (mService != null) {
2250 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002251 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002252 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002253 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002254 }
2255 }
2256 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002257
Dianne Hackbornd6847842010-01-12 18:14:19 -08002258 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002259 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002260 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002261 * a separate challenge are not taken into account.
2262 *
2263 * <p>This method can be called on the {@link DevicePolicyManager} instance
2264 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2265 * restrictions on the parent profile.
2266 *
Robin Lee25e26452015-06-02 09:56:29 -07002267 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002268 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002269 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002270 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002271 */
Robin Lee25e26452015-06-02 09:56:29 -07002272 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002273 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002274 }
2275
2276 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002277 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002278 if (mService != null) {
2279 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002280 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002281 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002282 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002283 }
2284 }
2285 return 0;
2286 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002287
Dianne Hackbornd6847842010-01-12 18:14:19 -08002288 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002289 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2290 * do not have a separate timeout to lock for work challenge only.
2291 *
2292 * @hide
2293 */
2294 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2295 if (mService != null) {
2296 try {
2297 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2298 } catch (RemoteException e) {
2299 throw e.rethrowFromSystemServer();
2300 }
2301 }
2302 return 0;
2303 }
2304
2305 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002306 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2307 * this call.
2308 * <p>
2309 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2310 * to be able to call this method; if it has not, a security exception will be thrown.
2311 * <p>
2312 * This method can be called on the {@link DevicePolicyManager} instance returned by
2313 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002314 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002315 * @throws SecurityException if the calling application does not own an active administrator
2316 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002317 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002318 public void lockNow() {
2319 if (mService != null) {
2320 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002321 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002322 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002323 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002324 }
2325 }
2326 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002327
Dianne Hackbornd6847842010-01-12 18:14:19 -08002328 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002329 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002330 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002331 */
2332 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2333
2334 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002335 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2336 * data.
2337 *
Paul Crowley2934b262014-12-02 11:21:13 +00002338 * <p>This flag may only be set by device owner admins; if it is set by
2339 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002340 */
2341 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2342
2343 /**
Suprabh Shukla556b05a2016-08-10 15:49:24 -07002344 * Ask that all user data be wiped. If called as a secondary user, the user will be removed and
2345 * other users will remain unaffected. Calling from the primary user will cause the device to
2346 * reboot, erasing all device data - including all the secondary users and their data - while
2347 * booting up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002348 * <p>
2349 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2350 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002351 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002352 * @param flags Bit mask of additional options: currently supported flags are
2353 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2354 * @throws SecurityException if the calling application does not own an active administrator
2355 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002356 */
2357 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002358 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08002359 if (mService != null) {
2360 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002361 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002362 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002363 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002364 }
2365 }
2366 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002367
Dianne Hackbornd6847842010-01-12 18:14:19 -08002368 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002369 * Called by an application that is administering the device to set the
2370 * global proxy and exclusion list.
2371 * <p>
2372 * The calling device admin must have requested
2373 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2374 * this method; if it has not, a security exception will be thrown.
2375 * Only the first device admin can set the proxy. If a second admin attempts
2376 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002377 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002378 * be returned.
2379 * The method can be called repeatedly by the device admin alrady setting the
2380 * proxy to update the proxy and exclusion list.
2381 *
Robin Lee25e26452015-06-02 09:56:29 -07002382 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002383 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2384 * Pass Proxy.NO_PROXY to reset the proxy.
2385 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002386 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2387 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002388 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002389 */
Robin Lee25e26452015-06-02 09:56:29 -07002390 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002391 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002392 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07002393 if (proxySpec == null) {
2394 throw new NullPointerException();
2395 }
2396 if (mService != null) {
2397 try {
2398 String hostSpec;
2399 String exclSpec;
2400 if (proxySpec.equals(Proxy.NO_PROXY)) {
2401 hostSpec = null;
2402 exclSpec = null;
2403 } else {
2404 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2405 throw new IllegalArgumentException();
2406 }
2407 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2408 String hostName = sa.getHostName();
2409 int port = sa.getPort();
2410 StringBuilder hostBuilder = new StringBuilder();
2411 hostSpec = hostBuilder.append(hostName)
2412 .append(":").append(Integer.toString(port)).toString();
2413 if (exclusionList == null) {
2414 exclSpec = "";
2415 } else {
2416 StringBuilder listBuilder = new StringBuilder();
2417 boolean firstDomain = true;
2418 for (String exclDomain : exclusionList) {
2419 if (!firstDomain) {
2420 listBuilder = listBuilder.append(",");
2421 } else {
2422 firstDomain = false;
2423 }
2424 listBuilder = listBuilder.append(exclDomain.trim());
2425 }
2426 exclSpec = listBuilder.toString();
2427 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002428 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2429 != android.net.Proxy.PROXY_VALID)
2430 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002431 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002432 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002433 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002434 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002435 }
2436 }
2437 return null;
2438 }
2439
2440 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002441 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2442 * HTTP proxies - they are generally network dependent. However if you're doing something
2443 * unusual like general internal filtering this may be useful. On a private network where the
2444 * proxy is not accessible, you may break HTTP using this.
2445 * <p>
2446 * This method requires the caller to be the device owner.
2447 * <p>
2448 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04002449 *
Jason Monk03bc9912014-05-13 09:44:57 -04002450 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002451 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2452 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2453 * {@code null} value will clear the global HTTP proxy.
2454 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04002455 */
Robin Lee25e26452015-06-02 09:56:29 -07002456 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2457 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002458 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04002459 if (mService != null) {
2460 try {
2461 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2462 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002463 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04002464 }
2465 }
2466 }
2467
2468 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002469 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002470 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2471 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002472 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002473 */
2474 public ComponentName getGlobalProxyAdmin() {
2475 if (mService != null) {
2476 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002477 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002478 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002479 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002480 }
2481 }
2482 return null;
2483 }
2484
2485 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002486 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002487 * indicating that encryption is not supported.
2488 */
2489 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2490
2491 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002492 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002493 * indicating that encryption is supported, but is not currently active.
2494 */
2495 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2496
2497 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002498 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002499 * indicating that encryption is not currently active, but is currently
2500 * being activated. This is only reported by devices that support
2501 * encryption of data and only when the storage is currently
2502 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2503 * to become encrypted will never return this value.
2504 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002505 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002506
2507 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002508 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002509 * indicating that encryption is active.
Amith Yamasani75db1252016-07-11 14:41:01 -07002510 * <p>
2511 * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002512 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002513 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002514
2515 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002516 * Result code for {@link #getStorageEncryptionStatus}:
2517 * indicating that encryption is active, but an encryption key has not
2518 * been set by the user.
2519 */
2520 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2521
2522 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08002523 * Result code for {@link #getStorageEncryptionStatus}:
Amith Yamasani75db1252016-07-11 14:41:01 -07002524 * indicating that encryption is active and the encryption key is tied to the user or profile.
2525 * <p>
2526 * This value is only returned to apps targeting API level 24 and above. For apps targeting
2527 * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
2528 * encryption key is specific to the user or profile.
Makoto Onukid4c9e542016-02-25 18:17:30 -08002529 */
2530 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2531
2532 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002533 * Activity action: begin the process of encrypting data on the device. This activity should
2534 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2535 * After resuming from this activity, use {@link #getStorageEncryption}
2536 * to check encryption status. However, on some devices this activity may never return, as
2537 * it may trigger a reboot and in some cases a complete data wipe of the device.
2538 */
2539 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2540 public static final String ACTION_START_ENCRYPTION
2541 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002542 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002543 * Widgets are enabled in keyguard
2544 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002545 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002546
2547 /**
Jim Miller50e62182014-04-23 17:25:00 -07002548 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002549 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002550 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2551
2552 /**
2553 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2554 */
2555 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2556
2557 /**
Jim Miller50e62182014-04-23 17:25:00 -07002558 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2559 */
2560 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2561
2562 /**
2563 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2564 */
2565 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2566
2567 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002568 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002569 * (e.g. PIN/Pattern/Password).
2570 */
2571 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2572
2573 /**
Jim Miller06e34502014-07-17 14:46:05 -07002574 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2575 */
2576 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2577
2578 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08002579 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
2580 */
2581 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
2582
2583 /**
Jim Miller35207742012-11-02 15:33:20 -07002584 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002585 */
2586 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002587
2588 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002589 * Called by an application that is administering the device to request that the storage system
2590 * be encrypted.
2591 * <p>
2592 * When multiple device administrators attempt to control device encryption, the most secure,
2593 * supported setting will always be used. If any device administrator requests device
2594 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2595 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002596 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002597 * <p>
2598 * This policy controls encryption of the secure (application data) storage area. Data written
2599 * to other storage areas may or may not be encrypted, and this policy does not require or
2600 * control the encryption of any other storage areas. There is one exception: If
2601 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2602 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2603 * written to disk within the encrypted storage area.
2604 * <p>
2605 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2606 * to create a device PIN or Password. In this case, the storage is encrypted, but the
2607 * encryption key may not be fully secured. For maximum security, the administrator should also
2608 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002609 *
2610 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2611 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002612 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002613 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2614 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2615 * {@link #getStorageEncryptionStatus()} to query the actual device state.
2616 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2617 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002618 */
Robin Lee25e26452015-06-02 09:56:29 -07002619 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002620 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002621 if (mService != null) {
2622 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002623 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002624 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002625 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002626 }
2627 }
2628 return ENCRYPTION_STATUS_UNSUPPORTED;
2629 }
2630
2631 /**
2632 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002633 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002634 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002635 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2636 * this will return the requested encryption setting as an aggregate of all active
2637 * administrators.
2638 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002639 */
Robin Lee25e26452015-06-02 09:56:29 -07002640 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002641 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002642 if (mService != null) {
2643 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002644 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002645 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002646 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002647 }
2648 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002649 return false;
2650 }
2651
2652 /**
2653 * Called by an application that is administering the device to
2654 * determine the current encryption status of the device.
Amith Yamasani75db1252016-07-11 14:41:01 -07002655 * <p>
Andy Stadler22dbfda2011-01-17 12:47:31 -08002656 * Depending on the returned status code, the caller may proceed in different
2657 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2658 * storage system does not support encryption. If the
2659 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2660 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002661 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2662 * storage system has enabled encryption but no password is set so further action
Amith Yamasani75db1252016-07-11 14:41:01 -07002663 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
2664 * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
2665 * no further action is required.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002666 *
Robin Lee7e678712014-07-24 16:41:31 +01002667 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002668 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002669 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
Amith Yamasani75db1252016-07-11 14:41:01 -07002670 * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002671 */
2672 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002673 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002674 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002675 }
2676
2677 /** @hide per-user version */
2678 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002679 if (mService != null) {
2680 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08002681 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002682 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002683 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08002684 }
2685 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002686 return ENCRYPTION_STATUS_UNSUPPORTED;
2687 }
2688
2689 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00002690 * Mark a CA certificate as approved by the device user. This means that they have been notified
2691 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2692 * keep the certificate on the device.
2693 *
2694 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2695 * this certificate.
2696 *
2697 * @hide
2698 */
2699 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2700 if (mService != null) {
2701 try {
2702 return mService.approveCaCert(alias, userHandle, approval);
2703 } catch (RemoteException e) {
2704 throw e.rethrowFromSystemServer();
2705 }
2706 }
2707 return false;
2708 }
2709
2710 /**
2711 * Check whether a CA certificate has been approved by the device user.
2712 *
2713 * @hide
2714 */
2715 public boolean isCaCertApproved(String alias, int userHandle) {
2716 if (mService != null) {
2717 try {
2718 return mService.isCaCertApproved(alias, userHandle);
2719 } catch (RemoteException e) {
2720 throw e.rethrowFromSystemServer();
2721 }
2722 }
2723 return false;
2724 }
2725
2726 /**
Robin Lee7e678712014-07-24 16:41:31 +01002727 * Installs the given certificate as a user CA.
2728 *
Robin Lee25e26452015-06-02 09:56:29 -07002729 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2730 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002731 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002732 *
2733 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002734 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002735 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2736 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002737 */
Robin Lee25e26452015-06-02 09:56:29 -07002738 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002739 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002740 if (mService != null) {
2741 try {
Robin Lee7e678712014-07-24 16:41:31 +01002742 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002743 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002744 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002745 }
2746 }
2747 return false;
2748 }
2749
2750 /**
Robin Lee7e678712014-07-24 16:41:31 +01002751 * Uninstalls the given certificate from trusted user CAs, if present.
2752 *
Robin Lee25e26452015-06-02 09:56:29 -07002753 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2754 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002755 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002756 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2757 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002758 */
Robin Lee25e26452015-06-02 09:56:29 -07002759 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002760 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002761 if (mService != null) {
2762 try {
Robin Lee306fe082014-06-19 14:04:24 +00002763 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002764 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002765 } catch (CertificateException e) {
2766 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002767 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002768 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002769 }
2770 }
2771 }
2772
2773 /**
Robin Lee7e678712014-07-24 16:41:31 +01002774 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2775 * If a user has installed any certificates by other means than device policy these will be
2776 * included too.
2777 *
Robin Lee25e26452015-06-02 09:56:29 -07002778 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2779 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002780 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002781 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2782 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002783 */
Robin Lee25e26452015-06-02 09:56:29 -07002784 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002785 List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01002786 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002787 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002788 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002789 mService.enforceCanManageCaCerts(admin);
2790 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2791 for (String alias : certStore.userAliases()) {
2792 try {
2793 certs.add(certStore.getCertificate(alias).getEncoded());
2794 } catch (CertificateException ce) {
2795 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2796 }
2797 }
2798 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002799 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002800 }
2801 }
2802 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002803 }
2804
2805 /**
Robin Lee7e678712014-07-24 16:41:31 +01002806 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2807 * means other than device policy will also be removed, except for system CA certificates.
2808 *
Robin Lee25e26452015-06-02 09:56:29 -07002809 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2810 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002811 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2812 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01002813 */
Robin Lee25e26452015-06-02 09:56:29 -07002814 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002815 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01002816 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002817 try {
2818 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2819 .toArray(new String[0]));
2820 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002821 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002822 }
2823 }
2824 }
2825
2826 /**
2827 * Returns whether this certificate is installed as a trusted CA.
2828 *
Robin Lee25e26452015-06-02 09:56:29 -07002829 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2830 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002831 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002832 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2833 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002834 */
Robin Lee25e26452015-06-02 09:56:29 -07002835 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002836 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002837 if (mService != null) {
2838 try {
2839 mService.enforceCanManageCaCerts(admin);
2840 return getCaCertAlias(certBuffer) != null;
2841 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002842 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002843 } catch (CertificateException ce) {
2844 Log.w(TAG, "Could not parse certificate", ce);
2845 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002846 }
2847 return false;
2848 }
2849
2850 /**
Robin Leece3399f2016-02-24 12:08:32 +00002851 * Called by a device or profile owner, or delegated certificate installer, to install a
2852 * certificate and corresponding private key. All apps within the profile will be able to access
2853 * the certificate and use the private key, given direct user approval.
2854 *
2855 * <p>Access to the installed credentials will not be granted to the caller of this API without
2856 * direct user approval. This is for security - should a certificate installer become
2857 * compromised, certificates it had already installed will be protected.
2858 *
2859 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00002860 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002861 *
Robin Lee25e26452015-06-02 09:56:29 -07002862 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2863 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002864 * @param privKey The private key to install.
2865 * @param cert The certificate to install.
2866 * @param alias The private key alias under which to install the certificate. If a certificate
2867 * with that alias already exists, it will be overwritten.
2868 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002869 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2870 * owner.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002871 */
Robin Leefbc65642015-08-03 16:21:22 +01002872 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2873 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00002874 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00002875 }
2876
2877 /**
2878 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00002879 * certificate chain and corresponding private key for the leaf certificate. All apps within the
2880 * profile will be able to access the certificate chain and use the private key, given direct
2881 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00002882 *
Robin Leea1b290e2016-03-09 14:38:36 +00002883 * <p>The caller of this API may grant itself access to the certificate and private key
2884 * immediately, without user approval. It is a best practice not to request this unless strictly
2885 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00002886 *
2887 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002888 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00002889 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00002890 * @param certs The certificate chain to install. The chain should start with the leaf
2891 * certificate and include the chain of trust in order. This will be returned by
2892 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00002893 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00002894 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00002895 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00002896 * credentials immediately. Otherwise, access to the credentials will be gated by user
2897 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00002898 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002899 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2900 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00002901 * @see android.security.KeyChain#getCertificateChain
Robin Leece3399f2016-02-24 12:08:32 +00002902 */
2903 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00002904 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002905 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002906 try {
Rubin Xub4365912016-03-23 12:13:22 +00002907 final byte[] pemCert = Credentials.convertToPem(certs[0]);
2908 byte[] pemChain = null;
2909 if (certs.length > 1) {
2910 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
2911 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01002912 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2913 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Rubin Xub4365912016-03-23 12:13:22 +00002914 return mService.installKeyPair(admin, pkcs8Key, pemCert, pemChain, alias,
2915 requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002916 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002917 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01002918 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2919 Log.w(TAG, "Failed to obtain private key material", e);
2920 } catch (CertificateException | IOException e) {
2921 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002922 }
2923 return false;
2924 }
2925
2926 /**
Robin Leea1b290e2016-03-09 14:38:36 +00002927 * Called by a device or profile owner, or delegated certificate installer, to remove a
2928 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01002929 *
2930 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002931 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01002932 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00002933 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002934 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2935 * owner.
Robin Leefbc65642015-08-03 16:21:22 +01002936 */
2937 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002938 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01002939 try {
2940 return mService.removeKeyPair(admin, alias);
2941 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002942 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01002943 }
Robin Leefbc65642015-08-03 16:21:22 +01002944 }
2945
2946 /**
Robin Lee25e26452015-06-02 09:56:29 -07002947 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00002948 * doesn't exist.
2949 */
2950 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2951 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2952 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2953 new ByteArrayInputStream(certBuffer));
2954 return new TrustedCertificateStore().getCertificateAlias(cert);
2955 }
2956
2957 /**
Rubin Xuec32b562015-03-03 17:34:05 +00002958 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01002959 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00002960 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01002961 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00002962 * <p>
2963 * Delegated certificate installer is a per-user state. The delegated access is persistent until
2964 * it is later cleared by calling this method with a null value or uninstallling the certificate
2965 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002966 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00002967 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
2968 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002969 * supplied certificate installer package must be installed when calling this API, otherwise an
2970 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00002971 *
Robin Lee25e26452015-06-02 09:56:29 -07002972 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00002973 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002974 * access. If {@code null} is given the current package will be cleared.
2975 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002976 */
Robin Lee25e26452015-06-02 09:56:29 -07002977 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
2978 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002979 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00002980 if (mService != null) {
2981 try {
Robin Lee25e26452015-06-02 09:56:29 -07002982 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00002983 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002984 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002985 }
2986 }
2987 }
2988
2989 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002990 * Called by a profile owner or device owner to retrieve the certificate installer for the user.
2991 * null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00002992 *
Robin Lee25e26452015-06-02 09:56:29 -07002993 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002994 * @return The package name of the current delegated certificate installer, or {@code null} if
2995 * none is set.
2996 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002997 */
Robin Lee25e26452015-06-02 09:56:29 -07002998 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002999 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003000 if (mService != null) {
3001 try {
Robin Lee25e26452015-06-02 09:56:29 -07003002 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00003003 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003004 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003005 }
3006 }
3007 return null;
3008 }
3009
3010 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003011 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003012 * specific application for the current user.
3013 *
3014 * @deprecated this version only exists for compability with previous developer preview builds.
3015 * TODO: delete once there are no longer any live references.
3016 * @hide
3017 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003018 @Deprecated
Robin Leedc679712016-05-03 13:23:03 +01003019 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3020 throws NameNotFoundException, UnsupportedOperationException {
3021 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3022 }
3023
3024 /**
3025 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003026 * specific application for the current user. This connection is automatically granted and
3027 * persisted after a reboot.
3028 * <p>
3029 * The designated package should declare a {@link android.net.VpnService} in its manifest
3030 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3031 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003032 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003033 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003034 * remove an existing always-on VPN configuration.
3035 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3036 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3037 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003038 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003039 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3040 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3041 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003042 */
Robin Leedc679712016-05-03 13:23:03 +01003043 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3044 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003045 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003046 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003047 if (mService != null) {
3048 try {
Robin Leedc679712016-05-03 13:23:03 +01003049 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003050 throw new NameNotFoundException(vpnPackage);
3051 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003052 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003053 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003054 }
3055 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003056 }
3057
3058 /**
3059 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003060 * always-on VPN connection for the current user. If there is no such package, or the always-on
3061 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003062 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003063 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3064 * is set.
3065 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003066 */
3067 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003068 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003069 if (mService != null) {
3070 try {
3071 return mService.getAlwaysOnVpnPackage(admin);
3072 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003073 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003074 }
3075 }
3076 return null;
3077 }
3078
3079 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003080 * Called by an application that is administering the device to disable all cameras on the
3081 * device, for this user. After setting this, no applications running as this user will be able
3082 * to access any cameras on the device.
3083 * <p>
3084 * If the caller is device owner, then the restriction will be applied to all users.
3085 * <p>
3086 * The calling device admin must have requested
3087 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3088 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003089 *
3090 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3091 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003092 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3093 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003094 */
Robin Lee25e26452015-06-02 09:56:29 -07003095 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003096 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07003097 if (mService != null) {
3098 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003099 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003100 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003101 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003102 }
3103 }
3104 }
3105
3106 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003107 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003108 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003109 * @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 -07003110 * have disabled the camera
3111 */
Robin Lee25e26452015-06-02 09:56:29 -07003112 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003113 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003114 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003115 }
3116
3117 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003118 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003119 if (mService != null) {
3120 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003121 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003122 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003123 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003124 }
3125 }
3126 return false;
3127 }
3128
3129 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003130 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003131 * <p>
3132 * There must be only one user on the device, managed by the device owner. Otherwise a
3133 * {@link SecurityException} will be thrown.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003134 *
3135 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003136 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3137 * wasn't triggered because a previous bugreport operation is still active (either the
3138 * bugreport is still running or waiting for the user to share or decline)
3139 * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3140 * than the one managed by the device owner.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003141 */
3142 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003143 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003144 if (mService != null) {
3145 try {
3146 return mService.requestBugreport(admin);
3147 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003148 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003149 }
3150 }
3151 return false;
3152 }
3153
3154 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07003155 * Determine whether or not creating a guest user has been disabled for the device
3156 *
3157 * @hide
3158 */
3159 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3160 // Currently guest users can always be created if multi-user is enabled
3161 // TODO introduce a policy for guest user creation
3162 return false;
3163 }
3164
3165 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01003166 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3167 * screen capture also prevents the content from being shown on display devices that do not have
3168 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3169 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003170 * <p>
3171 * The calling device admin must be a device or profile owner. If it is not, a security
3172 * exception will be thrown.
3173 * <p>
3174 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3175 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01003176 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003177 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003178 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003179 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003180 */
Robin Lee25e26452015-06-02 09:56:29 -07003181 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003182 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003183 if (mService != null) {
3184 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003185 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003186 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003187 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003188 }
3189 }
3190 }
3191
3192 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003193 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003194 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003195 * @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 +01003196 * have disabled screen capture.
3197 */
Robin Lee25e26452015-06-02 09:56:29 -07003198 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003199 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003200 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003201 }
3202
3203 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003204 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003205 if (mService != null) {
3206 try {
3207 return mService.getScreenCaptureDisabled(admin, userHandle);
3208 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003209 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003210 }
3211 }
3212 return false;
3213 }
3214
3215 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003216 * Called by a device owner to set whether auto time is required. If auto time is required the
3217 * user cannot set the date and time, but has to use network date and time.
3218 * <p>
3219 * Note: if auto time is required the user can still manually set the time zone.
3220 * <p>
3221 * The calling device admin must be a device owner. If it is not, a security exception will be
3222 * thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003223 *
3224 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3225 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003226 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003227 */
Robin Lee25e26452015-06-02 09:56:29 -07003228 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003229 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003230 if (mService != null) {
3231 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003232 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003233 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003234 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003235 }
3236 }
3237 }
3238
3239 /**
3240 * @return true if auto time is required.
3241 */
3242 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003243 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003244 if (mService != null) {
3245 try {
3246 return mService.getAutoTimeRequired();
3247 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003248 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003249 }
3250 }
3251 return false;
3252 }
3253
3254 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003255 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003256 * <p>
3257 * The system user is exempt from this policy - it is never ephemeral.
3258 * <p>
3259 * The calling device admin must be the device owner. If it is not, a security exception will be
3260 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003261 *
3262 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3263 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003264 * subsequently created users will be ephemeral.
3265 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003266 * @hide
3267 */
3268 public void setForceEphemeralUsers(
3269 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003270 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003271 if (mService != null) {
3272 try {
3273 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3274 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003275 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003276 }
3277 }
3278 }
3279
3280 /**
3281 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003282 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003283 * @hide
3284 */
3285 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003286 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003287 if (mService != null) {
3288 try {
3289 return mService.getForceEphemeralUsers(admin);
3290 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003291 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003292 }
3293 }
3294 return false;
3295 }
3296
3297 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003298 * Called by an application that is administering the device to disable keyguard customizations,
3299 * such as widgets. After setting this, keyguard features will be disabled according to the
3300 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003301 * <p>
3302 * The calling device admin must have requested
3303 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3304 * if it has not, a security exception will be thrown.
3305 * <p>
3306 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3307 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3308 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003309 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003310 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003311 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00003312 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003313 * there is one, or the parent user otherwise.
3314 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3315 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003316 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003317 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3318 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003319 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3320 * profile.
3321 * <p>
3322 * Requests to disable other features on a managed profile will be ignored.
3323 * <p>
3324 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003325 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003326 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003327 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003328 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003329 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3330 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3331 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3332 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3333 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3334 * @throws SecurityException if {@code admin} is not an active administrator or does not user
3335 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07003336 */
Robin Lee25e26452015-06-02 09:56:29 -07003337 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003338 if (mService != null) {
3339 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003340 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003341 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003342 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003343 }
3344 }
3345 }
3346
3347 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003348 * Determine whether or not features have been disabled in keyguard either by the calling
Rubin Xud3609d42016-07-13 18:32:57 +01003349 * admin, if specified, or all admins that set restrictions on this user and its participating
Esteban Talaverac1c83592016-02-17 17:56:15 +00003350 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3351 *
3352 * <p>This method can be called on the {@link DevicePolicyManager} instance
3353 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3354 * restrictions on the parent profile.
3355 *
Esteban Talavera62399912016-01-11 15:37:55 +00003356 * @param admin The name of the admin component to check, or {@code null} to check whether any
3357 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003358 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3359 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003360 */
Robin Lee25e26452015-06-02 09:56:29 -07003361 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003362 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003363 }
3364
3365 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003366 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003367 if (mService != null) {
3368 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003369 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003370 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003371 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003372 }
3373 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003374 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003375 }
3376
3377 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003378 * @hide
3379 */
Robin Lee25e26452015-06-02 09:56:29 -07003380 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3381 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003382 if (mService != null) {
3383 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003384 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003385 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003386 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003387 }
3388 }
3389 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003390
Dianne Hackbornd6847842010-01-12 18:14:19 -08003391 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003392 * @hide
3393 */
Robin Lee25e26452015-06-02 09:56:29 -07003394 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003395 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003396 }
3397
3398 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003399 * @hide
3400 */
Robin Lee25e26452015-06-02 09:56:29 -07003401 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003402 if (mService != null) {
3403 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003404 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003405 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003406 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003407 }
3408 }
3409 }
3410
3411 /**
3412 * @hide
3413 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003414 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003415 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003416 if (mService != null) {
3417 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003418 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003419 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003420 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003421 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003422 }
3423 }
3424 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003425
Dianne Hackbornd6847842010-01-12 18:14:19 -08003426 /**
3427 * @hide
3428 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003429 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003430 if (mService != null) {
3431 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003432 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003433 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003434 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003435 }
3436 }
3437 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003438
Dianne Hackbornd6847842010-01-12 18:14:19 -08003439 /**
3440 * @hide
3441 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003442 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003443 if (mService != null) {
3444 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003445 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003446 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003447 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003448 }
3449 }
3450 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003451
3452 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003453 * @hide
3454 */
3455 public void reportFailedFingerprintAttempt(int userHandle) {
3456 if (mService != null) {
3457 try {
3458 mService.reportFailedFingerprintAttempt(userHandle);
3459 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003460 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003461 }
3462 }
3463 }
3464
3465 /**
3466 * @hide
3467 */
3468 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3469 if (mService != null) {
3470 try {
3471 mService.reportSuccessfulFingerprintAttempt(userHandle);
3472 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003473 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003474 }
3475 }
3476 }
3477
3478 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003479 * Should be called when keyguard has been dismissed.
3480 * @hide
3481 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003482 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003483 if (mService != null) {
3484 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003485 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003486 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003487 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003488 }
3489 }
3490 }
3491
3492 /**
3493 * Should be called when keyguard view has been shown to the user.
3494 * @hide
3495 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003496 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003497 if (mService != null) {
3498 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003499 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003500 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003501 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003502 }
3503 }
3504 }
3505
3506 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003507 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003508 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003509 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3510 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003511 * @return whether the package was successfully registered as the device owner.
3512 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003513 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003514 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003515 public boolean setDeviceOwner(ComponentName who) {
3516 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003517 }
3518
3519 /**
3520 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003521 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003522 public boolean setDeviceOwner(ComponentName who, int userId) {
3523 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003524 }
3525
3526 /**
3527 * @hide
3528 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003529 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3530 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003531 }
3532
3533 /**
3534 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003535 * Sets the given package as the device owner. The package must already be installed. There
3536 * must not already be a device owner.
3537 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3538 * this method.
3539 * Calling this after the setup phase of the primary user has completed is allowed only if
3540 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003541 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003542 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003543 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003544 * @return whether the package was successfully registered as the device owner.
3545 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003546 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003547 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003548 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003549 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003550 if (mService != null) {
3551 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003552 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003553 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003554 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003555 }
3556 }
3557 return false;
3558 }
3559
3560 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003561 * Used to determine if a particular package has been registered as a Device Owner app.
3562 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003563 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003564 * package is currently registered as the device owner app, pass in the package name from
3565 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003566 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003567 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3568 * the setup process.
3569 * @param packageName the package name of the app, to compare with the registered device owner
3570 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003571 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003572 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003573 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003574 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003575 return isDeviceOwnerAppOnCallingUser(packageName);
3576 }
3577
3578 /**
3579 * @return true if a package is registered as device owner, only when it's running on the
3580 * calling user.
3581 *
3582 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3583 * @hide
3584 */
3585 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3586 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3587 }
3588
3589 /**
3590 * @return true if a package is registered as device owner, even if it's running on a different
3591 * user.
3592 *
3593 * <p>Requires the MANAGE_USERS permission.
3594 *
3595 * @hide
3596 */
3597 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3598 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3599 }
3600
3601 /**
3602 * @return device owner component name, only when it's running on the calling user.
3603 *
3604 * @hide
3605 */
3606 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3607 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3608 }
3609
3610 /**
3611 * @return device owner component name, even if it's running on a different user.
3612 *
3613 * <p>Requires the MANAGE_USERS permission.
3614 *
3615 * @hide
3616 */
3617 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3618 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3619 }
3620
3621 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003622 if (packageName == null) {
3623 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003624 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003625 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003626 if (deviceOwner == null) {
3627 return false;
3628 }
3629 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003630 }
3631
Makoto Onukic8a5a552015-11-19 14:29:12 -08003632 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3633 if (mService != null) {
3634 try {
3635 return mService.getDeviceOwnerComponent(callingUserOnly);
3636 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003637 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003638 }
3639 }
3640 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003641 }
3642
Jason Monkb0dced82014-06-06 14:36:20 -04003643 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003644 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3645 * no device owner.
3646 *
3647 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003648 *
3649 * @hide
3650 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003651 public int getDeviceOwnerUserId() {
3652 if (mService != null) {
3653 try {
3654 return mService.getDeviceOwnerUserId();
3655 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003656 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003657 }
3658 }
3659 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003660 }
3661
3662 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003663 * Clears the current device owner. The caller must be the device owner. This function should be
3664 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3665 * a part of device setup before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003666 *
3667 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003668 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3669 * does not own the current device owner component.
Jason Monkb0dced82014-06-06 14:36:20 -04003670 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003671 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003672 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04003673 if (mService != null) {
3674 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003675 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003676 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003677 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04003678 }
3679 }
3680 }
3681
Makoto Onukia52562c2015-10-01 16:12:31 -07003682 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003683 * Returns the device owner package name, only if it's running on the calling user.
3684 *
3685 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003686 *
3687 * @hide
3688 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003689 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003690 public String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003691 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003692 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3693 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003694 }
3695
3696 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003697 * @return true if the device is managed by any device owner.
3698 *
3699 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003700 *
3701 * @hide
3702 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003703 public boolean isDeviceManaged() {
3704 return getDeviceOwnerComponentOnAnyUser() != null;
3705 }
3706
3707 /**
3708 * Returns the device owner name. Note this method *will* return the device owner
3709 * name when it's running on a different user.
3710 *
3711 * <p>Requires the MANAGE_USERS permission.
3712 *
3713 * @hide
3714 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003715 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003716 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003717 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07003718 if (mService != null) {
3719 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003720 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003721 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003722 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003723 }
3724 }
3725 return null;
3726 }
Adam Connors776c5552014-01-09 10:42:56 +00003727
3728 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003729 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003730 * @deprecated Do not use
3731 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003732 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003733 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003734 @SystemApi
3735 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003736 return null;
3737 }
3738
3739 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003740 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003741 * @deprecated Do not use
3742 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003743 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003744 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003745 @SystemApi
3746 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003747 return null;
3748 }
3749
Julia Reynolds20118f12015-02-11 12:34:08 -05003750 /**
Adam Connors776c5552014-01-09 10:42:56 +00003751 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003752 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303753 * Sets the given component as an active admin and registers the package as the profile
3754 * owner for this user. The package must already be installed and there shouldn't be
3755 * an existing profile owner registered for this user. Also, this method must be called
3756 * before the user setup has been completed.
3757 * <p>
3758 * This method can only be called by system apps that hold MANAGE_USERS permission and
3759 * MANAGE_DEVICE_ADMINS permission.
3760 * @param admin The component to register as an active admin and profile owner.
3761 * @param ownerName The user-visible name of the entity that is managing this user.
3762 * @return whether the admin was successfully registered as the profile owner.
3763 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3764 * the user has already been set up.
3765 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003766 @Deprecated
Justin Morey80440cc2014-07-24 09:16:35 -05003767 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003768 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303769 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003770 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303771 if (mService != null) {
3772 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003773 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303774 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003775 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303776 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003777 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303778 }
3779 }
3780 return false;
3781 }
3782
3783 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003784 * Clears the active profile owner and removes all user restrictions. The caller must be from
3785 * the same package as the active profile owner for this user, otherwise a SecurityException
3786 * will be thrown.
3787 * <p>
3788 * This doesn't work for managed profile owners.
Makoto Onuki5bf68022016-01-27 13:49:19 -08003789 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003790 * @param admin The component to remove as the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003791 * @throws SecurityException if {@code admin} is not an active profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003792 */
Robin Lee25e26452015-06-02 09:56:29 -07003793 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003794 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003795 if (mService != null) {
3796 try {
3797 mService.clearProfileOwner(admin);
3798 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003799 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003800 }
3801 }
3802 }
3803
3804 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003805 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003806 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003807 */
3808 public boolean hasUserSetupCompleted() {
3809 if (mService != null) {
3810 try {
3811 return mService.hasUserSetupCompleted();
3812 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003813 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003814 }
3815 }
3816 return true;
3817 }
3818
3819 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003820 * @hide
3821 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003822 * already be installed. There must not already be a profile owner for this user.
3823 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3824 * this method.
3825 * Calling this after the setup phase of the specified user has completed is allowed only if:
3826 * - the caller is SYSTEM_UID.
3827 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003828 * @param admin the component name to be registered as profile owner.
3829 * @param ownerName the human readable name of the organisation associated with this DPM.
3830 * @param userHandle the userId to set the profile owner for.
3831 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003832 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3833 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003834 */
Robin Lee25e26452015-06-02 09:56:29 -07003835 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003836 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003837 if (mService != null) {
3838 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003839 if (ownerName == null) {
3840 ownerName = "";
3841 }
3842 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003843 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003844 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003845 }
3846 }
3847 return false;
3848 }
3849
3850 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003851 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003852 * <p>
3853 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003854 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003855 * <p>
3856 * If the device owner information contains only whitespaces then the message on the lock screen
3857 * will be blank and the user will not be allowed to change it.
3858 * <p>
3859 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003860 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3861 * and set a new version of this string accordingly.
3862 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003863 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003864 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003865 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003866 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003867 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003868 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003869 if (mService != null) {
3870 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003871 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003872 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003873 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003874 }
3875 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003876 }
3877
3878 /**
3879 * @return The device owner information. If it is not set returns {@code null}.
3880 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003881 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003882 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003883 if (mService != null) {
3884 try {
3885 return mService.getDeviceOwnerLockScreenInfo();
3886 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003887 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003888 }
3889 }
3890 return null;
3891 }
3892
3893 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003894 * Called by device or profile owners to suspend packages for this user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003895 * <p>
3896 * A suspended package will not be able to start activities. Its notifications will be hidden,
3897 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
3898 * device.
3899 * <p>
3900 * The package must already be installed. If the package is uninstalled while suspended the
3901 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00003902 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003903 *
3904 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003905 * @param packageNames The package names to suspend or unsuspend.
3906 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003907 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003908 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003909 * this method.
3910 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003911 */
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003912 public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003913 boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003914 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003915 if (mService != null) {
3916 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003917 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003918 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003919 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003920 }
3921 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003922 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003923 }
3924
3925 /**
3926 * Called by device or profile owners to determine if a package is suspended.
3927 *
3928 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3929 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00003930 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003931 * suspended, could not be found or an error occurred.
3932 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003933 * @throws NameNotFoundException if the package could not be found.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003934 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003935 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
3936 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003937 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003938 if (mService != null) {
3939 try {
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003940 return mService.isPackageSuspended(admin, packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003941 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003942 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003943 } catch (IllegalArgumentException ex) {
3944 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003945 }
3946 }
3947 return false;
3948 }
3949
3950 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003951 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3952 * be used. Only the profile owner can call this.
3953 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01003954 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003955 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003956 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003957 */
Robin Lee25e26452015-06-02 09:56:29 -07003958 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003959 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003960 if (mService != null) {
3961 try {
3962 mService.setProfileEnabled(admin);
3963 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003964 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003965 }
3966 }
3967 }
3968
3969 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003970 * Sets the name of the profile. In the device owner case it sets the name of the user which it
3971 * is called from. Only a profile owner or device owner can call this. If this is never called
3972 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003973 *
3974 * @see #isProfileOwnerApp
3975 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07003976 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003977 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003978 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003979 */
Robin Lee25e26452015-06-02 09:56:29 -07003980 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003981 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01003982 if (mService != null) {
3983 try {
Robin Lee25e26452015-06-02 09:56:29 -07003984 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003985 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003986 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003987 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003988 }
3989 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003990
3991 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003992 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08003993 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003994 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00003995 *
3996 * @param packageName The package name of the app to compare with the registered profile owner.
3997 * @return Whether or not the package is registered as the profile owner.
3998 */
3999 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004000 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00004001 if (mService != null) {
4002 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08004003 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01004004 return profileOwner != null
4005 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004006 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004007 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004008 }
4009 }
4010 return false;
4011 }
4012
4013 /**
4014 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004015 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004016 * owner has been set for that user.
4017 * @throws IllegalArgumentException if the userId is invalid.
4018 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004019 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004020 public ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004021 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004022 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4023 }
4024
4025 /**
4026 * @see #getProfileOwner()
4027 * @hide
4028 */
4029 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004030 if (mService != null) {
4031 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004032 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00004033 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004034 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004035 }
4036 }
4037 return null;
4038 }
4039
4040 /**
4041 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004042 * @return the human readable name of the organisation associated with this DPM or {@code null}
4043 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00004044 * @throws IllegalArgumentException if the userId is invalid.
4045 */
4046 public String getProfileOwnerName() throws IllegalArgumentException {
4047 if (mService != null) {
4048 try {
4049 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4050 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004051 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004052 }
4053 }
4054 return null;
4055 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004056
4057 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07004058 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08004059 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07004060 * @return the human readable name of the organisation associated with this profile owner or
4061 * null if one is not set.
4062 * @throws IllegalArgumentException if the userId is invalid.
4063 */
4064 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02004065 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004066 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07004067 if (mService != null) {
4068 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02004069 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07004070 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004071 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07004072 }
4073 }
4074 return null;
4075 }
4076
4077 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004078 * Called by a profile owner or device owner to add a default intent handler activity for
4079 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004080 * handler even if the set of potential event handlers for the intent filter changes and if the
4081 * intent preferences are reset.
4082 * <p>
4083 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
4084 * When the activity is (re)installed, it is automatically reset as default intent handler for
4085 * the filter.
4086 * <p>
4087 * The calling device admin must be a profile owner or device owner. If it is not, a security
4088 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004089 *
4090 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4091 * @param filter The IntentFilter for which a default handler is added.
4092 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004093 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004094 */
Robin Lee25e26452015-06-02 09:56:29 -07004095 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
4096 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004097 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004098 if (mService != null) {
4099 try {
4100 mService.addPersistentPreferredActivity(admin, filter, activity);
4101 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004102 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004103 }
4104 }
4105 }
4106
4107 /**
4108 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00004109 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004110 * <p>
4111 * The calling device admin must be a profile owner. If it is not, a security exception will be
4112 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004113 *
4114 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4115 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004116 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004117 */
Robin Lee25e26452015-06-02 09:56:29 -07004118 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004119 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004120 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004121 if (mService != null) {
4122 try {
4123 mService.clearPackagePersistentPreferredActivities(admin, packageName);
4124 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004125 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004126 }
4127 }
4128 }
Robin Lee66e5d962014-04-09 16:44:21 +01004129
4130 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004131 * Called by a profile owner or device owner to grant permission to a package to manage
4132 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4133 * {@link #getApplicationRestrictions}.
4134 * <p>
4135 * This permission is persistent until it is later cleared by calling this method with a
4136 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00004137 * <p>
4138 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00004139 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004140 *
4141 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4142 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004143 * APIs. If {@code null} is given the current package will be cleared.
4144 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00004145 * @throws NameNotFoundException if {@code packageName} is not found
Esteban Talaverabf60f722015-12-10 16:26:44 +00004146 */
4147 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00004148 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004149 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004150 if (mService != null) {
4151 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00004152 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4153 throw new NameNotFoundException(packageName);
4154 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00004155 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004156 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004157 }
4158 }
4159 }
4160
4161 /**
4162 * Called by a profile owner or device owner to retrieve the application restrictions managing
4163 * package for the current user, or {@code null} if none is set.
4164 *
4165 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4166 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004167 * {@code null} if none is set.
4168 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004169 */
4170 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004171 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004172 if (mService != null) {
4173 try {
4174 return mService.getApplicationRestrictionsManagingPackage(admin);
4175 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004176 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004177 }
4178 }
4179 return null;
4180 }
4181
4182 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00004183 * Called by any application to find out whether it has been granted permission via
4184 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4185 * for the calling user.
4186 *
4187 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4188 * that method.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004189 */
4190 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004191 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004192 if (mService != null) {
4193 try {
4194 return mService.isCallerApplicationRestrictionsManagingPackage();
4195 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004196 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004197 }
4198 }
4199 return false;
4200 }
4201
4202 /**
4203 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004204 * <p>
4205 * The caller must be a profile or device owner on that user, or the package allowed to manage
4206 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4207 * security exception will be thrown.
4208 * <p>
4209 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01004210 * <ul>
4211 * <li>{@code boolean}
4212 * <li>{@code int}
4213 * <li>{@code String} or {@code String[]}
4214 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4215 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004216 * <p>
4217 * If the restrictions are not available yet, but may be applied in the near future, the caller
4218 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004219 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004220 * <p>
4221 * The application restrictions are only made visible to the target application via
4222 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4223 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00004224 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01004225 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07004226 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
4227 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004228 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004229 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004230 * @param packageName The name of the package to update restricted settings for.
4231 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004232 * set of active restrictions.
4233 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004234 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004235 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01004236 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07004237 @WorkerThread
Esteban Talaverabf60f722015-12-10 16:26:44 +00004238 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01004239 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004240 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004241 if (mService != null) {
4242 try {
4243 mService.setApplicationRestrictions(admin, packageName, settings);
4244 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004245 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004246 }
4247 }
4248 }
4249
4250 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004251 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4252 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4253 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07004254 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004255 * <p>
4256 * The calling device admin must have requested
4257 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4258 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01004259 * <p>
4260 * This method can be called on the {@link DevicePolicyManager} instance returned by
4261 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
4262 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004263 *
4264 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004265 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004266 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4267 * strictly disabled according to the state of the
4268 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4269 * <p>
4270 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4271 * admins, then it's up to the TrustAgent itself to aggregate the values from all
4272 * device admins.
4273 * <p>
4274 * Consult documentation for the specific TrustAgent to determine legal options
4275 * parameters.
4276 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4277 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07004278 */
Robin Lee25e26452015-06-02 09:56:29 -07004279 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4280 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004281 if (mService != null) {
4282 try {
Tony Mak089d8402016-04-05 17:42:55 +01004283 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004284 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004285 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004286 }
4287 }
4288 }
4289
4290 /**
Jim Millere303bf42014-08-26 17:12:29 -07004291 * Gets configuration for the given trust agent based on aggregating all calls to
4292 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4293 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01004294 * <p>
4295 * This method can be called on the {@link DevicePolicyManager} instance returned by
4296 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
4297 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004298 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004299 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4300 * this function returns a list of configurations for all admins that declare
4301 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4302 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4303 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4304 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004305 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004306 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004307 */
Robin Lee25e26452015-06-02 09:56:29 -07004308 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4309 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004310 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004311 }
4312
4313 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004314 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4315 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004316 if (mService != null) {
4317 try {
Tony Mak089d8402016-04-05 17:42:55 +01004318 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
4319 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004320 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004321 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004322 }
4323 }
Jim Millere303bf42014-08-26 17:12:29 -07004324 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004325 }
4326
4327 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004328 * Called by a profile owner of a managed profile to set whether caller-Id information from the
4329 * managed profile will be shown in the parent profile, for incoming calls.
4330 * <p>
4331 * The calling device admin must be a profile owner. If it is not, a security exception will be
4332 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004333 *
Robin Lee25e26452015-06-02 09:56:29 -07004334 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004335 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004336 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004337 */
Robin Lee25e26452015-06-02 09:56:29 -07004338 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004339 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004340 if (mService != null) {
4341 try {
Robin Lee25e26452015-06-02 09:56:29 -07004342 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004343 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004344 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004345 }
4346 }
4347 }
4348
4349 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004350 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4351 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004352 * <p>
4353 * The calling device admin must be a profile owner. If it is not, a security exception will be
4354 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004355 *
Robin Lee25e26452015-06-02 09:56:29 -07004356 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004357 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004358 */
Robin Lee25e26452015-06-02 09:56:29 -07004359 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004360 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004361 if (mService != null) {
4362 try {
Robin Lee25e26452015-06-02 09:56:29 -07004363 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004364 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004365 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004366 }
4367 }
4368 return false;
4369 }
4370
4371 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004372 * Determine whether or not caller-Id information has been disabled.
4373 *
4374 * @param userHandle The user for whom to check the caller-id permission
4375 * @hide
4376 */
4377 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4378 if (mService != null) {
4379 try {
4380 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4381 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004382 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07004383 }
4384 }
4385 return false;
4386 }
4387
4388 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004389 * Called by a profile owner of a managed profile to set whether contacts search from the
4390 * managed profile will be shown in the parent profile, for incoming calls.
4391 * <p>
4392 * The calling device admin must be a profile owner. If it is not, a security exception will be
4393 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004394 *
4395 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4396 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004397 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004398 */
4399 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4400 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004401 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004402 if (mService != null) {
4403 try {
4404 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4405 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004406 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004407 }
4408 }
4409 }
4410
4411 /**
4412 * Called by a profile owner of a managed profile to determine whether or not contacts search
4413 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004414 * <p>
4415 * The calling device admin must be a profile owner. If it is not, a security exception will be
4416 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004417 *
4418 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004419 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004420 */
4421 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004422 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004423 if (mService != null) {
4424 try {
4425 return mService.getCrossProfileContactsSearchDisabled(admin);
4426 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004427 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004428 }
4429 }
4430 return false;
4431 }
4432
4433
4434 /**
4435 * Determine whether or not contacts search has been disabled.
4436 *
4437 * @param userHandle The user for whom to check the contacts search permission
4438 * @hide
4439 */
4440 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4441 if (mService != null) {
4442 try {
4443 return mService
4444 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4445 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004446 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004447 }
4448 }
4449 return false;
4450 }
4451
4452 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004453 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004454 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004455 * @hide
4456 */
4457 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004458 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004459 if (mService != null) {
4460 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004461 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4462 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004463 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004464 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07004465 }
4466 }
4467 }
4468
4469 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004470 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004471 * @hide
4472 */
4473 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4474 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004475 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004476 originalIntent);
4477 }
4478
4479 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004480 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4481 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004482 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004483 * The calling device admin must be a profile owner. If it is not, a security exception will be
4484 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004485 * <p>
4486 * This API works on managed profile only.
4487 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004488 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4489 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4490 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004491 */
Robin Lee25e26452015-06-02 09:56:29 -07004492 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004493 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004494 if (mService != null) {
4495 try {
Robin Lee25e26452015-06-02 09:56:29 -07004496 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004497 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004498 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004499 }
4500 }
4501 }
4502
4503 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004504 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4505 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004506 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004507 * The calling device admin must be a profile owner. If it is not, a security exception will be
4508 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004509 * <p>
4510 * This API works on managed profile only.
4511 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004512 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4513 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004514 */
Robin Lee25e26452015-06-02 09:56:29 -07004515 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004516 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004517 if (mService != null) {
4518 try {
Robin Lee25e26452015-06-02 09:56:29 -07004519 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004520 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004521 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004522 }
4523 }
4524 return true;
4525 }
4526
4527 /**
4528 * Determine whether or not Bluetooth devices cannot access contacts.
4529 * <p>
4530 * This API works on managed profile UserHandle only.
4531 *
4532 * @param userHandle The user for whom to check the caller-id permission
4533 * @hide
4534 */
4535 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4536 if (mService != null) {
4537 try {
4538 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4539 .getIdentifier());
4540 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004541 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004542 }
4543 }
4544 return true;
4545 }
4546
4547 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004548 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004549 * profile can also be resolved in the parent, or vice versa. Only activity intents are
4550 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004551 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004552 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004553 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004554 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004555 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004556 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4557 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004558 */
Robin Lee25e26452015-06-02 09:56:29 -07004559 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004560 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004561 if (mService != null) {
4562 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004563 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004564 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004565 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004566 }
4567 }
4568 }
4569
4570 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004571 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4572 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004573 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004574 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004575 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004576 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004577 */
Robin Lee25e26452015-06-02 09:56:29 -07004578 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004579 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004580 if (mService != null) {
4581 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004582 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004583 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004584 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004585 }
4586 }
4587 }
4588
4589 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004590 * Called by a profile or device owner to set the permitted accessibility services. When set by
4591 * a device owner or profile owner the restriction applies to all profiles of the user the
4592 * device owner or profile owner is an admin for. By default the user can use any accessiblity
4593 * service. When zero or more packages have been added, accessiblity services that are not in
4594 * the list and not part of the system can not be enabled by the user.
4595 * <p>
4596 * Calling with a null value for the list disables the restriction so that all services can be
4597 * used, calling with an empty list only allows the builtin system's services.
4598 * <p>
4599 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004600 *
4601 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4602 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004603 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4604 * accessibility services enabled, that are not in the list.
4605 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004606 */
Robin Lee25e26452015-06-02 09:56:29 -07004607 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004608 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004609 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004610 if (mService != null) {
4611 try {
4612 return mService.setPermittedAccessibilityServices(admin, packageNames);
4613 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004614 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004615 }
4616 }
4617 return false;
4618 }
4619
4620 /**
4621 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004622 * <p>
4623 * An empty list means no accessibility services except system services are allowed. Null means
4624 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004625 *
4626 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4627 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004628 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004629 */
Robin Lee25e26452015-06-02 09:56:29 -07004630 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004631 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004632 if (mService != null) {
4633 try {
4634 return mService.getPermittedAccessibilityServices(admin);
4635 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004636 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004637 }
4638 }
4639 return null;
4640 }
4641
4642 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004643 * Called by the system to check if a specific accessibility service is disabled by admin.
4644 *
4645 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4646 * @param packageName Accessibility service package name that needs to be checked.
4647 * @param userHandle user id the admin is running as.
4648 * @return true if the accessibility service is permitted, otherwise false.
4649 *
4650 * @hide
4651 */
4652 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4653 @NonNull String packageName, int userHandle) {
4654 if (mService != null) {
4655 try {
4656 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4657 userHandle);
4658 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004659 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004660 }
4661 }
4662 return false;
4663 }
4664
4665 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004666 * Returns the list of accessibility services permitted by the device or profiles
4667 * owners of this user.
4668 *
4669 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4670 * it will contain the intersection of the permitted lists for any device or profile
4671 * owners that apply to this user. It will also include any system accessibility services.
4672 *
4673 * @param userId which user to check for.
4674 * @return List of accessiblity service package names.
4675 * @hide
4676 */
4677 @SystemApi
4678 public List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004679 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004680 if (mService != null) {
4681 try {
4682 return mService.getPermittedAccessibilityServicesForUser(userId);
4683 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004684 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004685 }
4686 }
4687 return null;
4688 }
4689
4690 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004691 * Called by a profile or device owner to set the permitted input methods services. When set by
4692 * a device owner or profile owner the restriction applies to all profiles of the user the
4693 * device owner or profile owner is an admin for. By default the user can use any input method.
4694 * When zero or more packages have been added, input method that are not in the list and not
4695 * part of the system can not be enabled by the user. This method will fail if it is called for
4696 * a admin that is not for the foreground user or a profile of the foreground user.
4697 * <p>
4698 * Calling with a null value for the list disables the restriction so that all input methods can
4699 * be used, calling with an empty list disables all but the system's own input methods.
4700 * <p>
4701 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004702 *
4703 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4704 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004705 * @return true if setting the restriction succeeded. It will fail if there are one or more
4706 * non-system input methods currently enabled that are not in the packageNames list.
4707 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004708 */
Robin Lee25e26452015-06-02 09:56:29 -07004709 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004710 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004711 if (mService != null) {
4712 try {
4713 return mService.setPermittedInputMethods(admin, packageNames);
4714 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004715 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004716 }
4717 }
4718 return false;
4719 }
4720
4721
4722 /**
4723 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004724 * <p>
4725 * An empty list means no input methods except system input methods are allowed. Null means all
4726 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004727 *
4728 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4729 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004730 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004731 */
Robin Lee25e26452015-06-02 09:56:29 -07004732 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004733 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004734 if (mService != null) {
4735 try {
4736 return mService.getPermittedInputMethods(admin);
4737 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004738 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004739 }
4740 }
4741 return null;
4742 }
4743
4744 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004745 * Called by the system to check if a specific input method is disabled by admin.
4746 *
4747 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4748 * @param packageName Input method package name that needs to be checked.
4749 * @param userHandle user id the admin is running as.
4750 * @return true if the input method is permitted, otherwise false.
4751 *
4752 * @hide
4753 */
4754 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4755 @NonNull String packageName, int userHandle) {
4756 if (mService != null) {
4757 try {
4758 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4759 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004760 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004761 }
4762 }
4763 return false;
4764 }
4765
4766 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004767 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004768 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004769 *
4770 * <p>Null means all input methods are allowed, if a non-null list is returned
4771 * it will contain the intersection of the permitted lists for any device or profile
4772 * owners that apply to this user. It will also include any system input methods.
4773 *
4774 * @return List of input method package names.
4775 * @hide
4776 */
4777 @SystemApi
4778 public List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004779 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004780 if (mService != null) {
4781 try {
4782 return mService.getPermittedInputMethodsForCurrentUser();
4783 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004784 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004785 }
4786 }
4787 return null;
4788 }
4789
4790 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004791 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4792 * currently installed it.
4793 *
4794 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4795 *
4796 * @return List of package names to keep cached.
4797 * @hide
4798 */
4799 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004800 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004801 if (mService != null) {
4802 try {
4803 return mService.getKeepUninstalledPackages(admin);
4804 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004805 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004806 }
4807 }
4808 return null;
4809 }
4810
4811 /**
4812 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4813 * currently installed it.
4814 *
4815 * <p>Please note that setting this policy does not imply that specified apps will be
4816 * automatically pre-cached.</p>
4817 *
4818 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4819 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004820 * @throws SecurityException if {@code admin} is not a device owner.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004821 * @hide
4822 */
4823 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4824 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004825 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004826 if (mService != null) {
4827 try {
4828 mService.setKeepUninstalledPackages(admin, packageNames);
4829 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004830 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004831 }
4832 }
4833 }
4834
4835 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004836 * Called by a device owner to create a user with the specified name. The UserHandle returned
4837 * by this method should not be persisted as user handles are recycled as users are removed and
4838 * created. If you need to persist an identifier for this user, use
4839 * {@link UserManager#getSerialNumberForUser}.
4840 *
4841 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4842 * @param name the user's name
4843 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004844 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4845 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004846 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004847 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004848 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004849 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004850 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004851 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004852 return null;
4853 }
4854
4855 /**
Jason Monk03978a42014-06-10 15:05:30 -04004856 * Called by a device owner to create a user with the specified name. The UserHandle returned
4857 * by this method should not be persisted as user handles are recycled as users are removed and
4858 * created. If you need to persist an identifier for this user, use
4859 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4860 * immediately.
4861 *
4862 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4863 * as registered as an active admin on the new user. The profile owner package will be
4864 * installed on the new user if it already is installed on the device.
4865 *
4866 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4867 * profileOwnerComponent when onEnable is called.
4868 *
4869 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4870 * @param name the user's name
4871 * @param ownerName the human readable name of the organisation associated with this DPM.
4872 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4873 * the user.
4874 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4875 * on the new user.
4876 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004877 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4878 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004879 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004880 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004881 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04004882 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004883 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004884 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4885 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004886 return null;
4887 }
4888
4889 /**
phweissa92e1212016-01-25 17:14:10 +01004890 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01004891 */
4892 public static final int SKIP_SETUP_WIZARD = 0x0001;
4893
4894 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01004895 * Flag used by {@link #createAndManageUser} to specify that the user should be created
4896 * ephemeral.
4897 * @hide
4898 */
4899 public static final int MAKE_USER_EPHEMERAL = 0x0002;
4900
4901 /**
phweissa92e1212016-01-25 17:14:10 +01004902 * Called by a device owner to create a user with the specified name and a given component of
4903 * the calling package as profile owner. The UserHandle returned by this method should not be
4904 * persisted as user handles are recycled as users are removed and created. If you need to
4905 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4906 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004907 * <p>
4908 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
4909 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
4910 * be registered as an active admin on the new user. The profile owner package will be installed
4911 * on the new user.
4912 * <p>
4913 * If the adminExtras are not null, they will be stored on the device until the user is started
4914 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01004915 *
4916 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4917 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01004918 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004919 * same package as admin, otherwise no user is created and an
4920 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01004921 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004922 * user.
phweissa92e1212016-01-25 17:14:10 +01004923 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01004924 * @see UserHandle
4925 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4926 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004927 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01004928 */
4929 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01004930 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4931 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004932 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01004933 try {
phweissa92e1212016-01-25 17:14:10 +01004934 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01004935 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004936 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01004937 }
phweiss343fb332016-01-25 14:48:59 +01004938 }
4939
4940 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004941 * Called by a device owner to remove a user and all associated data. The primary user can not
4942 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04004943 *
4944 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4945 * @param userHandle the user to remove.
4946 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004947 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04004948 */
Robin Lee25e26452015-06-02 09:56:29 -07004949 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004950 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04004951 try {
4952 return mService.removeUser(admin, userHandle);
4953 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004954 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04004955 }
4956 }
4957
4958 /**
Jason Monk582d9112014-07-09 19:57:08 -04004959 * Called by a device owner to switch the specified user to the foreground.
4960 *
4961 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4962 * @param userHandle the user to switch to; null will switch to primary.
4963 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004964 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04004965 * @see Intent#ACTION_USER_FOREGROUND
4966 */
Robin Lee25e26452015-06-02 09:56:29 -07004967 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004968 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04004969 try {
4970 return mService.switchUser(admin, userHandle);
4971 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004972 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04004973 }
4974 }
4975
4976 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004977 * Retrieves the application restrictions for a given target application running in the calling
4978 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004979 * <p>
4980 * The caller must be a profile or device owner on that user, or the package allowed to manage
4981 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4982 * security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01004983 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07004984 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
4985 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004986 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004987 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004988 * @param packageName The name of the package to fetch restricted settings of.
4989 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004990 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
4991 * {@link Bundle} if no restrictions have been set.
4992 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004993 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01004994 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07004995 @WorkerThread
Esteban Talaverabf60f722015-12-10 16:26:44 +00004996 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004997 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004998 if (mService != null) {
4999 try {
5000 return mService.getApplicationRestrictions(admin, packageName);
5001 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005002 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01005003 }
5004 }
5005 return null;
5006 }
Amith Yamasanibe465322014-04-24 13:45:17 -07005007
5008 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005009 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005010 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005011 * The calling device admin must be a profile or device owner; if it is not, a security
5012 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005013 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005014 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5015 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5016 * for the list of keys.
5017 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005018 */
Robin Lee25e26452015-06-02 09:56:29 -07005019 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005020 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005021 if (mService != null) {
5022 try {
5023 mService.setUserRestriction(admin, key, true);
5024 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005025 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005026 }
5027 }
5028 }
5029
5030 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005031 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005032 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005033 * The calling device admin must be a profile or device owner; if it is not, a security
5034 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005035 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005036 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5037 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5038 * for the list of keys.
5039 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005040 */
Robin Lee25e26452015-06-02 09:56:29 -07005041 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005042 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005043 if (mService != null) {
5044 try {
5045 mService.setUserRestriction(admin, key, false);
5046 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005047 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005048 }
5049 }
5050 }
Adam Connors010cfd42014-04-16 12:48:13 +01005051
5052 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005053 * Called by a profile or device owner to get user restrictions set with
5054 * {@link #addUserRestriction(ComponentName, String)}.
5055 * <p>
5056 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005057 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005058 * {@link UserManager#getUserRestrictions()}.
5059 *
5060 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005061 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005062 */
5063 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005064 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005065 Bundle ret = null;
5066 if (mService != null) {
5067 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07005068 ret = mService.getUserRestrictions(admin);
5069 } catch (RemoteException e) {
5070 throw e.rethrowFromSystemServer();
5071 }
5072 }
5073 return ret == null ? new Bundle() : ret;
5074 }
5075
5076 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005077 * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
5078 * unavailable for use, but the data and actual package file remain.
Julia Reynolds966881e2014-05-14 12:23:08 -04005079 *
5080 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005081 * @param packageName The name of the package to hide or unhide.
5082 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005083 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005084 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005085 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005086 */
Robin Lee25e26452015-06-02 09:56:29 -07005087 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005088 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005089 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005090 if (mService != null) {
5091 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005092 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04005093 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005094 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005095 }
5096 }
5097 return false;
5098 }
5099
5100 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005101 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04005102 *
5103 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005104 * @param packageName The name of the package to retrieve the hidden status of.
5105 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005106 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005107 */
Robin Lee25e26452015-06-02 09:56:29 -07005108 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005109 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005110 if (mService != null) {
5111 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005112 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04005113 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005114 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005115 }
5116 }
5117 return false;
5118 }
5119
5120 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005121 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005122 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005123 *
5124 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08005125 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005126 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005127 */
Robin Lee25e26452015-06-02 09:56:29 -07005128 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005129 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005130 if (mService != null) {
5131 try {
5132 mService.enableSystemApp(admin, packageName);
5133 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005134 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005135 }
5136 }
5137 }
5138
5139 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005140 * Called by profile or device owners to re-enable system apps by intent that were disabled by
5141 * default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005142 *
5143 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5144 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005145 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00005146 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005147 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005148 */
Robin Lee25e26452015-06-02 09:56:29 -07005149 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005150 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005151 if (mService != null) {
5152 try {
5153 return mService.enableSystemAppWithIntent(admin, intent);
5154 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005155 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005156 }
5157 }
5158 return 0;
5159 }
5160
5161 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00005162 * Called by a device owner or profile owner to disable account management for a specific type
5163 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005164 * <p>
5165 * The calling device admin must be a device owner or profile owner. If it is not, a security
5166 * exception will be thrown.
5167 * <p>
5168 * When account management is disabled for an account type, adding or removing an account of
5169 * that type will not be possible.
5170 * <p>
5171 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00005172 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5173 * management for a specific type is disabled.
5174 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01005175 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5176 * @param accountType For which account management is disabled or enabled.
5177 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005178 * enabled (false).
5179 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01005180 */
Robin Lee25e26452015-06-02 09:56:29 -07005181 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01005182 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005183 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01005184 if (mService != null) {
5185 try {
5186 mService.setAccountManagementDisabled(admin, accountType, disabled);
5187 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005188 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01005189 }
5190 }
5191 }
5192
5193 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005194 * Gets the array of accounts for which account management is disabled by the profile owner.
5195 *
5196 * <p> Account management can be disabled/enabled by calling
5197 * {@link #setAccountManagementDisabled}.
5198 *
5199 * @return a list of account types for which account management has been disabled.
5200 *
5201 * @see #setAccountManagementDisabled
5202 */
5203 public String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005204 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005205 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005206 }
5207
5208 /**
5209 * @see #getAccountTypesWithManagementDisabled()
5210 * @hide
5211 */
5212 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005213 if (mService != null) {
5214 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005215 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005216 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005217 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005218 }
5219 }
5220
5221 return null;
5222 }
justinzhang511e0d82014-03-24 16:09:24 -04005223
5224 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005225 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005226 * <p>
5227 * Any packages that shares uid with an allowed package will also be allowed to activate lock
5228 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5229 * package list results in locked tasks belonging to those packages to be finished. This
5230 * function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005231 *
Jason Monkd7b86212014-06-16 13:15:38 -04005232 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04005233 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005234 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005235 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00005236 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5237 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04005238 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04005239 */
Robin Lee25e26452015-06-02 09:56:29 -07005240 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04005241 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005242 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005243 if (mService != null) {
5244 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005245 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04005246 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005247 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005248 }
5249 }
5250 }
5251
5252 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005253 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04005254 *
5255 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04005256 * @hide
5257 */
Robin Lee25e26452015-06-02 09:56:29 -07005258 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005259 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005260 if (mService != null) {
5261 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005262 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04005263 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005264 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005265 }
5266 }
5267 return null;
5268 }
5269
5270 /**
5271 * This function lets the caller know whether the given component is allowed to start the
5272 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04005273 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04005274 */
Jason Monkd7b86212014-06-16 13:15:38 -04005275 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005276 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04005277 if (mService != null) {
5278 try {
Jason Monkd7b86212014-06-16 13:15:38 -04005279 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04005280 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005281 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005282 }
5283 }
5284 return false;
5285 }
Julia Reynoldsda551652014-05-14 17:15:16 -04005286
5287 /**
5288 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5289 * 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 -07005290 * <p>
5291 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005292 * <ul>
5293 * <li>{@link Settings.Global#ADB_ENABLED}</li>
5294 * <li>{@link Settings.Global#AUTO_TIME}</li>
5295 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005296 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005297 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005298 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005299 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5300 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5301 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5302 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5303 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005304 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005305 * <p>
5306 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005307 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005308 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5309 * {@link android.bluetooth.BluetoothAdapter#enable()} and
5310 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005311 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005312 * <li>{@link Settings.Global#MODE_RINGER}. Use
5313 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005314 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005315 * <li>{@link Settings.Global#WIFI_ON}. Use
5316 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005317 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005318 *
5319 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5320 * @param setting The name of the setting to update.
5321 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005322 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005323 */
Robin Lee25e26452015-06-02 09:56:29 -07005324 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005325 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005326 if (mService != null) {
5327 try {
5328 mService.setGlobalSetting(admin, setting, value);
5329 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005330 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005331 }
5332 }
5333 }
5334
5335 /**
5336 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5337 * that the value of the setting is in the correct form for the setting type should be performed
5338 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005339 * <p>
5340 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005341 * <ul>
5342 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005343 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005344 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5345 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005346 * <p>
5347 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04005348 * <ul>
5349 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5350 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005351 *
Julia Reynoldsda551652014-05-14 17:15:16 -04005352 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5353 * @param setting The name of the setting to update.
5354 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005355 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005356 */
Robin Lee25e26452015-06-02 09:56:29 -07005357 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005358 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005359 if (mService != null) {
5360 try {
5361 mService.setSecureSetting(admin, setting, value);
5362 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005363 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005364 }
5365 }
5366 }
5367
Amith Yamasanif20d6402014-05-24 15:34:37 -07005368 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005369 * Designates a specific service component as the provider for making permission requests of a
5370 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005371 * <p/>
5372 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005373 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07005374 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005375 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005376 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5377 * provider previously assigned.
5378 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005379 */
Robin Lee25e26452015-06-02 09:56:29 -07005380 public void setRestrictionsProvider(@NonNull ComponentName admin,
5381 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005382 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07005383 if (mService != null) {
5384 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005385 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005386 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005387 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07005388 }
5389 }
5390 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005391
5392 /**
5393 * Called by profile or device owners to set the master volume mute on or off.
5394 *
5395 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5396 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005397 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005398 */
Robin Lee25e26452015-06-02 09:56:29 -07005399 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005400 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005401 if (mService != null) {
5402 try {
5403 mService.setMasterVolumeMuted(admin, on);
5404 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005405 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005406 }
5407 }
5408 }
5409
5410 /**
5411 * Called by profile or device owners to check whether the master volume mute is on or off.
5412 *
5413 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5414 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005415 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005416 */
Robin Lee25e26452015-06-02 09:56:29 -07005417 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005418 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005419 if (mService != null) {
5420 try {
5421 return mService.isMasterVolumeMuted(admin);
5422 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005423 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005424 }
5425 }
5426 return false;
5427 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005428
5429 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005430 * Called by profile or device owners to change whether a user can uninstall a package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005431 *
5432 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5433 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005434 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005435 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005436 */
Robin Lee25e26452015-06-02 09:56:29 -07005437 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005438 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005439 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005440 if (mService != null) {
5441 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005442 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005443 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005444 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005445 }
5446 }
5447 }
5448
5449 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005450 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005451 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005452 * <p>
5453 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005454 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5455 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5456 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005457 *
Robin Lee25e26452015-06-02 09:56:29 -07005458 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005459 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005460 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005461 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005462 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005463 */
Robin Lee25e26452015-06-02 09:56:29 -07005464 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005465 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005466 if (mService != null) {
5467 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005468 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005469 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005470 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005471 }
5472 }
5473 return false;
5474 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005475
5476 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005477 * Called by the profile owner of a managed profile to enable widget providers from a given
5478 * package to be available in the parent profile. As a result the user will be able to add
5479 * widgets from the white-listed package running under the profile to a widget host which runs
5480 * under the parent profile, for example the home screen. Note that a package may have zero or
5481 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07005482 * <p>
5483 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005484 *
5485 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5486 * @param packageName The package from which widget providers are white-listed.
5487 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005488 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005489 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5490 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5491 */
Robin Lee25e26452015-06-02 09:56:29 -07005492 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005493 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005494 if (mService != null) {
5495 try {
5496 return mService.addCrossProfileWidgetProvider(admin, packageName);
5497 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005498 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005499 }
5500 }
5501 return false;
5502 }
5503
5504 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005505 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005506 * package to be available in the parent profile. For this method to take effect the package
5507 * should have been added via
5508 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07005509 * <p>
5510 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005511 *
5512 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005513 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005514 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005515 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005516 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5517 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5518 */
Esteban Talavera62399912016-01-11 15:37:55 +00005519 public boolean removeCrossProfileWidgetProvider(
5520 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005521 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005522 if (mService != null) {
5523 try {
5524 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5525 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005526 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005527 }
5528 }
5529 return false;
5530 }
5531
5532 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005533 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005534 * available in the parent profile.
5535 *
5536 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5537 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07005538 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5539 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005540 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005541 */
Robin Lee25e26452015-06-02 09:56:29 -07005542 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005543 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07005544 if (mService != null) {
5545 try {
5546 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5547 if (providers != null) {
5548 return providers;
5549 }
5550 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005551 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005552 }
5553 }
5554 return Collections.emptyList();
5555 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005556
5557 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005558 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005559 *
5560 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5561 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005562 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005563 */
Robin Lee25e26452015-06-02 09:56:29 -07005564 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005565 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005566 try {
5567 mService.setUserIcon(admin, icon);
5568 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005569 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005570 }
5571 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005572
5573 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005574 * Called by device owners to set a local system update policy. When a new policy is set,
5575 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005576 *
Robin Lee25e26452015-06-02 09:56:29 -07005577 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005578 * components in the device owner package can set system update policies and the most
5579 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07005580 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005581 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005582 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005583 */
Robin Lee25e26452015-06-02 09:56:29 -07005584 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005585 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005586 if (mService != null) {
5587 try {
Robin Lee25e26452015-06-02 09:56:29 -07005588 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005589 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005590 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005591 }
5592 }
5593 }
5594
5595 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005596 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005597 *
Robin Lee25e26452015-06-02 09:56:29 -07005598 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005599 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01005600 public SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005601 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005602 if (mService != null) {
5603 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005604 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005605 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005606 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005607 }
5608 }
5609 return null;
5610 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005611
5612 /**
5613 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005614 * <p>
5615 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5616 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5617 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5618 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01005619 *
5620 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005621 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005622 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005623 * place. {@code true} otherwise.
5624 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01005625 */
Robin Lee25e26452015-06-02 09:56:29 -07005626 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005627 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01005628 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005629 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005630 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005631 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01005632 }
5633 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005634
5635 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005636 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005637 * notifications, quick settings and other screen overlays that allow escaping from a single use
5638 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005639 *
5640 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005641 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005642 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5643 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005644 */
Robin Lee25e26452015-06-02 09:56:29 -07005645 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005646 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00005647 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005648 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005649 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005650 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00005651 }
5652 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005653
5654 /**
5655 * Callable by the system update service to notify device owners about pending updates.
5656 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5657 * permission.
5658 *
5659 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5660 * when the current pending update was first available. -1 if no update is available.
5661 * @hide
5662 */
5663 @SystemApi
5664 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005665 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01005666 if (mService != null) {
5667 try {
5668 mService.notifyPendingSystemUpdate(updateReceivedTime);
5669 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005670 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01005671 }
5672 }
5673 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005674
5675 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005676 * Called by profile or device owners to set the default response for future runtime permission
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005677 * requests by applications. The policy can allow for normal operation which prompts the user to
5678 * grant a permission, or can allow automatic granting or denying of runtime permission requests
5679 * by an application. This also applies to new permissions declared by app updates. When a
5680 * permission is denied or granted this way, the effect is equivalent to setting the permission
5681 * grant state via {@link #setPermissionGrantState}.
5682 * <p/>
5683 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005684 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005685 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005686 * @param admin Which profile or device owner this request is associated with.
5687 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005688 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5689 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005690 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005691 */
Robin Lee25e26452015-06-02 09:56:29 -07005692 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005693 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005694 try {
5695 mService.setPermissionPolicy(admin, policy);
5696 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005697 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005698 }
5699 }
5700
5701 /**
5702 * Returns the current runtime permission policy set by the device or profile owner. The
5703 * default is {@link #PERMISSION_POLICY_PROMPT}.
5704 * @param admin Which profile or device owner this request is associated with.
5705 * @return the current policy for future permission requests.
5706 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005707 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005708 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005709 try {
5710 return mService.getPermissionPolicy(admin);
5711 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005712 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005713 }
5714 }
5715
5716 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005717 * Sets the grant state of a runtime permission for a specific application. The state can be
5718 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5719 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5720 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5721 * the permission is granted and the user cannot manage it through the UI. This might affect all
5722 * permissions in a group that the runtime permission belongs to. This method can only be called
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005723 * by a profile or device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005724 * <p/>
5725 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5726 * the permission. It retains the previous grant, if any.
5727 * <p/>
5728 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005729 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005730 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005731 * @param admin Which profile or device owner this request is associated with.
5732 * @param packageName The application to grant or revoke a permission to.
5733 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005734 * @param grantState The permission grant state which is one of
5735 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5736 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005737 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005738 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005739 * @see #PERMISSION_GRANT_STATE_DENIED
5740 * @see #PERMISSION_GRANT_STATE_DEFAULT
5741 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005742 */
Robin Lee25e26452015-06-02 09:56:29 -07005743 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005744 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005745 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005746 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005747 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005748 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005749 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005750 }
5751 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005752
5753 /**
5754 * Returns the current grant state of a runtime permission for a specific application.
5755 *
5756 * @param admin Which profile or device owner this request is associated with.
5757 * @param packageName The application to check the grant state for.
5758 * @param permission The permission to check for.
5759 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005760 * has not set a grant state, the return value is
5761 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5762 * permission is currently granted for the package.
5763 * <p/>
5764 * If a grant state was set by the profile or device owner, then the return value will
5765 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5766 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5767 * currently denied or granted.
5768 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07005769 * @see #setPermissionGrantState(ComponentName, String, String, int)
5770 * @see PackageManager#checkPermission(String, String)
5771 */
Robin Lee25e26452015-06-02 09:56:29 -07005772 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005773 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005774 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07005775 try {
5776 return mService.getPermissionGrantState(admin, packageName, permission);
5777 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005778 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07005779 }
5780 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005781
5782 /**
5783 * Returns if provisioning a managed profile or device is possible or not.
5784 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5785 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005786 * @return if provisioning a managed profile or device is possible or not.
5787 * @throws IllegalArgumentException if the supplied action is not valid.
5788 */
5789 public boolean isProvisioningAllowed(String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005790 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005791 try {
5792 return mService.isProvisioningAllowed(action);
5793 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005794 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005795 }
5796 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005797
5798 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005799 * Return if this user is a managed profile of another user. An admin can become the profile
5800 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01005801 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005802 * @param admin Which profile owner this request is associated with.
5803 * @return if this user is a managed profile of another user.
5804 */
5805 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005806 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005807 try {
5808 return mService.isManagedProfile(admin);
5809 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005810 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005811 }
5812 }
5813
5814 /**
5815 * @hide
5816 * Return if this user is a system-only user. An admin can manage a device from a system only
5817 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5818 * @param admin Which device owner this request is associated with.
5819 * @return if this user is a system-only user.
5820 */
5821 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5822 try {
5823 return mService.isSystemOnlyUser(admin);
5824 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005825 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005826 }
5827 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005828
5829 /**
5830 * Called by device owner to get the MAC address of the Wi-Fi device.
5831 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005832 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005833 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5834 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5835 * <p>
5836 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5837 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005838 */
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005839 public String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005840 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005841 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005842 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005843 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005844 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005845 }
5846 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005847
5848 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005849 * Called by device owner to reboot the device. If there is an ongoing call on the device,
5850 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005851 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005852 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005853 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005854 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005855 */
5856 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005857 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005858 try {
5859 mService.reboot(admin);
5860 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005861 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005862 }
5863 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005864
5865 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005866 * Called by a device admin to set the short support message. This will be displayed to the user
5867 * in settings screens where funtionality has been disabled by the admin. The message should be
5868 * limited to a short statement such as "This setting is disabled by your administrator. Contact
5869 * someone@example.com for support." If the message is longer than 200 characters it may be
5870 * truncated.
5871 * <p>
5872 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005873 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5874 * and set a new version of this string accordingly.
5875 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005876 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005877 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005878 * @param message Short message to be displayed to the user in settings or null to clear the
5879 * existing message.
5880 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005881 */
5882 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005883 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005884 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005885 if (mService != null) {
5886 try {
5887 mService.setShortSupportMessage(admin, message);
5888 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005889 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005890 }
5891 }
5892 }
5893
5894 /**
5895 * Called by a device admin to get the short support message.
5896 *
5897 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005898 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
5899 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005900 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005901 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005902 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005903 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005904 if (mService != null) {
5905 try {
5906 return mService.getShortSupportMessage(admin);
5907 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005908 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005909 }
5910 }
5911 return null;
5912 }
5913
5914 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005915 * Called by a device admin to set the long support message. This will be displayed to the user
5916 * in the device administators settings screen.
5917 * <p>
5918 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005919 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5920 * and set a new version of this string accordingly.
5921 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005922 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005923 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005924 * @param message Long message to be displayed to the user in settings or null to clear the
5925 * existing message.
5926 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005927 */
5928 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005929 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005930 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005931 if (mService != null) {
5932 try {
5933 mService.setLongSupportMessage(admin, message);
5934 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005935 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005936 }
5937 }
5938 }
5939
5940 /**
5941 * Called by a device admin to get the long support message.
5942 *
5943 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005944 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
5945 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005946 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005947 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005948 public CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005949 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005950 if (mService != null) {
5951 try {
5952 return mService.getLongSupportMessage(admin);
5953 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005954 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005955 }
5956 }
5957 return null;
5958 }
5959
5960 /**
5961 * Called by the system to get the short support message.
5962 *
5963 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5964 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005965 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00005966 *
5967 * @hide
5968 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005969 public CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
5970 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00005971 if (mService != null) {
5972 try {
5973 return mService.getShortSupportMessageForUser(admin, userHandle);
5974 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005975 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005976 }
5977 }
5978 return null;
5979 }
5980
5981
5982 /**
5983 * Called by the system to get the long support message.
5984 *
5985 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5986 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005987 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00005988 *
5989 * @hide
5990 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005991 public CharSequence getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00005992 if (mService != null) {
5993 try {
5994 return mService.getLongSupportMessageForUser(admin, userHandle);
5995 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005996 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005997 }
5998 }
5999 return null;
6000 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006001
6002 /**
Esteban Talavera62399912016-01-11 15:37:55 +00006003 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
6004 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01006005 *
6006 * <p>The following methods are supported for the parent instance, all other methods will
6007 * throw a SecurityException when called on the parent instance:
6008 * <ul>
6009 * <li>{@link #getPasswordQuality}</li>
6010 * <li>{@link #setPasswordQuality}</li>
6011 * <li>{@link #getPasswordMinimumLength}</li>
6012 * <li>{@link #setPasswordMinimumLength}</li>
6013 * <li>{@link #getPasswordMinimumUpperCase}</li>
6014 * <li>{@link #setPasswordMinimumUpperCase}</li>
6015 * <li>{@link #getPasswordMinimumLowerCase}</li>
6016 * <li>{@link #setPasswordMinimumLowerCase}</li>
6017 * <li>{@link #getPasswordMinimumLetters}</li>
6018 * <li>{@link #setPasswordMinimumLetters}</li>
6019 * <li>{@link #getPasswordMinimumNumeric}</li>
6020 * <li>{@link #setPasswordMinimumNumeric}</li>
6021 * <li>{@link #getPasswordMinimumSymbols}</li>
6022 * <li>{@link #setPasswordMinimumSymbols}</li>
6023 * <li>{@link #getPasswordMinimumNonLetter}</li>
6024 * <li>{@link #setPasswordMinimumNonLetter}</li>
6025 * <li>{@link #getPasswordHistoryLength}</li>
6026 * <li>{@link #setPasswordHistoryLength}</li>
6027 * <li>{@link #getPasswordExpirationTimeout}</li>
6028 * <li>{@link #setPasswordExpirationTimeout}</li>
6029 * <li>{@link #getPasswordExpiration}</li>
6030 * <li>{@link #isActivePasswordSufficient}</li>
6031 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
6032 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
6033 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
6034 * <li>{@link #getMaximumTimeToLock}</li>
6035 * <li>{@link #setMaximumTimeToLock}</li>
6036 * <li>{@link #lockNow}</li>
6037 * <li>{@link #getKeyguardDisabledFeatures}</li>
6038 * <li>{@link #setKeyguardDisabledFeatures}</li>
6039 * <li>{@link #getTrustAgentConfiguration}</li>
6040 * <li>{@link #setTrustAgentConfiguration}</li>
6041 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006042 *
6043 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006044 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006045 */
6046 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006047 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006048 try {
6049 if (!mService.isManagedProfile(admin)) {
6050 throw new SecurityException("The current user does not have a parent profile.");
6051 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06006052 return new DevicePolicyManager(mContext, mService, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006053 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006054 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006055 }
6056 }
6057
6058 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006059 * Called by device owner to control the security logging feature. Logging can only be
6060 * enabled on single user devices where the sole user is managed by the device owner.
6061 *
6062 * <p> Security logs contain various information intended for security auditing purposes.
6063 * See {@link SecurityEvent} for details.
6064 *
6065 * <p>There must be only one user on the device, managed by the device owner.
6066 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006067 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006068 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006069 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006070 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00006071 * @see #retrieveSecurityLogs
6072 */
6073 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006074 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00006075 try {
6076 mService.setSecurityLoggingEnabled(admin, enabled);
6077 } catch (RemoteException re) {
6078 throw re.rethrowFromSystemServer();
6079 }
6080 }
6081
6082 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006083 * Return whether security logging is enabled or not by the device owner.
6084 *
6085 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
6086 * thrown.
6087 *
6088 * @param admin Which device owner this request is associated with.
6089 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
6090 * @throws SecurityException if {@code admin} is not a device owner.
6091 */
6092 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006093 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006094 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006095 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006096 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006097 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006098 }
6099 }
6100
6101 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006102 * Called by device owner to retrieve all new security logging entries since the last call to
6103 * this API after device boots.
6104 *
6105 * <p> Access to the logs is rate limited and it will only return new logs after the device
6106 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
6107 *
6108 * <p>There must be only one user on the device, managed by the device owner.
6109 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006110 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006111 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006112 * @return the new batch of security logs which is a list of {@link SecurityEvent},
6113 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006114 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006115 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006116 public List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006117 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006118 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006119 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006120 if (list != null) {
6121 return list.getList();
6122 } else {
6123 // Rate limit exceeded.
6124 return null;
6125 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006126 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006127 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006128 }
6129 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00006130
6131 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006132 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
6133 * profile.
6134 *
6135 * @hide
6136 */
6137 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
6138 mContext.checkSelfPermission(
6139 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
6140 if (!uInfo.isManagedProfile()) {
6141 throw new SecurityException("The user " + uInfo.id
6142 + " does not have a parent profile.");
6143 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06006144 return new DevicePolicyManager(mContext, mService, true);
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006145 }
6146
6147 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006148 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006149 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006150 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
6151 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
6152 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
6153 * about data corruption when parsing. </strong>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006154 * <p>
6155 * There must be only one user on the device, managed by the device owner. Otherwise a
6156 * {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006157 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006158 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006159 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
6160 * is not supported on the device.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006161 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006162 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006163 public List<SecurityEvent> retrievePreRebootSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006164 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006165 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006166 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006167 if (list != null) {
6168 return list.getList();
6169 } else {
6170 return null;
6171 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006172 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006173 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006174 }
6175 }
6176
6177 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006178 * Called by a profile owner of a managed profile to set the color used for customization. This
6179 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01006180 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006181 * <p>
6182 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00006183 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
6184 *
6185 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006186 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006187 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006188 */
6189 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006190 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006191 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006192 // always enforce alpha channel to have 100% opacity
6193 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00006194 mService.setOrganizationColor(admin, color);
6195 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006196 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006197 }
6198 }
6199
6200 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006201 * @hide
6202 *
6203 * Sets the color used for customization.
6204 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01006205 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006206 * @param userId which user to set the color to.
6207 * @RequiresPermission(allOf = {
6208 * Manifest.permission.MANAGE_USERS,
6209 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
6210 */
6211 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
6212 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006213 // always enforce alpha channel to have 100% opacity
6214 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006215 mService.setOrganizationColorForUser(color, userId);
6216 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006217 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006218 }
6219 }
6220
6221 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00006222 * Called by a profile owner of a managed profile to retrieve the color used for customization.
6223 * This color is used as background color of the confirm credentials screen for that user.
6224 *
6225 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006226 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006227 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006228 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006229 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006230 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006231 try {
6232 return mService.getOrganizationColor(admin);
6233 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006234 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006235 }
6236 }
6237
6238 /**
6239 * @hide
6240 * Retrieve the customization color for a given user.
6241 *
6242 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006243 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006244 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006245 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00006246 try {
6247 return mService.getOrganizationColorForUser(userHandle);
6248 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006249 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006250 }
6251 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006252
6253 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006254 * Called by a profile owner of a managed profile to set the name of the organization under
6255 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006256 * <p>
6257 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006258 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6259 * and set a new version of this string accordingly.
6260 *
6261 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6262 * @param title The organization name or {@code null} to clear a previously set name.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006263 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006264 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006265 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006266 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006267 try {
6268 mService.setOrganizationName(admin, title);
6269 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006270 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006271 }
6272 }
6273
6274 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006275 * Called by a profile owner of a managed profile to retrieve the name of the organization under
6276 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006277 *
6278 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6279 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006280 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006281 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006282 public CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006283 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006284 try {
6285 return mService.getOrganizationName(admin);
6286 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006287 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006288 }
6289 }
6290
6291 /**
6292 * Retrieve the default title message used in the confirm credentials screen for a given user.
6293 *
6294 * @param userHandle The user id of the user we're interested in.
6295 * @return The organization name or {@code null} if none is set.
6296 *
6297 * @hide
6298 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006299 public CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006300 try {
6301 return mService.getOrganizationNameForUser(userHandle);
6302 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006303 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006304 }
6305 }
6306
6307 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00006308 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6309 * return {@link #STATE_USER_UNMANAGED}
6310 * @hide
6311 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00006312 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00006313 @UserProvisioningState
6314 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006315 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00006316 if (mService != null) {
6317 try {
6318 return mService.getUserProvisioningState();
6319 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006320 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006321 }
6322 }
6323 return STATE_USER_UNMANAGED;
6324 }
6325
6326 /**
6327 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6328 *
6329 * @param state to store
6330 * @param userHandle for user
6331 * @hide
6332 */
6333 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6334 if (mService != null) {
6335 try {
6336 mService.setUserProvisioningState(state, userHandle);
6337 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006338 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006339 }
6340 }
6341 }
6342
6343 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006344 * @hide
6345 * Indicates the entity that controls the device or profile owner. A user/profile is considered
6346 * affiliated if it is managed by the same entity as the device.
6347 *
6348 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6349 * user/profile is considered affiliated if the following conditions are both met:
6350 * <ul>
6351 * <li>The device owner and the user's/profile's profile owner have called this method,
6352 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6353 * and a profile owner intersect, they must have come from the same source, which means that
6354 * the device owner and profile owner are controlled by the same entity.</li>
6355 * <li>The device owner's and profile owner's package names are the same.</li>
6356 * </ul>
6357 *
6358 * @param admin Which profile or device owner this request is associated with.
6359 * @param ids A set of opaque affiliation ids.
6360 */
6361 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006362 throwIfParentInstance("setAffiliationIds");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006363 try {
6364 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6365 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006366 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006367 }
6368 }
6369
6370 /**
6371 * @hide
6372 * Returns whether this user/profile is affiliated with the device. See
6373 * {@link #setAffiliationIds} for the definition of affiliation.
6374 *
6375 * @return whether this user/profile is affiliated with the device.
6376 */
6377 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006378 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006379 try {
6380 return mService != null && mService.isAffiliatedUser();
6381 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006382 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006383 }
6384 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006385
6386 /**
6387 * @hide
6388 * Returns whether the uninstall for {@code packageName} for the current user is in queue
6389 * to be started
6390 * @param packageName the package to check for
6391 * @return whether the uninstall intent for {@code packageName} is pending
6392 */
6393 public boolean isUninstallInQueue(String packageName) {
6394 try {
6395 return mService.isUninstallInQueue(packageName);
6396 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006397 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006398 }
6399 }
6400
6401 /**
6402 * @hide
6403 * @param packageName the package containing active DAs to be uninstalled
6404 */
6405 public void uninstallPackageWithActiveAdmins(String packageName) {
6406 try {
6407 mService.uninstallPackageWithActiveAdmins(packageName);
6408 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006409 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006410 }
6411 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01006412
Kenny Guy38dcca52016-04-19 13:09:18 +01006413 /**
6414 * @hide
6415 * Remove a test admin synchronously without sending it a broadcast about being removed.
6416 * If the admin is a profile owner or device owner it will still be removed.
6417 *
6418 * @param userHandle user id to remove the admin for.
6419 * @param admin The administration compononent to remove.
6420 * @throws SecurityException if the caller is not shell / root or the admin package
6421 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
6422 */
6423 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
6424 try {
6425 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
6426 } catch (RemoteException re) {
6427 throw re.rethrowFromSystemServer();
6428 }
6429 }
6430
Mahaver Chopra790d1982016-07-07 16:06:49 +01006431 /**
6432 * @hide
6433 * @return whether {@link android.provider.Settings.Global#DEVICE_PROVISIONED} has ever been set
6434 * to 1.
6435 */
6436 public boolean isDeviceProvisioned() {
6437 try {
6438 return mService.isDeviceProvisioned();
6439 } catch (RemoteException re) {
6440 throw re.rethrowFromSystemServer();
6441 }
6442 }
6443
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01006444 /**
6445 * @hide
6446 * Writes that the provisioning configuration has been applied.
6447 */
6448 public void setDeviceProvisioningConfigApplied() {
6449 try {
6450 mService.setDeviceProvisioningConfigApplied();
6451 } catch (RemoteException re) {
6452 throw re.rethrowFromSystemServer();
6453 }
6454 }
6455
6456 /**
6457 * @hide
6458 * @return whether the provisioning configuration has been applied.
6459 */
6460 public boolean isDeviceProvisioningConfigApplied() {
6461 try {
6462 return mService.isDeviceProvisioningConfigApplied();
6463 } catch (RemoteException re) {
6464 throw re.rethrowFromSystemServer();
6465 }
6466 }
6467
Victor Chang9bfc65f2016-08-15 12:27:09 +01006468 /**
6469 * @hide
Victor Chang3577ed22016-08-25 18:49:26 +01006470 * Force update user setup completed status. This API has no effect on user build.
6471 * @throws {@link SecurityException} if the caller has no
6472 * {@link android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS} or the caller is
6473 * not {@link UserHandle.SYSTEM_USER}
Victor Chang9bfc65f2016-08-15 12:27:09 +01006474 */
6475 public void forceUpdateUserSetupComplete() {
6476 try {
6477 mService.forceUpdateUserSetupComplete();
6478 } catch (RemoteException re) {
6479 throw re.rethrowFromSystemServer();
6480 }
6481 }
6482
Benjamin Franzbc33c822016-04-15 08:57:52 +01006483 private void throwIfParentInstance(String functionName) {
6484 if (mParentInstance) {
6485 throw new SecurityException(functionName + " cannot be called on the parent instance");
6486 }
6487 }
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02006488
6489 /**
6490 * @hide
6491 * Enable backup service.
6492 * <p>This includes all backup and restore mechanisms.
6493 * Setting this to {@code false} will make backup service no-op or return empty results.
6494 *
6495 * <p>There must be only one user on the device, managed by the device owner.
6496 * Otherwise a {@link SecurityException} will be thrown.
6497 *
6498 * <p>Backup service is off by default when device owner is present.
6499 */
6500 public void setBackupServiceEnabled(@NonNull ComponentName admin, boolean enabled) {
6501 try {
6502 mService.setBackupServiceEnabled(admin, enabled);
6503 } catch (RemoteException re) {
6504 throw re.rethrowFromSystemServer();
6505 }
6506 }
6507
6508 /**
6509 * @hide
6510 * @return {@code true} if backup service is enabled, {@code false} otherwise.
6511 */
6512 public boolean isBackupServiceEnabled(@NonNull ComponentName admin) {
6513 try {
6514 return mService.isBackupServiceEnabled(admin);
6515 } catch (RemoteException re) {
6516 throw re.rethrowFromSystemServer();
6517 }
6518 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006519}