blob: 6d8d5e93c1eee7a15cb5c40d6efb8f7e30464da8 [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;
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +010026import android.annotation.TestApi;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000027import android.annotation.UserIdInt;
Fyodor Kupolov4e9af062016-07-18 16:59:11 -070028import android.annotation.WorkerThread;
Jason Monkd7b86212014-06-16 13:15:38 -040029import android.app.Activity;
Tony Mak46aabe52016-11-14 12:53:06 +000030import android.app.IServiceConnection;
Rubin Xuaab7a412016-12-30 21:13:29 +000031import android.app.KeyguardManager;
Michal Karpinski6235a942016-03-15 12:07:23 +000032import android.app.admin.SecurityLog.SecurityEvent;
Dianne Hackbornd6847842010-01-12 18:14:19 -080033import android.content.ComponentName;
34import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010035import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000036import android.content.IntentFilter;
Tony Mak46aabe52016-11-14 12:53:06 +000037import android.content.ServiceConnection;
Victor Chang98607132017-01-27 11:51:56 +000038import android.content.pm.ApplicationInfo;
Dianne Hackbornd6847842010-01-12 18:14:19 -080039import android.content.pm.PackageManager;
Victor Changcd14c0a2016-03-16 19:10:15 +000040import android.content.pm.PackageManager.NameNotFoundException;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000041import android.content.pm.ParceledListSlice;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000042import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050043import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040044import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000045import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010046import android.os.Bundle;
Victor Changc10f6692016-12-09 15:24:00 +000047import android.os.Parcelable;
Jim Millere303bf42014-08-26 17:12:29 -070048import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000049import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080050import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080051import android.os.RemoteException;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070052import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040053import android.os.UserManager;
Ricky Wai494b95d2015-11-20 16:07:15 +000054import android.provider.ContactsContract.Directory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000055import android.provider.Settings;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010056import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070057import android.service.restrictions.RestrictionsReceiver;
Mahaver Chopra1216ae52016-03-11 15:39:48 +000058import android.telephony.TelephonyManager;
Dianne Hackbornd6847842010-01-12 18:14:19 -080059import android.util.Log;
60
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070061import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040062import com.android.org.conscrypt.TrustedCertificateStore;
63
64import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080065import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000066import java.lang.annotation.Retention;
67import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070068import java.net.InetSocketAddress;
69import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010070import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000071import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010072import java.security.PrivateKey;
73import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040074import java.security.cert.CertificateException;
75import java.security.cert.CertificateFactory;
76import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010077import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000078import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070079import java.util.ArrayList;
Rubin Xub4365912016-03-23 12:13:22 +000080import java.util.Arrays;
Svetoslav976e8bd2014-07-16 15:12:03 -070081import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080082import java.util.List;
Dianne Hackbornd6847842010-01-12 18:14:19 -080083
84/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000085 * Public interface for managing policies enforced on a device. Most clients of this class must be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070086 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
87 * administrator</a>. Additionally, a device administrator may be registered as either a profile or
88 * device owner. A given method is accessible to all device administrators unless the documentation
89 * for that method specifies that it is restricted to either device or profile owners. Any
90 * application calling an api may only pass as an argument a device administrator component it
91 * owns. Otherwise, a {@link SecurityException} will be thrown.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080092 * <div class="special reference">
93 * <h3>Developer Guides</h3>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070094 * <p>
95 * For more information about managing policies for device administration, read the <a href=
96 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
97 * guide. </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080098 */
99public class DevicePolicyManager {
100 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -0800101
102 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -0800103 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +0000104 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700105
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600106 /** @hide */
107 public DevicePolicyManager(Context context, IDevicePolicyManager service) {
108 this(context, service, false);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800109 }
110
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800111 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700112 @VisibleForTesting
Jeff Sharkey49ca5292016-05-10 12:54:45 -0600113 protected DevicePolicyManager(Context context, IDevicePolicyManager service,
114 boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700115 mContext = context;
116 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000117 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700118 }
119
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700120 /** @hide test will override it. */
121 @VisibleForTesting
122 protected int myUserId() {
123 return UserHandle.myUserId();
124 }
125
Dianne Hackbornd6847842010-01-12 18:14:19 -0800126 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000127 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000128 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100129 * <p>A managed profile allows data separation for example for the usage of a
130 * device as a personal and corporate device. The user which provisioning is started from and
131 * the managed profile share a launcher.
132 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800133 * <p>This intent will typically be sent by a mobile device management application (MDM).
134 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
135 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100136 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000137 * <p>It is possible to check if provisioning is allowed or not by querying the method
138 * {@link #isProvisioningAllowed(String)}.
139 *
140 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000141 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700142 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000143 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
144 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000145 *
Benjamin Franzea956242016-03-21 15:45:56 +0000146 * <p>The intent may also contain the following extras:
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000147 * <ul>
Benjamin Franzea956242016-03-21 15:45:56 +0000148 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
149 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
150 * {@link android.os.Build.VERSION_CODES#N}</li>
151 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
152 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
153 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Victor Chang51d84f92016-11-16 12:22:56 +0000154 * <li>{@link #EXTRA_PROVISIONING_SKIP_USER_CONSENT}, optional</li>
Victor Chang89ee2792016-11-23 12:10:55 +0000155 * <li>{@link #EXTRA_PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION}, optional</li>
Victor Changc10f6692016-12-09 15:24:00 +0000156 * <li>{@link #EXTRA_PROVISIONING_DISCLAIMERS}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000157 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000158 *
Benjamin Franzea956242016-03-21 15:45:56 +0000159 * <p>When managed provisioning has completed, broadcasts are sent to the application specified
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000160 * in the provisioning intent. The
161 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
162 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
163 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100164 *
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000165 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when managed provisioning has
166 * completed, along with the above broadcast, activity intent
167 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the application specified in
168 * the provisioning intent.
169 *
Benjamin Franzea956242016-03-21 15:45:56 +0000170 * <p>If provisioning fails, the managedProfile is removed so the device returns to its
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100171 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100172 *
173 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
174 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
175 * the provisioning flow was successful, although this doesn't guarantee the full flow will
176 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
177 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000178 */
179 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
180 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100181 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000182
183 /**
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000184 * Activity action: Starts the provisioning flow which sets up a managed user.
185 *
186 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800187 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000188 * owner who has full control over the user. Provisioning can only happen before user setup has
189 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
190 * allowed.
191 *
Benjamin Franzea956242016-03-21 15:45:56 +0000192 * <p>The intent contains the following extras:
193 * <ul>
194 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
195 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
196 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
197 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
198 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
199 * </ul>
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000200 *
Benjamin Franzea956242016-03-21 15:45:56 +0000201 * <p>If provisioning fails, the device returns to its previous state.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000202 *
203 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
204 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
205 * the provisioning flow was successful, although this doesn't guarantee the full flow will
206 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
207 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Benjamin Franzea956242016-03-21 15:45:56 +0000208 *
209 * @hide
Mahaver Chopra5e732562015-11-05 11:55:12 +0000210 */
211 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
212 public static final String ACTION_PROVISION_MANAGED_USER
213 = "android.app.action.PROVISION_MANAGED_USER";
214
215 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100216 * Activity action: Starts the provisioning flow which sets up a managed device.
217 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
218 *
219 * <p> During device owner provisioning a device admin app is set as the owner of the device.
220 * A device owner has full control over the device. The device owner can not be modified by the
221 * user.
222 *
223 * <p> A typical use case would be a device that is owned by a company, but used by either an
224 * employee or client.
225 *
226 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000227 * It is possible to check if provisioning is allowed or not by querying the method
228 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100229 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000230 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100231 * <ul>
232 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
233 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
234 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100235 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000236 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000237 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Victor Changc10f6692016-12-09 15:24:00 +0000238 * <li>{@link #EXTRA_PROVISIONING_DISCLAIMERS}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100239 * </ul>
240 *
Benjamin Franzea956242016-03-21 15:45:56 +0000241 * <p>When device owner provisioning has completed, an intent of the type
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100242 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
243 * device owner.
244 *
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000245 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has
246 * completed, along with the above broadcast, activity intent
247 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner.
248 *
Benjamin Franzea956242016-03-21 15:45:56 +0000249 * <p>If provisioning fails, the device is factory reset.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100250 *
Alan Treadway4582f812015-07-28 11:49:35 +0100251 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
252 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
253 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
254 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100255 */
256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
257 public static final String ACTION_PROVISION_MANAGED_DEVICE
258 = "android.app.action.PROVISION_MANAGED_DEVICE";
259
260 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000261 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000262 *
263 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
264 * the device. A device owner has full control over the device. The device owner can not be
265 * modified by the user and the only way of resetting the device is via factory reset.
266 *
267 * <p>A typical use case would be a device that is owned by a company, but used by either an
268 * employee or client.
269 *
270 * <p>The provisioning message should be sent to an unprovisioned device.
271 *
272 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
273 * by a privileged app with the permission
274 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
275 *
276 * <p>The provisioning intent contains the following properties:
277 * <ul>
278 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
279 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
280 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
281 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Victor Chang38cfd9c2017-01-04 17:41:11 +0000282 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL}, optional</li>
283 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI}, optional</li>
Steven Ng980a1b62016-02-02 17:43:18 +0000284 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
285 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
286 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
287 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
288 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
289 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
290 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
291 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
292 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
293 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
294 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
Victor Chang38cfd9c2017-01-04 17:41:11 +0000295 * <li>{@link #EXTRA_PROVISIONING_SUPPORT_URL}, optional</li>
296 * <li>{@link #EXTRA_PROVISIONING_ORGANIZATION_NAME}, optional</li>
Steven Ng980a1b62016-02-02 17:43:18 +0000297 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
298 *
299 * @hide
300 */
301 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
302 @SystemApi
303 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
304 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
305
306 /**
307 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000308 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
309 *
310 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
311 * management state that is distinct from that reached by
312 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
313 * user, and only has control over device-wide policies, not individual users and their data.
314 * The primary benefit is that multiple non-system users are supported when provisioning using
315 * this form of device management.
316 *
Benjamin Franzea956242016-03-21 15:45:56 +0000317 * <p>During device owner provisioning a device admin app is set as the owner of the device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000318 * A device owner has full control over the device. The device owner can not be modified by the
319 * user.
320 *
Benjamin Franzea956242016-03-21 15:45:56 +0000321 * <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 +0000322 * employee or client.
323 *
Benjamin Franzea956242016-03-21 15:45:56 +0000324 * <p>An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000325 * It is possible to check if provisioning is allowed or not by querying the method
326 * {@link #isProvisioningAllowed(String)}.
327 *
328 * <p>The intent contains the following extras:
329 * <ul>
330 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
331 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
332 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
333 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Benjamin Franzea956242016-03-21 15:45:56 +0000334 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
335 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Alan Treadway46dd4492015-11-09 13:57:19 +0000336 * </ul>
337 *
Benjamin Franzea956242016-03-21 15:45:56 +0000338 * <p>When device owner provisioning has completed, an intent of the type
Alan Treadway46dd4492015-11-09 13:57:19 +0000339 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
340 * device owner.
341 *
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000342 * <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has
343 * completed, along with the above broadcast, activity intent
344 * {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner.
345 *
Benjamin Franzea956242016-03-21 15:45:56 +0000346 * <p>If provisioning fails, the device is factory reset.
Alan Treadway46dd4492015-11-09 13:57:19 +0000347 *
348 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
349 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
350 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
351 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
352 *
353 * @hide
354 */
355 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
356 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
357 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
358
359 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000360 * Activity action: Finalizes management provisioning, should be used after user-setup
361 * has been completed and {@link #getUserProvisioningState()} returns one of:
362 * <ul>
363 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
364 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
365 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
366 * </ul>
367 *
368 * @hide
369 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000370 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000371 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
372 public static final String ACTION_PROVISION_FINALIZATION
373 = "android.app.action.PROVISION_FINALIZATION";
374
375 /**
Michal Karpinskiba244092016-02-25 17:28:24 +0000376 * Action: Bugreport sharing with device owner has been accepted by the user.
377 *
378 * @hide
379 */
380 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
Rubin Xu7226c7d2017-02-06 17:18:50 +0000381 "com.android.server.action.REMOTE_BUGREPORT_SHARING_ACCEPTED";
Michal Karpinskiba244092016-02-25 17:28:24 +0000382
383 /**
384 * Action: Bugreport sharing with device owner has been declined by the user.
385 *
386 * @hide
387 */
388 public static final String ACTION_BUGREPORT_SHARING_DECLINED =
Rubin Xu7226c7d2017-02-06 17:18:50 +0000389 "com.android.server.action.REMOTE_BUGREPORT_SHARING_DECLINED";
Michal Karpinskiba244092016-02-25 17:28:24 +0000390
391 /**
Esteban Talavera01576862016-12-15 11:16:44 +0000392 * Action: Bugreport has been collected and is dispatched to {@code DevicePolicyManagerService}.
Michal Karpinskiba244092016-02-25 17:28:24 +0000393 *
394 * @hide
395 */
396 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
397 "android.intent.action.REMOTE_BUGREPORT_DISPATCH";
398
399 /**
400 * Extra for shared bugreport's SHA-256 hash.
401 *
402 * @hide
403 */
404 public static final String EXTRA_REMOTE_BUGREPORT_HASH =
405 "android.intent.extra.REMOTE_BUGREPORT_HASH";
406
407 /**
408 * Extra for remote bugreport notification shown type.
409 *
410 * @hide
411 */
412 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
413 "android.app.extra.bugreport_notification_type";
414
415 /**
416 * Notification type for a started remote bugreport flow.
417 *
418 * @hide
419 */
420 public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
421
422 /**
423 * Notification type for a bugreport that has already been accepted to be shared, but is still
424 * being taken.
425 *
426 * @hide
427 */
428 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
429
430 /**
431 * Notification type for a bugreport that has been taken and can be shared or declined.
432 *
433 * @hide
434 */
435 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
436
437 /**
Michal Karpinski8f010dd2016-06-21 15:05:53 +0100438 * Default and maximum timeout in milliseconds after which unlocking with weak auth times out,
439 * i.e. the user has to use a strong authentication method like password, PIN or pattern.
440 *
441 * @hide
442 */
443 public static final long DEFAULT_STRONG_AUTH_TIMEOUT_MS = 72 * 60 * 60 * 1000; // 72h
444
445 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100446 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100447 * allows a mobile device management application or NFC programmer application which starts
448 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100449 * <p>
450 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
451 * sends the intent to pass data to itself on the newly created profile.
452 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
453 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100454 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
455 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
456 * message should contain a stringified {@link java.util.Properties} instance, whose string
457 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
458 * management application after provisioning.
459 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100460 * <p>
461 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700462 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
463 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100464 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100465 */
466 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100467 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100468
469 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100470 * A String extra holding the package name of the mobile device management application that
471 * will be set as the profile owner or device owner.
472 *
473 * <p>If an application starts provisioning directly via an intent with action
474 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
475 * application that started provisioning. The package will be set as profile owner in that case.
476 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000477 * <p>This package is set as device owner when device owner provisioning is started by an NFC
478 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000479 *
480 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700481 * This receiver will be set as the profile or device owner and active admin.
Benjamin Franzea956242016-03-21 15:45:56 +0000482 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000483 * @see DeviceAdminReceiver
484 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100485 * supported, but only if there is only one device admin receiver in the package that requires
486 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000487 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000488 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000489 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100490 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000491
492 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000493 * A ComponentName extra indicating the device admin receiver of the mobile device management
494 * application that will be set as the profile owner or device owner and active admin.
495 *
496 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100497 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
498 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
499 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000500 *
501 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100502 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
503 * message containing an NFC record with MIME type
Benjamin Franzea956242016-03-21 15:45:56 +0000504 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000505 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000506 *
507 * @see DeviceAdminReceiver
508 */
509 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
510 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
511
512 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000513 * An {@link android.accounts.Account} extra holding the account to migrate during managed
514 * profile provisioning. If the account supplied is present in the primary user, it will be
515 * copied, along with its credentials to the managed profile and removed from the primary user.
516 *
517 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
518 */
519
520 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
521 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
522
523 /**
Victor Changaa9cbc02016-12-05 20:50:57 +0000524 * Boolean extra to indicate that the migrated account should be kept. This is used in
525 * conjunction with {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}. If it's set to {@code true},
526 * the account will not be removed from the primary user after it is migrated to the newly
527 * created user or profile.
Victor Chang89ee2792016-11-23 12:10:55 +0000528 *
529 * <p> Defaults to {@code false}
530 *
Victor Changaa9cbc02016-12-05 20:50:57 +0000531 * <p> Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
532 * {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}
Victor Chang89ee2792016-11-23 12:10:55 +0000533 */
534 public static final String EXTRA_PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION
535 = "android.app.extra.PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION";
536
537 /**
Mahaver761ce772017-03-13 16:40:45 +0000538 * @deprecated From {@link android.os.Build.VERSION_CODES#O}, never used while provisioning the
539 * device.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100540 */
Mahaver761ce772017-03-13 16:40:45 +0000541 @Deprecated
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100542 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
543 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100544
545 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000546 * A integer extra indicating the predominant color to show during the provisioning.
547 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000548 *
549 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
550 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
551 */
552 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
553 "android.app.extra.PROVISIONING_MAIN_COLOR";
554
555 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000556 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700557 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000558 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100559 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
560 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000561 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000562 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
563 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000564
565 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100566 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
567 * will be set to.
568 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000569 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
570 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100571 */
572 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100573 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100574
575 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100576 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
577 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100578 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000579 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
580 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100581 */
582 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100583 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100584
585 /**
586 * A String extra holding the {@link java.util.Locale} that the device will be set to.
587 * Format: xx_yy, where xx is the language code, and yy the country code.
588 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000589 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
590 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100591 */
592 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100593 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100594
595 /**
596 * A String extra holding the ssid of the wifi network that should be used during nfc device
597 * owner provisioning for downloading the mobile device management application.
598 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000599 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
600 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100601 */
602 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100603 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100604
605 /**
606 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
607 * is hidden or not.
608 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000609 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
610 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100611 */
612 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100613 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100614
615 /**
616 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100617 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
618 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100619 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000620 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
621 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100622 */
623 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100624 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100625
626 /**
627 * A String extra holding the password of the wifi network in
628 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
629 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000630 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
631 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100632 */
633 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100634 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100635
636 /**
637 * A String extra holding the proxy host for the wifi network in
638 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
639 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000640 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
641 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100642 */
643 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100644 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100645
646 /**
647 * An int extra holding the proxy port for the wifi network in
648 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
649 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000650 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
651 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100652 */
653 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100654 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100655
656 /**
657 * A String extra holding the proxy bypass for the wifi network in
658 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
659 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000660 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
661 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100662 */
663 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100664 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100665
666 /**
667 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
668 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
669 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000670 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
671 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100672 */
673 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100674 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100675
676 /**
677 * A String extra holding a url that specifies the download location of the device admin
678 * package. When not provided it is assumed that the device admin package is already installed.
679 *
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.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100682 */
683 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100684 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100685
686 /**
Victor Chang38cfd9c2017-01-04 17:41:11 +0000687 * A String extra holding the localized name of the organization under management.
688 *
689 * The name is displayed only during provisioning.
690 *
691 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
692 *
693 * @hide
694 */
695 @SystemApi
696 public static final String EXTRA_PROVISIONING_ORGANIZATION_NAME =
697 "android.app.extra.PROVISIONING_ORGANIZATION_NAME";
698
699 /**
700 * A String extra holding a url to the website of the device's provider. The website can be
701 * opened in a browser during provisioning.
702 *
703 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
704 *
705 * @hide
706 */
707 @SystemApi
708 public static final String EXTRA_PROVISIONING_SUPPORT_URL =
709 "android.app.extra.PROVISIONING_SUPPORT_URL";
710
711 /**
712 * A String extra holding the localized name of the device admin package. It should be the same
713 * as the app label of the package.
714 *
715 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
716 *
717 * @hide
718 */
719 @SystemApi
720 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL =
721 "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL";
722
723 /**
724 * A {@link Uri} extra pointing to the app icon of device admin package. This image will be
725 * shown during the provisioning.
726 * <h5>The following URI schemes are accepted:</h5>
727 * <ul>
728 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
729 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
730 * </ul>
731 *
732 * <p> It is the responsibility of the caller to provide an image with a reasonable
733 * pixel density for the device.
734 *
735 * <p> If a content: URI is passed, the intent should have the flag
736 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
737 * {@link android.content.ClipData} of the intent too.
738 *
739 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
740 *
741 * @hide
742 */
743 @SystemApi
744 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI =
745 "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI";
746
747 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400748 * An int extra holding a minimum required version code for the device admin package. If the
749 * device admin is already installed on the device, it will only be re-downloaded from
750 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
751 * installed package is less than this version code.
752 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400753 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400754 * provisioning via an NFC bump.
755 */
756 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
757 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
758
759 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100760 * A String extra holding a http cookie header which should be used in the http request to the
761 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
762 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000763 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
764 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100765 */
766 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100767 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100768
769 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100770 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
771 * the file at download location specified in
772 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100773 *
Benjamin Franzea956242016-03-21 15:45:56 +0000774 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
775 * present. The provided checksum must match the checksum of the file at the download
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100776 * location. If the checksum doesn't match an error will be shown to the user and the user will
777 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100778 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000779 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
780 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100781 *
782 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
783 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700784 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100785 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100786 */
787 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100788 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100789
790 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100791 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100792 * android package archive at the download location specified in {@link
793 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
794 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100795 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100796 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
797 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
798 *
Benjamin Franzea956242016-03-21 15:45:56 +0000799 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
800 * present. The provided checksum must match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100801 * the download location. If the checksum does not match an error will be shown to the user and
802 * the user will be asked to factory reset the device.
803 *
804 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
805 * provisioning via an NFC bump.
806 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100807 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
808 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100809
810 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000811 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
812 * has completed successfully.
813 *
814 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700815 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000816 *
Mahaver7074caf2016-11-29 20:52:18 +0000817 * <p>This intent will contain the following extras
818 * <ul>
819 * <li>{@link Intent#EXTRA_USER}, corresponds to the {@link UserHandle} of the managed
820 * profile.</li>
821 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, corresponds to the account requested to
822 * be migrated at provisioning time, if any.</li>
823 * </ul>
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000824 */
825 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
826 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
827 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
828
829 /**
Mahaver Chopra3c58cfe2016-11-01 21:25:59 +0000830 * Activity action: This activity action is sent to indicate that provisioning of a managed
831 * profile or managed device has completed successfully. It'll be sent at the same time as
832 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast but this will be
833 * delivered faster as it's an activity intent.
834 *
835 * <p>The intent is only sent to the application on the profile that requested provisioning. In
836 * the device owner case the profile is the primary user.
837 *
838 * @see #ACTION_PROVISION_MANAGED_PROFILE
839 * @see #ACTION_PROVISION_MANAGED_DEVICE
840 */
841 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
842 public static final String ACTION_PROVISIONING_SUCCESSFUL =
843 "android.app.action.PROVISIONING_SUCCESSFUL";
844
845 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000846 * A boolean extra indicating whether device encryption can be skipped as part of device owner
847 * or managed profile provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500848 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400849 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100850 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Benjamin Franzea956242016-03-21 15:45:56 +0000851 *
852 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
853 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500854 */
855 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
856 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
857
858 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000859 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
860 * provisioning. If this extra is not passed, a default image will be shown.
861 * <h5>The following URI schemes are accepted:</h5>
862 * <ul>
863 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
864 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
865 * </ul>
866 *
Victor Changc10f6692016-12-09 15:24:00 +0000867 * <p> It is the responsibility of the caller to provide an image with a reasonable
Victor Chang38cfd9c2017-01-04 17:41:11 +0000868 * pixel density for the device.
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000869 *
870 * <p> If a content: URI is passed, the intent should have the flag
871 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
872 * {@link android.content.ClipData} of the intent too.
873 *
874 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
875 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
876 */
877 public static final String EXTRA_PROVISIONING_LOGO_URI =
878 "android.app.extra.PROVISIONING_LOGO_URI";
879
880 /**
Victor Changc10f6692016-12-09 15:24:00 +0000881 * A {@link Bundle}[] extra consisting of list of disclaimer headers and disclaimer contents.
882 * Each {@link Bundle} must have both {@link #EXTRA_PROVISIONING_DISCLAIMER_HEADER}
883 * as disclaimer header, and {@link #EXTRA_PROVISIONING_DISCLAIMER_CONTENT} as disclaimer
884 * content.
885 *
886 * <p> The extra typically contains one disclaimer from the company of mobile device
887 * management application (MDM), and one disclaimer from the organization.
888 *
889 * <p> Call {@link Bundle#putParcelableArray(String, Parcelable[])} to put the {@link Bundle}[]
890 *
891 * <p> Maximum 3 key-value pairs can be specified. The rest will be ignored.
892 *
893 * <p> Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
894 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
895 */
896 public static final String EXTRA_PROVISIONING_DISCLAIMERS =
897 "android.app.extra.PROVISIONING_DISCLAIMERS";
898
899 /**
900 * A String extra of localized disclaimer header.
901 *
902 * <p> The extra is typically the company name of mobile device management application (MDM)
903 * or the organization name.
904 *
905 * <p> Use in Bundle {@link #EXTRA_PROVISIONING_DISCLAIMERS}
Victor Chang98607132017-01-27 11:51:56 +0000906 *
907 * <p> System app, i.e. application with {@link ApplicationInfo#FLAG_SYSTEM}, can also insert a
908 * disclaimer by declaring an application-level meta-data in {@code AndroidManifest.xml}.
909 * Must use it with {@link #EXTRA_PROVISIONING_DISCLAIMER_CONTENT}. Here is the example:
910 *
911 * <pre>
912 * &lt;meta-data
913 * android:name="android.app.extra.PROVISIONING_DISCLAIMER_HEADER"
914 * android:resource="@string/disclaimer_header"
915 * /&gt;</pre>
Victor Changc10f6692016-12-09 15:24:00 +0000916 */
917 public static final String EXTRA_PROVISIONING_DISCLAIMER_HEADER =
918 "android.app.extra.PROVISIONING_DISCLAIMER_HEADER";
919
920 /**
921 * A {@link Uri} extra pointing to disclaimer content.
922 *
923 * <h5>The following URI schemes are accepted:</h5>
924 * <ul>
925 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
926 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
927 * </ul>
928 *
929 * <p> Styled text is supported in the disclaimer content. The content is parsed by
930 * {@link android.text.Html#fromHtml(String)} and displayed in a
931 * {@link android.widget.TextView}.
932 *
933 * <p> If a <code>content:</code> URI is passed, URI is passed, the intent should have the flag
934 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
935 * {@link android.content.ClipData} of the intent too.
936 *
937 * <p> Use in Bundle {@link #EXTRA_PROVISIONING_DISCLAIMERS}
Victor Chang98607132017-01-27 11:51:56 +0000938 *
939 * <p> System app, i.e. application with {@link ApplicationInfo#FLAG_SYSTEM}, can also insert a
940 * disclaimer by declaring an application-level meta-data in {@code AndroidManifest.xml}.
941 * Must use it with {@link #EXTRA_PROVISIONING_DISCLAIMER_HEADER}. Here is the example:
942 *
943 * <pre>
944 * &lt;meta-data
945 * android:name="android.app.extra.PROVISIONING_DISCLAIMER_CONTENT"
946 * android:resource="@string/disclaimer_content"
947 * /&gt;</pre>
Victor Changc10f6692016-12-09 15:24:00 +0000948 */
949 public static final String EXTRA_PROVISIONING_DISCLAIMER_CONTENT =
950 "android.app.extra.PROVISIONING_DISCLAIMER_CONTENT";
951
952 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000953 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
954 * during setup-wizard.
955 *
956 * <p>If unspecified, defaults to {@code true} to match the behavior in
957 * {@link android.os.Build.VERSION_CODES#M} and earlier.
958 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000959 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
960 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000961 *
962 * @hide
963 */
964 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
965 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
966
967 /**
Victor Chang51d84f92016-11-16 12:22:56 +0000968 * A boolean extra indicating if the user consent steps from the provisioning flow should be
969 * skipped. If unspecified, defaults to {@code false}.
970 *
971 * It can only be used by an existing device owner trying to create a managed profile via
972 * {@link #ACTION_PROVISION_MANAGED_PROFILE}. Otherwise it is ignored.
973 */
974 public static final String EXTRA_PROVISIONING_SKIP_USER_CONSENT =
975 "android.app.extra.PROVISIONING_SKIP_USER_CONSENT";
976
977 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000978 * This MIME type is used for starting the device owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100979 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400980 * <p>During device owner provisioning a device admin app is set as the owner of the device.
981 * A device owner has full control over the device. The device owner can not be modified by the
982 * user and the only way of resetting the device is if the device owner app calls a factory
983 * reset.
984 *
985 * <p> A typical use case would be a device that is owned by a company, but used by either an
986 * employee or client.
987 *
Benjamin Franzea956242016-03-21 15:45:56 +0000988 * <p> The NFC message must be sent to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100989 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000990 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100991 * contains the following properties:
992 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400993 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
994 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100995 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400996 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100997 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
998 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
999 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
1000 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
1001 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
1002 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
1003 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
1004 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
1005 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
1006 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +01001007 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
1008 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
1009 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +01001010 *
Nicolas Prevot18440252015-03-09 14:07:17 +00001011 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001012 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -04001013 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
1014 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
1015 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -04001016 */
1017 public static final String MIME_TYPE_PROVISIONING_NFC
1018 = "application/com.android.managedprovisioning";
1019
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +01001020 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001021 * Activity action: ask the user to add a new device administrator to the system.
1022 * The desired policy is the ComponentName of the policy in the
1023 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
1024 * bring the user through adding the device administrator to the system (or
1025 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001026 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001027 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
1028 * field to provide the user with additional explanation (in addition
1029 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001030 *
1031 * <p>If your administrator is already active, this will ordinarily return immediately (without
1032 * user intervention). However, if your administrator has been updated and is requesting
1033 * additional uses-policy flags, the user will be presented with the new list. New policies
1034 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001035 */
1036 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1037 public static final String ACTION_ADD_DEVICE_ADMIN
1038 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001039
Dianne Hackbornd6847842010-01-12 18:14:19 -08001040 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001041 * @hide
1042 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -07001043 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001044 *
Amith Yamasani814e9872015-03-23 14:04:53 -07001045 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
1046 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001047 * to remotely control restrictions on the user.
1048 *
Makoto Onukic8a5a552015-11-19 14:29:12 -08001049 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001050 * result of whether or not the user approved the action. If approved, the result will
1051 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
1052 * as a profile owner.
1053 *
1054 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
1055 * field to provide the user with additional explanation (in addition
1056 * to your component's description) about what is being added.
1057 *
Amith Yamasani814e9872015-03-23 14:04:53 -07001058 * <p>If there is already a profile owner active or the caller is not a system app, the
1059 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001060 */
1061 @SystemApi
1062 public static final String ACTION_SET_PROFILE_OWNER
1063 = "android.app.action.SET_PROFILE_OWNER";
1064
1065 /**
1066 * @hide
1067 * Name of the profile owner admin that controls the user.
1068 */
1069 @SystemApi
1070 public static final String EXTRA_PROFILE_OWNER_NAME
1071 = "android.app.extra.PROFILE_OWNER_NAME";
1072
1073 /**
Nicolas Prevot00799002015-07-27 18:15:20 +01001074 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -07001075 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001076 *
Jim Miller284b62e2010-06-08 14:27:42 -07001077 * @hide
1078 */
1079 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
1080 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
1081
1082 /**
Tony Mak1970f972016-08-30 17:41:48 +01001083 * Broadcast action: sent when the device owner is set, changed or cleared.
Nicolas Prevot00799002015-07-27 18:15:20 +01001084 *
1085 * This broadcast is sent only to the primary user.
1086 * @see #ACTION_PROVISION_MANAGED_DEVICE
1087 */
1088 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1089 public static final String ACTION_DEVICE_OWNER_CHANGED
1090 = "android.app.action.DEVICE_OWNER_CHANGED";
1091
1092 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001093 * The ComponentName of the administrator component.
1094 *
1095 * @see #ACTION_ADD_DEVICE_ADMIN
1096 */
1097 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001098
Dianne Hackbornd6847842010-01-12 18:14:19 -08001099 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001100 * An optional CharSequence providing additional explanation for why the
1101 * admin is being added.
1102 *
1103 * @see #ACTION_ADD_DEVICE_ADMIN
1104 */
1105 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001106
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001107 /**
phweiss73145f42017-01-17 19:06:38 +01001108 * Constant to indicate the feature of disabling the camera. Used as argument to
1109 * {@link #createAdminSupportIntent(String)}.
1110 * @see #setCameraDisabled(ComponentName, boolean)
1111 */
1112 public static final String POLICY_DISABLE_CAMERA = "policy_disable_camera";
1113
1114 /**
1115 * Constant to indicate the feature of disabling screen captures. Used as argument to
1116 * {@link #createAdminSupportIntent(String)}.
1117 * @see #setScreenCaptureDisabled(ComponentName, boolean)
1118 */
1119 public static final String POLICY_DISABLE_SCREEN_CAPTURE = "policy_disable_screen_capture";
1120
1121 /**
1122 * A String indicating a specific restricted feature. Can be a user restriction from the
1123 * {@link UserManager}, e.g. {@link UserManager#DISALLOW_ADJUST_VOLUME}, or one of the values
1124 * {@link #POLICY_DISABLE_CAMERA} or {@link #POLICY_DISABLE_SCREEN_CAPTURE}.
1125 * @see #createAdminSupportIntent(String)
1126 * @hide
1127 */
1128 @TestApi
1129 public static final String EXTRA_RESTRICTION = "android.app.extra.RESTRICTION";
1130
1131 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001132 * Activity action: have the user enter a new password. This activity should
1133 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
1134 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
1135 * enter a new password that meets the current requirements. You can use
1136 * {@link #isActivePasswordSufficient()} to determine whether you need to
1137 * have the user select a new password in order to meet the current
1138 * constraints. Upon being resumed from this activity, you can check the new
1139 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +00001140 *
1141 * If the intent is launched from within a managed profile with a profile
1142 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
1143 * this will trigger entering a new password for the parent of the profile.
1144 * For all other cases it will trigger entering a new password for the user
1145 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001146 *
1147 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -08001148 */
1149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1150 public static final String ACTION_SET_NEW_PASSWORD
1151 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -07001152
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00001153 /**
Benjamin Franzc9921092016-01-08 17:17:44 +00001154 * Activity action: have the user enter a new password for the parent profile.
1155 * If the intent is launched from within a managed profile, this will trigger
1156 * entering a new password for the parent of the profile. In all other cases
1157 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
1158 */
1159 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1160 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
1161 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
1162
1163 /**
phweissa0cb2512016-12-14 21:37:48 +01001164 * Broadcast action: Tell the status bar to open the device monitoring dialog, e.g. when
1165 * Network logging was enabled and the user tapped the notification.
1166 * <p class="note">This is a protected intent that can only be sent by the system.</p>
1167 * @hide
1168 */
1169 public static final String ACTION_SHOW_DEVICE_MONITORING_DIALOG
1170 = "android.app.action.SHOW_DEVICE_MONITORING_DIALOG";
1171
1172 /**
Edman Anjos9e62c312017-01-26 22:22:58 +01001173 * Broadcast Action: Sent after application delegation scopes are changed. The new delegation
1174 * scopes will be sent in an {@code ArrayList<String>} extra identified by the
1175 * {@link #EXTRA_DELEGATION_SCOPES} key.
Edman Anjosf9946772016-11-28 16:35:15 +01001176 *
1177 * <p class=”note”> Note: This is a protected intent that can only be sent by the system.</p>
1178 */
1179 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1180 public static final String ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED =
1181 "android.app.action.APPLICATION_DELEGATION_SCOPES_CHANGED";
1182
1183 /**
Edman Anjos9e62c312017-01-26 22:22:58 +01001184 * An {@code ArrayList<String>} corresponding to the delegation scopes given to an app in the
Edman Anjosf9946772016-11-28 16:35:15 +01001185 * {@link #ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED} broadcast.
1186 */
1187 public static final String EXTRA_DELEGATION_SCOPES = "android.app.extra.DELEGATION_SCOPES";
1188
1189 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +00001190 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
1191 * the parent profile to access intents sent from the managed profile.
1192 * That is, when an app in the managed profile calls
1193 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
1194 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00001195 */
Nicolas Prevot86a96732014-09-08 12:13:05 +01001196 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00001197
1198 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +00001199 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
1200 * the managed profile to access intents sent from the parent profile.
1201 * That is, when an app in the parent profile calls
1202 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
1203 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00001204 */
Nicolas Prevot86a96732014-09-08 12:13:05 +01001205 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001206
Dianne Hackbornd6847842010-01-12 18:14:19 -08001207 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01001208 * Broadcast action: notify that a new local system update policy has been set by the device
1209 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00001210 */
1211 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +01001212 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
1213 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +00001214
Amith Yamasanid49489b2015-04-28 14:00:26 -07001215 /**
1216 * Permission policy to prompt user for new permission requests for runtime permissions.
1217 * Already granted or denied permissions are not affected by this.
1218 */
1219 public static final int PERMISSION_POLICY_PROMPT = 0;
1220
1221 /**
1222 * Permission policy to always grant new permission requests for runtime permissions.
1223 * Already granted or denied permissions are not affected by this.
1224 */
1225 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
1226
1227 /**
1228 * Permission policy to always deny new permission requests for runtime permissions.
1229 * Already granted or denied permissions are not affected by this.
1230 */
1231 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
1232
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07001233 /**
1234 * Runtime permission state: The user can manage the permission
1235 * through the UI.
1236 */
1237 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
1238
1239 /**
1240 * Runtime permission state: The permission is granted to the app
1241 * and the user cannot manage the permission through the UI.
1242 */
1243 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
1244
1245 /**
1246 * Runtime permission state: The permission is denied to the app
1247 * and the user cannot manage the permission through the UI.
1248 */
1249 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +00001250
1251 /**
Edman Anjosf9946772016-11-28 16:35:15 +01001252 * Delegation of certificate installation and management. This scope grants access to the
1253 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
1254 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair} APIs.
1255 */
1256 public static final String DELEGATION_CERT_INSTALL = "delegation-cert-install";
1257
1258 /**
1259 * Delegation of application restrictions management. This scope grants access to the
1260 * {@link #setApplicationRestrictions} and {@link #getApplicationRestrictions} APIs.
1261 */
1262 public static final String DELEGATION_APP_RESTRICTIONS = "delegation-app-restrictions";
1263
1264 /**
Edman Anjosa5f2fb12016-12-19 11:25:54 -08001265 * Delegation of application uninstall block. This scope grants access to the
1266 * {@link #setUninstallBlocked} API.
1267 */
1268 public static final String DELEGATION_BLOCK_UNINSTALL = "delegation-block-uninstall";
1269
1270 /**
Edman Anjos52088e42017-01-13 22:26:17 +01001271 * Delegation of permission policy and permission grant state. This scope grants access to the
1272 * {@link #setPermissionPolicy}, {@link #getPermissionGrantState},
1273 * and {@link #setPermissionGrantState} APIs.
1274 */
1275 public static final String DELEGATION_PERMISSION_GRANT = "delegation-permission-grant";
1276
1277 /**
1278 * Delegation of package access state. This scope grants access to the
1279 * {@link #isApplicationHidden}, {@link #setApplicationHidden}, {@link #isPackageSuspended}, and
1280 * {@link #setPackagesSuspended} APIs.
1281 */
1282 public static final String DELEGATION_PACKAGE_ACCESS = "delegation-package-access";
1283
1284 /**
1285 * Delegation for enabling system apps. This scope grants access to the {@link #enableSystemApp}
1286 * API.
1287 */
1288 public static final String DELEGATION_ENABLE_SYSTEM_APP = "delegation-enable-system-app";
1289
1290 /**
1291 * Delegation of management of uninstalled packages. This scope grants access to the
1292 * {@code #setKeepUninstalledPackages} and {@code #getKeepUninstalledPackages} APIs.
1293 * @hide
1294 */
1295 public static final String DELEGATION_KEEP_UNINSTALLED_PACKAGES =
1296 "delegation-keep-uninstalled-packages";
1297
1298 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00001299 * No management for current user in-effect. This is the default.
1300 * @hide
1301 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001302 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001303 public static final int STATE_USER_UNMANAGED = 0;
1304
1305 /**
1306 * Management partially setup, user setup needs to be completed.
1307 * @hide
1308 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001309 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001310 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1311
1312 /**
1313 * Management partially setup, user setup completed.
1314 * @hide
1315 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001316 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001317 public static final int STATE_USER_SETUP_COMPLETE = 2;
1318
1319 /**
1320 * Management setup and active on current user.
1321 * @hide
1322 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001323 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001324 public static final int STATE_USER_SETUP_FINALIZED = 3;
1325
1326 /**
1327 * Management partially setup on a managed profile.
1328 * @hide
1329 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001330 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001331 public static final int STATE_USER_PROFILE_COMPLETE = 4;
1332
1333 /**
1334 * @hide
1335 */
1336 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
1337 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
1338 @Retention(RetentionPolicy.SOURCE)
1339 public @interface UserProvisioningState {}
1340
1341 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001342 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001343 *
1344 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1345 * {@link #ACTION_PROVISION_MANAGED_PROFILE}, {@link #ACTION_PROVISION_MANAGED_USER} and
1346 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when provisioning is allowed.
1347 *
1348 * @hide
1349 */
1350 public static final int CODE_OK = 0;
1351
1352 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001353 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001354 *
1355 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and
1356 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the device already has a device
1357 * owner.
1358 *
1359 * @hide
1360 */
1361 public static final int CODE_HAS_DEVICE_OWNER = 1;
1362
1363 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001364 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001365 *
1366 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1367 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the user has a profile owner and for
1368 * {@link #ACTION_PROVISION_MANAGED_PROFILE} when the profile owner is already set.
1369 *
1370 * @hide
1371 */
1372 public static final int CODE_USER_HAS_PROFILE_OWNER = 2;
1373
1374 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001375 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001376 *
1377 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and
1378 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the user isn't running.
1379 *
1380 * @hide
1381 */
1382 public static final int CODE_USER_NOT_RUNNING = 3;
1383
1384 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001385 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001386 *
1387 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1388 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} if the device has already been setup and
1389 * for {@link #ACTION_PROVISION_MANAGED_USER} if the user has already been setup.
1390 *
1391 * @hide
1392 */
1393 public static final int CODE_USER_SETUP_COMPLETED = 4;
1394
1395 /**
1396 * Code used to indicate that the device also has a user other than the system user.
1397 *
1398 * @hide
1399 */
1400 public static final int CODE_NONSYSTEM_USER_EXISTS = 5;
1401
1402 /**
1403 * Code used to indicate that device has an account that prevents provisioning.
1404 *
1405 * @hide
1406 */
1407 public static final int CODE_ACCOUNTS_NOT_EMPTY = 6;
1408
1409 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001410 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001411 *
1412 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and
1413 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} if the user is not a system user.
1414 *
1415 * @hide
1416 */
1417 public static final int CODE_NOT_SYSTEM_USER = 7;
1418
1419 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001420 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001421 *
1422 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1423 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} and {@link #ACTION_PROVISION_MANAGED_USER}
1424 * when the device is a watch and is already paired.
1425 *
1426 * @hide
1427 */
1428 public static final int CODE_HAS_PAIRED = 8;
1429
1430 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001431 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001432 *
1433 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} and
1434 * {@link #ACTION_PROVISION_MANAGED_USER} on devices which do not support managed users.
1435 *
1436 * @see {@link PackageManager#FEATURE_MANAGED_USERS}
1437 * @hide
1438 */
1439 public static final int CODE_MANAGED_USERS_NOT_SUPPORTED = 9;
1440
1441 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001442 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001443 *
1444 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_USER} if the user is a system user.
1445 *
1446 * @hide
1447 */
1448 public static final int CODE_SYSTEM_USER = 10;
1449
1450 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001451 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001452 *
1453 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when the user cannot have more
1454 * managed profiles.
1455 *
1456 * @hide
1457 */
1458 public static final int CODE_CANNOT_ADD_MANAGED_PROFILE = 11;
1459
1460 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001461 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001462 *
1463 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_USER} and
1464 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} on devices not running with split system
1465 * user.
1466 *
1467 * @hide
1468 */
1469 public static final int CODE_NOT_SYSTEM_USER_SPLIT = 12;
1470
1471 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001472 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001473 *
1474 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
1475 * {@link #ACTION_PROVISION_MANAGED_PROFILE}, {@link #ACTION_PROVISION_MANAGED_USER} and
1476 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} on devices which do no support device
1477 * admins.
1478 *
1479 * @hide
1480 */
1481 public static final int CODE_DEVICE_ADMIN_NOT_SUPPORTED = 13;
1482
1483 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001484 * Result code for {@link #checkProvisioningPreCondition}.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001485 *
Esteban Talavera6c9116a2016-11-24 16:12:44 +00001486 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when the device the user is a
1487 * system user on a split system user device.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001488 *
1489 * @hide
1490 */
1491 public static final int CODE_SPLIT_SYSTEM_USER_DEVICE_SYSTEM_USER = 14;
1492
1493 /**
Esteban Talavera01576862016-12-15 11:16:44 +00001494 * Result code for {@link #checkProvisioningPreCondition}.
1495 *
1496 * <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when adding a managed profile is
1497 * disallowed by {@link UserManager#DISALLOW_ADD_MANAGED_PROFILE}.
1498 *
1499 * @hide
1500 */
1501 public static final int CODE_ADD_MANAGED_PROFILE_DISALLOWED = 15;
1502
1503 /**
1504 * Result codes for {@link #checkProvisioningPreCondition} indicating all the provisioning pre
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001505 * conditions.
1506 *
1507 * @hide
1508 */
1509 @Retention(RetentionPolicy.SOURCE)
1510 @IntDef({CODE_OK, CODE_HAS_DEVICE_OWNER, CODE_USER_HAS_PROFILE_OWNER, CODE_USER_NOT_RUNNING,
1511 CODE_USER_SETUP_COMPLETED, CODE_NOT_SYSTEM_USER, CODE_HAS_PAIRED,
1512 CODE_MANAGED_USERS_NOT_SUPPORTED, CODE_SYSTEM_USER, CODE_CANNOT_ADD_MANAGED_PROFILE,
1513 CODE_NOT_SYSTEM_USER_SPLIT, CODE_DEVICE_ADMIN_NOT_SUPPORTED,
Esteban Talavera01576862016-12-15 11:16:44 +00001514 CODE_SPLIT_SYSTEM_USER_DEVICE_SYSTEM_USER, CODE_ADD_MANAGED_PROFILE_DISALLOWED})
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00001515 public @interface ProvisioningPreCondition {}
1516
1517 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001518 * Return true if the given administrator component is currently active (enabled) in the system.
1519 *
1520 * @param admin The administrator component to check for.
1521 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1522 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001523 */
Robin Lee25e26452015-06-02 09:56:29 -07001524 public boolean isAdminActive(@NonNull ComponentName admin) {
Charles He8c760562016-10-25 16:36:53 +01001525 throwIfParentInstance("isAdminActive");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001526 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001527 }
1528
1529 /**
1530 * @see #isAdminActive(ComponentName)
1531 * @hide
1532 */
Robin Lee25e26452015-06-02 09:56:29 -07001533 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001534 if (mService != null) {
1535 try {
Robin Lee25e26452015-06-02 09:56:29 -07001536 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001537 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001538 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001539 }
1540 }
1541 return false;
1542 }
Charles Hedea0c3b2017-01-13 10:04:12 +00001543
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001544 /**
1545 * Return true if the given administrator component is currently being removed
1546 * for the user.
1547 * @hide
1548 */
Robin Lee25e26452015-06-02 09:56:29 -07001549 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001550 if (mService != null) {
1551 try {
Robin Lee25e26452015-06-02 09:56:29 -07001552 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001553 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001554 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001555 }
1556 }
1557 return false;
1558 }
1559
Dianne Hackbornd6847842010-01-12 18:14:19 -08001560 /**
Robin Lee25e26452015-06-02 09:56:29 -07001561 * Return a list of all currently active device administrators' component
1562 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001563 * returned.
1564 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07001565 public @Nullable List<ComponentName> getActiveAdmins() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001566 throwIfParentInstance("getActiveAdmins");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001567 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001568 }
1569
1570 /**
1571 * @see #getActiveAdmins()
1572 * @hide
1573 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07001574 public @Nullable List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001575 if (mService != null) {
1576 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001577 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001578 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001579 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001580 }
1581 }
1582 return null;
1583 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001584
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001585 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001586 * Used by package administration code to determine if a package can be stopped
1587 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001588 * @hide
1589 */
David Ouyang3a83a332017-01-11 16:36:40 -08001590 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001591 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001592 return packageHasActiveAdmins(packageName, myUserId());
1593 }
1594
1595 /**
1596 * Used by package administration code to determine if a package can be stopped
1597 * or uninstalled.
1598 * @hide
1599 */
1600 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001601 if (mService != null) {
1602 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001603 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001604 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001605 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001606 }
1607 }
1608 return false;
1609 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001610
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001611 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001612 * Remove a current administration component. This can only be called
1613 * by the application that owns the administration component; if you
1614 * try to remove someone else's component, a security exception will be
1615 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001616 *
1617 * <p>Note that the operation is not synchronous and the admin might still be active (as
1618 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001619 *
1620 * @param admin The administration compononent to remove.
1621 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001622 */
Robin Lee25e26452015-06-02 09:56:29 -07001623 public void removeActiveAdmin(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001624 throwIfParentInstance("removeActiveAdmin");
Dianne Hackbornd6847842010-01-12 18:14:19 -08001625 if (mService != null) {
1626 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001627 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001628 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001629 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001630 }
1631 }
1632 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001633
Dianne Hackbornd6847842010-01-12 18:14:19 -08001634 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001635 * Returns true if an administrator has been granted a particular device policy. This can be
1636 * used to check whether the administrator was activated under an earlier set of policies, but
1637 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001638 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001639 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1640 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001641 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001642 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001643 */
Robin Lee25e26452015-06-02 09:56:29 -07001644 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001645 throwIfParentInstance("hasGrantedPolicy");
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001646 if (mService != null) {
1647 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001648 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001649 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001650 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001651 }
1652 }
1653 return false;
1654 }
1655
1656 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001657 * Returns true if the Profile Challenge is available to use for the given profile user.
1658 *
1659 * @hide
1660 */
1661 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1662 if (mService != null) {
1663 try {
1664 return mService.isSeparateProfileChallengeAllowed(userHandle);
1665 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001666 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001667 }
1668 }
1669 return false;
1670 }
1671
1672 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001673 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1674 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001675 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001676 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001677 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001678
Dianne Hackbornd6847842010-01-12 18:14:19 -08001679 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001680 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1681 * recognition technology. This implies technologies that can recognize the identity of
1682 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1683 * Note that quality constants are ordered so that higher values are more restrictive.
1684 */
1685 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1686
1687 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001688 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001689 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001690 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001691 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001692 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001693
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001694 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001695 * Constant for {@link #setPasswordQuality}: the user must have entered a
1696 * password containing at least numeric characters. Note that quality
1697 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001698 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001699 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001700
Dianne Hackbornd6847842010-01-12 18:14:19 -08001701 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001702 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001703 * password containing at least numeric characters with no repeating (4444)
1704 * or ordered (1234, 4321, 2468) sequences. Note that quality
1705 * constants are ordered so that higher values are more restrictive.
1706 */
1707 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1708
1709 /**
1710 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001711 * password containing at least alphabetic (or other symbol) characters.
1712 * Note that quality constants are ordered so that higher values are more
1713 * restrictive.
1714 */
1715 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001716
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001717 /**
1718 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001719 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001720 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001721 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001722 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001723 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001724
Dianne Hackbornd6847842010-01-12 18:14:19 -08001725 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001726 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001727 * password containing at least a letter, a numerical digit and a special
1728 * symbol, by default. With this password quality, passwords can be
1729 * restricted to contain various sets of characters, like at least an
1730 * uppercase letter, etc. These are specified using various methods,
1731 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1732 * that quality constants are ordered so that higher values are more
1733 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001734 */
1735 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1736
1737 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001738 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1739 * modify password. In case this password quality is set, the password is
1740 * managed by a profile owner. The profile owner can set any password,
1741 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1742 * that quality constants are ordered so that higher values are more
1743 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1744 * the highest.
1745 * @hide
1746 */
1747 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1748
1749 /**
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001750 * @hide
1751 *
1752 * adb shell dpm set-{device,profile}-owner will normally not allow installing an owner to
1753 * a user with accounts. {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED}
1754 * and {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} are the account features
1755 * used by authenticator to exempt their accounts from this:
1756 *
1757 * <ul>
1758 * <li>Non-test-only DO/PO still can't be installed when there are accounts.
1759 * <p>In order to make an apk test-only, add android:testOnly="true" to the
1760 * &lt;application&gt; tag in the manifest.
1761 *
1762 * <li>Test-only DO/PO can be installed even when there are accounts, as long as all the
1763 * accounts have the {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} feature.
1764 * Some authenticators claim to have any features, so to detect it, we also check
1765 * {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} and disallow installing
1766 * if any of the accounts have it.
1767 * </ul>
1768 */
Makoto Onuki47c203d2017-02-13 16:21:19 -08001769 @SystemApi
1770 @TestApi
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001771 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED =
1772 "android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED";
1773
1774 /** @hide See {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} */
Makoto Onuki47c203d2017-02-13 16:21:19 -08001775 @SystemApi
1776 @TestApi
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001777 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED =
1778 "android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED";
1779
1780 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001781 * Called by an application that is administering the device to set the password restrictions it
1782 * is imposing. After setting this, the user will not be able to enter a new password that is
1783 * not at least as restrictive as what has been set. Note that the current password will remain
1784 * until the user has set a new one, so the change does not take place immediately. To prompt
1785 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001786 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001787 * <p>
1788 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1789 * requested quality constant (between the policy set here, the user's preference, and any other
1790 * considerations) is the one that is in effect.
1791 * <p>
1792 * The calling device admin must have requested
1793 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1794 * not, a security exception will be thrown.
1795 * <p>
1796 * This method can be called on the {@link DevicePolicyManager} instance returned by
1797 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1798 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001799 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001800 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001801 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1802 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1803 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1804 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1805 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1806 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001807 */
Robin Lee25e26452015-06-02 09:56:29 -07001808 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001809 if (mService != null) {
1810 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001811 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001812 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001813 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001814 }
1815 }
1816 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001817
Dianne Hackbornd6847842010-01-12 18:14:19 -08001818 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001819 * Retrieve the current minimum password quality for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001820 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001821 * a separate challenge are not taken into account.
1822 *
1823 * <p>This method can be called on the {@link DevicePolicyManager} instance
1824 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1825 * restrictions on the parent profile.
1826 *
Robin Lee25e26452015-06-02 09:56:29 -07001827 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001828 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001829 */
Robin Lee25e26452015-06-02 09:56:29 -07001830 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001831 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001832 }
1833
1834 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001835 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001836 if (mService != null) {
1837 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001838 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001839 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001840 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001841 }
1842 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001843 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001844 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001845
Dianne Hackbornd6847842010-01-12 18:14:19 -08001846 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001847 * Called by an application that is administering the device to set the minimum allowed password
1848 * length. After setting this, the user will not be able to enter a new password that is not at
1849 * least as restrictive as what has been set. Note that the current password will remain until
1850 * the user has set a new one, so the change does not take place immediately. To prompt the user
1851 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1852 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1853 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1854 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1855 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1856 * {@link #setPasswordQuality}.
1857 * <p>
1858 * The calling device admin must have requested
1859 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1860 * not, a security exception will be thrown.
1861 * <p>
1862 * This method can be called on the {@link DevicePolicyManager} instance returned by
1863 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1864 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001865 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001866 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001867 * @param length The new desired minimum password length. A value of 0 means there is no
1868 * restriction.
1869 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1870 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001871 */
Robin Lee25e26452015-06-02 09:56:29 -07001872 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001873 if (mService != null) {
1874 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001875 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001876 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001877 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001878 }
1879 }
1880 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001881
Dianne Hackbornd6847842010-01-12 18:14:19 -08001882 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001883 * Retrieve the current minimum password length for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001884 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001885 * a separate challenge are not taken into account.
1886 *
1887 * <p>This method can be called on the {@link DevicePolicyManager} instance
1888 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1889 * restrictions on the parent profile.
1890 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001891 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001892 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001893 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001894 */
Robin Lee25e26452015-06-02 09:56:29 -07001895 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001896 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001897 }
1898
1899 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001900 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001901 if (mService != null) {
1902 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001903 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001904 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001905 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001906 }
1907 }
1908 return 0;
1909 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001910
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001911 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001912 * Called by an application that is administering the device to set the minimum number of upper
1913 * case letters required in the password. After setting this, the user will not be able to enter
1914 * a new password that is not at least as restrictive as what has been set. Note that the
1915 * current password will remain until the user has set a new one, so the change does not take
1916 * place immediately. To prompt the user for a new password, use
1917 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1918 * setting this value. This constraint is only imposed if the administrator has also requested
1919 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001920 * <p>
1921 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001922 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1923 * not, a security exception will be thrown.
1924 * <p>
1925 * This method can be called on the {@link DevicePolicyManager} instance returned by
1926 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1927 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001928 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001929 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1930 * @param length The new desired minimum number of upper case letters required in the password.
1931 * A value of 0 means there is no restriction.
1932 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1933 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001934 */
Robin Lee25e26452015-06-02 09:56:29 -07001935 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001936 if (mService != null) {
1937 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001938 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001939 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001940 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001941 }
1942 }
1943 }
1944
1945 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001946 * Retrieve the current number of upper case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001947 * for a particular admin or all admins that set restrictions on this user and
Esteban Talaverac1c83592016-02-17 17:56:15 +00001948 * its participating profiles. Restrictions on profiles that have a separate challenge
1949 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001950 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001951 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001952 * and only applies when the password quality is
1953 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001954 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001955 * <p>This method can be called on the {@link DevicePolicyManager} instance
1956 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1957 * restrictions on the parent profile.
1958 *
Robin Lee25e26452015-06-02 09:56:29 -07001959 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001960 * aggregate all admins.
1961 * @return The minimum number of upper case letters required in the
1962 * password.
1963 */
Robin Lee25e26452015-06-02 09:56:29 -07001964 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001965 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001966 }
1967
1968 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001969 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001970 if (mService != null) {
1971 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001972 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001973 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001974 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001975 }
1976 }
1977 return 0;
1978 }
1979
1980 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001981 * Called by an application that is administering the device to set the minimum number of lower
1982 * case letters required in the password. After setting this, the user will not be able to enter
1983 * a new password that is not at least as restrictive as what has been set. Note that the
1984 * current password will remain until the user has set a new one, so the change does not take
1985 * place immediately. To prompt the user for a new password, use
1986 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1987 * setting this value. This constraint is only imposed if the administrator has also requested
1988 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001989 * <p>
1990 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001991 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1992 * not, a security exception will be thrown.
1993 * <p>
1994 * This method can be called on the {@link DevicePolicyManager} instance returned by
1995 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1996 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001997 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001998 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1999 * @param length The new desired minimum number of lower case letters required in the password.
2000 * A value of 0 means there is no restriction.
2001 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2002 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002003 */
Robin Lee25e26452015-06-02 09:56:29 -07002004 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002005 if (mService != null) {
2006 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002007 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002008 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002009 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002010 }
2011 }
2012 }
2013
2014 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002015 * Retrieve the current number of lower case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002016 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002017 * and its participating profiles. Restrictions on profiles that have
2018 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01002019 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00002020 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002021 * and only applies when the password quality is
2022 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002023 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002024 * <p>This method can be called on the {@link DevicePolicyManager} instance
2025 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2026 * restrictions on the parent profile.
2027 *
Robin Lee25e26452015-06-02 09:56:29 -07002028 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002029 * aggregate all admins.
2030 * @return The minimum number of lower case letters required in the
2031 * password.
2032 */
Robin Lee25e26452015-06-02 09:56:29 -07002033 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002034 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002035 }
2036
2037 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002038 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002039 if (mService != null) {
2040 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002041 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002042 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002043 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002044 }
2045 }
2046 return 0;
2047 }
2048
2049 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002050 * Called by an application that is administering the device to set the minimum number of
2051 * letters required in the password. After setting this, the user will not be able to enter a
2052 * new password that is not at least as restrictive as what has been set. Note that the current
2053 * password will remain until the user has set a new one, so the change does not take place
2054 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
2055 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
2056 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
2057 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002058 * <p>
2059 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002060 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2061 * not, a security exception will be thrown.
2062 * <p>
2063 * This method can be called on the {@link DevicePolicyManager} instance returned by
2064 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2065 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002066 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002067 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2068 * @param length The new desired minimum number of letters required in the password. A value of
2069 * 0 means there is no restriction.
2070 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2071 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002072 */
Robin Lee25e26452015-06-02 09:56:29 -07002073 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002074 if (mService != null) {
2075 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002076 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002077 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002078 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002079 }
2080 }
2081 }
2082
2083 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002084 * Retrieve the current number of letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002085 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002086 * and its participating profiles. Restrictions on profiles that have
2087 * a separate challenge are not taken into account.
2088 * This is the same value as set by
2089 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002090 * and only applies when the password quality is
2091 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002092 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002093 * <p>This method can be called on the {@link DevicePolicyManager} instance
2094 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2095 * restrictions on the parent profile.
2096 *
Robin Lee25e26452015-06-02 09:56:29 -07002097 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002098 * aggregate all admins.
2099 * @return The minimum number of letters required in the password.
2100 */
Robin Lee25e26452015-06-02 09:56:29 -07002101 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002102 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002103 }
2104
2105 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002106 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002107 if (mService != null) {
2108 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002109 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002110 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002111 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002112 }
2113 }
2114 return 0;
2115 }
2116
2117 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002118 * Called by an application that is administering the device to set the minimum number of
2119 * numerical digits required in the password. After setting this, the user will not be able to
2120 * enter a new password that is not at least as restrictive as what has been set. Note that the
2121 * current password will remain until the user has set a new one, so the change does not take
2122 * place immediately. To prompt the user for a new password, use
2123 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
2124 * setting this value. This constraint is only imposed if the administrator has also requested
2125 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002126 * <p>
2127 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002128 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2129 * not, a security exception will be thrown.
2130 * <p>
2131 * This method can be called on the {@link DevicePolicyManager} instance returned by
2132 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2133 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002134 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002135 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2136 * @param length The new desired minimum number of numerical digits required in the password. A
2137 * value of 0 means there is no restriction.
2138 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2139 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002140 */
Robin Lee25e26452015-06-02 09:56:29 -07002141 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002142 if (mService != null) {
2143 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002144 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002145 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002146 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002147 }
2148 }
2149 }
2150
2151 /**
2152 * Retrieve the current number of numerical digits required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002153 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002154 * and its participating profiles. Restrictions on profiles that have
2155 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01002156 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00002157 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002158 * and only applies when the password quality is
2159 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002160 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002161 * <p>This method can be called on the {@link DevicePolicyManager} instance
2162 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2163 * restrictions on the parent profile.
2164 *
Robin Lee25e26452015-06-02 09:56:29 -07002165 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002166 * aggregate all admins.
2167 * @return The minimum number of numerical digits required in the password.
2168 */
Robin Lee25e26452015-06-02 09:56:29 -07002169 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002170 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002171 }
2172
2173 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002174 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002175 if (mService != null) {
2176 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002177 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002178 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002179 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002180 }
2181 }
2182 return 0;
2183 }
2184
2185 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002186 * Called by an application that is administering the device to set the minimum number of
2187 * symbols required in the password. After setting this, the user will not be able to enter a
2188 * new password that is not at least as restrictive as what has been set. Note that the current
2189 * password will remain until the user has set a new one, so the change does not take place
2190 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
2191 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
2192 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
2193 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002194 * <p>
2195 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002196 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2197 * not, a security exception will be thrown.
2198 * <p>
2199 * This method can be called on the {@link DevicePolicyManager} instance returned by
2200 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2201 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002202 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002203 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2204 * @param length The new desired minimum number of symbols required in the password. A value of
2205 * 0 means there is no restriction.
2206 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2207 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002208 */
Robin Lee25e26452015-06-02 09:56:29 -07002209 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002210 if (mService != null) {
2211 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002212 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002213 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002214 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002215 }
2216 }
2217 }
2218
2219 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002220 * Retrieve the current number of symbols required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002221 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002222 * and its participating profiles. Restrictions on profiles that have
2223 * a separate challenge are not taken into account. This is the same value as
2224 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002225 * and only applies when the password quality is
2226 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002227 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002228 * <p>This method can be called on the {@link DevicePolicyManager} instance
2229 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2230 * restrictions on the parent profile.
2231 *
Robin Lee25e26452015-06-02 09:56:29 -07002232 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002233 * aggregate all admins.
2234 * @return The minimum number of symbols required in the password.
2235 */
Robin Lee25e26452015-06-02 09:56:29 -07002236 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002237 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002238 }
2239
2240 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002241 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002242 if (mService != null) {
2243 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002244 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002245 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002246 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002247 }
2248 }
2249 return 0;
2250 }
2251
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002252 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002253 * Called by an application that is administering the device to set the minimum number of
2254 * non-letter characters (numerical digits or symbols) required in the password. After setting
2255 * this, the user will not be able to enter a new password that is not at least as restrictive
2256 * as what has been set. Note that the current password will remain until the user has set a new
2257 * one, so the change does not take place immediately. To prompt the user for a new password,
2258 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
2259 * setting this value. This constraint is only imposed if the administrator has also requested
2260 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002261 * <p>
2262 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002263 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2264 * not, a security exception will be thrown.
2265 * <p>
2266 * This method can be called on the {@link DevicePolicyManager} instance returned by
2267 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2268 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002269 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002270 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2271 * @param length The new desired minimum number of letters required in the password. A value of
2272 * 0 means there is no restriction.
2273 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2274 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002275 */
Robin Lee25e26452015-06-02 09:56:29 -07002276 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002277 if (mService != null) {
2278 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002279 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002280 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002281 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002282 }
2283 }
2284 }
2285
2286 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002287 * Retrieve the current number of non-letter characters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002288 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002289 * and its participating profiles. Restrictions on profiles that have
2290 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01002291 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00002292 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002293 * and only applies when the password quality is
2294 * {@link #PASSWORD_QUALITY_COMPLEX}.
2295 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002296 * <p>This method can be called on the {@link DevicePolicyManager} instance
2297 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2298 * restrictions on the parent profile.
2299 *
Robin Lee25e26452015-06-02 09:56:29 -07002300 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002301 * aggregate all admins.
2302 * @return The minimum number of letters required in the password.
2303 */
Robin Lee25e26452015-06-02 09:56:29 -07002304 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002305 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002306 }
2307
2308 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002309 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002310 if (mService != null) {
2311 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002312 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002313 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002314 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002315 }
2316 }
2317 return 0;
2318 }
2319
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002320 /**
2321 * Called by an application that is administering the device to set the length of the password
2322 * history. After setting this, the user will not be able to enter a new password that is the
2323 * same as any password in the history. Note that the current password will remain until the
2324 * user has set a new one, so the change does not take place immediately. To prompt the user for
2325 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
2326 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
2327 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
2328 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
2329 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
2330 * <p>
2331 * The calling device admin must have requested
2332 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2333 * not, a security exception will be thrown.
2334 * <p>
2335 * This method can be called on the {@link DevicePolicyManager} instance returned by
2336 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2337 * profile.
2338 *
2339 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2340 * @param length The new desired length of password history. A value of 0 means there is no
2341 * restriction.
2342 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2343 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
2344 */
Robin Lee25e26452015-06-02 09:56:29 -07002345 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002346 if (mService != null) {
2347 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002348 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002349 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002350 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002351 }
2352 }
2353 }
2354
2355 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002356 * Called by a device admin to set the password expiration timeout. Calling this method will
2357 * restart the countdown for password expiration for the given admin, as will changing the
2358 * device password (for all admins).
2359 * <p>
2360 * The provided timeout is the time delta in ms and will be added to the current time. For
2361 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
2362 * 432000000 ms for timeout.
2363 * <p>
2364 * To disable password expiration, a value of 0 may be used for timeout.
2365 * <p>
2366 * The calling device admin must have requested
2367 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
2368 * not, a security exception will be thrown.
2369 * <p>
2370 * Note that setting the password will automatically reset the expiration time for all active
2371 * admins. Active admins do not need to explicitly call this method in that case.
2372 * <p>
2373 * This method can be called on the {@link DevicePolicyManager} instance returned by
2374 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2375 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002376 *
Jim Millera4e28d12010-11-08 16:15:47 -08002377 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002378 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
2379 * there is no restriction (unlimited).
2380 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2381 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08002382 */
Robin Lee25e26452015-06-02 09:56:29 -07002383 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08002384 if (mService != null) {
2385 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002386 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08002387 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002388 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08002389 }
2390 }
2391 }
2392
2393 /**
Jim Miller6b857682011-02-16 16:27:41 -08002394 * Get the password expiration timeout for the given admin. The expiration timeout is the
2395 * recurring expiration timeout provided in the call to
2396 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00002397 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
2398 * have set restrictions on profiles that have a separate challenge are not taken into account.
2399 *
2400 * <p>This method can be called on the {@link DevicePolicyManager} instance
2401 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2402 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08002403 *
Robin Lee25e26452015-06-02 09:56:29 -07002404 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08002405 * @return The timeout for the given admin or the minimum of all timeouts
2406 */
Robin Lee25e26452015-06-02 09:56:29 -07002407 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08002408 if (mService != null) {
2409 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002410 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08002411 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002412 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08002413 }
2414 }
2415 return 0;
2416 }
2417
2418 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002419 * Get the current password expiration time for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002420 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002421 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
2422 * of all expiration times is returned - which will be the minimum of all of them.
2423 *
2424 * <p>This method can be called on the {@link DevicePolicyManager} instance
2425 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2426 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08002427 *
Robin Lee25e26452015-06-02 09:56:29 -07002428 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002429 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08002430 */
Robin Lee25e26452015-06-02 09:56:29 -07002431 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08002432 if (mService != null) {
2433 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002434 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08002435 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002436 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08002437 }
2438 }
2439 return 0;
2440 }
2441
2442 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002443 * Retrieve the current password history length for a particular admin or all admins that
Rubin Xud3609d42016-07-13 18:32:57 +01002444 * set restrictions on this user and its participating profiles. Restrictions on profiles that
Esteban Talaverac1c83592016-02-17 17:56:15 +00002445 * have a separate challenge are not taken into account.
2446 *
2447 * <p>This method can be called on the {@link DevicePolicyManager} instance
2448 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2449 * restrictions on the parent profile.
2450 *
Robin Lee25e26452015-06-02 09:56:29 -07002451 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002452 * all admins.
2453 * @return The length of the password history
2454 */
Robin Lee25e26452015-06-02 09:56:29 -07002455 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002456 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002457 }
2458
2459 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002460 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002461 if (mService != null) {
2462 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002463 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002464 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002465 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002466 }
2467 }
2468 return 0;
2469 }
2470
Dianne Hackbornd6847842010-01-12 18:14:19 -08002471 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08002472 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002473 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08002474 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08002475 * @return Returns the maximum length that the user can enter.
2476 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002477 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002478 // Kind-of arbitrary.
2479 return 16;
2480 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002481
Dianne Hackborn254cb442010-01-27 19:23:59 -08002482 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002483 * Determine whether the current password the user has set is sufficient to meet the policy
2484 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
2485 * user and its participating profiles. Restrictions on profiles that have a separate challenge
Andrew Scull5daf2732016-11-14 15:02:45 +00002486 * are not taken into account. The user must be unlocked in order to perform the check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002487 * <p>
2488 * The calling device admin must have requested
2489 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2490 * not, a security exception will be thrown.
2491 * <p>
2492 * This method can be called on the {@link DevicePolicyManager} instance returned by
2493 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
2494 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002495 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01002496 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002497 * @throws SecurityException if the calling application does not own an active administrator
2498 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Andrew Scull5daf2732016-11-14 15:02:45 +00002499 * @throws InvalidStateException if the user is not unlocked.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002500 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002501 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002502 if (mService != null) {
2503 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002504 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002505 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002506 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002507 }
2508 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002509 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002510 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002511
Dianne Hackbornd6847842010-01-12 18:14:19 -08002512 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002513 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002514 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002515 * requested by the admins of the parent user and its profiles.
2516 *
2517 * @param userHandle the userId of the profile to check the password for.
2518 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002519 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002520 * @hide
2521 */
2522 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2523 if (mService != null) {
2524 try {
2525 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2526 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002527 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002528 }
2529 }
2530 return false;
2531 }
2532
2533 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002534 * Retrieve the number of times the user has failed at entering a password since that last
2535 * successful password entry.
2536 * <p>
2537 * This method can be called on the {@link DevicePolicyManager} instance returned by
2538 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2539 * password attemts for the parent user.
2540 * <p>
2541 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2542 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002543 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002544 * @return The number of times user has entered an incorrect password since the last correct
2545 * password entry.
2546 * @throws SecurityException if the calling application does not own an active administrator
2547 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002548 */
2549 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002550 return getCurrentFailedPasswordAttempts(myUserId());
2551 }
2552
2553 /**
2554 * Retrieve the number of times the given user has failed at entering a
2555 * password since that last successful password entry.
2556 *
2557 * <p>The calling device admin must have requested
2558 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2559 * not and it is not the system uid, a security exception will be thrown.
2560 *
2561 * @hide
2562 */
2563 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002564 if (mService != null) {
2565 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002566 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002567 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002568 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002569 }
2570 }
2571 return -1;
2572 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002573
2574 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002575 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002576 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002577 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002578 * @hide
2579 */
2580 public boolean getDoNotAskCredentialsOnBoot() {
2581 if (mService != null) {
2582 try {
2583 return mService.getDoNotAskCredentialsOnBoot();
2584 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002585 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002586 }
2587 }
2588 return false;
2589 }
2590
2591 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002592 * Setting this to a value greater than zero enables a built-in policy that will perform a
2593 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2594 * This built-in policy combines watching for failed passwords and wiping the device, and
2595 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002596 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002597 * <p>
2598 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2599 * revoking credentials, or reporting the failure to a server), you should implement
2600 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2601 * use this API, because if the maximum count is reached, the device or profile will be wiped
2602 * immediately, and your callback will not be invoked.
2603 * <p>
2604 * This method can be called on the {@link DevicePolicyManager} instance returned by
2605 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2606 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002607 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002608 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002609 * @param num The number of failed password attempts at which point the device or profile will
2610 * be wiped.
2611 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2612 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2613 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002614 */
Robin Lee25e26452015-06-02 09:56:29 -07002615 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002616 if (mService != null) {
2617 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002618 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002619 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002620 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002621 }
2622 }
2623 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002624
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002625 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002626 * Retrieve the current maximum number of login attempts that are allowed before the device
Rubin Xud3609d42016-07-13 18:32:57 +01002627 * or profile is wiped, for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002628 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2629 * not taken into account.
2630 *
2631 * <p>This method can be called on the {@link DevicePolicyManager} instance
2632 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2633 * the value for the parent profile.
2634 *
Robin Lee25e26452015-06-02 09:56:29 -07002635 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002636 * all admins.
2637 */
Robin Lee25e26452015-06-02 09:56:29 -07002638 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002639 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002640 }
2641
2642 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002643 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002644 if (mService != null) {
2645 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002646 return mService.getMaximumFailedPasswordsForWipe(
2647 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002648 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002649 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002650 }
2651 }
2652 return 0;
2653 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002654
Dianne Hackborn254cb442010-01-27 19:23:59 -08002655 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002656 * Returns the profile with the smallest maximum failed passwords for wipe,
2657 * for the given user. So for primary user, it might return the primary or
2658 * a managed profile. For a secondary user, it would be the same as the
2659 * user passed in.
2660 * @hide Used only by Keyguard
2661 */
2662 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2663 if (mService != null) {
2664 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002665 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2666 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002667 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002668 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002669 }
2670 }
2671 return UserHandle.USER_NULL;
2672 }
2673
2674 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002675 * Flag for {@link #resetPassword}: don't allow other admins to change
2676 * the password again until the user has entered it.
2677 */
2678 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002679
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002680 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002681 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2682 * If the flag is set, the device can be booted without asking for user password.
2683 * The absence of this flag does not change the current boot requirements. This flag
2684 * can be set by the device owner only. If the app is not the device owner, the flag
2685 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2686 * device to factory defaults.
2687 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002688 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002689
2690 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002691 * Force a new device unlock password (the password needed to access the entire device, not for
2692 * individual accounts) on the user. This takes effect immediately.
2693 * <p>
Rubin Xuaab7a412016-12-30 21:13:29 +00002694 * <em>For device owner and profile owners targeting SDK level
2695 * {@link android.os.Build.VERSION_CODES#O} or above, this API is no longer available and will
2696 * throw {@link SecurityException}. Please use the new API {@link #resetPasswordWithToken}
2697 * instead. </em>
2698 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002699 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002700 * device admins that are not device owner and not profile owner.
2701 * The password can now only be changed if there is currently no password set. Device owner
Ricky Wai977ade22016-05-24 15:02:41 +01002702 * and profile owner can still do this when user is unlocked and does not have a managed
2703 * profile.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002704 * <p>
2705 * The given password must be sufficient for the current password quality and length constraints
2706 * as returned by {@link #getPasswordQuality(ComponentName)} and
2707 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2708 * it will be rejected and false returned. Note that the password may be a stronger quality
2709 * (containing alphanumeric characters when the requested quality is only numeric), in which
2710 * case the currently active quality will be increased to match.
2711 * <p>
2712 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002713 * current password constraints allow it. <em>Note: This will not work in
2714 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2715 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2716 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002717 * <p>
2718 * The calling device admin must have requested
2719 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2720 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002721 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002722 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002723 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002724 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2725 * @return Returns true if the password was applied, or false if it is not acceptable for the
2726 * current constraints or if the user has not been decrypted yet.
2727 * @throws SecurityException if the calling application does not own an active administrator
2728 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Ricky Wai977ade22016-05-24 15:02:41 +01002729 * @throws IllegalStateException if the calling user is locked or has a managed profile.
Andrew Scull3f81f4e2016-07-29 16:29:58 +01002730 * @throws IllegalArgumentException if the password does not meet system requirements.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002731 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002732 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002733 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002734 if (mService != null) {
2735 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002736 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002737 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002738 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002739 }
2740 }
2741 return false;
2742 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002743
Dianne Hackbornd6847842010-01-12 18:14:19 -08002744 /**
Rubin Xuaab7a412016-12-30 21:13:29 +00002745 * Called by a profile or device owner to provision a token which can later be used to reset the
2746 * device lockscreen password (if called by device owner), or work challenge (if called by
2747 * profile owner), via {@link #resetPasswordWithToken}.
2748 * <p>
2749 * If the user currently has a lockscreen password, the provisioned token will not be
2750 * immediately usable; it only becomes active after the user performs a confirm credential
2751 * operation, which can be triggered by {@link KeyguardManager#createConfirmDeviceCredentialIntent}.
2752 * If the user has no lockscreen password, the token is activated immediately. In all cases,
2753 * the active state of the current token can be checked by {@link #isResetPasswordTokenActive}.
2754 * For security reasons, un-activated tokens are only stored in memory and will be lost once
2755 * the device reboots. In this case a new token needs to be provisioned again.
2756 * <p>
2757 * Once provisioned and activated, the token will remain effective even if the user changes
2758 * or clears the lockscreen password.
2759 * <p>
2760 * <em>This token is highly sensitive and should be treated at the same level as user
2761 * credentials. In particular, NEVER store this token on device in plaintext, especially in
2762 * Device-Encrypted storage if the token will be used to reset password on FBE devices before
2763 * user unlocks.
2764 * </em>
2765 *
2766 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2767 * @param token a secure token a least 32-byte long, which must be generated by a
2768 * cryptographically strong random number generator.
2769 * @return true if the operation is successful, false otherwise.
2770 * @throws IllegalArgumentException if the supplied token is invalid.
2771 * @throws SecurityException
2772 */
2773 public boolean setResetPasswordToken(ComponentName admin, byte[] token) {
2774 throwIfParentInstance("setResetPasswordToken");
2775 if (mService != null) {
2776 try {
2777 return mService.setResetPasswordToken(admin, token);
2778 } catch (RemoteException e) {
2779 throw e.rethrowFromSystemServer();
2780 }
2781 }
2782 return false;
2783 }
2784
2785 /**
2786 * Called by a profile or device owner to revoke the current password reset token.
2787 *
2788 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2789 * @return true if the operation is successful, false otherwise.
2790 */
2791 public boolean clearResetPasswordToken(ComponentName admin) {
2792 throwIfParentInstance("clearResetPasswordToken");
2793 if (mService != null) {
2794 try {
2795 return mService.clearResetPasswordToken(admin);
2796 } catch (RemoteException e) {
2797 throw e.rethrowFromSystemServer();
2798 }
2799 }
2800 return false;
2801 }
2802
2803 /**
2804 * Called by a profile or device owner to check if the current reset password token is active.
2805 *
2806 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2807 * @return true if the token is active, false otherwise.
2808 * @throws IllegalStateException if no token has been set.
2809 */
2810 public boolean isResetPasswordTokenActive(ComponentName admin) {
2811 throwIfParentInstance("isResetPasswordTokenActive");
2812 if (mService != null) {
2813 try {
2814 return mService.isResetPasswordTokenActive(admin);
2815 } catch (RemoteException e) {
2816 throw e.rethrowFromSystemServer();
2817 }
2818 }
2819 return false;
2820 }
2821
2822 /**
2823 * Called by device or profile owner to force set a new device unlock password or a work profile
2824 * challenge on current user. This takes effect immediately.
2825 * <p>
2826 * Unlike {@link #resetPassword}, this API can change the password even before the user or
2827 * device is unlocked or decrypted. The supplied token must have been previously provisioned via
2828 * {@link #setResetPasswordToken}, and in active state {@link #isResetPasswordTokenActive}.
2829 * <p>
2830 * The given password must be sufficient for the current password quality and length constraints
2831 * as returned by {@link #getPasswordQuality(ComponentName)} and
2832 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2833 * it will be rejected and false returned. Note that the password may be a stronger quality
2834 * (containing alphanumeric characters when the requested quality is only numeric), in which
2835 * case the currently active quality will be increased to match.
2836 * <p>
2837 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
2838 * current password constraints allow it.
2839 *
2840 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2841 * @param password The new password for the user. Null or empty clears the password.
2842 * @param token the password reset token previously provisioned by #setResetPasswordToken.
2843 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
2844 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2845 * @return Returns true if the password was applied, or false if it is not acceptable for the
2846 * current constraints.
2847 * @throws SecurityException if the calling application does not own an active administrator
2848 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
2849 * @throws IllegalStateException if the provided token is not valid.
2850 * @throws IllegalArgumentException if the password does not meet system requirements.
2851 */
2852 public boolean resetPasswordWithToken(@NonNull ComponentName admin, String password,
2853 byte[] token, int flags) {
2854 throwIfParentInstance("resetPassword");
2855 if (mService != null) {
2856 try {
2857 return mService.resetPasswordWithToken(admin, password, token, flags);
2858 } catch (RemoteException e) {
2859 throw e.rethrowFromSystemServer();
2860 }
2861 }
2862 return false;
2863 }
2864
2865 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002866 * Called by an application that is administering the device to set the maximum time for user
2867 * activity until the device will lock. This limits the length that the user can set. It takes
2868 * effect immediately.
2869 * <p>
2870 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2871 * to be able to call this method; if it has not, a security exception will be thrown.
2872 * <p>
2873 * This method can be called on the {@link DevicePolicyManager} instance returned by
2874 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2875 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002876 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002877 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002878 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2879 * is no restriction.
2880 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2881 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002882 */
Robin Lee25e26452015-06-02 09:56:29 -07002883 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002884 if (mService != null) {
2885 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002886 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002887 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002888 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002889 }
2890 }
2891 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002892
Dianne Hackbornd6847842010-01-12 18:14:19 -08002893 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002894 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002895 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002896 * a separate challenge are not taken into account.
2897 *
2898 * <p>This method can be called on the {@link DevicePolicyManager} instance
2899 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2900 * restrictions on the parent profile.
2901 *
Robin Lee25e26452015-06-02 09:56:29 -07002902 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002903 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002904 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002905 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002906 */
Robin Lee25e26452015-06-02 09:56:29 -07002907 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002908 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002909 }
2910
2911 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002912 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002913 if (mService != null) {
2914 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002915 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002916 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002917 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002918 }
2919 }
2920 return 0;
2921 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002922
Dianne Hackbornd6847842010-01-12 18:14:19 -08002923 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002924 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2925 * do not have a separate timeout to lock for work challenge only.
2926 *
2927 * @hide
2928 */
2929 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2930 if (mService != null) {
2931 try {
2932 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2933 } catch (RemoteException e) {
2934 throw e.rethrowFromSystemServer();
2935 }
2936 }
2937 return 0;
2938 }
2939
2940 /**
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002941 * Called by a device/profile owner to set the timeout after which unlocking with secondary, non
2942 * strong auth (e.g. fingerprint, trust agents) times out, i.e. the user has to use a strong
2943 * authentication method like password, pin or pattern.
2944 *
2945 * <p>This timeout is used internally to reset the timer to require strong auth again after
2946 * specified timeout each time it has been successfully used.
2947 *
2948 * <p>Fingerprint can also be disabled altogether using {@link #KEYGUARD_DISABLE_FINGERPRINT}.
2949 *
2950 * <p>Trust agents can also be disabled altogether using {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
2951 *
2952 * <p>The calling device admin must be a device or profile owner. If it is not,
2953 * a {@link SecurityException} will be thrown.
2954 *
Michal Karpinski943aabd2016-10-06 11:09:25 +01002955 * <p>The calling device admin can verify the value it has set by calling
2956 * {@link #getRequiredStrongAuthTimeout(ComponentName)} and passing in its instance.
2957 *
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002958 * <p>This method can be called on the {@link DevicePolicyManager} instance returned by
2959 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2960 * profile.
2961 *
2962 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2963 * @param timeoutMs The new timeout, after which the user will have to unlock with strong
Michal Karpinski943aabd2016-10-06 11:09:25 +01002964 * authentication method. A value of 0 means the admin is not participating in
2965 * controlling the timeout.
2966 * The minimum and maximum timeouts are platform-defined and are typically 1 hour and
2967 * 72 hours, respectively. Though discouraged, the admin may choose to require strong
2968 * auth at all times using {@link #KEYGUARD_DISABLE_FINGERPRINT} and/or
2969 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002970 *
2971 * @throws SecurityException if {@code admin} is not a device or profile owner.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002972 */
2973 public void setRequiredStrongAuthTimeout(@NonNull ComponentName admin,
2974 long timeoutMs) {
2975 if (mService != null) {
2976 try {
2977 mService.setRequiredStrongAuthTimeout(admin, timeoutMs, mParentInstance);
2978 } catch (RemoteException e) {
2979 throw e.rethrowFromSystemServer();
2980 }
2981 }
2982 }
2983
2984 /**
2985 * Determine for how long the user will be able to use secondary, non strong auth for
2986 * authentication, since last strong method authentication (password, pin or pattern) was used.
2987 * After the returned timeout the user is required to use strong authentication method.
2988 *
2989 * <p>This method can be called on the {@link DevicePolicyManager} instance
2990 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2991 * restrictions on the parent profile.
2992 *
2993 * @param admin The name of the admin component to check, or {@code null} to aggregate
2994 * accross all participating admins.
Michal Karpinski943aabd2016-10-06 11:09:25 +01002995 * @return The timeout or 0 if not configured for the provided admin.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002996 */
2997 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin) {
2998 return getRequiredStrongAuthTimeout(admin, myUserId());
2999 }
3000
3001 /** @hide per-user version */
3002 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin, @UserIdInt int userId) {
3003 if (mService != null) {
3004 try {
3005 return mService.getRequiredStrongAuthTimeout(admin, userId, mParentInstance);
3006 } catch (RemoteException e) {
3007 throw e.rethrowFromSystemServer();
3008 }
3009 }
3010 return DEFAULT_STRONG_AUTH_TIMEOUT_MS;
3011 }
3012
3013 /**
Andrew Scull85a63bc2016-10-24 13:47:47 +01003014 * Flag for {@link #lockNow(int)}: also evict the user's credential encryption key from the
3015 * keyring. The user's credential will need to be entered again in order to derive the
3016 * credential encryption key that will be stored back in the keyring for future use.
3017 * <p>
3018 * This flag can only be used by a profile owner when locking a managed profile on an FBE
3019 * device.
3020 * <p>
3021 * In order to secure user data, the user will be stopped and restarted so apps should wait
3022 * until they are next run to perform further actions.
3023 */
3024 public static final int FLAG_EVICT_CE_KEY = 1;
3025
3026 /** @hide */
3027 @Retention(RetentionPolicy.SOURCE)
3028 @IntDef(flag=true, value={FLAG_EVICT_CE_KEY})
3029 public @interface LockNowFlag {}
3030
3031 /**
3032 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
3033 * this call.
3034 * <p>
3035 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
3036 * to be able to call this method; if it has not, a security exception will be thrown.
3037 * <p>
3038 * This method can be called on the {@link DevicePolicyManager} instance returned by
3039 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
3040 * <p>
3041 * Equivalent to calling {@link #lockNow(int)} with no flags.
3042 *
3043 * @throws SecurityException if the calling application does not own an active administrator
3044 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
3045 */
3046 public void lockNow() {
3047 lockNow(0);
3048 }
3049
3050 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003051 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
3052 * this call.
3053 * <p>
3054 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
3055 * to be able to call this method; if it has not, a security exception will be thrown.
3056 * <p>
3057 * This method can be called on the {@link DevicePolicyManager} instance returned by
3058 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003059 *
Andrew Scull85a63bc2016-10-24 13:47:47 +01003060 * @param flags May be 0 or {@link #FLAG_EVICT_CE_KEY}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003061 * @throws SecurityException if the calling application does not own an active administrator
Andrew Scull85a63bc2016-10-24 13:47:47 +01003062 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} or the
3063 * {@link #FLAG_EVICT_CE_KEY} flag is passed by an application that is not a profile
3064 * owner of a managed profile.
3065 * @throws IllegalArgumentException if the {@link #FLAG_EVICT_CE_KEY} flag is passed when
3066 * locking the parent profile.
3067 * @throws UnsupportedOperationException if the {@link #FLAG_EVICT_CE_KEY} flag is passed on a
3068 * non-FBE device.
Dianne Hackbornd6847842010-01-12 18:14:19 -08003069 */
Andrew Scull85a63bc2016-10-24 13:47:47 +01003070 public void lockNow(@LockNowFlag int flags) {
Dianne Hackborndf83afa2010-01-20 13:37:26 -08003071 if (mService != null) {
3072 try {
Andrew Scull85a63bc2016-10-24 13:47:47 +01003073 mService.lockNow(flags, mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08003074 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003075 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08003076 }
3077 }
3078 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003079
Dianne Hackbornd6847842010-01-12 18:14:19 -08003080 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07003081 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00003082 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07003083 */
3084 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
3085
3086 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00003087 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
3088 * data.
3089 *
Paul Crowley2934b262014-12-02 11:21:13 +00003090 * <p>This flag may only be set by device owner admins; if it is set by
3091 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00003092 */
3093 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
3094
3095 /**
Suprabh Shukla556b05a2016-08-10 15:49:24 -07003096 * Ask that all user data be wiped. If called as a secondary user, the user will be removed and
3097 * other users will remain unaffected. Calling from the primary user will cause the device to
3098 * reboot, erasing all device data - including all the secondary users and their data - while
3099 * booting up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003100 * <p>
3101 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
3102 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003103 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003104 * @param flags Bit mask of additional options: currently supported flags are
3105 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
3106 * @throws SecurityException if the calling application does not own an active administrator
3107 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08003108 */
3109 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003110 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08003111 if (mService != null) {
3112 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003113 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003114 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003115 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003116 }
3117 }
3118 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003119
Dianne Hackbornd6847842010-01-12 18:14:19 -08003120 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07003121 * Called by an application that is administering the device to set the
3122 * global proxy and exclusion list.
3123 * <p>
3124 * The calling device admin must have requested
3125 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
3126 * this method; if it has not, a security exception will be thrown.
3127 * Only the first device admin can set the proxy. If a second admin attempts
3128 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07003129 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07003130 * be returned.
3131 * The method can be called repeatedly by the device admin alrady setting the
3132 * proxy to update the proxy and exclusion list.
3133 *
Robin Lee25e26452015-06-02 09:56:29 -07003134 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07003135 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
3136 * Pass Proxy.NO_PROXY to reset the proxy.
3137 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07003138 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
3139 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08003140 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07003141 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003142 public @Nullable ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07003143 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003144 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07003145 if (proxySpec == null) {
3146 throw new NullPointerException();
3147 }
3148 if (mService != null) {
3149 try {
3150 String hostSpec;
3151 String exclSpec;
3152 if (proxySpec.equals(Proxy.NO_PROXY)) {
3153 hostSpec = null;
3154 exclSpec = null;
3155 } else {
3156 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
3157 throw new IllegalArgumentException();
3158 }
3159 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
3160 String hostName = sa.getHostName();
3161 int port = sa.getPort();
3162 StringBuilder hostBuilder = new StringBuilder();
3163 hostSpec = hostBuilder.append(hostName)
3164 .append(":").append(Integer.toString(port)).toString();
3165 if (exclusionList == null) {
3166 exclSpec = "";
3167 } else {
3168 StringBuilder listBuilder = new StringBuilder();
3169 boolean firstDomain = true;
3170 for (String exclDomain : exclusionList) {
3171 if (!firstDomain) {
3172 listBuilder = listBuilder.append(",");
3173 } else {
3174 firstDomain = false;
3175 }
3176 listBuilder = listBuilder.append(exclDomain.trim());
3177 }
3178 exclSpec = listBuilder.toString();
3179 }
Yuhao Zheng90704842014-02-28 17:22:45 -08003180 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
3181 != android.net.Proxy.PROXY_VALID)
3182 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07003183 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003184 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07003185 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003186 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07003187 }
3188 }
3189 return null;
3190 }
3191
3192 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003193 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
3194 * HTTP proxies - they are generally network dependent. However if you're doing something
3195 * unusual like general internal filtering this may be useful. On a private network where the
3196 * proxy is not accessible, you may break HTTP using this.
3197 * <p>
3198 * This method requires the caller to be the device owner.
3199 * <p>
3200 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04003201 *
Jason Monk03bc9912014-05-13 09:44:57 -04003202 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003203 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3204 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
3205 * {@code null} value will clear the global HTTP proxy.
3206 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04003207 */
Robin Lee25e26452015-06-02 09:56:29 -07003208 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
3209 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003210 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04003211 if (mService != null) {
3212 try {
3213 mService.setRecommendedGlobalProxy(admin, proxyInfo);
3214 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003215 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04003216 }
3217 }
3218 }
3219
3220 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07003221 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07003222 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
3223 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08003224 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07003225 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003226 public @Nullable ComponentName getGlobalProxyAdmin() {
Oscar Montemayor69238c62010-08-03 10:51:06 -07003227 if (mService != null) {
3228 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003229 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07003230 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003231 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07003232 }
3233 }
3234 return null;
3235 }
3236
3237 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08003238 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003239 * indicating that encryption is not supported.
3240 */
3241 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
3242
3243 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08003244 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003245 * indicating that encryption is supported, but is not currently active.
3246 */
3247 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
3248
3249 /**
Robin Lee3795fb02015-02-16 14:17:23 +00003250 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003251 * indicating that encryption is not currently active, but is currently
3252 * being activated. This is only reported by devices that support
3253 * encryption of data and only when the storage is currently
3254 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
3255 * to become encrypted will never return this value.
3256 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08003257 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003258
3259 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08003260 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003261 * indicating that encryption is active.
Amith Yamasani75db1252016-07-11 14:41:01 -07003262 * <p>
3263 * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003264 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08003265 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003266
3267 /**
Robin Lee3795fb02015-02-16 14:17:23 +00003268 * Result code for {@link #getStorageEncryptionStatus}:
3269 * indicating that encryption is active, but an encryption key has not
3270 * been set by the user.
3271 */
3272 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
3273
3274 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08003275 * Result code for {@link #getStorageEncryptionStatus}:
Amith Yamasani75db1252016-07-11 14:41:01 -07003276 * indicating that encryption is active and the encryption key is tied to the user or profile.
3277 * <p>
3278 * This value is only returned to apps targeting API level 24 and above. For apps targeting
3279 * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
3280 * encryption key is specific to the user or profile.
Makoto Onukid4c9e542016-02-25 18:17:30 -08003281 */
3282 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
3283
3284 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003285 * Activity action: begin the process of encrypting data on the device. This activity should
3286 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
3287 * After resuming from this activity, use {@link #getStorageEncryption}
3288 * to check encryption status. However, on some devices this activity may never return, as
3289 * it may trigger a reboot and in some cases a complete data wipe of the device.
3290 */
3291 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3292 public static final String ACTION_START_ENCRYPTION
3293 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003294 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07003295 * Widgets are enabled in keyguard
3296 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07003297 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07003298
3299 /**
Jim Miller50e62182014-04-23 17:25:00 -07003300 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07003301 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07003302 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
3303
3304 /**
3305 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
3306 */
3307 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
3308
3309 /**
Jim Miller50e62182014-04-23 17:25:00 -07003310 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
3311 */
3312 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
3313
3314 /**
3315 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
3316 */
3317 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
3318
3319 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02003320 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07003321 * (e.g. PIN/Pattern/Password).
3322 */
3323 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
3324
3325 /**
Jim Miller06e34502014-07-17 14:46:05 -07003326 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
3327 */
3328 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
3329
3330 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08003331 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
3332 */
3333 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
3334
3335 /**
Jim Miller35207742012-11-02 15:33:20 -07003336 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07003337 */
3338 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07003339
3340 /**
Robin Leeacdeac62017-02-21 22:13:38 +00003341 * Keyguard features that when set on a managed profile that doesn't have its own challenge will
3342 * affect the profile's parent user. These can also be set on the managed profile's parent
3343 * {@link DevicePolicyManager} instance.
3344 *
3345 * @hide
3346 */
3347 public static final int PROFILE_KEYGUARD_FEATURES_AFFECT_OWNER =
3348 DevicePolicyManager.KEYGUARD_DISABLE_TRUST_AGENTS
3349 | DevicePolicyManager.KEYGUARD_DISABLE_FINGERPRINT;
3350
3351 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003352 * Called by an application that is administering the device to request that the storage system
3353 * be encrypted.
3354 * <p>
3355 * When multiple device administrators attempt to control device encryption, the most secure,
3356 * supported setting will always be used. If any device administrator requests device
3357 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
3358 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003359 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003360 * <p>
3361 * This policy controls encryption of the secure (application data) storage area. Data written
3362 * to other storage areas may or may not be encrypted, and this policy does not require or
3363 * control the encryption of any other storage areas. There is one exception: If
3364 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
3365 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
3366 * written to disk within the encrypted storage area.
3367 * <p>
3368 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
3369 * to create a device PIN or Password. In this case, the storage is encrypted, but the
3370 * encryption key may not be fully secured. For maximum security, the administrator should also
3371 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003372 *
3373 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3374 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08003375 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003376 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
3377 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
3378 * {@link #getStorageEncryptionStatus()} to query the actual device state.
3379 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3380 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003381 */
Robin Lee25e26452015-06-02 09:56:29 -07003382 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003383 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003384 if (mService != null) {
3385 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003386 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003387 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003388 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003389 }
3390 }
3391 return ENCRYPTION_STATUS_UNSUPPORTED;
3392 }
3393
3394 /**
3395 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08003396 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003397 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08003398 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
3399 * this will return the requested encryption setting as an aggregate of all active
3400 * administrators.
3401 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003402 */
Robin Lee25e26452015-06-02 09:56:29 -07003403 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003404 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003405 if (mService != null) {
3406 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003407 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003408 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003409 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003410 }
3411 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08003412 return false;
3413 }
3414
3415 /**
3416 * Called by an application that is administering the device to
3417 * determine the current encryption status of the device.
Amith Yamasani75db1252016-07-11 14:41:01 -07003418 * <p>
Andy Stadler22dbfda2011-01-17 12:47:31 -08003419 * Depending on the returned status code, the caller may proceed in different
3420 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
3421 * storage system does not support encryption. If the
3422 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
3423 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00003424 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
3425 * storage system has enabled encryption but no password is set so further action
Amith Yamasani75db1252016-07-11 14:41:01 -07003426 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
3427 * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
3428 * no further action is required.
Andy Stadler22dbfda2011-01-17 12:47:31 -08003429 *
Robin Lee7e678712014-07-24 16:41:31 +01003430 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08003431 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00003432 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
Amith Yamasani75db1252016-07-11 14:41:01 -07003433 * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08003434 */
3435 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003436 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003437 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003438 }
3439
3440 /** @hide per-user version */
3441 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08003442 if (mService != null) {
3443 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08003444 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08003445 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003446 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08003447 }
3448 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003449 return ENCRYPTION_STATUS_UNSUPPORTED;
3450 }
3451
3452 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00003453 * Mark a CA certificate as approved by the device user. This means that they have been notified
3454 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
3455 * keep the certificate on the device.
3456 *
3457 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
3458 * this certificate.
3459 *
3460 * @hide
3461 */
3462 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
3463 if (mService != null) {
3464 try {
3465 return mService.approveCaCert(alias, userHandle, approval);
3466 } catch (RemoteException e) {
3467 throw e.rethrowFromSystemServer();
3468 }
3469 }
3470 return false;
3471 }
3472
3473 /**
3474 * Check whether a CA certificate has been approved by the device user.
3475 *
3476 * @hide
3477 */
3478 public boolean isCaCertApproved(String alias, int userHandle) {
3479 if (mService != null) {
3480 try {
3481 return mService.isCaCertApproved(alias, userHandle);
3482 } catch (RemoteException e) {
3483 throw e.rethrowFromSystemServer();
3484 }
3485 }
3486 return false;
3487 }
3488
3489 /**
Robin Lee7e678712014-07-24 16:41:31 +01003490 * Installs the given certificate as a user CA.
3491 *
Edman Anjosf9946772016-11-28 16:35:15 +01003492 * The caller must be a profile or device owner on that user, or a delegate package given the
3493 * {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a
3494 * security exception will be thrown.
3495 *
Robin Lee25e26452015-06-02 09:56:29 -07003496 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3497 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003498 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04003499 *
3500 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01003501 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003502 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3503 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003504 * @see #setDelegatedScopes
3505 * @see #DELEGATION_CERT_INSTALL
Maggie Benthallda51e682013-08-08 22:35:44 -04003506 */
Robin Lee25e26452015-06-02 09:56:29 -07003507 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003508 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04003509 if (mService != null) {
3510 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003511 return mService.installCaCert(admin, mContext.getPackageName(), certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04003512 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003513 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04003514 }
3515 }
3516 return false;
3517 }
3518
3519 /**
Robin Lee7e678712014-07-24 16:41:31 +01003520 * Uninstalls the given certificate from trusted user CAs, if present.
3521 *
Edman Anjosf9946772016-11-28 16:35:15 +01003522 * The caller must be a profile or device owner on that user, or a delegate package given the
3523 * {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a
3524 * security exception will be thrown.
3525 *
Robin Lee25e26452015-06-02 09:56:29 -07003526 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3527 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003528 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003529 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3530 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003531 * @see #setDelegatedScopes
3532 * @see #DELEGATION_CERT_INSTALL
Maggie Benthallda51e682013-08-08 22:35:44 -04003533 */
Robin Lee25e26452015-06-02 09:56:29 -07003534 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003535 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04003536 if (mService != null) {
3537 try {
Robin Lee306fe082014-06-19 14:04:24 +00003538 final String alias = getCaCertAlias(certBuffer);
Edman Anjosf9946772016-11-28 16:35:15 +01003539 mService.uninstallCaCerts(admin, mContext.getPackageName(), new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00003540 } catch (CertificateException e) {
3541 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04003542 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003543 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04003544 }
3545 }
3546 }
3547
3548 /**
Robin Lee7e678712014-07-24 16:41:31 +01003549 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
3550 * If a user has installed any certificates by other means than device policy these will be
3551 * included too.
3552 *
Robin Lee25e26452015-06-02 09:56:29 -07003553 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3554 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003555 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003556 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3557 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04003558 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003559 public @NonNull List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
3560 final List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01003561 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003562 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01003563 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003564 mService.enforceCanManageCaCerts(admin, mContext.getPackageName());
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003565 final TrustedCertificateStore certStore = new TrustedCertificateStore();
3566 for (String alias : certStore.userAliases()) {
3567 try {
3568 certs.add(certStore.getCertificate(alias).getEncoded());
3569 } catch (CertificateException ce) {
3570 Log.w(TAG, "Could not encode certificate: " + alias, ce);
3571 }
3572 }
3573 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003574 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01003575 }
3576 }
3577 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04003578 }
3579
3580 /**
Robin Lee7e678712014-07-24 16:41:31 +01003581 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
3582 * means other than device policy will also be removed, except for system CA certificates.
3583 *
Robin Lee25e26452015-06-02 09:56:29 -07003584 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3585 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003586 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3587 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01003588 */
Robin Lee25e26452015-06-02 09:56:29 -07003589 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003590 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01003591 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07003592 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003593 mService.uninstallCaCerts(admin, mContext.getPackageName(),
3594 new TrustedCertificateStore().userAliases() .toArray(new String[0]));
Robin Lee83881bd2015-06-09 16:04:38 -07003595 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003596 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01003597 }
3598 }
3599 }
3600
3601 /**
3602 * Returns whether this certificate is installed as a trusted CA.
3603 *
Robin Lee25e26452015-06-02 09:56:29 -07003604 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3605 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003606 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003607 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3608 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04003609 */
Robin Lee25e26452015-06-02 09:56:29 -07003610 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003611 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003612 if (mService != null) {
3613 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003614 mService.enforceCanManageCaCerts(admin, mContext.getPackageName());
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003615 return getCaCertAlias(certBuffer) != null;
3616 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003617 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003618 } catch (CertificateException ce) {
3619 Log.w(TAG, "Could not parse certificate", ce);
3620 }
Maggie Benthallda51e682013-08-08 22:35:44 -04003621 }
3622 return false;
3623 }
3624
3625 /**
Robin Leece3399f2016-02-24 12:08:32 +00003626 * Called by a device or profile owner, or delegated certificate installer, to install a
3627 * certificate and corresponding private key. All apps within the profile will be able to access
3628 * the certificate and use the private key, given direct user approval.
3629 *
3630 * <p>Access to the installed credentials will not be granted to the caller of this API without
3631 * direct user approval. This is for security - should a certificate installer become
3632 * compromised, certificates it had already installed will be protected.
3633 *
3634 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00003635 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003636 *
Robin Lee25e26452015-06-02 09:56:29 -07003637 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3638 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003639 * @param privKey The private key to install.
3640 * @param cert The certificate to install.
3641 * @param alias The private key alias under which to install the certificate. If a certificate
3642 * with that alias already exists, it will be overwritten.
3643 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003644 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3645 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003646 * @see #setDelegatedScopes
3647 * @see #DELEGATION_CERT_INSTALL
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003648 */
Robin Leefbc65642015-08-03 16:21:22 +01003649 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
3650 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00003651 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00003652 }
3653
3654 /**
3655 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00003656 * certificate chain and corresponding private key for the leaf certificate. All apps within the
3657 * profile will be able to access the certificate chain and use the private key, given direct
3658 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00003659 *
Robin Leea1b290e2016-03-09 14:38:36 +00003660 * <p>The caller of this API may grant itself access to the certificate and private key
3661 * immediately, without user approval. It is a best practice not to request this unless strictly
3662 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00003663 *
3664 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003665 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00003666 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00003667 * @param certs The certificate chain to install. The chain should start with the leaf
3668 * certificate and include the chain of trust in order. This will be returned by
3669 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00003670 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00003671 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00003672 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00003673 * credentials immediately. Otherwise, access to the credentials will be gated by user
3674 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00003675 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003676 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3677 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00003678 * @see android.security.KeyChain#getCertificateChain
Edman Anjosf9946772016-11-28 16:35:15 +01003679 * @see #setDelegatedScopes
3680 * @see #DELEGATION_CERT_INSTALL
Robin Leece3399f2016-02-24 12:08:32 +00003681 */
3682 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00003683 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003684 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003685 try {
Rubin Xub4365912016-03-23 12:13:22 +00003686 final byte[] pemCert = Credentials.convertToPem(certs[0]);
3687 byte[] pemChain = null;
3688 if (certs.length > 1) {
3689 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
3690 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01003691 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
3692 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Edman Anjosf9946772016-11-28 16:35:15 +01003693 return mService.installKeyPair(admin, mContext.getPackageName(), pkcs8Key, pemCert,
3694 pemChain, alias, requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003695 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003696 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01003697 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
3698 Log.w(TAG, "Failed to obtain private key material", e);
3699 } catch (CertificateException | IOException e) {
3700 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003701 }
3702 return false;
3703 }
3704
3705 /**
Robin Leea1b290e2016-03-09 14:38:36 +00003706 * Called by a device or profile owner, or delegated certificate installer, to remove a
3707 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01003708 *
3709 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003710 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01003711 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00003712 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003713 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3714 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003715 * @see #setDelegatedScopes
3716 * @see #DELEGATION_CERT_INSTALL
Robin Leefbc65642015-08-03 16:21:22 +01003717 */
3718 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003719 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01003720 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003721 return mService.removeKeyPair(admin, mContext.getPackageName(), alias);
Robin Leefbc65642015-08-03 16:21:22 +01003722 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003723 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01003724 }
Robin Leefbc65642015-08-03 16:21:22 +01003725 }
3726
3727 /**
Robin Lee25e26452015-06-02 09:56:29 -07003728 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00003729 * doesn't exist.
3730 */
3731 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
3732 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
3733 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
3734 new ByteArrayInputStream(certBuffer));
3735 return new TrustedCertificateStore().getCertificateAlias(cert);
3736 }
3737
3738 /**
Rubin Xuec32b562015-03-03 17:34:05 +00003739 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01003740 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00003741 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01003742 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00003743 * <p>
3744 * Delegated certificate installer is a per-user state. The delegated access is persistent until
3745 * it is later cleared by calling this method with a null value or uninstallling the certificate
3746 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003747 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00003748 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
3749 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003750 * supplied certificate installer package must be installed when calling this API, otherwise an
3751 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00003752 *
Robin Lee25e26452015-06-02 09:56:29 -07003753 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00003754 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003755 * access. If {@code null} is given the current package will be cleared.
3756 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003757 *
3758 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes}
3759 * with the {@link #DELEGATION_CERT_INSTALL} scope instead.
Rubin Xuec32b562015-03-03 17:34:05 +00003760 */
Edman Anjosf9946772016-11-28 16:35:15 +01003761 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07003762 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
3763 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003764 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003765 if (mService != null) {
3766 try {
Robin Lee25e26452015-06-02 09:56:29 -07003767 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00003768 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003769 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003770 }
3771 }
3772 }
3773
3774 /**
Edman Anjosf9946772016-11-28 16:35:15 +01003775 * Called by a profile owner or device owner to retrieve the certificate installer for the user,
3776 * or {@code null} if none is set. If there are multiple delegates this function will return one
3777 * of them.
Rubin Xuec32b562015-03-03 17:34:05 +00003778 *
Robin Lee25e26452015-06-02 09:56:29 -07003779 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003780 * @return The package name of the current delegated certificate installer, or {@code null} if
3781 * none is set.
3782 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003783 *
3784 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages}
3785 * with the {@link #DELEGATION_CERT_INSTALL} scope instead.
Rubin Xuec32b562015-03-03 17:34:05 +00003786 */
Edman Anjosf9946772016-11-28 16:35:15 +01003787 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07003788 public @Nullable String getCertInstallerPackage(@NonNull ComponentName admin)
3789 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003790 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003791 if (mService != null) {
3792 try {
Robin Lee25e26452015-06-02 09:56:29 -07003793 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00003794 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003795 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003796 }
3797 }
3798 return null;
3799 }
3800
3801 /**
Edman Anjosf9946772016-11-28 16:35:15 +01003802 * Called by a profile owner or device owner to grant access to privileged APIs to another app.
3803 * Granted APIs are determined by {@code scopes}, which is a list of the {@code DELEGATION_*}
3804 * constants.
3805 * <p>
Edman Anjos9e62c312017-01-26 22:22:58 +01003806 * A broadcast with the {@link #ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED} action will be
3807 * sent to the {@code delegatePackage} with its new scopes in an {@code ArrayList<String>} extra
3808 * under the {@link #EXTRA_DELEGATION_SCOPES} key. The broadcast is sent with the
3809 * {@link Intent#FLAG_RECEIVER_REGISTERED_ONLY} flag.
3810 * <p>
Edman Anjosf9946772016-11-28 16:35:15 +01003811 * Delegated scopes are a per-user state. The delegated access is persistent until it is later
3812 * cleared by calling this method with an empty {@code scopes} list or uninstalling the
3813 * {@code delegatePackage}.
3814 *
3815 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3816 * @param delegatePackage The package name of the app which will be given access.
3817 * @param scopes The groups of privileged APIs whose access should be granted to
3818 * {@code delegatedPackage}.
3819 * @throws SecurityException if {@code admin} is not a device or a profile owner.
3820 */
3821 public void setDelegatedScopes(@NonNull ComponentName admin, @NonNull String delegatePackage,
3822 @NonNull List<String> scopes) {
3823 throwIfParentInstance("setDelegatedScopes");
3824 if (mService != null) {
3825 try {
3826 mService.setDelegatedScopes(admin, delegatePackage, scopes);
3827 } catch (RemoteException e) {
3828 throw e.rethrowFromSystemServer();
3829 }
3830 }
3831 }
3832
3833 /**
3834 * Called by a profile owner or device owner to retrieve a list of the scopes given to a
3835 * delegate package. Other apps can use this method to retrieve their own delegated scopes by
3836 * passing {@code null} for {@code admin} and their own package name as
3837 * {@code delegatedPackage}.
3838 *
3839 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3840 * {@code null} if the caller is {@code delegatedPackage}.
3841 * @param delegatedPackage The package name of the app whose scopes should be retrieved.
3842 * @return A list containing the scopes given to {@code delegatedPackage}.
3843 * @throws SecurityException if {@code admin} is not a device or a profile owner.
3844 */
3845 @NonNull
Edman Anjos9e62c312017-01-26 22:22:58 +01003846 public List<String> getDelegatedScopes(@Nullable ComponentName admin,
Edman Anjosf9946772016-11-28 16:35:15 +01003847 @NonNull String delegatedPackage) {
3848 throwIfParentInstance("getDelegatedScopes");
3849 if (mService != null) {
3850 try {
3851 return mService.getDelegatedScopes(admin, delegatedPackage);
3852 } catch (RemoteException e) {
3853 throw e.rethrowFromSystemServer();
3854 }
3855 }
3856 return null;
3857 }
3858
3859 /**
3860 * Called by a profile owner or device owner to retrieve a list of delegate packages that were
3861 * granted a delegation scope.
3862 *
3863 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3864 * @param delegationScope The scope whose delegates should be retrieved.
3865 * @return A list of package names of the current delegated packages for
3866 {@code delegationScope}.
3867 * @throws SecurityException if {@code admin} is not a device or a profile owner.
3868 */
3869 @Nullable
3870 public List<String> getDelegatePackages(@NonNull ComponentName admin,
3871 @NonNull String delegationScope) {
3872 throwIfParentInstance("getDelegatePackages");
3873 if (mService != null) {
3874 try {
3875 return mService.getDelegatePackages(admin, delegationScope);
3876 } catch (RemoteException e) {
3877 throw e.rethrowFromSystemServer();
3878 }
3879 }
3880 return null;
3881 }
3882
3883 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003884 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003885 * specific application for the current user.
3886 *
3887 * @deprecated this version only exists for compability with previous developer preview builds.
3888 * TODO: delete once there are no longer any live references.
3889 * @hide
3890 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003891 @Deprecated
Robin Leedc679712016-05-03 13:23:03 +01003892 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3893 throws NameNotFoundException, UnsupportedOperationException {
3894 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3895 }
3896
3897 /**
3898 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003899 * specific application for the current user. This connection is automatically granted and
3900 * persisted after a reboot.
3901 * <p>
3902 * The designated package should declare a {@link android.net.VpnService} in its manifest
3903 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3904 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003905 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003906 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003907 * remove an existing always-on VPN configuration.
3908 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3909 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3910 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003911 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003912 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3913 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3914 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003915 */
Robin Leedc679712016-05-03 13:23:03 +01003916 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3917 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003918 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003919 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003920 if (mService != null) {
3921 try {
Robin Leedc679712016-05-03 13:23:03 +01003922 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003923 throw new NameNotFoundException(vpnPackage);
3924 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003925 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003926 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003927 }
3928 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003929 }
3930
3931 /**
3932 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003933 * always-on VPN connection for the current user. If there is no such package, or the always-on
3934 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003935 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003936 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3937 * is set.
3938 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003939 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003940 public @Nullable String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003941 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003942 if (mService != null) {
3943 try {
3944 return mService.getAlwaysOnVpnPackage(admin);
3945 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003946 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003947 }
3948 }
3949 return null;
3950 }
3951
3952 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003953 * Called by an application that is administering the device to disable all cameras on the
3954 * device, for this user. After setting this, no applications running as this user will be able
3955 * to access any cameras on the device.
3956 * <p>
3957 * If the caller is device owner, then the restriction will be applied to all users.
3958 * <p>
3959 * The calling device admin must have requested
3960 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3961 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003962 *
3963 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3964 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003965 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3966 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003967 */
Robin Lee25e26452015-06-02 09:56:29 -07003968 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003969 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07003970 if (mService != null) {
3971 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003972 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003973 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003974 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003975 }
3976 }
3977 }
3978
3979 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003980 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003981 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003982 * @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 -07003983 * have disabled the camera
3984 */
Robin Lee25e26452015-06-02 09:56:29 -07003985 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003986 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003987 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003988 }
3989
3990 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003991 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003992 if (mService != null) {
3993 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003994 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003995 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003996 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003997 }
3998 }
3999 return false;
4000 }
4001
4002 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004003 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004004 * <p>
Esteban Talaverad36dd152016-12-15 08:51:45 +00004005 * If the device contains secondary users or profiles, they must be affiliated with the device
4006 * owner user. Otherwise a {@link SecurityException} will be thrown. See
4007 * {@link #setAffiliationIds}.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004008 *
4009 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004010 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
4011 * wasn't triggered because a previous bugreport operation is still active (either the
4012 * bugreport is still running or waiting for the user to share or decline)
Esteban Talaverad36dd152016-12-15 08:51:45 +00004013 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
4014 * profile or secondary user that is not affiliated with the device owner user.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004015 */
4016 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004017 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004018 if (mService != null) {
4019 try {
4020 return mService.requestBugreport(admin);
4021 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004022 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004023 }
4024 }
4025 return false;
4026 }
4027
4028 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07004029 * Determine whether or not creating a guest user has been disabled for the device
4030 *
4031 * @hide
4032 */
4033 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
4034 // Currently guest users can always be created if multi-user is enabled
4035 // TODO introduce a policy for guest user creation
4036 return false;
4037 }
4038
4039 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01004040 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
4041 * screen capture also prevents the content from being shown on display devices that do not have
4042 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
4043 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004044 * <p>
4045 * The calling device admin must be a device or profile owner. If it is not, a security
4046 * exception will be thrown.
4047 * <p>
4048 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
4049 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01004050 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004051 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004052 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004053 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004054 */
Robin Lee25e26452015-06-02 09:56:29 -07004055 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004056 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004057 if (mService != null) {
4058 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08004059 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004060 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004061 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004062 }
4063 }
4064 }
4065
4066 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004067 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004068 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07004069 * @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 +01004070 * have disabled screen capture.
4071 */
Robin Lee25e26452015-06-02 09:56:29 -07004072 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004073 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004074 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004075 }
4076
4077 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004078 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004079 if (mService != null) {
4080 try {
4081 return mService.getScreenCaptureDisabled(admin, userHandle);
4082 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004083 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004084 }
4085 }
4086 return false;
4087 }
4088
4089 /**
Jason Parks841cb0a2017-01-17 15:25:17 -06004090 * Called by a device or profile owner to set whether auto time is required. If auto time is
4091 * required, no user will be able set the date and time and network date and time will be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004092 * <p>
4093 * Note: if auto time is required the user can still manually set the time zone.
4094 * <p>
Jason Parks841cb0a2017-01-17 15:25:17 -06004095 * The calling device admin must be a device or profile owner. If it is not, a security
4096 * exception will be thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004097 *
4098 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4099 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004100 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004101 */
Robin Lee25e26452015-06-02 09:56:29 -07004102 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004103 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004104 if (mService != null) {
4105 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08004106 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004107 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004108 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004109 }
4110 }
4111 }
4112
4113 /**
4114 * @return true if auto time is required.
4115 */
4116 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004117 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004118 if (mService != null) {
4119 try {
4120 return mService.getAutoTimeRequired();
4121 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004122 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004123 }
4124 }
4125 return false;
4126 }
4127
4128 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004129 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004130 * <p>
4131 * The system user is exempt from this policy - it is never ephemeral.
4132 * <p>
4133 * The calling device admin must be the device owner. If it is not, a security exception will be
4134 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004135 *
4136 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4137 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004138 * subsequently created users will be ephemeral.
4139 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004140 * @hide
4141 */
4142 public void setForceEphemeralUsers(
4143 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004144 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004145 if (mService != null) {
4146 try {
4147 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
4148 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004149 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004150 }
4151 }
4152 }
4153
4154 /**
4155 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004156 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004157 * @hide
4158 */
4159 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004160 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004161 if (mService != null) {
4162 try {
4163 return mService.getForceEphemeralUsers(admin);
4164 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004165 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004166 }
4167 }
4168 return false;
4169 }
4170
4171 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07004172 * Called by an application that is administering the device to disable keyguard customizations,
4173 * such as widgets. After setting this, keyguard features will be disabled according to the
4174 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004175 * <p>
4176 * The calling device admin must have requested
4177 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4178 * if it has not, a security exception will be thrown.
4179 * <p>
4180 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
4181 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
4182 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00004183 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00004184 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004185 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00004186 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004187 * there is one, or the parent user otherwise.
4188 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
4189 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00004190 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00004191 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
4192 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004193 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
4194 * profile.
4195 * <p>
4196 * Requests to disable other features on a managed profile will be ignored.
4197 * <p>
4198 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00004199 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07004200 *
Jim Millerb8ec4702012-08-31 17:19:10 -07004201 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07004202 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004203 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
4204 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
4205 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
4206 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
4207 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
4208 * @throws SecurityException if {@code admin} is not an active administrator or does not user
4209 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07004210 */
Robin Lee25e26452015-06-02 09:56:29 -07004211 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07004212 if (mService != null) {
4213 try {
Esteban Talavera62399912016-01-11 15:37:55 +00004214 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07004215 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004216 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07004217 }
4218 }
4219 }
4220
4221 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004222 * Determine whether or not features have been disabled in keyguard either by the calling
Rubin Xud3609d42016-07-13 18:32:57 +01004223 * admin, if specified, or all admins that set restrictions on this user and its participating
Esteban Talaverac1c83592016-02-17 17:56:15 +00004224 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
4225 *
4226 * <p>This method can be called on the {@link DevicePolicyManager} instance
4227 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
4228 * restrictions on the parent profile.
4229 *
Esteban Talavera62399912016-01-11 15:37:55 +00004230 * @param admin The name of the admin component to check, or {@code null} to check whether any
4231 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07004232 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
4233 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07004234 */
Robin Lee25e26452015-06-02 09:56:29 -07004235 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004236 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004237 }
4238
4239 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004240 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07004241 if (mService != null) {
4242 try {
Esteban Talavera62399912016-01-11 15:37:55 +00004243 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07004244 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004245 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07004246 }
4247 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07004248 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07004249 }
4250
4251 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08004252 * @hide
4253 */
Robin Lee25e26452015-06-02 09:56:29 -07004254 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
4255 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004256 if (mService != null) {
4257 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01004258 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004259 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004260 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004261 }
4262 }
4263 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07004264
Dianne Hackbornd6847842010-01-12 18:14:19 -08004265 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01004266 * @hide
4267 */
Robin Lee25e26452015-06-02 09:56:29 -07004268 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004269 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01004270 }
4271
4272 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08004273 * @hide
4274 */
Robin Lee25e26452015-06-02 09:56:29 -07004275 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08004276 if (mService != null) {
4277 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004278 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08004279 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004280 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08004281 }
4282 }
4283 }
4284
4285 /**
4286 * @hide
4287 */
Andrew Scull5f9e6f32016-08-02 14:22:17 +01004288 public void setActivePasswordState(PasswordMetrics metrics, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004289 if (mService != null) {
4290 try {
Andrew Scull5f9e6f32016-08-02 14:22:17 +01004291 mService.setActivePasswordState(metrics, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004292 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004293 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004294 }
4295 }
4296 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07004297
Dianne Hackbornd6847842010-01-12 18:14:19 -08004298 /**
4299 * @hide
4300 */
Andrew Scull5daf2732016-11-14 15:02:45 +00004301 public void reportPasswordChanged(@UserIdInt int userId) {
4302 if (mService != null) {
4303 try {
4304 mService.reportPasswordChanged(userId);
4305 } catch (RemoteException e) {
4306 throw e.rethrowFromSystemServer();
4307 }
4308 }
4309 }
4310
4311 /**
4312 * @hide
4313 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004314 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004315 if (mService != null) {
4316 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004317 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004318 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004319 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004320 }
4321 }
4322 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07004323
Dianne Hackbornd6847842010-01-12 18:14:19 -08004324 /**
4325 * @hide
4326 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004327 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004328 if (mService != null) {
4329 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004330 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004331 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004332 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004333 }
4334 }
4335 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07004336
4337 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004338 * @hide
4339 */
4340 public void reportFailedFingerprintAttempt(int userHandle) {
4341 if (mService != null) {
4342 try {
4343 mService.reportFailedFingerprintAttempt(userHandle);
4344 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004345 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004346 }
4347 }
4348 }
4349
4350 /**
4351 * @hide
4352 */
4353 public void reportSuccessfulFingerprintAttempt(int userHandle) {
4354 if (mService != null) {
4355 try {
4356 mService.reportSuccessfulFingerprintAttempt(userHandle);
4357 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004358 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004359 }
4360 }
4361 }
4362
4363 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00004364 * Should be called when keyguard has been dismissed.
4365 * @hide
4366 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004367 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00004368 if (mService != null) {
4369 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004370 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00004371 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004372 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00004373 }
4374 }
4375 }
4376
4377 /**
4378 * Should be called when keyguard view has been shown to the user.
4379 * @hide
4380 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004381 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00004382 if (mService != null) {
4383 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004384 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00004385 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004386 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00004387 }
4388 }
4389 }
4390
4391 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07004392 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00004393 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07004394 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
4395 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07004396 * @return whether the package was successfully registered as the device owner.
4397 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00004398 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07004399 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004400 public boolean setDeviceOwner(ComponentName who) {
4401 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004402 }
4403
4404 /**
4405 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07004406 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004407 public boolean setDeviceOwner(ComponentName who, int userId) {
4408 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07004409 }
4410
4411 /**
4412 * @hide
4413 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004414 public boolean setDeviceOwner(ComponentName who, String ownerName) {
4415 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07004416 }
4417
4418 /**
4419 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00004420 * Sets the given package as the device owner. The package must already be installed. There
4421 * must not already be a device owner.
4422 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
4423 * this method.
4424 * Calling this after the setup phase of the primary user has completed is allowed only if
4425 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07004426 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004427 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07004428 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004429 * @return whether the package was successfully registered as the device owner.
4430 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00004431 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004432 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004433 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004434 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07004435 if (mService != null) {
4436 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07004437 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07004438 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004439 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07004440 }
4441 }
4442 return false;
4443 }
4444
4445 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004446 * Used to determine if a particular package has been registered as a Device Owner app.
4447 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07004448 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004449 * package is currently registered as the device owner app, pass in the package name from
4450 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07004451 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004452 * exact mechanism by which a device admin app is registered as a device owner app is defined by
4453 * the setup process.
4454 * @param packageName the package name of the app, to compare with the registered device owner
4455 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08004456 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07004457 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004458 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004459 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08004460 return isDeviceOwnerAppOnCallingUser(packageName);
4461 }
4462
4463 /**
4464 * @return true if a package is registered as device owner, only when it's running on the
4465 * calling user.
4466 *
4467 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
4468 * @hide
4469 */
4470 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
4471 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
4472 }
4473
4474 /**
4475 * @return true if a package is registered as device owner, even if it's running on a different
4476 * user.
4477 *
4478 * <p>Requires the MANAGE_USERS permission.
4479 *
4480 * @hide
4481 */
4482 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
4483 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
4484 }
4485
4486 /**
4487 * @return device owner component name, only when it's running on the calling user.
4488 *
4489 * @hide
4490 */
4491 public ComponentName getDeviceOwnerComponentOnCallingUser() {
4492 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
4493 }
4494
4495 /**
4496 * @return device owner component name, even if it's running on a different user.
4497 *
4498 * <p>Requires the MANAGE_USERS permission.
4499 *
4500 * @hide
4501 */
Polina Bondarenko23561db2016-12-16 11:47:28 +01004502 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08004503 public ComponentName getDeviceOwnerComponentOnAnyUser() {
4504 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
4505 }
4506
4507 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08004508 if (packageName == null) {
4509 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07004510 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08004511 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08004512 if (deviceOwner == null) {
4513 return false;
4514 }
4515 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07004516 }
4517
Makoto Onukic8a5a552015-11-19 14:29:12 -08004518 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
4519 if (mService != null) {
4520 try {
4521 return mService.getDeviceOwnerComponent(callingUserOnly);
4522 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004523 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08004524 }
4525 }
4526 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004527 }
4528
Jason Monkb0dced82014-06-06 14:36:20 -04004529 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08004530 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
4531 * no device owner.
4532 *
4533 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07004534 *
4535 * @hide
4536 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08004537 public int getDeviceOwnerUserId() {
4538 if (mService != null) {
4539 try {
4540 return mService.getDeviceOwnerUserId();
4541 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004542 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08004543 }
4544 }
4545 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07004546 }
4547
4548 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004549 * Clears the current device owner. The caller must be the device owner. This function should be
4550 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004551 * a part of device setup, before it completes.
4552 * <p>
4553 * While some policies previously set by the device owner will be cleared by this method, it is
4554 * a best-effort process and some other policies will still remain in place after the device
4555 * owner is cleared.
Jason Monk94d2cf92014-06-18 09:53:34 -04004556 *
4557 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004558 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
4559 * does not own the current device owner component.
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004560 *
4561 * @deprecated This method is expected to be used for testing purposes only. The device owner
4562 * will lose control of the device and its data after calling it. In order to protect any
4563 * sensitive data that remains on the device, it is advised that the device owner factory resets
4564 * the device instead of calling this method. See {@link #wipeData(int)}.
Jason Monkb0dced82014-06-06 14:36:20 -04004565 */
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004566 @Deprecated
Jason Monk94d2cf92014-06-18 09:53:34 -04004567 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004568 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04004569 if (mService != null) {
4570 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04004571 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04004572 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004573 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04004574 }
4575 }
4576 }
4577
Makoto Onukia52562c2015-10-01 16:12:31 -07004578 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08004579 * Returns the device owner package name, only if it's running on the calling user.
4580 *
4581 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07004582 *
4583 * @hide
4584 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004585 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004586 public @Nullable String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004587 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08004588 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
4589 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07004590 }
4591
4592 /**
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004593 * Called by the system to find out whether the device is managed by a Device Owner.
Makoto Onukic8a5a552015-11-19 14:29:12 -08004594 *
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004595 * @return whether the device is managed by a Device Owner.
4596 * @throws SecurityException if the caller is not the device owner, does not hold the
4597 * MANAGE_USERS permission and is not the system.
Makoto Onukia52562c2015-10-01 16:12:31 -07004598 *
4599 * @hide
4600 */
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004601 @SystemApi
4602 @TestApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08004603 public boolean isDeviceManaged() {
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004604 try {
4605 return mService.hasDeviceOwner();
4606 } catch (RemoteException re) {
4607 throw re.rethrowFromSystemServer();
4608 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08004609 }
4610
4611 /**
4612 * Returns the device owner name. Note this method *will* return the device owner
4613 * name when it's running on a different user.
4614 *
4615 * <p>Requires the MANAGE_USERS permission.
4616 *
4617 * @hide
4618 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08004619 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08004620 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004621 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07004622 if (mService != null) {
4623 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07004624 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07004625 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004626 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004627 }
4628 }
4629 return null;
4630 }
Adam Connors776c5552014-01-09 10:42:56 +00004631
4632 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04004633 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004634 * @deprecated Do not use
4635 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05004636 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004637 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05004638 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004639 public @Nullable String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05004640 return null;
4641 }
4642
4643 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004644 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004645 * @deprecated Do not use
4646 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004647 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004648 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004649 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004650 public @Nullable ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004651 return null;
4652 }
4653
Julia Reynolds20118f12015-02-11 12:34:08 -05004654 /**
Adam Connors776c5552014-01-09 10:42:56 +00004655 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004656 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304657 * Sets the given component as an active admin and registers the package as the profile
4658 * owner for this user. The package must already be installed and there shouldn't be
4659 * an existing profile owner registered for this user. Also, this method must be called
4660 * before the user setup has been completed.
4661 * <p>
4662 * This method can only be called by system apps that hold MANAGE_USERS permission and
4663 * MANAGE_DEVICE_ADMINS permission.
4664 * @param admin The component to register as an active admin and profile owner.
4665 * @param ownerName The user-visible name of the entity that is managing this user.
4666 * @return whether the admin was successfully registered as the profile owner.
4667 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
4668 * the user has already been set up.
4669 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004670 @Deprecated
Justin Morey80440cc2014-07-24 09:16:35 -05004671 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07004672 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304673 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004674 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304675 if (mService != null) {
4676 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004677 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304678 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004679 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304680 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004681 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304682 }
4683 }
4684 return false;
4685 }
4686
4687 /**
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004688 * Clears the active profile owner. The caller must be the profile owner of this user, otherwise
4689 * a SecurityException will be thrown. This method is not available to managed profile owners.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004690 * <p>
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004691 * While some policies previously set by the profile owner will be cleared by this method, it is
4692 * a best-effort process and some other policies will still remain in place after the profile
4693 * owner is cleared.
Makoto Onuki5bf68022016-01-27 13:49:19 -08004694 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004695 * @param admin The component to remove as the profile owner.
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004696 * @throws SecurityException if {@code admin} is not an active profile owner, or the method is
4697 * being called from a managed profile.
4698 *
4699 * @deprecated This method is expected to be used for testing purposes only. The profile owner
4700 * will lose control of the user and its data after calling it. In order to protect any
4701 * sensitive data that remains on this user, it is advised that the profile owner deletes it
4702 * instead of calling this method. See {@link #wipeData(int)}.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004703 */
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004704 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004705 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004706 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004707 if (mService != null) {
4708 try {
4709 mService.clearProfileOwner(admin);
4710 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004711 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004712 }
4713 }
4714 }
4715
4716 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05004717 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004718 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004719 */
4720 public boolean hasUserSetupCompleted() {
4721 if (mService != null) {
4722 try {
4723 return mService.hasUserSetupCompleted();
4724 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004725 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004726 }
4727 }
4728 return true;
4729 }
4730
4731 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004732 * @hide
4733 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00004734 * already be installed. There must not already be a profile owner for this user.
4735 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
4736 * this method.
4737 * Calling this after the setup phase of the specified user has completed is allowed only if:
4738 * - the caller is SYSTEM_UID.
4739 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004740 * @param admin the component name to be registered as profile owner.
4741 * @param ownerName the human readable name of the organisation associated with this DPM.
4742 * @param userHandle the userId to set the profile owner for.
4743 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00004744 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
4745 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004746 */
Robin Lee25e26452015-06-02 09:56:29 -07004747 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01004748 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004749 if (mService != null) {
4750 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004751 if (ownerName == null) {
4752 ownerName = "";
4753 }
4754 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00004755 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004756 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004757 }
4758 }
4759 return false;
4760 }
4761
4762 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004763 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004764 * <p>
4765 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004766 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004767 * <p>
4768 * If the device owner information contains only whitespaces then the message on the lock screen
4769 * will be blank and the user will not be allowed to change it.
4770 * <p>
4771 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00004772 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
4773 * and set a new version of this string accordingly.
4774 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004775 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004776 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004777 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004778 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004779 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004780 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004781 if (mService != null) {
4782 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004783 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004784 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004785 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004786 }
4787 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004788 }
4789
4790 /**
4791 * @return The device owner information. If it is not set returns {@code null}.
4792 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004793 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004794 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004795 if (mService != null) {
4796 try {
4797 return mService.getDeviceOwnerLockScreenInfo();
4798 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004799 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004800 }
4801 }
4802 return null;
4803 }
4804
4805 /**
Edman Anjos52088e42017-01-13 22:26:17 +01004806 * Called by device or profile owners to suspend packages for this user. This function can be
4807 * called by a device owner, profile owner, or by a delegate given the
4808 * {@link #DELEGATION_PACKAGE_ACCESS} scope via {@link #setDelegatedScopes}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004809 * <p>
4810 * A suspended package will not be able to start activities. Its notifications will be hidden,
4811 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
4812 * device.
4813 * <p>
4814 * The package must already be installed. If the package is uninstalled while suspended the
4815 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00004816 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004817 *
Edman Anjos52088e42017-01-13 22:26:17 +01004818 * @param admin The name of the admin component to check, or {@code null} if the caller is a
4819 * package access delegate.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004820 * @param packageNames The package names to suspend or unsuspend.
4821 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004822 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004823 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004824 * this method.
4825 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01004826 * @see #setDelegatedScopes
4827 * @see #DELEGATION_PACKAGE_ACCESS
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004828 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004829 public @NonNull String[] setPackagesSuspended(@NonNull ComponentName admin,
4830 @NonNull String[] packageNames, boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004831 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004832 if (mService != null) {
4833 try {
Edman Anjos52088e42017-01-13 22:26:17 +01004834 return mService.setPackagesSuspended(admin, mContext.getPackageName(), packageNames,
4835 suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004836 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004837 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004838 }
4839 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004840 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004841 }
4842
4843 /**
Edman Anjos52088e42017-01-13 22:26:17 +01004844 * Determine if a package is suspended. This function can be called by a device owner, profile
4845 * owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
4846 * {@link #setDelegatedScopes}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004847 *
Edman Anjos52088e42017-01-13 22:26:17 +01004848 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
4849 * {@code null} if the caller is a package access delegate.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004850 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00004851 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004852 * suspended, could not be found or an error occurred.
4853 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004854 * @throws NameNotFoundException if the package could not be found.
Edman Anjos52088e42017-01-13 22:26:17 +01004855 * @see #setDelegatedScopes
4856 * @see #DELEGATION_PACKAGE_ACCESS
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004857 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004858 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
4859 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004860 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004861 if (mService != null) {
4862 try {
Edman Anjos52088e42017-01-13 22:26:17 +01004863 return mService.isPackageSuspended(admin, mContext.getPackageName(), packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004864 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004865 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004866 } catch (IllegalArgumentException ex) {
4867 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004868 }
4869 }
4870 return false;
4871 }
4872
4873 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004874 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
4875 * be used. Only the profile owner can call this.
4876 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01004877 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004878 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004879 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004880 */
Robin Lee25e26452015-06-02 09:56:29 -07004881 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004882 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004883 if (mService != null) {
4884 try {
4885 mService.setProfileEnabled(admin);
4886 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004887 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004888 }
4889 }
4890 }
4891
4892 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004893 * Sets the name of the profile. In the device owner case it sets the name of the user which it
4894 * is called from. Only a profile owner or device owner can call this. If this is never called
4895 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004896 *
4897 * @see #isProfileOwnerApp
4898 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07004899 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004900 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004901 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004902 */
Robin Lee25e26452015-06-02 09:56:29 -07004903 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004904 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01004905 if (mService != null) {
4906 try {
Robin Lee25e26452015-06-02 09:56:29 -07004907 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004908 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004909 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004910 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004911 }
4912 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004913
4914 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004915 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08004916 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004917 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00004918 *
4919 * @param packageName The package name of the app to compare with the registered profile owner.
4920 * @return Whether or not the package is registered as the profile owner.
4921 */
4922 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004923 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00004924 if (mService != null) {
4925 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08004926 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01004927 return profileOwner != null
4928 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004929 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004930 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004931 }
4932 }
4933 return false;
4934 }
4935
4936 /**
4937 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004938 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004939 * owner has been set for that user.
4940 * @throws IllegalArgumentException if the userId is invalid.
4941 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004942 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004943 public @Nullable ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004944 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004945 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4946 }
4947
4948 /**
4949 * @see #getProfileOwner()
4950 * @hide
4951 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004952 public @Nullable ComponentName getProfileOwnerAsUser(final int userId)
4953 throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004954 if (mService != null) {
4955 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004956 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00004957 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004958 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004959 }
4960 }
4961 return null;
4962 }
4963
4964 /**
4965 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004966 * @return the human readable name of the organisation associated with this DPM or {@code null}
4967 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00004968 * @throws IllegalArgumentException if the userId is invalid.
4969 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004970 public @Nullable String getProfileOwnerName() throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004971 if (mService != null) {
4972 try {
4973 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4974 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004975 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004976 }
4977 }
4978 return null;
4979 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004980
4981 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07004982 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08004983 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07004984 * @return the human readable name of the organisation associated with this profile owner or
4985 * null if one is not set.
4986 * @throws IllegalArgumentException if the userId is invalid.
4987 */
4988 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004989 public @Nullable String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004990 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07004991 if (mService != null) {
4992 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02004993 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07004994 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004995 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07004996 }
4997 }
4998 return null;
4999 }
5000
5001 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005002 * Called by a profile owner or device owner to add a default intent handler activity for
5003 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005004 * handler even if the set of potential event handlers for the intent filter changes and if the
5005 * intent preferences are reset.
5006 * <p>
5007 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
5008 * When the activity is (re)installed, it is automatically reset as default intent handler for
5009 * the filter.
5010 * <p>
5011 * The calling device admin must be a profile owner or device owner. If it is not, a security
5012 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005013 *
5014 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5015 * @param filter The IntentFilter for which a default handler is added.
5016 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005017 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005018 */
Robin Lee25e26452015-06-02 09:56:29 -07005019 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
5020 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005021 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005022 if (mService != null) {
5023 try {
5024 mService.addPersistentPreferredActivity(admin, filter, activity);
5025 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005026 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005027 }
5028 }
5029 }
5030
5031 /**
5032 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00005033 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005034 * <p>
5035 * The calling device admin must be a profile owner. If it is not, a security exception will be
5036 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005037 *
5038 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5039 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005040 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005041 */
Robin Lee25e26452015-06-02 09:56:29 -07005042 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005043 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005044 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005045 if (mService != null) {
5046 try {
5047 mService.clearPackagePersistentPreferredActivities(admin, packageName);
5048 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005049 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005050 }
5051 }
5052 }
Robin Lee66e5d962014-04-09 16:44:21 +01005053
5054 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00005055 * Called by a profile owner or device owner to grant permission to a package to manage
5056 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
5057 * {@link #getApplicationRestrictions}.
5058 * <p>
5059 * This permission is persistent until it is later cleared by calling this method with a
5060 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00005061 * <p>
5062 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00005063 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005064 *
5065 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5066 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005067 * APIs. If {@code null} is given the current package will be cleared.
5068 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00005069 * @throws NameNotFoundException if {@code packageName} is not found
Edman Anjosf9946772016-11-28 16:35:15 +01005070 *
5071 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes}
5072 * with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005073 */
Edman Anjosf9946772016-11-28 16:35:15 +01005074 @Deprecated
Esteban Talaverabf60f722015-12-10 16:26:44 +00005075 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00005076 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005077 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00005078 if (mService != null) {
5079 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00005080 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
5081 throw new NameNotFoundException(packageName);
5082 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00005083 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005084 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00005085 }
5086 }
5087 }
5088
5089 /**
5090 * Called by a profile owner or device owner to retrieve the application restrictions managing
Edman Anjosf9946772016-11-28 16:35:15 +01005091 * package for the current user, or {@code null} if none is set. If there are multiple
5092 * delegates this function will return one of them.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005093 *
5094 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5095 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005096 * {@code null} if none is set.
5097 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01005098 *
5099 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages}
5100 * with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005101 */
Edman Anjosf9946772016-11-28 16:35:15 +01005102 @Deprecated
5103 @Nullable
5104 public String getApplicationRestrictionsManagingPackage(
Makoto Onuki408e8e42016-10-25 12:10:27 -07005105 @NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005106 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00005107 if (mService != null) {
5108 try {
5109 return mService.getApplicationRestrictionsManagingPackage(admin);
5110 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005111 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00005112 }
5113 }
5114 return null;
5115 }
5116
5117 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00005118 * Called by any application to find out whether it has been granted permission via
5119 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
5120 * for the calling user.
5121 *
5122 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
5123 * that method.
Edman Anjosf9946772016-11-28 16:35:15 +01005124 *
5125 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatedScopes}
5126 * instead.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005127 */
Edman Anjosf9946772016-11-28 16:35:15 +01005128 @Deprecated
Esteban Talaverabf60f722015-12-10 16:26:44 +00005129 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005130 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00005131 if (mService != null) {
5132 try {
Edman Anjosf9946772016-11-28 16:35:15 +01005133 return mService.isCallerApplicationRestrictionsManagingPackage(
5134 mContext.getPackageName());
Esteban Talaverabf60f722015-12-10 16:26:44 +00005135 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005136 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00005137 }
5138 }
5139 return false;
5140 }
5141
5142 /**
5143 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005144 * <p>
5145 * The caller must be a profile or device owner on that user, or the package allowed to manage
Edman Anjosf9946772016-11-28 16:35:15 +01005146 * application restrictions via {@link #setDelegatedScopes} with the
5147 * {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005148 * <p>
5149 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01005150 * <ul>
5151 * <li>{@code boolean}
5152 * <li>{@code int}
5153 * <li>{@code String} or {@code String[]}
5154 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
5155 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005156 * <p>
5157 * If the restrictions are not available yet, but may be applied in the near future, the caller
5158 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00005159 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005160 * <p>
5161 * The application restrictions are only made visible to the target application via
5162 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
5163 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00005164 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01005165 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005166 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
5167 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00005168 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005169 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01005170 * @param packageName The name of the package to update restricted settings for.
5171 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005172 * set of active restrictions.
5173 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01005174 * @see #setDelegatedScopes
5175 * @see #DELEGATION_APP_RESTRICTIONS
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00005176 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01005177 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005178 @WorkerThread
Esteban Talaverabf60f722015-12-10 16:26:44 +00005179 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01005180 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005181 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01005182 if (mService != null) {
5183 try {
Edman Anjosf9946772016-11-28 16:35:15 +01005184 mService.setApplicationRestrictions(admin, mContext.getPackageName(), packageName,
5185 settings);
Robin Lee66e5d962014-04-09 16:44:21 +01005186 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005187 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01005188 }
5189 }
5190 }
5191
5192 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005193 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
5194 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
5195 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07005196 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005197 * <p>
5198 * The calling device admin must have requested
5199 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
5200 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01005201 * <p>
5202 * This method can be called on the {@link DevicePolicyManager} instance returned by
5203 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
5204 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07005205 *
5206 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07005207 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005208 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
5209 * strictly disabled according to the state of the
5210 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
5211 * <p>
5212 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
5213 * admins, then it's up to the TrustAgent itself to aggregate the values from all
5214 * device admins.
5215 * <p>
5216 * Consult documentation for the specific TrustAgent to determine legal options
5217 * parameters.
5218 * @throws SecurityException if {@code admin} is not an active administrator or does not use
5219 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07005220 */
Robin Lee25e26452015-06-02 09:56:29 -07005221 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
5222 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07005223 if (mService != null) {
5224 try {
Tony Mak089d8402016-04-05 17:42:55 +01005225 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07005226 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005227 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07005228 }
5229 }
5230 }
5231
5232 /**
Jim Millere303bf42014-08-26 17:12:29 -07005233 * Gets configuration for the given trust agent based on aggregating all calls to
5234 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
5235 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01005236 * <p>
5237 * This method can be called on the {@link DevicePolicyManager} instance returned by
5238 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
5239 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07005240 *
Jim Millerb5db57a2015-01-14 18:17:19 -08005241 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
5242 * this function returns a list of configurations for all admins that declare
5243 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
5244 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
5245 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
5246 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07005247 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07005248 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07005249 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005250 public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
5251 @Nullable ComponentName admin, @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005252 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07005253 }
5254
5255 /** @hide per-user version */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005256 public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
5257 @Nullable ComponentName admin, @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07005258 if (mService != null) {
5259 try {
Tony Mak089d8402016-04-05 17:42:55 +01005260 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
5261 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07005262 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005263 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07005264 }
5265 }
Jim Millere303bf42014-08-26 17:12:29 -07005266 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07005267 }
5268
5269 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005270 * Called by a profile owner of a managed profile to set whether caller-Id information from the
5271 * managed profile will be shown in the parent profile, for incoming calls.
5272 * <p>
5273 * The calling device admin must be a profile owner. If it is not, a security exception will be
5274 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01005275 *
Robin Lee25e26452015-06-02 09:56:29 -07005276 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01005277 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005278 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01005279 */
Robin Lee25e26452015-06-02 09:56:29 -07005280 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005281 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01005282 if (mService != null) {
5283 try {
Robin Lee25e26452015-06-02 09:56:29 -07005284 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01005285 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005286 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01005287 }
5288 }
5289 }
5290
5291 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005292 * Called by a profile owner of a managed profile to determine whether or not caller-Id
5293 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005294 * <p>
5295 * The calling device admin must be a profile owner. If it is not, a security exception will be
5296 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01005297 *
Robin Lee25e26452015-06-02 09:56:29 -07005298 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005299 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01005300 */
Robin Lee25e26452015-06-02 09:56:29 -07005301 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005302 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01005303 if (mService != null) {
5304 try {
Robin Lee25e26452015-06-02 09:56:29 -07005305 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01005306 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005307 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01005308 }
5309 }
5310 return false;
5311 }
5312
5313 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07005314 * Determine whether or not caller-Id information has been disabled.
5315 *
5316 * @param userHandle The user for whom to check the caller-id permission
5317 * @hide
5318 */
5319 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
5320 if (mService != null) {
5321 try {
5322 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
5323 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005324 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07005325 }
5326 }
5327 return false;
5328 }
5329
5330 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005331 * Called by a profile owner of a managed profile to set whether contacts search from the
5332 * managed profile will be shown in the parent profile, for incoming calls.
5333 * <p>
5334 * The calling device admin must be a profile owner. If it is not, a security exception will be
5335 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00005336 *
5337 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5338 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005339 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00005340 */
5341 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
5342 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005343 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00005344 if (mService != null) {
5345 try {
5346 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
5347 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005348 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00005349 }
5350 }
5351 }
5352
5353 /**
5354 * Called by a profile owner of a managed profile to determine whether or not contacts search
5355 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005356 * <p>
5357 * The calling device admin must be a profile owner. If it is not, a security exception will be
5358 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00005359 *
5360 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005361 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00005362 */
5363 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005364 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00005365 if (mService != null) {
5366 try {
5367 return mService.getCrossProfileContactsSearchDisabled(admin);
5368 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005369 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00005370 }
5371 }
5372 return false;
5373 }
5374
5375
5376 /**
5377 * Determine whether or not contacts search has been disabled.
5378 *
5379 * @param userHandle The user for whom to check the contacts search permission
5380 * @hide
5381 */
5382 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
5383 if (mService != null) {
5384 try {
5385 return mService
5386 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
5387 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005388 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00005389 }
5390 }
5391 return false;
5392 }
5393
5394 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005395 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00005396 *
Makoto Onuki1040da12015-03-19 11:24:00 -07005397 * @hide
5398 */
5399 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00005400 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07005401 if (mService != null) {
5402 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00005403 mService.startManagedQuickContact(actualLookupKey, actualContactId,
5404 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07005405 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005406 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07005407 }
5408 }
5409 }
5410
5411 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005412 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00005413 * @hide
5414 */
5415 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
5416 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00005417 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00005418 originalIntent);
5419 }
5420
5421 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005422 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
5423 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01005424 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005425 * The calling device admin must be a profile owner. If it is not, a security exception will be
5426 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01005427 * <p>
5428 * This API works on managed profile only.
5429 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005430 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5431 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
5432 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01005433 */
Robin Lee25e26452015-06-02 09:56:29 -07005434 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005435 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01005436 if (mService != null) {
5437 try {
Robin Lee25e26452015-06-02 09:56:29 -07005438 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01005439 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005440 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01005441 }
5442 }
5443 }
5444
5445 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005446 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
5447 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01005448 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005449 * The calling device admin must be a profile owner. If it is not, a security exception will be
5450 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01005451 * <p>
5452 * This API works on managed profile only.
5453 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005454 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5455 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01005456 */
Robin Lee25e26452015-06-02 09:56:29 -07005457 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005458 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01005459 if (mService != null) {
5460 try {
Robin Lee25e26452015-06-02 09:56:29 -07005461 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01005462 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005463 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01005464 }
5465 }
5466 return true;
5467 }
5468
5469 /**
5470 * Determine whether or not Bluetooth devices cannot access contacts.
5471 * <p>
5472 * This API works on managed profile UserHandle only.
5473 *
5474 * @param userHandle The user for whom to check the caller-id permission
5475 * @hide
5476 */
5477 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
5478 if (mService != null) {
5479 try {
5480 return mService.getBluetoothContactSharingDisabledForUser(userHandle
5481 .getIdentifier());
5482 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005483 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01005484 }
5485 }
5486 return true;
5487 }
5488
5489 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005490 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005491 * profile can also be resolved in the parent, or vice versa. Only activity intents are
5492 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00005493 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005494 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01005495 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005496 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01005497 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005498 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
5499 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005500 */
Robin Lee25e26452015-06-02 09:56:29 -07005501 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005502 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005503 if (mService != null) {
5504 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01005505 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005506 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005507 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005508 }
5509 }
5510 }
5511
5512 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005513 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
5514 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01005515 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005516 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005517 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005518 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005519 */
Robin Lee25e26452015-06-02 09:56:29 -07005520 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005521 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005522 if (mService != null) {
5523 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01005524 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005525 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005526 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005527 }
5528 }
5529 }
5530
5531 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005532 * Called by a profile or device owner to set the permitted accessibility services. When set by
5533 * a device owner or profile owner the restriction applies to all profiles of the user the
5534 * device owner or profile owner is an admin for. By default the user can use any accessiblity
5535 * service. When zero or more packages have been added, accessiblity services that are not in
5536 * the list and not part of the system can not be enabled by the user.
5537 * <p>
5538 * Calling with a null value for the list disables the restriction so that all services can be
5539 * used, calling with an empty list only allows the builtin system's services.
5540 * <p>
5541 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005542 *
5543 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5544 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005545 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
5546 * accessibility services enabled, that are not in the list.
5547 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005548 */
Robin Lee25e26452015-06-02 09:56:29 -07005549 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005550 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005551 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005552 if (mService != null) {
5553 try {
5554 return mService.setPermittedAccessibilityServices(admin, packageNames);
5555 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005556 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005557 }
5558 }
5559 return false;
5560 }
5561
5562 /**
5563 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005564 * <p>
5565 * An empty list means no accessibility services except system services are allowed. Null means
5566 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005567 *
5568 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5569 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005570 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005571 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005572 public @Nullable List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005573 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005574 if (mService != null) {
5575 try {
5576 return mService.getPermittedAccessibilityServices(admin);
5577 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005578 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005579 }
5580 }
5581 return null;
5582 }
5583
5584 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00005585 * Called by the system to check if a specific accessibility service is disabled by admin.
5586 *
5587 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5588 * @param packageName Accessibility service package name that needs to be checked.
5589 * @param userHandle user id the admin is running as.
5590 * @return true if the accessibility service is permitted, otherwise false.
5591 *
5592 * @hide
5593 */
5594 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
5595 @NonNull String packageName, int userHandle) {
5596 if (mService != null) {
5597 try {
5598 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
5599 userHandle);
5600 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005601 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00005602 }
5603 }
5604 return false;
5605 }
5606
5607 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005608 * Returns the list of accessibility services permitted by the device or profiles
5609 * owners of this user.
5610 *
5611 * <p>Null means all accessibility services are allowed, if a non-null list is returned
5612 * it will contain the intersection of the permitted lists for any device or profile
5613 * owners that apply to this user. It will also include any system accessibility services.
5614 *
5615 * @param userId which user to check for.
5616 * @return List of accessiblity service package names.
5617 * @hide
5618 */
5619 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07005620 public @Nullable List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005621 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005622 if (mService != null) {
5623 try {
5624 return mService.getPermittedAccessibilityServicesForUser(userId);
5625 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005626 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005627 }
5628 }
5629 return null;
5630 }
5631
5632 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005633 * Called by a profile or device owner to set the permitted input methods services. When set by
5634 * a device owner or profile owner the restriction applies to all profiles of the user the
5635 * device owner or profile owner is an admin for. By default the user can use any input method.
5636 * When zero or more packages have been added, input method that are not in the list and not
5637 * part of the system can not be enabled by the user. This method will fail if it is called for
5638 * a admin that is not for the foreground user or a profile of the foreground user.
5639 * <p>
5640 * Calling with a null value for the list disables the restriction so that all input methods can
5641 * be used, calling with an empty list disables all but the system's own input methods.
5642 * <p>
5643 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005644 *
5645 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5646 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005647 * @return true if setting the restriction succeeded. It will fail if there are one or more
5648 * non-system input methods currently enabled that are not in the packageNames list.
5649 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005650 */
Robin Lee25e26452015-06-02 09:56:29 -07005651 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005652 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005653 if (mService != null) {
5654 try {
5655 return mService.setPermittedInputMethods(admin, packageNames);
5656 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005657 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005658 }
5659 }
5660 return false;
5661 }
5662
5663
5664 /**
5665 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005666 * <p>
5667 * An empty list means no input methods except system input methods are allowed. Null means all
5668 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005669 *
5670 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5671 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005672 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005673 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005674 public @Nullable List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005675 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005676 if (mService != null) {
5677 try {
5678 return mService.getPermittedInputMethods(admin);
5679 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005680 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005681 }
5682 }
5683 return null;
5684 }
5685
5686 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00005687 * Called by the system to check if a specific input method is disabled by admin.
5688 *
5689 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5690 * @param packageName Input method package name that needs to be checked.
5691 * @param userHandle user id the admin is running as.
5692 * @return true if the input method is permitted, otherwise false.
5693 *
5694 * @hide
5695 */
5696 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
5697 @NonNull String packageName, int userHandle) {
5698 if (mService != null) {
5699 try {
5700 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
5701 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005702 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00005703 }
5704 }
5705 return false;
5706 }
5707
5708 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005709 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08005710 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005711 *
5712 * <p>Null means all input methods are allowed, if a non-null list is returned
5713 * it will contain the intersection of the permitted lists for any device or profile
5714 * owners that apply to this user. It will also include any system input methods.
5715 *
5716 * @return List of input method package names.
5717 * @hide
5718 */
5719 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07005720 public @Nullable List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005721 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005722 if (mService != null) {
5723 try {
5724 return mService.getPermittedInputMethodsForCurrentUser();
5725 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005726 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005727 }
5728 }
5729 return null;
5730 }
5731
5732 /**
Edman Anjos52088e42017-01-13 22:26:17 +01005733 * Get the list of apps to keep around as APKs even if no user has currently installed it. This
5734 * function can be called by a device owner or by a delegate given the
5735 * {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}.
5736 * <p>
5737 * Please note that packages returned in this method are not automatically pre-cached.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005738 *
Edman Anjos52088e42017-01-13 22:26:17 +01005739 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
5740 * {@code null} if the caller is a keep uninstalled packages delegate.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005741 * @return List of package names to keep cached.
Edman Anjos52088e42017-01-13 22:26:17 +01005742 * @see #setDelegatedScopes
5743 * @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005744 * @hide
5745 */
Edman Anjos52088e42017-01-13 22:26:17 +01005746 public @Nullable List<String> getKeepUninstalledPackages(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005747 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005748 if (mService != null) {
5749 try {
Edman Anjos52088e42017-01-13 22:26:17 +01005750 return mService.getKeepUninstalledPackages(admin, mContext.getPackageName());
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005751 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005752 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005753 }
5754 }
5755 return null;
5756 }
5757
5758 /**
Edman Anjos52088e42017-01-13 22:26:17 +01005759 * Set a list of apps to keep around as APKs even if no user has currently installed it. This
5760 * function can be called by a device owner or by a delegate given the
5761 * {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005762 *
5763 * <p>Please note that setting this policy does not imply that specified apps will be
5764 * automatically pre-cached.</p>
5765 *
Edman Anjos52088e42017-01-13 22:26:17 +01005766 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
5767 * {@code null} if the caller is a keep uninstalled packages delegate.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005768 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005769 * @throws SecurityException if {@code admin} is not a device owner.
Edman Anjos52088e42017-01-13 22:26:17 +01005770 * @see #setDelegatedScopes
5771 * @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005772 * @hide
5773 */
Edman Anjos52088e42017-01-13 22:26:17 +01005774 public void setKeepUninstalledPackages(@Nullable ComponentName admin,
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005775 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005776 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005777 if (mService != null) {
5778 try {
Edman Anjos52088e42017-01-13 22:26:17 +01005779 mService.setKeepUninstalledPackages(admin, mContext.getPackageName(), packageNames);
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005780 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005781 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005782 }
5783 }
5784 }
5785
5786 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04005787 * Called by a device owner to create a user with the specified name. The UserHandle returned
5788 * by this method should not be persisted as user handles are recycled as users are removed and
5789 * created. If you need to persist an identifier for this user, use
5790 * {@link UserManager#getSerialNumberForUser}.
5791 *
5792 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5793 * @param name the user's name
5794 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07005795 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5796 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01005797 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005798 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01005799 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04005800 */
Kenny Guy14f48e52015-06-29 15:12:36 +01005801 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07005802 public @Nullable UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04005803 return null;
5804 }
5805
5806 /**
Jason Monk03978a42014-06-10 15:05:30 -04005807 * Called by a device owner to create a user with the specified name. The UserHandle returned
5808 * by this method should not be persisted as user handles are recycled as users are removed and
5809 * created. If you need to persist an identifier for this user, use
5810 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
5811 * immediately.
5812 *
5813 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
5814 * as registered as an active admin on the new user. The profile owner package will be
5815 * installed on the new user if it already is installed on the device.
5816 *
5817 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
5818 * profileOwnerComponent when onEnable is called.
5819 *
5820 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5821 * @param name the user's name
5822 * @param ownerName the human readable name of the organisation associated with this DPM.
5823 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
5824 * the user.
5825 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
5826 * on the new user.
5827 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07005828 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5829 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01005830 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005831 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01005832 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04005833 */
Kenny Guy14f48e52015-06-29 15:12:36 +01005834 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07005835 public @Nullable UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
Robin Lee25e26452015-06-02 09:56:29 -07005836 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04005837 return null;
5838 }
5839
5840 /**
phweissa92e1212016-01-25 17:14:10 +01005841 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01005842 */
5843 public static final int SKIP_SETUP_WIZARD = 0x0001;
5844
5845 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01005846 * Flag used by {@link #createAndManageUser} to specify that the user should be created
5847 * ephemeral.
5848 * @hide
5849 */
5850 public static final int MAKE_USER_EPHEMERAL = 0x0002;
5851
5852 /**
phweissa92e1212016-01-25 17:14:10 +01005853 * Called by a device owner to create a user with the specified name and a given component of
5854 * the calling package as profile owner. The UserHandle returned by this method should not be
5855 * persisted as user handles are recycled as users are removed and created. If you need to
5856 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
5857 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005858 * <p>
5859 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
5860 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
5861 * be registered as an active admin on the new user. The profile owner package will be installed
5862 * on the new user.
5863 * <p>
5864 * If the adminExtras are not null, they will be stored on the device until the user is started
5865 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01005866 *
5867 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5868 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01005869 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005870 * same package as admin, otherwise no user is created and an
5871 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01005872 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005873 * user.
phweissa92e1212016-01-25 17:14:10 +01005874 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01005875 * @see UserHandle
5876 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5877 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005878 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01005879 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005880 public @Nullable UserHandle createAndManageUser(@NonNull ComponentName admin,
5881 @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01005882 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
5883 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005884 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01005885 try {
phweissa92e1212016-01-25 17:14:10 +01005886 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01005887 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005888 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01005889 }
phweiss343fb332016-01-25 14:48:59 +01005890 }
5891
5892 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005893 * Called by a device owner to remove a user and all associated data. The primary user can not
5894 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04005895 *
5896 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5897 * @param userHandle the user to remove.
5898 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005899 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04005900 */
Robin Lee25e26452015-06-02 09:56:29 -07005901 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005902 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04005903 try {
5904 return mService.removeUser(admin, userHandle);
5905 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005906 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04005907 }
5908 }
5909
5910 /**
Jason Monk582d9112014-07-09 19:57:08 -04005911 * Called by a device owner to switch the specified user to the foreground.
5912 *
5913 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5914 * @param userHandle the user to switch to; null will switch to primary.
5915 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005916 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04005917 * @see Intent#ACTION_USER_FOREGROUND
5918 */
Robin Lee25e26452015-06-02 09:56:29 -07005919 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005920 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04005921 try {
5922 return mService.switchUser(admin, userHandle);
5923 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005924 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04005925 }
5926 }
5927
5928 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00005929 * Retrieves the application restrictions for a given target application running in the calling
5930 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005931 * <p>
5932 * The caller must be a profile or device owner on that user, or the package allowed to manage
Edman Anjosf9946772016-11-28 16:35:15 +01005933 * application restrictions via {@link #setDelegatedScopes} with the
5934 * {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01005935 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005936 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
5937 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00005938 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005939 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01005940 * @param packageName The name of the package to fetch restricted settings of.
5941 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005942 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
5943 * {@link Bundle} if no restrictions have been set.
5944 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01005945 * @see #setDelegatedScopes
5946 * @see #DELEGATION_APP_RESTRICTIONS
Robin Lee66e5d962014-04-09 16:44:21 +01005947 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005948 @WorkerThread
Makoto Onuki408e8e42016-10-25 12:10:27 -07005949 public @NonNull Bundle getApplicationRestrictions(
5950 @Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005951 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01005952 if (mService != null) {
5953 try {
Edman Anjosf9946772016-11-28 16:35:15 +01005954 return mService.getApplicationRestrictions(admin, mContext.getPackageName(),
5955 packageName);
Robin Lee66e5d962014-04-09 16:44:21 +01005956 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005957 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01005958 }
5959 }
5960 return null;
5961 }
Amith Yamasanibe465322014-04-24 13:45:17 -07005962
5963 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005964 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005965 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005966 * The calling device admin must be a profile or device owner; if it is not, a security
5967 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005968 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005969 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5970 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5971 * for the list of keys.
5972 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005973 */
Robin Lee25e26452015-06-02 09:56:29 -07005974 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005975 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005976 if (mService != null) {
5977 try {
5978 mService.setUserRestriction(admin, key, true);
5979 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005980 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005981 }
5982 }
5983 }
5984
5985 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005986 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005987 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005988 * The calling device admin must be a profile or device owner; if it is not, a security
5989 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005990 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005991 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5992 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5993 * for the list of keys.
5994 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005995 */
Robin Lee25e26452015-06-02 09:56:29 -07005996 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005997 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005998 if (mService != null) {
5999 try {
6000 mService.setUserRestriction(admin, key, false);
6001 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006002 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07006003 }
6004 }
6005 }
Adam Connors010cfd42014-04-16 12:48:13 +01006006
6007 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006008 * Called by a profile or device owner to get user restrictions set with
6009 * {@link #addUserRestriction(ComponentName, String)}.
6010 * <p>
6011 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006012 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006013 * {@link UserManager#getUserRestrictions()}.
6014 *
6015 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006016 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006017 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006018 public @NonNull Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006019 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006020 Bundle ret = null;
6021 if (mService != null) {
6022 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07006023 ret = mService.getUserRestrictions(admin);
6024 } catch (RemoteException e) {
6025 throw e.rethrowFromSystemServer();
6026 }
6027 }
6028 return ret == null ? new Bundle() : ret;
6029 }
6030
6031 /**
phweiss73145f42017-01-17 19:06:38 +01006032 * Called by any app to display a support dialog when a feature was disabled by an admin.
6033 * This returns an intent that can be used with {@link Context#startActivity(Intent)} to
6034 * display the dialog. It will tell the user that the feature indicated by {@code restriction}
6035 * was disabled by an admin, and include a link for more information. The default content of
6036 * the dialog can be changed by the restricting admin via
6037 * {@link #setShortSupportMessage(ComponentName, CharSequence)}. If the restriction is not
6038 * set (i.e. the feature is available), then the return value will be {@code null}.
6039 * @param restriction Indicates for which feature the dialog should be displayed. Can be a
6040 * user restriction from {@link UserManager}, e.g.
6041 * {@link UserManager#DISALLOW_ADJUST_VOLUME}, or one of the constants
6042 * {@link #POLICY_DISABLE_CAMERA} or {@link #POLICY_DISABLE_SCREEN_CAPTURE}.
6043 * @return Intent An intent to be used to start the dialog-activity if the restriction is
6044 * set by an admin, or null if the restriction does not exist or no admin set it.
6045 */
6046 public Intent createAdminSupportIntent(@NonNull String restriction) {
6047 throwIfParentInstance("createAdminSupportIntent");
6048 if (mService != null) {
6049 try {
6050 return mService.createAdminSupportIntent(restriction);
6051 } catch (RemoteException e) {
6052 throw e.rethrowFromSystemServer();
6053 }
6054 }
6055 return null;
6056 }
6057
6058 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006059 * Hide or unhide packages. When a package is hidden it is unavailable for use, but the data and
6060 * actual package file remain. This function can be called by a device owner, profile owner, or
6061 * by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
6062 * {@link #setDelegatedScopes}.
Julia Reynolds966881e2014-05-14 12:23:08 -04006063 *
Edman Anjos52088e42017-01-13 22:26:17 +01006064 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6065 * {@code null} if the caller is a package access delegate.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006066 * @param packageName The name of the package to hide or unhide.
6067 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006068 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006069 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006070 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006071 * @see #setDelegatedScopes
6072 * @see #DELEGATION_PACKAGE_ACCESS
Julia Reynolds966881e2014-05-14 12:23:08 -04006073 */
Robin Lee25e26452015-06-02 09:56:29 -07006074 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006075 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006076 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04006077 if (mService != null) {
6078 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006079 return mService.setApplicationHidden(admin, mContext.getPackageName(), packageName,
6080 hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04006081 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006082 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04006083 }
6084 }
6085 return false;
6086 }
6087
6088 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006089 * Determine if a package is hidden. This function can be called by a device owner, profile
6090 * owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
6091 * {@link #setDelegatedScopes}.
Julia Reynolds966881e2014-05-14 12:23:08 -04006092 *
Edman Anjos52088e42017-01-13 22:26:17 +01006093 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6094 * {@code null} if the caller is a package access delegate.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006095 * @param packageName The name of the package to retrieve the hidden status of.
6096 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006097 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006098 * @see #setDelegatedScopes
6099 * @see #DELEGATION_PACKAGE_ACCESS
Julia Reynolds966881e2014-05-14 12:23:08 -04006100 */
Robin Lee25e26452015-06-02 09:56:29 -07006101 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006102 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04006103 if (mService != null) {
6104 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006105 return mService.isApplicationHidden(admin, mContext.getPackageName(), packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04006106 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006107 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04006108 }
6109 }
6110 return false;
6111 }
6112
6113 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006114 * Re-enable a system app that was disabled by default when the user was initialized. This
6115 * function can be called by a device owner, profile owner, or by a delegate given the
6116 * {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}.
Adam Connors655be2a2014-07-14 09:01:25 +00006117 *
Edman Anjos52088e42017-01-13 22:26:17 +01006118 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6119 * {@code null} if the caller is an enable system app delegate.
Makoto Onuki32b30572015-12-11 14:29:51 -08006120 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006121 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006122 * @see #setDelegatedScopes
6123 * @see #DELEGATION_PACKAGE_ACCESS
Adam Connors655be2a2014-07-14 09:01:25 +00006124 */
Robin Lee25e26452015-06-02 09:56:29 -07006125 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006126 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00006127 if (mService != null) {
6128 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006129 mService.enableSystemApp(admin, mContext.getPackageName(), packageName);
Adam Connors655be2a2014-07-14 09:01:25 +00006130 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006131 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00006132 }
6133 }
6134 }
6135
6136 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006137 * Re-enable system apps by intent that were disabled by default when the user was initialized.
6138 * This function can be called by a device owner, profile owner, or by a delegate given the
6139 * {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}.
Adam Connors655be2a2014-07-14 09:01:25 +00006140 *
Edman Anjos52088e42017-01-13 22:26:17 +01006141 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6142 * {@code null} if the caller is an enable system app delegate.
Adam Connors655be2a2014-07-14 09:01:25 +00006143 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006144 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00006145 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006146 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006147 * @see #setDelegatedScopes
6148 * @see #DELEGATION_PACKAGE_ACCESS
Adam Connors655be2a2014-07-14 09:01:25 +00006149 */
Robin Lee25e26452015-06-02 09:56:29 -07006150 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006151 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00006152 if (mService != null) {
6153 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006154 return mService.enableSystemAppWithIntent(admin, mContext.getPackageName(), intent);
Adam Connors655be2a2014-07-14 09:01:25 +00006155 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006156 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00006157 }
6158 }
6159 return 0;
6160 }
6161
6162 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00006163 * Called by a device owner or profile owner to disable account management for a specific type
6164 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006165 * <p>
6166 * The calling device admin must be a device owner or profile owner. If it is not, a security
6167 * exception will be thrown.
6168 * <p>
6169 * When account management is disabled for an account type, adding or removing an account of
6170 * that type will not be possible.
6171 * <p>
6172 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00006173 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
6174 * management for a specific type is disabled.
6175 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01006176 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6177 * @param accountType For which account management is disabled or enabled.
6178 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006179 * enabled (false).
6180 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01006181 */
Robin Lee25e26452015-06-02 09:56:29 -07006182 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01006183 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006184 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01006185 if (mService != null) {
6186 try {
6187 mService.setAccountManagementDisabled(admin, accountType, disabled);
6188 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006189 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01006190 }
6191 }
6192 }
6193
6194 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006195 * Gets the array of accounts for which account management is disabled by the profile owner.
6196 *
6197 * <p> Account management can be disabled/enabled by calling
6198 * {@link #setAccountManagementDisabled}.
6199 *
6200 * @return a list of account types for which account management has been disabled.
6201 *
6202 * @see #setAccountManagementDisabled
6203 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006204 public @Nullable String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006205 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07006206 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01006207 }
6208
6209 /**
6210 * @see #getAccountTypesWithManagementDisabled()
6211 * @hide
6212 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006213 public @Nullable String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006214 if (mService != null) {
6215 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01006216 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006217 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006218 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006219 }
6220 }
6221
6222 return null;
6223 }
justinzhang511e0d82014-03-24 16:09:24 -04006224
6225 /**
Jason Monkd7b86212014-06-16 13:15:38 -04006226 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006227 * <p>
Esteban Talaverabdcada92017-02-01 14:20:06 +00006228 * Any packages that share uid with an allowed package will also be allowed to activate lock
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006229 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
Esteban Talaverabdcada92017-02-01 14:20:06 +00006230 * package list results in locked tasks belonging to those packages to be finished.
6231 * <p>
6232 * This function can only be called by the device owner or by a profile owner of a user/profile
6233 * that is affiliated with the device owner user. See {@link #setAffiliationIds}. Any packages
6234 * set via this method will be cleared if the user becomes unaffiliated.
Jason Monkd7b86212014-06-16 13:15:38 -04006235 *
Jason Monkd7b86212014-06-16 13:15:38 -04006236 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04006237 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Esteban Talaverabdcada92017-02-01 14:20:06 +00006238 * @throws SecurityException if {@code admin} is not the device owner, or the profile owner of
6239 * an affiliated user or profile.
Jason Monkd7b86212014-06-16 13:15:38 -04006240 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00006241 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
6242 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04006243 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04006244 */
Esteban Talaverabdcada92017-02-01 14:20:06 +00006245 public void setLockTaskPackages(@NonNull ComponentName admin, @NonNull String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04006246 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006247 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04006248 if (mService != null) {
6249 try {
Jason Monk48aacba2014-08-13 16:29:08 -04006250 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04006251 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006252 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04006253 }
6254 }
6255 }
6256
6257 /**
Esteban Talaverabdcada92017-02-01 14:20:06 +00006258 * Returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04006259 *
Esteban Talaverabdcada92017-02-01 14:20:06 +00006260 * @throws SecurityException if {@code admin} is not the device owner, or the profile owner of
6261 * an affiliated user or profile.
6262 * @see #setLockTaskPackages
justinzhang511e0d82014-03-24 16:09:24 -04006263 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006264 public @NonNull String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006265 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04006266 if (mService != null) {
6267 try {
Jason Monk48aacba2014-08-13 16:29:08 -04006268 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04006269 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006270 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04006271 }
6272 }
Esteban Talaverabdcada92017-02-01 14:20:06 +00006273 return new String[0];
justinzhang511e0d82014-03-24 16:09:24 -04006274 }
6275
6276 /**
6277 * This function lets the caller know whether the given component is allowed to start the
6278 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04006279 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04006280 */
Jason Monkd7b86212014-06-16 13:15:38 -04006281 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006282 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04006283 if (mService != null) {
6284 try {
Jason Monkd7b86212014-06-16 13:15:38 -04006285 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04006286 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006287 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04006288 }
6289 }
6290 return false;
6291 }
Julia Reynoldsda551652014-05-14 17:15:16 -04006292
6293 /**
6294 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
6295 * 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 -07006296 * <p>
6297 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006298 * <ul>
6299 * <li>{@link Settings.Global#ADB_ENABLED}</li>
6300 * <li>{@link Settings.Global#AUTO_TIME}</li>
6301 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006302 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006303 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006304 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006305 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
6306 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
6307 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
6308 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
6309 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006310 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006311 * <p>
6312 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006313 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006314 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
6315 * {@link android.bluetooth.BluetoothAdapter#enable()} and
6316 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006317 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006318 * <li>{@link Settings.Global#MODE_RINGER}. Use
6319 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006320 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006321 * <li>{@link Settings.Global#WIFI_ON}. Use
6322 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006323 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04006324 *
6325 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6326 * @param setting The name of the setting to update.
6327 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006328 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04006329 */
Robin Lee25e26452015-06-02 09:56:29 -07006330 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006331 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04006332 if (mService != null) {
6333 try {
6334 mService.setGlobalSetting(admin, setting, value);
6335 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006336 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04006337 }
6338 }
6339 }
6340
6341 /**
6342 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
6343 * that the value of the setting is in the correct form for the setting type should be performed
6344 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006345 * <p>
6346 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006347 * <ul>
6348 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
6349 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
6350 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006351 * <p>
6352 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04006353 * <ul>
6354 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
6355 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006356 *
Suprabh Shukla0b1356f2017-02-21 14:33:50 -08006357 * <strong>Note: Starting from Android O, apps should no longer call this method with the
6358 * setting {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS}, which is
6359 * deprecated. Instead, device owners or profile owners should use the restriction
6360 * {@link UserManager#DISALLOW_INSTALL_UNKNOWN_SOURCES}.
6361 * If any app targeting {@link android.os.Build.VERSION_CODES#O} or higher calls this method
6362 * with {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS},
6363 * an {@link UnsupportedOperationException} is thrown.
6364 * </strong>
6365 *
Julia Reynoldsda551652014-05-14 17:15:16 -04006366 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6367 * @param setting The name of the setting to update.
6368 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006369 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04006370 */
Robin Lee25e26452015-06-02 09:56:29 -07006371 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006372 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04006373 if (mService != null) {
6374 try {
6375 mService.setSecureSetting(admin, setting, value);
6376 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006377 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04006378 }
6379 }
6380 }
6381
Amith Yamasanif20d6402014-05-24 15:34:37 -07006382 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006383 * Designates a specific service component as the provider for making permission requests of a
6384 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07006385 * <p/>
6386 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006387 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07006388 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07006389 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006390 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
6391 * provider previously assigned.
6392 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07006393 */
Robin Lee25e26452015-06-02 09:56:29 -07006394 public void setRestrictionsProvider(@NonNull ComponentName admin,
6395 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006396 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07006397 if (mService != null) {
6398 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07006399 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07006400 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006401 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07006402 }
6403 }
6404 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04006405
6406 /**
6407 * Called by profile or device owners to set the master volume mute on or off.
Nicolas Prevotaef3ce22016-09-22 12:00:25 +01006408 * This has no effect when set on a managed profile.
Julia Reynolds4a21b252014-06-04 11:11:43 -04006409 *
6410 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6411 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006412 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04006413 */
Robin Lee25e26452015-06-02 09:56:29 -07006414 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006415 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04006416 if (mService != null) {
6417 try {
6418 mService.setMasterVolumeMuted(admin, on);
6419 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006420 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04006421 }
6422 }
6423 }
6424
6425 /**
6426 * Called by profile or device owners to check whether the master volume mute is on or off.
6427 *
6428 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6429 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006430 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04006431 */
Robin Lee25e26452015-06-02 09:56:29 -07006432 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006433 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04006434 if (mService != null) {
6435 try {
6436 return mService.isMasterVolumeMuted(admin);
6437 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006438 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04006439 }
6440 }
6441 return false;
6442 }
Kenny Guyc13053b2014-05-29 14:17:17 +01006443
6444 /**
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006445 * Change whether a user can uninstall a package. This function can be called by a device owner,
6446 * profile owner, or by a delegate given the {@link #DELEGATION_BLOCK_UNINSTALL} scope via
6447 * {@link #setDelegatedScopes}.
Kenny Guyc13053b2014-05-29 14:17:17 +01006448 *
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006449 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6450 * {@code null} if the caller is a block uninstall delegate.
Kenny Guyc13053b2014-05-29 14:17:17 +01006451 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01006452 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006453 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006454 * @see #setDelegatedScopes
6455 * @see #DELEGATION_BLOCK_UNINSTALL
Kenny Guyc13053b2014-05-29 14:17:17 +01006456 */
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006457 public void setUninstallBlocked(@Nullable ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01006458 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006459 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01006460 if (mService != null) {
6461 try {
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006462 mService.setUninstallBlocked(admin, mContext.getPackageName(), packageName,
6463 uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01006464 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006465 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01006466 }
6467 }
6468 }
6469
6470 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08006471 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00006472 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00006473 * <p>
6474 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006475 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
6476 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
6477 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01006478 *
Robin Lee25e26452015-06-02 09:56:29 -07006479 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006480 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01006481 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00006482 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006483 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01006484 */
Robin Lee25e26452015-06-02 09:56:29 -07006485 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006486 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01006487 if (mService != null) {
6488 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01006489 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01006490 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006491 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01006492 }
6493 }
6494 return false;
6495 }
Svetoslav976e8bd2014-07-16 15:12:03 -07006496
6497 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006498 * Called by the profile owner of a managed profile to enable widget providers from a given
6499 * package to be available in the parent profile. As a result the user will be able to add
6500 * widgets from the white-listed package running under the profile to a widget host which runs
6501 * under the parent profile, for example the home screen. Note that a package may have zero or
6502 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07006503 * <p>
6504 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07006505 *
6506 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6507 * @param packageName The package from which widget providers are white-listed.
6508 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006509 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07006510 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
6511 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
6512 */
Robin Lee25e26452015-06-02 09:56:29 -07006513 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006514 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07006515 if (mService != null) {
6516 try {
6517 return mService.addCrossProfileWidgetProvider(admin, packageName);
6518 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006519 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07006520 }
6521 }
6522 return false;
6523 }
6524
6525 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07006526 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006527 * package to be available in the parent profile. For this method to take effect the package
6528 * should have been added via
6529 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07006530 * <p>
6531 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07006532 *
6533 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006534 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07006535 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006536 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07006537 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
6538 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
6539 */
Esteban Talavera62399912016-01-11 15:37:55 +00006540 public boolean removeCrossProfileWidgetProvider(
6541 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006542 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07006543 if (mService != null) {
6544 try {
6545 return mService.removeCrossProfileWidgetProvider(admin, packageName);
6546 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006547 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07006548 }
6549 }
6550 return false;
6551 }
6552
6553 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07006554 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07006555 * available in the parent profile.
6556 *
6557 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6558 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07006559 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
6560 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006561 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07006562 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006563 public @NonNull List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006564 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07006565 if (mService != null) {
6566 try {
6567 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
6568 if (providers != null) {
6569 return providers;
6570 }
6571 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006572 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07006573 }
6574 }
6575 return Collections.emptyList();
6576 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006577
6578 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08006579 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006580 *
6581 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6582 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006583 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006584 */
Robin Lee25e26452015-06-02 09:56:29 -07006585 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006586 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006587 try {
6588 mService.setUserIcon(admin, icon);
6589 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006590 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006591 }
6592 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04006593
6594 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01006595 * Called by device owners to set a local system update policy. When a new policy is set,
6596 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00006597 *
Robin Lee25e26452015-06-02 09:56:29 -07006598 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006599 * components in the device owner package can set system update policies and the most
6600 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07006601 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006602 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01006603 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00006604 */
Robin Lee25e26452015-06-02 09:56:29 -07006605 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006606 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00006607 if (mService != null) {
6608 try {
Robin Lee25e26452015-06-02 09:56:29 -07006609 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00006610 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006611 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00006612 }
6613 }
6614 }
6615
6616 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01006617 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00006618 *
Robin Lee25e26452015-06-02 09:56:29 -07006619 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00006620 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006621 public @Nullable SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006622 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00006623 if (mService != null) {
6624 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01006625 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00006626 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006627 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00006628 }
6629 }
6630 return null;
6631 }
Benjamin Franze36087e2015-04-07 16:40:34 +01006632
6633 /**
6634 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006635 * <p>
6636 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
6637 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
6638 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
6639 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01006640 *
6641 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01006642 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01006643 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006644 * place. {@code true} otherwise.
6645 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01006646 */
Robin Lee25e26452015-06-02 09:56:29 -07006647 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006648 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01006649 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01006650 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01006651 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006652 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01006653 }
6654 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00006655
6656 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01006657 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006658 * notifications, quick settings and other screen overlays that allow escaping from a single use
6659 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00006660 *
6661 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01006662 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006663 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
6664 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00006665 */
Robin Lee25e26452015-06-02 09:56:29 -07006666 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006667 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00006668 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01006669 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00006670 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006671 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00006672 }
6673 }
Rubin Xudc105cc2015-04-14 23:38:01 +01006674
6675 /**
Charles Hedea0c3b2017-01-13 10:04:12 +00006676 * Called by the system update service to notify device and profile owners of pending system
6677 * updates.
Rubin Xudc105cc2015-04-14 23:38:01 +01006678 *
Charles Hedea0c3b2017-01-13 10:04:12 +00006679 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
6680 * permission. This method should only be used when it is unknown whether the pending system
6681 * update is a security patch. Otherwise, use
6682 * {@link #notifyPendingSystemUpdate(long, boolean)}.
6683 *
6684 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()}
6685 * indicating when the current pending update was first available. {@code -1} if no
6686 * update is available.
6687 * @see #notifyPendingSystemUpdate(long, boolean)
Rubin Xudc105cc2015-04-14 23:38:01 +01006688 * @hide
6689 */
6690 @SystemApi
6691 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006692 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01006693 if (mService != null) {
6694 try {
Charles Hedea0c3b2017-01-13 10:04:12 +00006695 mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime));
6696 } catch (RemoteException re) {
6697 throw re.rethrowFromSystemServer();
6698 }
6699 }
6700 }
6701
6702 /**
6703 * Called by the system update service to notify device and profile owners of pending system
6704 * updates.
6705 *
6706 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
6707 * permission. This method should be used instead of {@link #notifyPendingSystemUpdate(long)}
6708 * when it is known whether the pending system update is a security patch.
6709 *
6710 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()}
6711 * indicating when the current pending update was first available. {@code -1} if no
6712 * update is available.
6713 * @param isSecurityPatch {@code true} if this system update is purely a security patch;
6714 * {@code false} if not.
6715 * @see #notifyPendingSystemUpdate(long)
6716 * @hide
6717 */
6718 @SystemApi
6719 public void notifyPendingSystemUpdate(long updateReceivedTime, boolean isSecurityPatch) {
6720 throwIfParentInstance("notifyPendingSystemUpdate");
6721 if (mService != null) {
6722 try {
6723 mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime,
6724 isSecurityPatch));
Rubin Xudc105cc2015-04-14 23:38:01 +01006725 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006726 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01006727 }
6728 }
6729 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04006730
6731 /**
Pavel Grafovd65799e2016-12-02 11:21:45 +00006732 * Called by device or profile owners to get information about a pending system update.
6733 *
6734 * @param admin Which profile or device owner this request is associated with.
6735 * @return Information about a pending system update or {@code null} if no update pending.
6736 * @throws SecurityException if {@code admin} is not a device or profile owner.
6737 * @see DeviceAdminReceiver#onSystemUpdatePending(Context, Intent, long)
6738 */
6739 public @Nullable SystemUpdateInfo getPendingSystemUpdate(@NonNull ComponentName admin) {
6740 throwIfParentInstance("getPendingSystemUpdate");
6741 try {
6742 return mService.getPendingSystemUpdate(admin);
6743 } catch (RemoteException re) {
6744 throw re.rethrowFromSystemServer();
6745 }
6746 }
6747
6748 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006749 * Set the default response for future runtime permission requests by applications. This
6750 * function can be called by a device owner, profile owner, or by a delegate given the
6751 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
6752 * The policy can allow for normal operation which prompts the user to grant a permission, or
6753 * can allow automatic granting or denying of runtime permission requests by an application.
6754 * This also applies to new permissions declared by app updates. When a permission is denied or
6755 * granted this way, the effect is equivalent to setting the permission * grant state via
6756 * {@link #setPermissionGrantState}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006757 * <p/>
6758 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07006759 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01006760 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07006761 * @param admin Which profile or device owner this request is associated with.
6762 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006763 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
6764 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01006765 * @see #setPermissionGrantState
Edman Anjos52088e42017-01-13 22:26:17 +01006766 * @see #setDelegatedScopes
6767 * @see #DELEGATION_PERMISSION_GRANT
Amith Yamasanid49489b2015-04-28 14:00:26 -07006768 */
Robin Lee25e26452015-06-02 09:56:29 -07006769 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006770 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07006771 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006772 mService.setPermissionPolicy(admin, mContext.getPackageName(), policy);
Amith Yamasanid49489b2015-04-28 14:00:26 -07006773 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006774 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07006775 }
6776 }
6777
6778 /**
6779 * Returns the current runtime permission policy set by the device or profile owner. The
6780 * default is {@link #PERMISSION_POLICY_PROMPT}.
Edman Anjos52088e42017-01-13 22:26:17 +01006781 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07006782 * @param admin Which profile or device owner this request is associated with.
6783 * @return the current policy for future permission requests.
6784 */
Esteban Talavera28b95702015-06-24 15:23:42 +01006785 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006786 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07006787 try {
6788 return mService.getPermissionPolicy(admin);
6789 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006790 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07006791 }
6792 }
6793
6794 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006795 * Sets the grant state of a runtime permission for a specific application. The state can be
6796 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
6797 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
6798 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
6799 * the permission is granted and the user cannot manage it through the UI. This might affect all
6800 * permissions in a group that the runtime permission belongs to. This method can only be called
Edman Anjos52088e42017-01-13 22:26:17 +01006801 * by a profile owner, device owner, or a delegate given the
6802 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006803 * <p/>
6804 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
6805 * the permission. It retains the previous grant, if any.
6806 * <p/>
6807 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07006808 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07006809 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07006810 * @param admin Which profile or device owner this request is associated with.
6811 * @param packageName The application to grant or revoke a permission to.
6812 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006813 * @param grantState The permission grant state which is one of
6814 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
6815 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07006816 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006817 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07006818 * @see #PERMISSION_GRANT_STATE_DENIED
6819 * @see #PERMISSION_GRANT_STATE_DEFAULT
6820 * @see #PERMISSION_GRANT_STATE_GRANTED
Edman Anjos52088e42017-01-13 22:26:17 +01006821 * @see #setDelegatedScopes
6822 * @see #DELEGATION_PERMISSION_GRANT
Amith Yamasanid49489b2015-04-28 14:00:26 -07006823 */
Robin Lee25e26452015-06-02 09:56:29 -07006824 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07006825 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006826 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07006827 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006828 return mService.setPermissionGrantState(admin, mContext.getPackageName(), packageName,
6829 permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07006830 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006831 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07006832 }
6833 }
Amith Yamasani184b3752015-05-22 13:00:51 -07006834
6835 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006836 * Returns the current grant state of a runtime permission for a specific application. This
6837 * function can be called by a device owner, profile owner, or by a delegate given the
6838 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
Amith Yamasani184b3752015-05-22 13:00:51 -07006839 *
Edman Anjos52088e42017-01-13 22:26:17 +01006840 * @param admin Which profile or device owner this request is associated with, or {@code null}
6841 * if the caller is a permission grant delegate.
Amith Yamasani184b3752015-05-22 13:00:51 -07006842 * @param packageName The application to check the grant state for.
6843 * @param permission The permission to check for.
6844 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006845 * has not set a grant state, the return value is
6846 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
6847 * permission is currently granted for the package.
6848 * <p/>
6849 * If a grant state was set by the profile or device owner, then the return value will
6850 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
6851 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
6852 * currently denied or granted.
6853 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07006854 * @see #setPermissionGrantState(ComponentName, String, String, int)
6855 * @see PackageManager#checkPermission(String, String)
Edman Anjos52088e42017-01-13 22:26:17 +01006856 * @see #setDelegatedScopes
6857 * @see #DELEGATION_PERMISSION_GRANT
Amith Yamasani184b3752015-05-22 13:00:51 -07006858 */
Bartosz Fabianowski4b0624f2017-01-16 11:47:28 +01006859 public int getPermissionGrantState(@Nullable ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07006860 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006861 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07006862 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006863 return mService.getPermissionGrantState(admin, mContext.getPackageName(), packageName,
6864 permission);
Amith Yamasani184b3752015-05-22 13:00:51 -07006865 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006866 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07006867 }
6868 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006869
6870 /**
Esteban Talavera01576862016-12-15 11:16:44 +00006871 * Returns whether it is possible for the caller to initiate provisioning of a managed profile
6872 * or device, setting itself as the device or profile owner.
6873 *
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006874 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
6875 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Esteban Talavera01576862016-12-15 11:16:44 +00006876 * @return whether provisioning a managed profile or device is possible.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006877 * @throws IllegalArgumentException if the supplied action is not valid.
6878 */
Esteban Talavera01576862016-12-15 11:16:44 +00006879 public boolean isProvisioningAllowed(@NonNull String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006880 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006881 try {
Esteban Talavera01576862016-12-15 11:16:44 +00006882 return mService.isProvisioningAllowed(action, mContext.getPackageName());
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006883 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006884 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006885 }
6886 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006887
6888 /**
Esteban Talavera01576862016-12-15 11:16:44 +00006889 * Checks whether it is possible to initiate provisioning a managed device,
6890 * profile or user, setting the given package as owner.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00006891 *
6892 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
6893 * {@link #ACTION_PROVISION_MANAGED_PROFILE},
6894 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE},
6895 * {@link #ACTION_PROVISION_MANAGED_USER}
Esteban Talavera01576862016-12-15 11:16:44 +00006896 * @param packageName The package of the component that would be set as device, user, or profile
6897 * owner.
6898 * @return A {@link ProvisioningPreCondition} value indicating whether provisioning is allowed.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00006899 * @hide
6900 */
Esteban Talavera01576862016-12-15 11:16:44 +00006901 public @ProvisioningPreCondition int checkProvisioningPreCondition(
6902 String action, @NonNull String packageName) {
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00006903 try {
Esteban Talavera01576862016-12-15 11:16:44 +00006904 return mService.checkProvisioningPreCondition(action, packageName);
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00006905 } catch (RemoteException re) {
6906 throw re.rethrowFromSystemServer();
6907 }
6908 }
6909
6910 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006911 * Return if this user is a managed profile of another user. An admin can become the profile
6912 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01006913 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006914 * @param admin Which profile owner this request is associated with.
6915 * @return if this user is a managed profile of another user.
6916 */
6917 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006918 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006919 try {
6920 return mService.isManagedProfile(admin);
6921 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006922 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006923 }
6924 }
6925
6926 /**
6927 * @hide
6928 * Return if this user is a system-only user. An admin can manage a device from a system only
6929 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
6930 * @param admin Which device owner this request is associated with.
6931 * @return if this user is a system-only user.
6932 */
6933 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
6934 try {
6935 return mService.isSystemOnlyUser(admin);
6936 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006937 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006938 }
6939 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006940
6941 /**
6942 * Called by device owner to get the MAC address of the Wi-Fi device.
6943 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08006944 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006945 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
6946 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
6947 * <p>
6948 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
6949 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006950 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006951 public @Nullable String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006952 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006953 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08006954 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006955 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006956 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006957 }
6958 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006959
6960 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00006961 * Called by device owner to reboot the device. If there is an ongoing call on the device,
6962 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006963 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00006964 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006965 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00006966 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006967 */
6968 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006969 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006970 try {
6971 mService.reboot(admin);
6972 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006973 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006974 }
6975 }
Kenny Guy06de4e72015-12-22 12:07:39 +00006976
6977 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006978 * Called by a device admin to set the short support message. This will be displayed to the user
6979 * in settings screens where funtionality has been disabled by the admin. The message should be
6980 * limited to a short statement such as "This setting is disabled by your administrator. Contact
6981 * someone@example.com for support." If the message is longer than 200 characters it may be
6982 * truncated.
6983 * <p>
6984 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006985 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6986 * and set a new version of this string accordingly.
6987 *
Kenny Guy06de4e72015-12-22 12:07:39 +00006988 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00006989 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006990 * @param message Short message to be displayed to the user in settings or null to clear the
6991 * existing message.
6992 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00006993 */
6994 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006995 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006996 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00006997 if (mService != null) {
6998 try {
6999 mService.setShortSupportMessage(admin, message);
7000 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007001 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007002 }
7003 }
7004 }
7005
7006 /**
7007 * Called by a device admin to get the short support message.
7008 *
7009 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007010 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
7011 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007012 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007013 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007014 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007015 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007016 if (mService != null) {
7017 try {
7018 return mService.getShortSupportMessage(admin);
7019 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007020 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007021 }
7022 }
7023 return null;
7024 }
7025
7026 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007027 * Called by a device admin to set the long support message. This will be displayed to the user
7028 * in the device administators settings screen.
7029 * <p>
7030 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007031 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
7032 * and set a new version of this string accordingly.
7033 *
Kenny Guy06de4e72015-12-22 12:07:39 +00007034 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00007035 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007036 * @param message Long message to be displayed to the user in settings or null to clear the
7037 * existing message.
7038 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007039 */
7040 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007041 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007042 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007043 if (mService != null) {
7044 try {
7045 mService.setLongSupportMessage(admin, message);
7046 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007047 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007048 }
7049 }
7050 }
7051
7052 /**
7053 * Called by a device admin to get the long support message.
7054 *
7055 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007056 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
7057 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007058 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007059 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007060 public @Nullable CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007061 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007062 if (mService != null) {
7063 try {
7064 return mService.getLongSupportMessage(admin);
7065 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007066 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007067 }
7068 }
7069 return null;
7070 }
7071
7072 /**
7073 * Called by the system to get the short support message.
7074 *
7075 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7076 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007077 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00007078 *
7079 * @hide
7080 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007081 public @Nullable CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007082 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00007083 if (mService != null) {
7084 try {
7085 return mService.getShortSupportMessageForUser(admin, userHandle);
7086 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007087 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007088 }
7089 }
7090 return null;
7091 }
7092
7093
7094 /**
7095 * Called by the system to get the long support message.
7096 *
7097 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7098 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007099 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00007100 *
7101 * @hide
7102 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007103 public @Nullable CharSequence getLongSupportMessageForUser(
7104 @NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00007105 if (mService != null) {
7106 try {
7107 return mService.getLongSupportMessageForUser(admin, userHandle);
7108 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007109 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007110 }
7111 }
7112 return null;
7113 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007114
7115 /**
Esteban Talavera62399912016-01-11 15:37:55 +00007116 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
7117 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01007118 *
7119 * <p>The following methods are supported for the parent instance, all other methods will
7120 * throw a SecurityException when called on the parent instance:
7121 * <ul>
7122 * <li>{@link #getPasswordQuality}</li>
7123 * <li>{@link #setPasswordQuality}</li>
7124 * <li>{@link #getPasswordMinimumLength}</li>
7125 * <li>{@link #setPasswordMinimumLength}</li>
7126 * <li>{@link #getPasswordMinimumUpperCase}</li>
7127 * <li>{@link #setPasswordMinimumUpperCase}</li>
7128 * <li>{@link #getPasswordMinimumLowerCase}</li>
7129 * <li>{@link #setPasswordMinimumLowerCase}</li>
7130 * <li>{@link #getPasswordMinimumLetters}</li>
7131 * <li>{@link #setPasswordMinimumLetters}</li>
7132 * <li>{@link #getPasswordMinimumNumeric}</li>
7133 * <li>{@link #setPasswordMinimumNumeric}</li>
7134 * <li>{@link #getPasswordMinimumSymbols}</li>
7135 * <li>{@link #setPasswordMinimumSymbols}</li>
7136 * <li>{@link #getPasswordMinimumNonLetter}</li>
7137 * <li>{@link #setPasswordMinimumNonLetter}</li>
7138 * <li>{@link #getPasswordHistoryLength}</li>
7139 * <li>{@link #setPasswordHistoryLength}</li>
7140 * <li>{@link #getPasswordExpirationTimeout}</li>
7141 * <li>{@link #setPasswordExpirationTimeout}</li>
7142 * <li>{@link #getPasswordExpiration}</li>
Charles He8c760562016-10-25 16:36:53 +01007143 * <li>{@link #getPasswordMaximumLength}</li>
Benjamin Franz66b45f02016-04-05 19:12:39 +01007144 * <li>{@link #isActivePasswordSufficient}</li>
7145 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
7146 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
7147 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
7148 * <li>{@link #getMaximumTimeToLock}</li>
7149 * <li>{@link #setMaximumTimeToLock}</li>
7150 * <li>{@link #lockNow}</li>
7151 * <li>{@link #getKeyguardDisabledFeatures}</li>
7152 * <li>{@link #setKeyguardDisabledFeatures}</li>
7153 * <li>{@link #getTrustAgentConfiguration}</li>
7154 * <li>{@link #setTrustAgentConfiguration}</li>
Michal Karpinskia20d8bb2016-11-23 12:09:08 +00007155 * <li>{@link #getRequiredStrongAuthTimeout}</li>
7156 * <li>{@link #setRequiredStrongAuthTimeout}</li>
Benjamin Franz66b45f02016-04-05 19:12:39 +01007157 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007158 *
7159 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007160 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007161 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007162 public @NonNull DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007163 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007164 try {
7165 if (!mService.isManagedProfile(admin)) {
7166 throw new SecurityException("The current user does not have a parent profile.");
7167 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06007168 return new DevicePolicyManager(mContext, mService, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007169 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007170 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007171 }
7172 }
7173
7174 /**
Esteban Talaverad36dd152016-12-15 08:51:45 +00007175 * Called by device owner to control the security logging feature.
Michal Karpinski6235a942016-03-15 12:07:23 +00007176 *
7177 * <p> Security logs contain various information intended for security auditing purposes.
7178 * See {@link SecurityEvent} for details.
7179 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007180 * <p><strong>Note:</strong> The device owner won't be able to retrieve security logs if there
7181 * are unaffiliated secondary users or profiles on the device, regardless of whether the
7182 * feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for
7183 * all users to become affiliated. Therefore it's recommended that affiliation ids are set for
7184 * new users as soon as possible after provisioning via {@link #setAffiliationIds}.
Michal Karpinskib58e4962016-03-01 14:55:10 +00007185 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007186 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00007187 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007188 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00007189 * @see #retrieveSecurityLogs
7190 */
7191 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007192 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00007193 try {
7194 mService.setSecurityLoggingEnabled(admin, enabled);
7195 } catch (RemoteException re) {
7196 throw re.rethrowFromSystemServer();
7197 }
7198 }
7199
7200 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00007201 * Return whether security logging is enabled or not by the device owner.
7202 *
7203 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
7204 * thrown.
7205 *
7206 * @param admin Which device owner this request is associated with.
7207 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
7208 * @throws SecurityException if {@code admin} is not a device owner.
7209 */
Bartosz Fabianowski0ec00002017-03-24 14:22:24 +01007210 public boolean isSecurityLoggingEnabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007211 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007212 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00007213 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007214 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007215 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007216 }
7217 }
7218
7219 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00007220 * Called by device owner to retrieve all new security logging entries since the last call to
7221 * this API after device boots.
7222 *
7223 * <p> Access to the logs is rate limited and it will only return new logs after the device
7224 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
7225 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007226 * <p>If there is any other user or profile on the device, it must be affiliated with the
7227 * device owner. Otherwise a {@link SecurityException} will be thrown. See
7228 * {@link #setAffiliationIds}
Michal Karpinskib58e4962016-03-01 14:55:10 +00007229 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007230 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00007231 * @return the new batch of security logs which is a list of {@link SecurityEvent},
7232 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007233 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
7234 * profile or secondary user that is not affiliated with the device owner user.
7235 * @see DeviceAdminReceiver#onSecurityLogsAvailable
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007236 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007237 public @Nullable List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007238 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007239 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00007240 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007241 if (list != null) {
7242 return list.getList();
7243 } else {
7244 // Rate limit exceeded.
7245 return null;
7246 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007247 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007248 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007249 }
7250 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00007251
7252 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00007253 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
7254 * profile.
7255 *
7256 * @hide
7257 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007258 public @NonNull DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00007259 mContext.checkSelfPermission(
7260 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
7261 if (!uInfo.isManagedProfile()) {
7262 throw new SecurityException("The user " + uInfo.id
7263 + " does not have a parent profile.");
7264 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06007265 return new DevicePolicyManager(mContext, mService, true);
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00007266 }
7267
7268 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007269 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007270 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01007271 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
7272 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
7273 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
7274 * about data corruption when parsing. </strong>
Esteban Talaverad36dd152016-12-15 08:51:45 +00007275 *
7276 * <p>If there is any other user or profile on the device, it must be affiliated with the
7277 * device owner. Otherwise a {@link SecurityException} will be thrown. See
7278 * {@link #setAffiliationIds}
Michal Karpinskib58e4962016-03-01 14:55:10 +00007279 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007280 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01007281 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
7282 * is not supported on the device.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007283 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
7284 * profile or secondary user that is not affiliated with the device owner user.
7285 * @see #retrieveSecurityLogs
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007286 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007287 public @Nullable List<SecurityEvent> retrievePreRebootSecurityLogs(
7288 @NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007289 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007290 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00007291 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01007292 if (list != null) {
7293 return list.getList();
7294 } else {
7295 return null;
7296 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007297 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007298 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007299 }
7300 }
7301
7302 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007303 * Called by a profile owner of a managed profile to set the color used for customization. This
7304 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01007305 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007306 * <p>
7307 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00007308 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
7309 *
7310 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01007311 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007312 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00007313 */
7314 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007315 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00007316 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01007317 // always enforce alpha channel to have 100% opacity
7318 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00007319 mService.setOrganizationColor(admin, color);
7320 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007321 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00007322 }
7323 }
7324
7325 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007326 * @hide
7327 *
7328 * Sets the color used for customization.
7329 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01007330 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007331 * @param userId which user to set the color to.
7332 * @RequiresPermission(allOf = {
7333 * Manifest.permission.MANAGE_USERS,
7334 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
7335 */
7336 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
7337 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01007338 // always enforce alpha channel to have 100% opacity
7339 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007340 mService.setOrganizationColorForUser(color, userId);
7341 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007342 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007343 }
7344 }
7345
7346 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00007347 * Called by a profile owner of a managed profile to retrieve the color used for customization.
7348 * This color is used as background color of the confirm credentials screen for that user.
7349 *
7350 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01007351 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007352 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00007353 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01007354 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007355 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00007356 try {
7357 return mService.getOrganizationColor(admin);
7358 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007359 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00007360 }
7361 }
7362
7363 /**
7364 * @hide
7365 * Retrieve the customization color for a given user.
7366 *
7367 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01007368 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00007369 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01007370 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00007371 try {
7372 return mService.getOrganizationColorForUser(userHandle);
7373 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007374 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00007375 }
7376 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007377
7378 /**
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007379 * Called by the device owner or profile owner to set the name of the organization under
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007380 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007381 * <p>
7382 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007383 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
7384 * and set a new version of this string accordingly.
7385 *
7386 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7387 * @param title The organization name or {@code null} to clear a previously set name.
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007388 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007389 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01007390 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007391 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007392 try {
7393 mService.setOrganizationName(admin, title);
7394 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007395 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007396 }
7397 }
7398
7399 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007400 * Called by a profile owner of a managed profile to retrieve the name of the organization under
7401 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007402 *
7403 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7404 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007405 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007406 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007407 public @Nullable CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007408 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007409 try {
7410 return mService.getOrganizationName(admin);
7411 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007412 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007413 }
7414 }
7415
7416 /**
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007417 * Called by the system to retrieve the name of the organization managing the device.
7418 *
7419 * @return The organization name or {@code null} if none is set.
7420 * @throws SecurityException if the caller is not the device owner, does not hold the
7421 * MANAGE_USERS permission and is not the system.
7422 *
7423 * @hide
7424 */
7425 @SystemApi
7426 @TestApi
7427 public @Nullable CharSequence getDeviceOwnerOrganizationName() {
7428 try {
7429 return mService.getDeviceOwnerOrganizationName();
7430 } catch (RemoteException re) {
7431 throw re.rethrowFromSystemServer();
7432 }
7433 }
7434
7435 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007436 * Retrieve the default title message used in the confirm credentials screen for a given user.
7437 *
7438 * @param userHandle The user id of the user we're interested in.
7439 * @return The organization name or {@code null} if none is set.
7440 *
7441 * @hide
7442 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007443 public @Nullable CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007444 try {
7445 return mService.getOrganizationNameForUser(userHandle);
7446 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007447 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007448 }
7449 }
7450
7451 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00007452 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
7453 * return {@link #STATE_USER_UNMANAGED}
7454 * @hide
7455 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00007456 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00007457 @UserProvisioningState
7458 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007459 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00007460 if (mService != null) {
7461 try {
7462 return mService.getUserProvisioningState();
7463 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007464 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00007465 }
7466 }
7467 return STATE_USER_UNMANAGED;
7468 }
7469
7470 /**
7471 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
7472 *
7473 * @param state to store
7474 * @param userHandle for user
7475 * @hide
7476 */
7477 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
7478 if (mService != null) {
7479 try {
7480 mService.setUserProvisioningState(state, userHandle);
7481 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007482 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00007483 }
7484 }
7485 }
7486
7487 /**
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007488 * Indicates the entity that controls the device or profile owner. Two users/profiles are
7489 * affiliated if the set of ids set by their device or profile owners intersect.
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007490 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007491 * <p><strong>Note:</strong> Features that depend on user affiliation (such as security logging
7492 * or {@link #bindDeviceAdminServiceAsUser}) won't be available when a secondary user or profile
7493 * is created, until it becomes affiliated. Therefore it is recommended that the appropriate
7494 * affiliation ids are set by its profile owner as soon as possible after the user/profile is
7495 * created.
7496 *
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007497 * @param admin Which profile or device owner this request is associated with.
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007498 * @param ids A list of opaque non-empty affiliation ids. Duplicate elements will be ignored.
7499 *
7500 * @throws NullPointerException if {@code ids} is null or contains null elements.
7501 * @throws IllegalArgumentException if {@code ids} contains an empty string.
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007502 */
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007503 public void setAffiliationIds(@NonNull ComponentName admin, @NonNull List<String> ids) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007504 throwIfParentInstance("setAffiliationIds");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007505 try {
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007506 mService.setAffiliationIds(admin, ids);
7507 } catch (RemoteException e) {
7508 throw e.rethrowFromSystemServer();
7509 }
7510 }
7511
7512 /**
7513 * Returns the list of affiliation ids previously set via {@link #setAffiliationIds}, or an
7514 * empty list if none have been set.
7515 */
7516 public @NonNull List<String> getAffiliationIds(@NonNull ComponentName admin) {
7517 throwIfParentInstance("getAffiliationIds");
7518 try {
7519 return mService.getAffiliationIds(admin);
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007520 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007521 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007522 }
7523 }
7524
7525 /**
7526 * @hide
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007527 * Returns whether this user/profile is affiliated with the device.
7528 * <p>
7529 * By definition, the user that the device owner runs on is always affiliated with the device.
7530 * Any other user/profile is considered affiliated with the device if the set specified by its
7531 * profile owner via {@link #setAffiliationIds} intersects with the device owner's.
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007532 *
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007533 */
7534 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007535 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007536 try {
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007537 return mService.isAffiliatedUser();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007538 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007539 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007540 }
7541 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08007542
7543 /**
7544 * @hide
7545 * Returns whether the uninstall for {@code packageName} for the current user is in queue
7546 * to be started
7547 * @param packageName the package to check for
7548 * @return whether the uninstall intent for {@code packageName} is pending
7549 */
7550 public boolean isUninstallInQueue(String packageName) {
7551 try {
7552 return mService.isUninstallInQueue(packageName);
7553 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007554 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08007555 }
7556 }
7557
7558 /**
7559 * @hide
7560 * @param packageName the package containing active DAs to be uninstalled
7561 */
7562 public void uninstallPackageWithActiveAdmins(String packageName) {
7563 try {
7564 mService.uninstallPackageWithActiveAdmins(packageName);
7565 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007566 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08007567 }
7568 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01007569
Kenny Guy38dcca52016-04-19 13:09:18 +01007570 /**
7571 * @hide
7572 * Remove a test admin synchronously without sending it a broadcast about being removed.
7573 * If the admin is a profile owner or device owner it will still be removed.
7574 *
7575 * @param userHandle user id to remove the admin for.
7576 * @param admin The administration compononent to remove.
7577 * @throws SecurityException if the caller is not shell / root or the admin package
7578 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
7579 */
7580 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
7581 try {
7582 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
7583 } catch (RemoteException re) {
7584 throw re.rethrowFromSystemServer();
7585 }
7586 }
7587
Mahaver Chopra790d1982016-07-07 16:06:49 +01007588 /**
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007589 * Returns whether the device has been provisioned.
7590 *
7591 * <p>Not for use by third-party applications.
7592 *
Mahaver Chopra790d1982016-07-07 16:06:49 +01007593 * @hide
Mahaver Chopra790d1982016-07-07 16:06:49 +01007594 */
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007595 @SystemApi
Mahaver Chopra790d1982016-07-07 16:06:49 +01007596 public boolean isDeviceProvisioned() {
7597 try {
7598 return mService.isDeviceProvisioned();
7599 } catch (RemoteException re) {
7600 throw re.rethrowFromSystemServer();
7601 }
7602 }
7603
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007604 /**
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007605 * Writes that the provisioning configuration has been applied.
7606 *
7607 * <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS}
7608 * permission.
7609 *
7610 * <p>Not for use by third-party applications.
7611 *
7612 * @hide
7613 */
7614 @SystemApi
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007615 public void setDeviceProvisioningConfigApplied() {
7616 try {
7617 mService.setDeviceProvisioningConfigApplied();
7618 } catch (RemoteException re) {
7619 throw re.rethrowFromSystemServer();
7620 }
7621 }
7622
7623 /**
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007624 * Returns whether the provisioning configuration has been applied.
7625 *
7626 * <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS} permission.
7627 *
7628 * <p>Not for use by third-party applications.
7629 *
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007630 * @return whether the provisioning configuration has been applied.
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007631 *
7632 * @hide
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007633 */
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007634 @SystemApi
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007635 public boolean isDeviceProvisioningConfigApplied() {
7636 try {
7637 return mService.isDeviceProvisioningConfigApplied();
7638 } catch (RemoteException re) {
7639 throw re.rethrowFromSystemServer();
7640 }
7641 }
7642
Victor Chang9bfc65f2016-08-15 12:27:09 +01007643 /**
7644 * @hide
Victor Chang3577ed22016-08-25 18:49:26 +01007645 * Force update user setup completed status. This API has no effect on user build.
7646 * @throws {@link SecurityException} if the caller has no
Esteban Talavera01576862016-12-15 11:16:44 +00007647 * {@code android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS} or the caller is
7648 * not {@link UserHandle#SYSTEM_USER}
Victor Chang9bfc65f2016-08-15 12:27:09 +01007649 */
7650 public void forceUpdateUserSetupComplete() {
7651 try {
7652 mService.forceUpdateUserSetupComplete();
7653 } catch (RemoteException re) {
7654 throw re.rethrowFromSystemServer();
7655 }
7656 }
7657
Benjamin Franzbc33c822016-04-15 08:57:52 +01007658 private void throwIfParentInstance(String functionName) {
7659 if (mParentInstance) {
7660 throw new SecurityException(functionName + " cannot be called on the parent instance");
7661 }
7662 }
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007663
7664 /**
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007665 * Allows the device owner to enable or disable the backup service.
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007666 *
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007667 * <p> Backup service manages all backup and restore mechanisms on the device. Setting this to
7668 * false will prevent data from being backed up or restored.
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007669 *
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007670 * <p> Backup service is off by default when device owner is present.
7671 *
7672 * @throws SecurityException if {@code admin} is not a device owner.
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007673 */
7674 public void setBackupServiceEnabled(@NonNull ComponentName admin, boolean enabled) {
Esteban Talavera5b7f2d02017-02-17 09:45:24 +00007675 throwIfParentInstance("setBackupServiceEnabled");
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007676 try {
7677 mService.setBackupServiceEnabled(admin, enabled);
7678 } catch (RemoteException re) {
7679 throw re.rethrowFromSystemServer();
7680 }
7681 }
7682
7683 /**
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007684 * Return whether the backup service is enabled by the device owner.
7685 *
7686 * <p> Backup service manages all backup and restore mechanisms on the device.
7687 *
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007688 * @return {@code true} if backup service is enabled, {@code false} otherwise.
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007689 * @see #setBackupServiceEnabled
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007690 */
7691 public boolean isBackupServiceEnabled(@NonNull ComponentName admin) {
Esteban Talavera5b7f2d02017-02-17 09:45:24 +00007692 throwIfParentInstance("isBackupServiceEnabled");
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007693 try {
7694 return mService.isBackupServiceEnabled(admin);
7695 } catch (RemoteException re) {
7696 throw re.rethrowFromSystemServer();
7697 }
7698 }
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007699
7700 /**
Esteban Talaverad36dd152016-12-15 08:51:45 +00007701 * Called by a device owner to control the network logging feature.
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007702 *
Robin Leea40a2fb2017-02-08 17:07:06 +00007703 * <p> Network logs contain DNS lookup and connect() library call events. The following library
7704 * functions are recorded while network logging is active:
7705 * <ul>
7706 * <li>{@code getaddrinfo()}</li>
7707 * <li>{@code gethostbyname()}</li>
7708 * <li>{@code connect()}</li>
7709 * </ul>
7710 *
7711 * <p> Network logging is a low-overhead tool for forensics but it is not guaranteed to use
7712 * full system call logging; event reporting is enabled by default for all processes but not
7713 * strongly enforced.
7714 * Events from applications using alternative implementations of libc, making direct kernel
7715 * calls, or deliberately obfuscating traffic may not be recorded.
7716 *
7717 * <p> Some common network events may not be reported. For example:
7718 * <ul>
7719 * <li>Applications may hardcode IP addresses to reduce the number of DNS lookups, or use
7720 * an alternative system for name resolution, and so avoid calling
7721 * {@code getaddrinfo()} or {@code gethostbyname}.</li>
7722 * <li>Applications may use datagram sockets for performance reasons, for example
7723 * for a game client. Calling {@code connect()} is unnecessary for this kind of
7724 * socket, so it will not trigger a network event.</li>
7725 * </ul>
7726 *
7727 * <p> It is possible to directly intercept layer 3 traffic leaving the device using an
7728 * always-on VPN service.
7729 * See {@link #setAlwaysOnVpnPackage(ComponentName, String, boolean)}
7730 * and {@link android.net.VpnService} for details.
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007731 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007732 * <p><strong>Note:</strong> The device owner won't be able to retrieve network logs if there
7733 * are unaffiliated secondary users or profiles on the device, regardless of whether the
7734 * feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for
7735 * all users to become affiliated. Therefore it's recommended that affiliation ids are set for
7736 * new users as soon as possible after provisioning via {@link #setAffiliationIds}.
7737 *
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007738 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7739 * @param enabled whether network logging should be enabled or not.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007740 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007741 * @see #retrieveNetworkLogs
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007742 */
7743 public void setNetworkLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
7744 throwIfParentInstance("setNetworkLoggingEnabled");
7745 try {
7746 mService.setNetworkLoggingEnabled(admin, enabled);
7747 } catch (RemoteException re) {
7748 throw re.rethrowFromSystemServer();
7749 }
7750 }
7751
7752 /**
7753 * Return whether network logging is enabled by a device owner.
7754 *
phweissa4e169e2016-11-24 16:20:57 +01007755 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Can only
7756 * be {@code null} if the caller has MANAGE_USERS permission.
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007757 * @return {@code true} if network logging is enabled by device owner, {@code false} otherwise.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007758 * @throws SecurityException if {@code admin} is not a device owner and caller has
phweissa4e169e2016-11-24 16:20:57 +01007759 * no MANAGE_USERS permission
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007760 */
phweissa4e169e2016-11-24 16:20:57 +01007761 public boolean isNetworkLoggingEnabled(@Nullable ComponentName admin) {
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007762 throwIfParentInstance("isNetworkLoggingEnabled");
7763 try {
7764 return mService.isNetworkLoggingEnabled(admin);
7765 } catch (RemoteException re) {
7766 throw re.rethrowFromSystemServer();
7767 }
7768 }
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007769
7770 /**
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007771 * Called by device owner to retrieve the most recent batch of network logging events.
7772 * A device owner has to provide a batchToken provided as part of
7773 * {@link DeviceAdminReceiver#onNetworkLogsAvailable} callback. If the token doesn't match the
7774 * token of the most recent available batch of logs, {@code null} will be returned.
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007775 *
7776 * <p> {@link NetworkEvent} can be one of {@link DnsEvent} or {@link ConnectEvent}.
7777 *
7778 * <p> The list of network events is sorted chronologically, and contains at most 1200 events.
7779 *
7780 * <p> Access to the logs is rate limited and this method will only return a new batch of logs
7781 * after the device device owner has been notified via
7782 * {@link DeviceAdminReceiver#onNetworkLogsAvailable}.
7783 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007784 * <p>If a secondary user or profile is created, calling this method will throw a
7785 * {@link SecurityException} until all users become affiliated again. It will also no longer be
7786 * possible to retrieve the network logs batch with the most recent batchToken provided
7787 * by {@link DeviceAdminReceiver#onNetworkLogsAvailable}. See
7788 * {@link DevicePolicyManager#setAffiliationIds}.
7789 *
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007790 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007791 * @param batchToken A token of the batch to retrieve
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007792 * @return A new batch of network logs which is a list of {@link NetworkEvent}. Returns
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007793 * {@code null} if the batch represented by batchToken is no longer available or if
7794 * logging is disabled.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007795 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
7796 * profile or secondary user that is not affiliated with the device owner user.
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007797 * @see DeviceAdminReceiver#onNetworkLogsAvailable
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007798 */
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007799 public @Nullable List<NetworkEvent> retrieveNetworkLogs(@NonNull ComponentName admin,
7800 long batchToken) {
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007801 throwIfParentInstance("retrieveNetworkLogs");
7802 try {
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007803 return mService.retrieveNetworkLogs(admin, batchToken);
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007804 } catch (RemoteException re) {
7805 throw re.rethrowFromSystemServer();
7806 }
7807 }
Tony Mak46aabe52016-11-14 12:53:06 +00007808
7809 /**
Esteban Talavera2f897912017-01-26 10:30:48 +00007810 * Called by a device owner to bind to a service from a profile owner or vice versa.
7811 * See {@link #getBindDeviceAdminTargetUsers} for a definition of which
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007812 * device/profile owners are allowed to bind to services of another profile/device owner.
7813 * <p>
Tony Mak46aabe52016-11-14 12:53:06 +00007814 * The service must be unexported. Note that the {@link Context} used to obtain this
7815 * {@link DevicePolicyManager} instance via {@link Context#getSystemService(Class)} will be used
7816 * to bind to the {@link android.app.Service}.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007817 *
Tony Mak46aabe52016-11-14 12:53:06 +00007818 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7819 * @param serviceIntent Identifies the service to connect to. The Intent must specify either an
7820 * explicit component name or a package name to match an
7821 * {@link IntentFilter} published by a service.
Tony Makbf9928d2016-12-22 11:02:45 +00007822 * @param conn Receives information as the service is started and stopped in main thread. This
7823 * must be a valid {@link ServiceConnection} object; it must not be {@code null}.
Tony Mak46aabe52016-11-14 12:53:06 +00007824 * @param flags Operation options for the binding operation. See
7825 * {@link Context#bindService(Intent, ServiceConnection, int)}.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007826 * @param targetUser Which user to bind to. Must be one of the users returned by
7827 * {@link #getBindDeviceAdminTargetUsers}, otherwise a {@link SecurityException} will
7828 * be thrown.
Tony Mak46aabe52016-11-14 12:53:06 +00007829 * @return If you have successfully bound to the service, {@code true} is returned;
7830 * {@code false} is returned if the connection is not made and you will not
7831 * receive the service object.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007832 *
Tony Mak46aabe52016-11-14 12:53:06 +00007833 * @see Context#bindService(Intent, ServiceConnection, int)
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007834 * @see #getBindDeviceAdminTargetUsers(ComponentName)
Tony Mak46aabe52016-11-14 12:53:06 +00007835 */
7836 public boolean bindDeviceAdminServiceAsUser(
7837 @NonNull ComponentName admin, Intent serviceIntent, @NonNull ServiceConnection conn,
7838 @Context.BindServiceFlags int flags, @NonNull UserHandle targetUser) {
7839 throwIfParentInstance("bindDeviceAdminServiceAsUser");
7840 // Keep this in sync with ContextImpl.bindServiceCommon.
7841 try {
Tony Makbf9928d2016-12-22 11:02:45 +00007842 final IServiceConnection sd = mContext.getServiceDispatcher(
7843 conn, mContext.getMainThreadHandler(), flags);
Tony Mak46aabe52016-11-14 12:53:06 +00007844 serviceIntent.prepareToLeaveProcess(mContext);
7845 return mService.bindDeviceAdminServiceAsUser(admin,
7846 mContext.getIApplicationThread(), mContext.getActivityToken(), serviceIntent,
7847 sd, flags, targetUser.getIdentifier());
7848 } catch (RemoteException re) {
7849 throw re.rethrowFromSystemServer();
7850 }
7851 }
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007852
7853 /**
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007854 * Returns the list of target users that the calling device or profile owner can use when
7855 * calling {@link #bindDeviceAdminServiceAsUser}.
7856 * <p>
Esteban Talavera2f897912017-01-26 10:30:48 +00007857 * A device owner can bind to a service from a profile owner and vice versa, provided that:
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007858 * <ul>
7859 * <li>Both belong to the same package name.
Esteban Talavera2f897912017-01-26 10:30:48 +00007860 * <li>Both users are affiliated. See {@link #setAffiliationIds}.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007861 * </ul>
7862 */
7863 public @NonNull List<UserHandle> getBindDeviceAdminTargetUsers(@NonNull ComponentName admin) {
7864 throwIfParentInstance("getBindDeviceAdminTargetUsers");
7865 try {
7866 return mService.getBindDeviceAdminTargetUsers(admin);
7867 } catch (RemoteException re) {
7868 throw re.rethrowFromSystemServer();
7869 }
7870 }
7871
7872 /**
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007873 * Called by the system to get the time at which the device owner last retrieved security
7874 * logging entries.
7875 *
7876 * @return the time at which the device owner most recently retrieved security logging entries,
7877 * in milliseconds since epoch; -1 if security logging entries were never retrieved.
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007878 * @throws SecurityException if the caller is not the device owner, does not hold the
7879 * MANAGE_USERS permission and is not the system.
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007880 *
7881 * @hide
7882 */
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007883 @TestApi
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007884 public long getLastSecurityLogRetrievalTime() {
7885 try {
7886 return mService.getLastSecurityLogRetrievalTime();
7887 } catch (RemoteException re) {
7888 throw re.rethrowFromSystemServer();
7889 }
7890 }
7891
7892 /**
7893 * Called by the system to get the time at which the device owner last requested a bug report.
7894 *
7895 * @return the time at which the device owner most recently requested a bug report, in
7896 * milliseconds since epoch; -1 if a bug report was never requested.
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007897 * @throws SecurityException if the caller is not the device owner, does not hold the
7898 * MANAGE_USERS permission and is not the system.
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007899 *
7900 * @hide
7901 */
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007902 @TestApi
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007903 public long getLastBugReportRequestTime() {
7904 try {
7905 return mService.getLastBugReportRequestTime();
7906 } catch (RemoteException re) {
7907 throw re.rethrowFromSystemServer();
7908 }
7909 }
7910
7911 /**
7912 * Called by the system to get the time at which the device owner last retrieved network logging
7913 * events.
7914 *
7915 * @return the time at which the device owner most recently retrieved network logging events, in
7916 * milliseconds since epoch; -1 if network logging events were never retrieved.
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007917 * @throws SecurityException if the caller is not the device owner, does not hold the
7918 * MANAGE_USERS permission and is not the system.
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007919 *
7920 * @hide
7921 */
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007922 @TestApi
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007923 public long getLastNetworkLogRetrievalTime() {
7924 try {
7925 return mService.getLastNetworkLogRetrievalTime();
7926 } catch (RemoteException re) {
7927 throw re.rethrowFromSystemServer();
7928 }
7929 }
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007930
7931 /**
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007932 * Called by the system to find out whether the current user's IME was set by the device/profile
7933 * owner or the user.
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007934 *
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007935 * @return {@code true} if the user's IME was set by the device or profile owner, {@code false}
7936 * otherwise.
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007937 * @throws SecurityException if the caller is not the device owner/profile owner.
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007938 *
7939 * @hide
7940 */
7941 @TestApi
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007942 public boolean isCurrentInputMethodSetByOwner() {
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007943 try {
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007944 return mService.isCurrentInputMethodSetByOwner();
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007945 } catch (RemoteException re) {
7946 throw re.rethrowFromSystemServer();
7947 }
7948 }
Bartosz Fabianowski05dc9f72017-02-22 23:41:14 +01007949
Bartosz Fabianowski05dc9f72017-02-22 23:41:14 +01007950 /**
7951 * Called by the system to get a list of CA certificates that were installed by the device or
7952 * profile owner.
7953 *
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007954 * <p> The caller must be the target user's device owner/profile Owner or hold the
Bartosz Fabianowski05dc9f72017-02-22 23:41:14 +01007955 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS_FULL} permission.
7956 *
7957 * @param user The user for whom to retrieve information.
7958 * @return list of aliases identifying CA certificates installed by the device or profile owner
7959 * @throws SecurityException if the caller does not have permission to retrieve information
7960 * about the given user's CA certificates.
7961 *
7962 * @hide
7963 */
7964 @TestApi
7965 public List<String> getOwnerInstalledCaCerts(@NonNull UserHandle user) {
7966 try {
7967 return mService.getOwnerInstalledCaCerts(user).getList();
7968 } catch (RemoteException re) {
7969 throw re.rethrowFromSystemServer();
7970 }
7971 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08007972}