blob: bb5d830820aa909dcb08e3ce3479b4ae7bd1c3fe [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 /**
Alejandro Fernándezbfd61932017-04-04 19:33:01 +0100700 * A String extra holding a url to the website of the device provider so the user can open it
701 * during provisioning. If the url is not HTTPS, an error will be shown.
Victor Chang38cfd9c2017-01-04 17:41:11 +0000702 *
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 /**
Makoto Onukifc73d792017-03-22 14:22:35 -07001518 * Service action: Action for a service that device owner and profile owner can optionally
1519 * own. If a device owner or a profile owner has such a service, the system tries to keep
1520 * a bound connection to it, in order to keep their process always running.
1521 * The service must not be exported.
1522 */
1523 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1524 public static final String ACTION_DEVICE_ADMIN_SERVICE
1525 = "android.app.action.DEVICE_ADMIN_SERVICE";
1526
1527 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001528 * Return true if the given administrator component is currently active (enabled) in the system.
1529 *
1530 * @param admin The administrator component to check for.
1531 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1532 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001533 */
Robin Lee25e26452015-06-02 09:56:29 -07001534 public boolean isAdminActive(@NonNull ComponentName admin) {
Charles He8c760562016-10-25 16:36:53 +01001535 throwIfParentInstance("isAdminActive");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001536 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001537 }
1538
1539 /**
1540 * @see #isAdminActive(ComponentName)
1541 * @hide
1542 */
Robin Lee25e26452015-06-02 09:56:29 -07001543 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001544 if (mService != null) {
1545 try {
Robin Lee25e26452015-06-02 09:56:29 -07001546 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001547 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001548 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001549 }
1550 }
1551 return false;
1552 }
Charles Hedea0c3b2017-01-13 10:04:12 +00001553
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001554 /**
1555 * Return true if the given administrator component is currently being removed
1556 * for the user.
1557 * @hide
1558 */
Robin Lee25e26452015-06-02 09:56:29 -07001559 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001560 if (mService != null) {
1561 try {
Robin Lee25e26452015-06-02 09:56:29 -07001562 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001563 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001564 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001565 }
1566 }
1567 return false;
1568 }
1569
Dianne Hackbornd6847842010-01-12 18:14:19 -08001570 /**
Robin Lee25e26452015-06-02 09:56:29 -07001571 * Return a list of all currently active device administrators' component
1572 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001573 * returned.
1574 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07001575 public @Nullable List<ComponentName> getActiveAdmins() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001576 throwIfParentInstance("getActiveAdmins");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001577 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001578 }
1579
1580 /**
1581 * @see #getActiveAdmins()
1582 * @hide
1583 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07001584 public @Nullable List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001585 if (mService != null) {
1586 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001587 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001588 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001589 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001590 }
1591 }
1592 return null;
1593 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001594
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001595 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001596 * Used by package administration code to determine if a package can be stopped
1597 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001598 * @hide
1599 */
David Ouyang3a83a332017-01-11 16:36:40 -08001600 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001601 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001602 return packageHasActiveAdmins(packageName, myUserId());
1603 }
1604
1605 /**
1606 * Used by package administration code to determine if a package can be stopped
1607 * or uninstalled.
1608 * @hide
1609 */
1610 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001611 if (mService != null) {
1612 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001613 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001614 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001615 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001616 }
1617 }
1618 return false;
1619 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001620
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001621 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001622 * Remove a current administration component. This can only be called
1623 * by the application that owns the administration component; if you
1624 * try to remove someone else's component, a security exception will be
1625 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001626 *
1627 * <p>Note that the operation is not synchronous and the admin might still be active (as
1628 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001629 *
1630 * @param admin The administration compononent to remove.
1631 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001632 */
Robin Lee25e26452015-06-02 09:56:29 -07001633 public void removeActiveAdmin(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001634 throwIfParentInstance("removeActiveAdmin");
Dianne Hackbornd6847842010-01-12 18:14:19 -08001635 if (mService != null) {
1636 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001637 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001638 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001639 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001640 }
1641 }
1642 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001643
Dianne Hackbornd6847842010-01-12 18:14:19 -08001644 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001645 * Returns true if an administrator has been granted a particular device policy. This can be
1646 * used to check whether the administrator was activated under an earlier set of policies, but
1647 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001648 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001649 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1650 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001651 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001652 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001653 */
Robin Lee25e26452015-06-02 09:56:29 -07001654 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001655 throwIfParentInstance("hasGrantedPolicy");
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001656 if (mService != null) {
1657 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001658 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001659 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001660 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001661 }
1662 }
1663 return false;
1664 }
1665
1666 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001667 * Returns true if the Profile Challenge is available to use for the given profile user.
1668 *
1669 * @hide
1670 */
1671 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1672 if (mService != null) {
1673 try {
1674 return mService.isSeparateProfileChallengeAllowed(userHandle);
1675 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001676 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001677 }
1678 }
1679 return false;
1680 }
1681
1682 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001683 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1684 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001685 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001686 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001687 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001688
Dianne Hackbornd6847842010-01-12 18:14:19 -08001689 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001690 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1691 * recognition technology. This implies technologies that can recognize the identity of
1692 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1693 * Note that quality constants are ordered so that higher values are more restrictive.
1694 */
1695 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1696
1697 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001698 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001699 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001700 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001701 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001702 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001703
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001704 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001705 * Constant for {@link #setPasswordQuality}: the user must have entered a
1706 * password containing at least numeric characters. Note that quality
1707 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001708 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001709 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001710
Dianne Hackbornd6847842010-01-12 18:14:19 -08001711 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001712 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001713 * password containing at least numeric characters with no repeating (4444)
1714 * or ordered (1234, 4321, 2468) sequences. Note that quality
1715 * constants are ordered so that higher values are more restrictive.
1716 */
1717 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1718
1719 /**
1720 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001721 * password containing at least alphabetic (or other symbol) characters.
1722 * Note that quality constants are ordered so that higher values are more
1723 * restrictive.
1724 */
1725 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001726
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001727 /**
1728 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001729 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001730 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001731 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001732 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001733 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001734
Dianne Hackbornd6847842010-01-12 18:14:19 -08001735 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001736 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001737 * password containing at least a letter, a numerical digit and a special
1738 * symbol, by default. With this password quality, passwords can be
1739 * restricted to contain various sets of characters, like at least an
1740 * uppercase letter, etc. These are specified using various methods,
1741 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1742 * that quality constants are ordered so that higher values are more
1743 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001744 */
1745 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1746
1747 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001748 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1749 * modify password. In case this password quality is set, the password is
1750 * managed by a profile owner. The profile owner can set any password,
1751 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1752 * that quality constants are ordered so that higher values are more
1753 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1754 * the highest.
1755 * @hide
1756 */
1757 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1758
1759 /**
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001760 * @hide
1761 *
1762 * adb shell dpm set-{device,profile}-owner will normally not allow installing an owner to
1763 * a user with accounts. {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED}
1764 * and {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} are the account features
1765 * used by authenticator to exempt their accounts from this:
1766 *
1767 * <ul>
1768 * <li>Non-test-only DO/PO still can't be installed when there are accounts.
1769 * <p>In order to make an apk test-only, add android:testOnly="true" to the
1770 * &lt;application&gt; tag in the manifest.
1771 *
1772 * <li>Test-only DO/PO can be installed even when there are accounts, as long as all the
1773 * accounts have the {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} feature.
1774 * Some authenticators claim to have any features, so to detect it, we also check
1775 * {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} and disallow installing
1776 * if any of the accounts have it.
1777 * </ul>
1778 */
Makoto Onuki47c203d2017-02-13 16:21:19 -08001779 @SystemApi
1780 @TestApi
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001781 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED =
1782 "android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED";
1783
1784 /** @hide See {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} */
Makoto Onuki47c203d2017-02-13 16:21:19 -08001785 @SystemApi
1786 @TestApi
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001787 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED =
1788 "android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED";
1789
1790 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001791 * Called by an application that is administering the device to set the password restrictions it
1792 * is imposing. After setting this, the user will not be able to enter a new password that is
1793 * not at least as restrictive as what has been set. Note that the current password will remain
1794 * until the user has set a new one, so the change does not take place immediately. To prompt
1795 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001796 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001797 * <p>
1798 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1799 * requested quality constant (between the policy set here, the user's preference, and any other
1800 * considerations) is the one that is in effect.
1801 * <p>
1802 * The calling device admin must have requested
1803 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1804 * not, a security exception will be thrown.
1805 * <p>
1806 * This method can be called on the {@link DevicePolicyManager} instance returned by
1807 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1808 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001809 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001810 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001811 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1812 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1813 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1814 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1815 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1816 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001817 */
Robin Lee25e26452015-06-02 09:56:29 -07001818 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001819 if (mService != null) {
1820 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001821 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001822 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001823 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001824 }
1825 }
1826 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001827
Dianne Hackbornd6847842010-01-12 18:14:19 -08001828 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001829 * Retrieve the current minimum password quality for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001830 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001831 * a separate challenge are not taken into account.
1832 *
1833 * <p>This method can be called on the {@link DevicePolicyManager} instance
1834 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1835 * restrictions on the parent profile.
1836 *
Robin Lee25e26452015-06-02 09:56:29 -07001837 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001838 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001839 */
Robin Lee25e26452015-06-02 09:56:29 -07001840 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001841 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001842 }
1843
1844 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001845 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001846 if (mService != null) {
1847 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001848 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001849 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001850 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001851 }
1852 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001853 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001854 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001855
Dianne Hackbornd6847842010-01-12 18:14:19 -08001856 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001857 * Called by an application that is administering the device to set the minimum allowed password
1858 * length. After setting this, the user will not be able to enter a new password that is not at
1859 * least as restrictive as what has been set. Note that the current password will remain until
1860 * the user has set a new one, so the change does not take place immediately. To prompt the user
1861 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1862 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1863 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1864 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1865 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1866 * {@link #setPasswordQuality}.
1867 * <p>
1868 * The calling device admin must have requested
1869 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1870 * not, a security exception will be thrown.
1871 * <p>
1872 * This method can be called on the {@link DevicePolicyManager} instance returned by
1873 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1874 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001875 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001876 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001877 * @param length The new desired minimum password length. A value of 0 means there is no
1878 * restriction.
1879 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1880 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001881 */
Robin Lee25e26452015-06-02 09:56:29 -07001882 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001883 if (mService != null) {
1884 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001885 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001886 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001887 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001888 }
1889 }
1890 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001891
Dianne Hackbornd6847842010-01-12 18:14:19 -08001892 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001893 * Retrieve the current minimum password length for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001894 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001895 * a separate challenge are not taken into account.
1896 *
1897 * <p>This method can be called on the {@link DevicePolicyManager} instance
1898 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1899 * restrictions on the parent profile.
1900 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001901 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001902 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001903 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001904 */
Robin Lee25e26452015-06-02 09:56:29 -07001905 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001906 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001907 }
1908
1909 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001910 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001911 if (mService != null) {
1912 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001913 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001914 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001915 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001916 }
1917 }
1918 return 0;
1919 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001920
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001921 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001922 * Called by an application that is administering the device to set the minimum number of upper
1923 * case letters required in the password. After setting this, the user will not be able to enter
1924 * a new password that is not at least as restrictive as what has been set. Note that the
1925 * current password will remain until the user has set a new one, so the change does not take
1926 * place immediately. To prompt the user for a new password, use
1927 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1928 * setting this value. This constraint is only imposed if the administrator has also requested
1929 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001930 * <p>
1931 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001932 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1933 * not, a security exception will be thrown.
1934 * <p>
1935 * This method can be called on the {@link DevicePolicyManager} instance returned by
1936 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1937 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001938 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001939 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1940 * @param length The new desired minimum number of upper case letters required in the password.
1941 * A value of 0 means there is no restriction.
1942 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1943 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001944 */
Robin Lee25e26452015-06-02 09:56:29 -07001945 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001946 if (mService != null) {
1947 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001948 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001949 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001950 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001951 }
1952 }
1953 }
1954
1955 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001956 * Retrieve the current number of upper case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001957 * for a particular admin or all admins that set restrictions on this user and
Esteban Talaverac1c83592016-02-17 17:56:15 +00001958 * its participating profiles. Restrictions on profiles that have a separate challenge
1959 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001960 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001961 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001962 * and only applies when the password quality is
1963 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001964 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001965 * <p>This method can be called on the {@link DevicePolicyManager} instance
1966 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1967 * restrictions on the parent profile.
1968 *
Robin Lee25e26452015-06-02 09:56:29 -07001969 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001970 * aggregate all admins.
1971 * @return The minimum number of upper case letters required in the
1972 * password.
1973 */
Robin Lee25e26452015-06-02 09:56:29 -07001974 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001975 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001976 }
1977
1978 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001979 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001980 if (mService != null) {
1981 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001982 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001983 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001984 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001985 }
1986 }
1987 return 0;
1988 }
1989
1990 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001991 * Called by an application that is administering the device to set the minimum number of lower
1992 * case letters required in the password. After setting this, the user will not be able to enter
1993 * a new password that is not at least as restrictive as what has been set. Note that the
1994 * current password will remain until the user has set a new one, so the change does not take
1995 * place immediately. To prompt the user for a new password, use
1996 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1997 * setting this value. This constraint is only imposed if the administrator has also requested
1998 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001999 * <p>
2000 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002001 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2002 * not, a security exception will be thrown.
2003 * <p>
2004 * This method can be called on the {@link DevicePolicyManager} instance returned by
2005 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2006 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002007 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002008 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2009 * @param length The new desired minimum number of lower case letters required in the password.
2010 * A value of 0 means there is no restriction.
2011 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2012 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002013 */
Robin Lee25e26452015-06-02 09:56:29 -07002014 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002015 if (mService != null) {
2016 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002017 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002018 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002019 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002020 }
2021 }
2022 }
2023
2024 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002025 * Retrieve the current number of lower case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002026 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002027 * and its participating profiles. Restrictions on profiles that have
2028 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01002029 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00002030 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002031 * and only applies when the password quality is
2032 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002033 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002034 * <p>This method can be called on the {@link DevicePolicyManager} instance
2035 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2036 * restrictions on the parent profile.
2037 *
Robin Lee25e26452015-06-02 09:56:29 -07002038 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002039 * aggregate all admins.
2040 * @return The minimum number of lower case letters required in the
2041 * password.
2042 */
Robin Lee25e26452015-06-02 09:56:29 -07002043 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002044 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002045 }
2046
2047 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002048 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002049 if (mService != null) {
2050 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002051 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002052 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002053 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002054 }
2055 }
2056 return 0;
2057 }
2058
2059 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002060 * Called by an application that is administering the device to set the minimum number of
2061 * letters required in the password. After setting this, the user will not be able to enter a
2062 * new password that is not at least as restrictive as what has been set. Note that the current
2063 * password will remain until the user has set a new one, so the change does not take place
2064 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
2065 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
2066 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
2067 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002068 * <p>
2069 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002070 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2071 * not, a security exception will be thrown.
2072 * <p>
2073 * This method can be called on the {@link DevicePolicyManager} instance returned by
2074 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2075 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002076 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002077 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2078 * @param length The new desired minimum number of letters required in the password. A value of
2079 * 0 means there is no restriction.
2080 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2081 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002082 */
Robin Lee25e26452015-06-02 09:56:29 -07002083 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002084 if (mService != null) {
2085 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002086 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002087 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002088 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002089 }
2090 }
2091 }
2092
2093 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002094 * Retrieve the current number of letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002095 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002096 * and its participating profiles. Restrictions on profiles that have
2097 * a separate challenge are not taken into account.
2098 * This is the same value as set by
2099 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002100 * and only applies when the password quality is
2101 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002102 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002103 * <p>This method can be called on the {@link DevicePolicyManager} instance
2104 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2105 * restrictions on the parent profile.
2106 *
Robin Lee25e26452015-06-02 09:56:29 -07002107 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002108 * aggregate all admins.
2109 * @return The minimum number of letters required in the password.
2110 */
Robin Lee25e26452015-06-02 09:56:29 -07002111 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002112 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002113 }
2114
2115 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002116 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002117 if (mService != null) {
2118 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002119 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002120 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002121 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002122 }
2123 }
2124 return 0;
2125 }
2126
2127 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002128 * Called by an application that is administering the device to set the minimum number of
2129 * numerical digits required in the password. After setting this, the user will not be able to
2130 * enter a new password that is not at least as restrictive as what has been set. Note that the
2131 * current password will remain until the user has set a new one, so the change does not take
2132 * place immediately. To prompt the user for a new password, use
2133 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
2134 * setting this value. This constraint is only imposed if the administrator has also requested
2135 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002136 * <p>
2137 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002138 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2139 * not, a security exception will be thrown.
2140 * <p>
2141 * This method can be called on the {@link DevicePolicyManager} instance returned by
2142 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2143 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002144 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002145 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2146 * @param length The new desired minimum number of numerical digits required in the password. A
2147 * value of 0 means there is no restriction.
2148 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2149 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002150 */
Robin Lee25e26452015-06-02 09:56:29 -07002151 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002152 if (mService != null) {
2153 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002154 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002155 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002156 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002157 }
2158 }
2159 }
2160
2161 /**
2162 * Retrieve the current number of numerical digits required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002163 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002164 * and its participating profiles. Restrictions on profiles that have
2165 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01002166 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00002167 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002168 * and only applies when the password quality is
2169 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002170 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002171 * <p>This method can be called on the {@link DevicePolicyManager} instance
2172 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2173 * restrictions on the parent profile.
2174 *
Robin Lee25e26452015-06-02 09:56:29 -07002175 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002176 * aggregate all admins.
2177 * @return The minimum number of numerical digits required in the password.
2178 */
Robin Lee25e26452015-06-02 09:56:29 -07002179 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002180 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002181 }
2182
2183 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002184 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002185 if (mService != null) {
2186 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002187 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002188 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002189 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002190 }
2191 }
2192 return 0;
2193 }
2194
2195 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002196 * Called by an application that is administering the device to set the minimum number of
2197 * symbols required in the password. After setting this, the user will not be able to enter a
2198 * new password that is not at least as restrictive as what has been set. Note that the current
2199 * password will remain until the user has set a new one, so the change does not take place
2200 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
2201 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
2202 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
2203 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002204 * <p>
2205 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002206 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2207 * not, a security exception will be thrown.
2208 * <p>
2209 * This method can be called on the {@link DevicePolicyManager} instance returned by
2210 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2211 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002212 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002213 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2214 * @param length The new desired minimum number of symbols required in the password. A value of
2215 * 0 means there is no restriction.
2216 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2217 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002218 */
Robin Lee25e26452015-06-02 09:56:29 -07002219 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002220 if (mService != null) {
2221 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002222 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002223 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002224 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002225 }
2226 }
2227 }
2228
2229 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002230 * Retrieve the current number of symbols required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002231 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002232 * and its participating profiles. Restrictions on profiles that have
2233 * a separate challenge are not taken into account. This is the same value as
2234 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002235 * and only applies when the password quality is
2236 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002237 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002238 * <p>This method can be called on the {@link DevicePolicyManager} instance
2239 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2240 * restrictions on the parent profile.
2241 *
Robin Lee25e26452015-06-02 09:56:29 -07002242 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002243 * aggregate all admins.
2244 * @return The minimum number of symbols required in the password.
2245 */
Robin Lee25e26452015-06-02 09:56:29 -07002246 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002247 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002248 }
2249
2250 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002251 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002252 if (mService != null) {
2253 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002254 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002255 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002256 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07002257 }
2258 }
2259 return 0;
2260 }
2261
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002262 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002263 * Called by an application that is administering the device to set the minimum number of
2264 * non-letter characters (numerical digits or symbols) required in the password. After setting
2265 * this, the user will not be able to enter a new password that is not at least as restrictive
2266 * as what has been set. Note that the current password will remain until the user has set a new
2267 * one, so the change does not take place immediately. To prompt the user for a new password,
2268 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
2269 * setting this value. This constraint is only imposed if the administrator has also requested
2270 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002271 * <p>
2272 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002273 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2274 * not, a security exception will be thrown.
2275 * <p>
2276 * This method can be called on the {@link DevicePolicyManager} instance returned by
2277 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2278 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002279 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002280 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2281 * @param length The new desired minimum number of letters required in the password. A value of
2282 * 0 means there is no restriction.
2283 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2284 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002285 */
Robin Lee25e26452015-06-02 09:56:29 -07002286 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002287 if (mService != null) {
2288 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002289 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002290 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002291 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002292 }
2293 }
2294 }
2295
2296 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002297 * Retrieve the current number of non-letter characters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01002298 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002299 * and its participating profiles. Restrictions on profiles that have
2300 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01002301 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00002302 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002303 * and only applies when the password quality is
2304 * {@link #PASSWORD_QUALITY_COMPLEX}.
2305 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00002306 * <p>This method can be called on the {@link DevicePolicyManager} instance
2307 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2308 * restrictions on the parent profile.
2309 *
Robin Lee25e26452015-06-02 09:56:29 -07002310 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002311 * aggregate all admins.
2312 * @return The minimum number of letters required in the password.
2313 */
Robin Lee25e26452015-06-02 09:56:29 -07002314 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002315 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002316 }
2317
2318 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002319 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002320 if (mService != null) {
2321 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002322 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002323 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002324 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07002325 }
2326 }
2327 return 0;
2328 }
2329
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002330 /**
2331 * Called by an application that is administering the device to set the length of the password
2332 * history. After setting this, the user will not be able to enter a new password that is the
2333 * same as any password in the history. Note that the current password will remain until the
2334 * user has set a new one, so the change does not take place immediately. To prompt the user for
2335 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
2336 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
2337 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
2338 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
2339 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
2340 * <p>
2341 * The calling device admin must have requested
2342 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2343 * not, a security exception will be thrown.
2344 * <p>
2345 * This method can be called on the {@link DevicePolicyManager} instance returned by
2346 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2347 * profile.
2348 *
2349 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2350 * @param length The new desired length of password history. A value of 0 means there is no
2351 * restriction.
2352 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2353 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
2354 */
Robin Lee25e26452015-06-02 09:56:29 -07002355 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002356 if (mService != null) {
2357 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002358 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002359 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002360 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002361 }
2362 }
2363 }
2364
2365 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002366 * Called by a device admin to set the password expiration timeout. Calling this method will
2367 * restart the countdown for password expiration for the given admin, as will changing the
2368 * device password (for all admins).
2369 * <p>
2370 * The provided timeout is the time delta in ms and will be added to the current time. For
2371 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
2372 * 432000000 ms for timeout.
2373 * <p>
2374 * To disable password expiration, a value of 0 may be used for timeout.
2375 * <p>
2376 * The calling device admin must have requested
2377 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
2378 * not, a security exception will be thrown.
2379 * <p>
2380 * Note that setting the password will automatically reset the expiration time for all active
2381 * admins. Active admins do not need to explicitly call this method in that case.
2382 * <p>
2383 * This method can be called on the {@link DevicePolicyManager} instance returned by
2384 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2385 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002386 *
Jim Millera4e28d12010-11-08 16:15:47 -08002387 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002388 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
2389 * there is no restriction (unlimited).
2390 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
2391 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08002392 */
Robin Lee25e26452015-06-02 09:56:29 -07002393 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08002394 if (mService != null) {
2395 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002396 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08002397 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002398 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08002399 }
2400 }
2401 }
2402
2403 /**
Jim Miller6b857682011-02-16 16:27:41 -08002404 * Get the password expiration timeout for the given admin. The expiration timeout is the
2405 * recurring expiration timeout provided in the call to
2406 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00002407 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
2408 * have set restrictions on profiles that have a separate challenge are not taken into account.
2409 *
2410 * <p>This method can be called on the {@link DevicePolicyManager} instance
2411 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2412 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08002413 *
Robin Lee25e26452015-06-02 09:56:29 -07002414 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08002415 * @return The timeout for the given admin or the minimum of all timeouts
2416 */
Robin Lee25e26452015-06-02 09:56:29 -07002417 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08002418 if (mService != null) {
2419 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002420 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08002421 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002422 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08002423 }
2424 }
2425 return 0;
2426 }
2427
2428 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002429 * Get the current password expiration time for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002430 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002431 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
2432 * of all expiration times is returned - which will be the minimum of all of them.
2433 *
2434 * <p>This method can be called on the {@link DevicePolicyManager} instance
2435 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2436 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08002437 *
Robin Lee25e26452015-06-02 09:56:29 -07002438 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002439 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08002440 */
Robin Lee25e26452015-06-02 09:56:29 -07002441 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08002442 if (mService != null) {
2443 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002444 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08002445 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002446 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08002447 }
2448 }
2449 return 0;
2450 }
2451
2452 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002453 * Retrieve the current password history length for a particular admin or all admins that
Rubin Xud3609d42016-07-13 18:32:57 +01002454 * set restrictions on this user and its participating profiles. Restrictions on profiles that
Esteban Talaverac1c83592016-02-17 17:56:15 +00002455 * have a separate challenge are not taken into account.
2456 *
2457 * <p>This method can be called on the {@link DevicePolicyManager} instance
2458 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2459 * restrictions on the parent profile.
2460 *
Robin Lee25e26452015-06-02 09:56:29 -07002461 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002462 * all admins.
2463 * @return The length of the password history
2464 */
Robin Lee25e26452015-06-02 09:56:29 -07002465 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002466 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002467 }
2468
2469 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002470 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002471 if (mService != null) {
2472 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002473 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002474 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002475 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002476 }
2477 }
2478 return 0;
2479 }
2480
Dianne Hackbornd6847842010-01-12 18:14:19 -08002481 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08002482 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002483 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08002484 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08002485 * @return Returns the maximum length that the user can enter.
2486 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002487 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002488 // Kind-of arbitrary.
2489 return 16;
2490 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002491
Dianne Hackborn254cb442010-01-27 19:23:59 -08002492 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002493 * Determine whether the current password the user has set is sufficient to meet the policy
2494 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
2495 * user and its participating profiles. Restrictions on profiles that have a separate challenge
Andrew Scull5daf2732016-11-14 15:02:45 +00002496 * are not taken into account. The user must be unlocked in order to perform the check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002497 * <p>
2498 * The calling device admin must have requested
2499 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2500 * not, a security exception will be thrown.
2501 * <p>
2502 * This method can be called on the {@link DevicePolicyManager} instance returned by
2503 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
2504 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002505 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01002506 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002507 * @throws SecurityException if the calling application does not own an active administrator
2508 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Andrew Scull5daf2732016-11-14 15:02:45 +00002509 * @throws InvalidStateException if the user is not unlocked.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002510 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002511 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002512 if (mService != null) {
2513 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002514 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002515 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002516 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002517 }
2518 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002519 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002520 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002521
Dianne Hackbornd6847842010-01-12 18:14:19 -08002522 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002523 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002524 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002525 * requested by the admins of the parent user and its profiles.
2526 *
2527 * @param userHandle the userId of the profile to check the password for.
2528 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002529 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002530 * @hide
2531 */
2532 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2533 if (mService != null) {
2534 try {
2535 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2536 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002537 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002538 }
2539 }
2540 return false;
2541 }
2542
2543 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002544 * Retrieve the number of times the user has failed at entering a password since that last
2545 * successful password entry.
2546 * <p>
2547 * This method can be called on the {@link DevicePolicyManager} instance returned by
2548 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2549 * password attemts for the parent user.
2550 * <p>
2551 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2552 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002553 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002554 * @return The number of times user has entered an incorrect password since the last correct
2555 * password entry.
2556 * @throws SecurityException if the calling application does not own an active administrator
2557 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002558 */
2559 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002560 return getCurrentFailedPasswordAttempts(myUserId());
2561 }
2562
2563 /**
2564 * Retrieve the number of times the given user has failed at entering a
2565 * password since that last successful password entry.
2566 *
2567 * <p>The calling device admin must have requested
2568 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2569 * not and it is not the system uid, a security exception will be thrown.
2570 *
2571 * @hide
2572 */
2573 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002574 if (mService != null) {
2575 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002576 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002577 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002578 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002579 }
2580 }
2581 return -1;
2582 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002583
2584 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002585 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002586 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002587 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002588 * @hide
2589 */
2590 public boolean getDoNotAskCredentialsOnBoot() {
2591 if (mService != null) {
2592 try {
2593 return mService.getDoNotAskCredentialsOnBoot();
2594 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002595 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002596 }
2597 }
2598 return false;
2599 }
2600
2601 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002602 * Setting this to a value greater than zero enables a built-in policy that will perform a
2603 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2604 * This built-in policy combines watching for failed passwords and wiping the device, and
2605 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002606 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002607 * <p>
2608 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2609 * revoking credentials, or reporting the failure to a server), you should implement
2610 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2611 * use this API, because if the maximum count is reached, the device or profile will be wiped
2612 * immediately, and your callback will not be invoked.
2613 * <p>
2614 * This method can be called on the {@link DevicePolicyManager} instance returned by
2615 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2616 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002617 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002618 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002619 * @param num The number of failed password attempts at which point the device or profile will
2620 * be wiped.
2621 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2622 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2623 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002624 */
Robin Lee25e26452015-06-02 09:56:29 -07002625 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002626 if (mService != null) {
2627 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002628 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002629 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002630 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002631 }
2632 }
2633 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002634
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002635 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002636 * Retrieve the current maximum number of login attempts that are allowed before the device
Rubin Xud3609d42016-07-13 18:32:57 +01002637 * or profile is wiped, for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002638 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2639 * not taken into account.
2640 *
2641 * <p>This method can be called on the {@link DevicePolicyManager} instance
2642 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2643 * the value for the parent profile.
2644 *
Robin Lee25e26452015-06-02 09:56:29 -07002645 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002646 * all admins.
2647 */
Robin Lee25e26452015-06-02 09:56:29 -07002648 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002649 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002650 }
2651
2652 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002653 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002654 if (mService != null) {
2655 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002656 return mService.getMaximumFailedPasswordsForWipe(
2657 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002658 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002659 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002660 }
2661 }
2662 return 0;
2663 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002664
Dianne Hackborn254cb442010-01-27 19:23:59 -08002665 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002666 * Returns the profile with the smallest maximum failed passwords for wipe,
2667 * for the given user. So for primary user, it might return the primary or
2668 * a managed profile. For a secondary user, it would be the same as the
2669 * user passed in.
2670 * @hide Used only by Keyguard
2671 */
2672 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2673 if (mService != null) {
2674 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002675 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2676 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002677 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002678 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002679 }
2680 }
2681 return UserHandle.USER_NULL;
2682 }
2683
2684 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002685 * Flag for {@link #resetPassword}: don't allow other admins to change
2686 * the password again until the user has entered it.
2687 */
2688 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002689
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002690 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002691 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2692 * If the flag is set, the device can be booted without asking for user password.
2693 * The absence of this flag does not change the current boot requirements. This flag
2694 * can be set by the device owner only. If the app is not the device owner, the flag
2695 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2696 * device to factory defaults.
2697 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002698 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002699
2700 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002701 * Force a new device unlock password (the password needed to access the entire device, not for
2702 * individual accounts) on the user. This takes effect immediately.
2703 * <p>
Rubin Xuaab7a412016-12-30 21:13:29 +00002704 * <em>For device owner and profile owners targeting SDK level
2705 * {@link android.os.Build.VERSION_CODES#O} or above, this API is no longer available and will
2706 * throw {@link SecurityException}. Please use the new API {@link #resetPasswordWithToken}
2707 * instead. </em>
2708 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002709 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002710 * device admins that are not device owner and not profile owner.
2711 * The password can now only be changed if there is currently no password set. Device owner
Ricky Wai977ade22016-05-24 15:02:41 +01002712 * and profile owner can still do this when user is unlocked and does not have a managed
2713 * profile.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002714 * <p>
2715 * The given password must be sufficient for the current password quality and length constraints
2716 * as returned by {@link #getPasswordQuality(ComponentName)} and
2717 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2718 * it will be rejected and false returned. Note that the password may be a stronger quality
2719 * (containing alphanumeric characters when the requested quality is only numeric), in which
2720 * case the currently active quality will be increased to match.
2721 * <p>
2722 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002723 * current password constraints allow it. <em>Note: This will not work in
2724 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2725 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2726 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002727 * <p>
2728 * The calling device admin must have requested
2729 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2730 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002731 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002732 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002733 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002734 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2735 * @return Returns true if the password was applied, or false if it is not acceptable for the
2736 * current constraints or if the user has not been decrypted yet.
2737 * @throws SecurityException if the calling application does not own an active administrator
2738 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Ricky Wai977ade22016-05-24 15:02:41 +01002739 * @throws IllegalStateException if the calling user is locked or has a managed profile.
Andrew Scull3f81f4e2016-07-29 16:29:58 +01002740 * @throws IllegalArgumentException if the password does not meet system requirements.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002741 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002742 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002743 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002744 if (mService != null) {
2745 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002746 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002747 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002748 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002749 }
2750 }
2751 return false;
2752 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002753
Dianne Hackbornd6847842010-01-12 18:14:19 -08002754 /**
Rubin Xuaab7a412016-12-30 21:13:29 +00002755 * Called by a profile or device owner to provision a token which can later be used to reset the
2756 * device lockscreen password (if called by device owner), or work challenge (if called by
2757 * profile owner), via {@link #resetPasswordWithToken}.
2758 * <p>
2759 * If the user currently has a lockscreen password, the provisioned token will not be
2760 * immediately usable; it only becomes active after the user performs a confirm credential
2761 * operation, which can be triggered by {@link KeyguardManager#createConfirmDeviceCredentialIntent}.
2762 * If the user has no lockscreen password, the token is activated immediately. In all cases,
2763 * the active state of the current token can be checked by {@link #isResetPasswordTokenActive}.
2764 * For security reasons, un-activated tokens are only stored in memory and will be lost once
2765 * the device reboots. In this case a new token needs to be provisioned again.
2766 * <p>
2767 * Once provisioned and activated, the token will remain effective even if the user changes
2768 * or clears the lockscreen password.
2769 * <p>
2770 * <em>This token is highly sensitive and should be treated at the same level as user
2771 * credentials. In particular, NEVER store this token on device in plaintext, especially in
2772 * Device-Encrypted storage if the token will be used to reset password on FBE devices before
2773 * user unlocks.
2774 * </em>
2775 *
2776 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2777 * @param token a secure token a least 32-byte long, which must be generated by a
2778 * cryptographically strong random number generator.
2779 * @return true if the operation is successful, false otherwise.
2780 * @throws IllegalArgumentException if the supplied token is invalid.
2781 * @throws SecurityException
2782 */
2783 public boolean setResetPasswordToken(ComponentName admin, byte[] token) {
2784 throwIfParentInstance("setResetPasswordToken");
2785 if (mService != null) {
2786 try {
2787 return mService.setResetPasswordToken(admin, token);
2788 } catch (RemoteException e) {
2789 throw e.rethrowFromSystemServer();
2790 }
2791 }
2792 return false;
2793 }
2794
2795 /**
2796 * Called by a profile or device owner to revoke the current password reset token.
2797 *
2798 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2799 * @return true if the operation is successful, false otherwise.
2800 */
2801 public boolean clearResetPasswordToken(ComponentName admin) {
2802 throwIfParentInstance("clearResetPasswordToken");
2803 if (mService != null) {
2804 try {
2805 return mService.clearResetPasswordToken(admin);
2806 } catch (RemoteException e) {
2807 throw e.rethrowFromSystemServer();
2808 }
2809 }
2810 return false;
2811 }
2812
2813 /**
2814 * Called by a profile or device owner to check if the current reset password token is active.
2815 *
2816 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2817 * @return true if the token is active, false otherwise.
2818 * @throws IllegalStateException if no token has been set.
2819 */
2820 public boolean isResetPasswordTokenActive(ComponentName admin) {
2821 throwIfParentInstance("isResetPasswordTokenActive");
2822 if (mService != null) {
2823 try {
2824 return mService.isResetPasswordTokenActive(admin);
2825 } catch (RemoteException e) {
2826 throw e.rethrowFromSystemServer();
2827 }
2828 }
2829 return false;
2830 }
2831
2832 /**
2833 * Called by device or profile owner to force set a new device unlock password or a work profile
2834 * challenge on current user. This takes effect immediately.
2835 * <p>
2836 * Unlike {@link #resetPassword}, this API can change the password even before the user or
2837 * device is unlocked or decrypted. The supplied token must have been previously provisioned via
2838 * {@link #setResetPasswordToken}, and in active state {@link #isResetPasswordTokenActive}.
2839 * <p>
2840 * The given password must be sufficient for the current password quality and length constraints
2841 * as returned by {@link #getPasswordQuality(ComponentName)} and
2842 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2843 * it will be rejected and false returned. Note that the password may be a stronger quality
2844 * (containing alphanumeric characters when the requested quality is only numeric), in which
2845 * case the currently active quality will be increased to match.
2846 * <p>
2847 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
2848 * current password constraints allow it.
2849 *
2850 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2851 * @param password The new password for the user. Null or empty clears the password.
2852 * @param token the password reset token previously provisioned by #setResetPasswordToken.
2853 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
2854 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2855 * @return Returns true if the password was applied, or false if it is not acceptable for the
2856 * current constraints.
2857 * @throws SecurityException if the calling application does not own an active administrator
2858 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
2859 * @throws IllegalStateException if the provided token is not valid.
2860 * @throws IllegalArgumentException if the password does not meet system requirements.
2861 */
2862 public boolean resetPasswordWithToken(@NonNull ComponentName admin, String password,
2863 byte[] token, int flags) {
2864 throwIfParentInstance("resetPassword");
2865 if (mService != null) {
2866 try {
2867 return mService.resetPasswordWithToken(admin, password, token, flags);
2868 } catch (RemoteException e) {
2869 throw e.rethrowFromSystemServer();
2870 }
2871 }
2872 return false;
2873 }
2874
2875 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002876 * Called by an application that is administering the device to set the maximum time for user
2877 * activity until the device will lock. This limits the length that the user can set. It takes
2878 * effect immediately.
2879 * <p>
2880 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2881 * to be able to call this method; if it has not, a security exception will be thrown.
2882 * <p>
2883 * This method can be called on the {@link DevicePolicyManager} instance returned by
2884 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2885 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002886 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002887 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002888 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2889 * is no restriction.
2890 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2891 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002892 */
Robin Lee25e26452015-06-02 09:56:29 -07002893 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002894 if (mService != null) {
2895 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002896 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002897 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002898 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002899 }
2900 }
2901 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002902
Dianne Hackbornd6847842010-01-12 18:14:19 -08002903 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002904 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002905 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002906 * a separate challenge are not taken into account.
2907 *
2908 * <p>This method can be called on the {@link DevicePolicyManager} instance
2909 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2910 * restrictions on the parent profile.
2911 *
Robin Lee25e26452015-06-02 09:56:29 -07002912 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002913 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002914 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002915 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002916 */
Robin Lee25e26452015-06-02 09:56:29 -07002917 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002918 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002919 }
2920
2921 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002922 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002923 if (mService != null) {
2924 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002925 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002926 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002927 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002928 }
2929 }
2930 return 0;
2931 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002932
Dianne Hackbornd6847842010-01-12 18:14:19 -08002933 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002934 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2935 * do not have a separate timeout to lock for work challenge only.
2936 *
2937 * @hide
2938 */
2939 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2940 if (mService != null) {
2941 try {
2942 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2943 } catch (RemoteException e) {
2944 throw e.rethrowFromSystemServer();
2945 }
2946 }
2947 return 0;
2948 }
2949
2950 /**
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002951 * Called by a device/profile owner to set the timeout after which unlocking with secondary, non
2952 * strong auth (e.g. fingerprint, trust agents) times out, i.e. the user has to use a strong
2953 * authentication method like password, pin or pattern.
2954 *
2955 * <p>This timeout is used internally to reset the timer to require strong auth again after
2956 * specified timeout each time it has been successfully used.
2957 *
2958 * <p>Fingerprint can also be disabled altogether using {@link #KEYGUARD_DISABLE_FINGERPRINT}.
2959 *
2960 * <p>Trust agents can also be disabled altogether using {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
2961 *
2962 * <p>The calling device admin must be a device or profile owner. If it is not,
2963 * a {@link SecurityException} will be thrown.
2964 *
Michal Karpinski943aabd2016-10-06 11:09:25 +01002965 * <p>The calling device admin can verify the value it has set by calling
2966 * {@link #getRequiredStrongAuthTimeout(ComponentName)} and passing in its instance.
2967 *
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002968 * <p>This method can be called on the {@link DevicePolicyManager} instance returned by
2969 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2970 * profile.
2971 *
2972 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2973 * @param timeoutMs The new timeout, after which the user will have to unlock with strong
Michal Karpinski943aabd2016-10-06 11:09:25 +01002974 * authentication method. A value of 0 means the admin is not participating in
2975 * controlling the timeout.
2976 * The minimum and maximum timeouts are platform-defined and are typically 1 hour and
2977 * 72 hours, respectively. Though discouraged, the admin may choose to require strong
2978 * auth at all times using {@link #KEYGUARD_DISABLE_FINGERPRINT} and/or
2979 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002980 *
2981 * @throws SecurityException if {@code admin} is not a device or profile owner.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01002982 */
2983 public void setRequiredStrongAuthTimeout(@NonNull ComponentName admin,
2984 long timeoutMs) {
2985 if (mService != null) {
2986 try {
2987 mService.setRequiredStrongAuthTimeout(admin, timeoutMs, mParentInstance);
2988 } catch (RemoteException e) {
2989 throw e.rethrowFromSystemServer();
2990 }
2991 }
2992 }
2993
2994 /**
2995 * Determine for how long the user will be able to use secondary, non strong auth for
2996 * authentication, since last strong method authentication (password, pin or pattern) was used.
2997 * After the returned timeout the user is required to use strong authentication method.
2998 *
2999 * <p>This method can be called on the {@link DevicePolicyManager} instance
3000 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3001 * restrictions on the parent profile.
3002 *
3003 * @param admin The name of the admin component to check, or {@code null} to aggregate
3004 * accross all participating admins.
Michal Karpinski943aabd2016-10-06 11:09:25 +01003005 * @return The timeout or 0 if not configured for the provided admin.
Michal Karpinski8f010dd2016-06-21 15:05:53 +01003006 */
3007 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin) {
3008 return getRequiredStrongAuthTimeout(admin, myUserId());
3009 }
3010
3011 /** @hide per-user version */
3012 public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin, @UserIdInt int userId) {
3013 if (mService != null) {
3014 try {
3015 return mService.getRequiredStrongAuthTimeout(admin, userId, mParentInstance);
3016 } catch (RemoteException e) {
3017 throw e.rethrowFromSystemServer();
3018 }
3019 }
3020 return DEFAULT_STRONG_AUTH_TIMEOUT_MS;
3021 }
3022
3023 /**
Andrew Scull85a63bc2016-10-24 13:47:47 +01003024 * Flag for {@link #lockNow(int)}: also evict the user's credential encryption key from the
3025 * keyring. The user's credential will need to be entered again in order to derive the
3026 * credential encryption key that will be stored back in the keyring for future use.
3027 * <p>
3028 * This flag can only be used by a profile owner when locking a managed profile on an FBE
3029 * device.
3030 * <p>
3031 * In order to secure user data, the user will be stopped and restarted so apps should wait
3032 * until they are next run to perform further actions.
3033 */
3034 public static final int FLAG_EVICT_CE_KEY = 1;
3035
3036 /** @hide */
3037 @Retention(RetentionPolicy.SOURCE)
3038 @IntDef(flag=true, value={FLAG_EVICT_CE_KEY})
3039 public @interface LockNowFlag {}
3040
3041 /**
3042 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
3043 * this call.
3044 * <p>
3045 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
3046 * to be able to call this method; if it has not, a security exception will be thrown.
3047 * <p>
3048 * This method can be called on the {@link DevicePolicyManager} instance returned by
3049 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
3050 * <p>
3051 * Equivalent to calling {@link #lockNow(int)} with no flags.
3052 *
3053 * @throws SecurityException if the calling application does not own an active administrator
3054 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
3055 */
3056 public void lockNow() {
3057 lockNow(0);
3058 }
3059
3060 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003061 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
3062 * this call.
3063 * <p>
3064 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
3065 * to be able to call this method; if it has not, a security exception will be thrown.
3066 * <p>
3067 * This method can be called on the {@link DevicePolicyManager} instance returned by
3068 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003069 *
Andrew Scull85a63bc2016-10-24 13:47:47 +01003070 * @param flags May be 0 or {@link #FLAG_EVICT_CE_KEY}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003071 * @throws SecurityException if the calling application does not own an active administrator
Andrew Scull85a63bc2016-10-24 13:47:47 +01003072 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} or the
3073 * {@link #FLAG_EVICT_CE_KEY} flag is passed by an application that is not a profile
3074 * owner of a managed profile.
3075 * @throws IllegalArgumentException if the {@link #FLAG_EVICT_CE_KEY} flag is passed when
3076 * locking the parent profile.
3077 * @throws UnsupportedOperationException if the {@link #FLAG_EVICT_CE_KEY} flag is passed on a
3078 * non-FBE device.
Dianne Hackbornd6847842010-01-12 18:14:19 -08003079 */
Andrew Scull85a63bc2016-10-24 13:47:47 +01003080 public void lockNow(@LockNowFlag int flags) {
Dianne Hackborndf83afa2010-01-20 13:37:26 -08003081 if (mService != null) {
3082 try {
Andrew Scull85a63bc2016-10-24 13:47:47 +01003083 mService.lockNow(flags, mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08003084 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003085 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08003086 }
3087 }
3088 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003089
Dianne Hackbornd6847842010-01-12 18:14:19 -08003090 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07003091 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00003092 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07003093 */
3094 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
3095
3096 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00003097 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
3098 * data.
3099 *
Paul Crowley2934b262014-12-02 11:21:13 +00003100 * <p>This flag may only be set by device owner admins; if it is set by
3101 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00003102 */
3103 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
3104
3105 /**
Suprabh Shukla556b05a2016-08-10 15:49:24 -07003106 * Ask that all user data be wiped. If called as a secondary user, the user will be removed and
3107 * other users will remain unaffected. Calling from the primary user will cause the device to
3108 * reboot, erasing all device data - including all the secondary users and their data - while
3109 * booting up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003110 * <p>
3111 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
3112 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003113 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003114 * @param flags Bit mask of additional options: currently supported flags are
3115 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
3116 * @throws SecurityException if the calling application does not own an active administrator
3117 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08003118 */
3119 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003120 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08003121 if (mService != null) {
3122 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003123 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003124 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003125 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003126 }
3127 }
3128 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003129
Dianne Hackbornd6847842010-01-12 18:14:19 -08003130 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07003131 * Called by an application that is administering the device to set the
3132 * global proxy and exclusion list.
3133 * <p>
3134 * The calling device admin must have requested
3135 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
3136 * this method; if it has not, a security exception will be thrown.
3137 * Only the first device admin can set the proxy. If a second admin attempts
3138 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07003139 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07003140 * be returned.
3141 * The method can be called repeatedly by the device admin alrady setting the
3142 * proxy to update the proxy and exclusion list.
3143 *
Robin Lee25e26452015-06-02 09:56:29 -07003144 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07003145 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
3146 * Pass Proxy.NO_PROXY to reset the proxy.
3147 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07003148 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
3149 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08003150 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07003151 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003152 public @Nullable ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07003153 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003154 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07003155 if (proxySpec == null) {
3156 throw new NullPointerException();
3157 }
3158 if (mService != null) {
3159 try {
3160 String hostSpec;
3161 String exclSpec;
3162 if (proxySpec.equals(Proxy.NO_PROXY)) {
3163 hostSpec = null;
3164 exclSpec = null;
3165 } else {
3166 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
3167 throw new IllegalArgumentException();
3168 }
3169 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
3170 String hostName = sa.getHostName();
3171 int port = sa.getPort();
3172 StringBuilder hostBuilder = new StringBuilder();
3173 hostSpec = hostBuilder.append(hostName)
3174 .append(":").append(Integer.toString(port)).toString();
3175 if (exclusionList == null) {
3176 exclSpec = "";
3177 } else {
3178 StringBuilder listBuilder = new StringBuilder();
3179 boolean firstDomain = true;
3180 for (String exclDomain : exclusionList) {
3181 if (!firstDomain) {
3182 listBuilder = listBuilder.append(",");
3183 } else {
3184 firstDomain = false;
3185 }
3186 listBuilder = listBuilder.append(exclDomain.trim());
3187 }
3188 exclSpec = listBuilder.toString();
3189 }
Yuhao Zheng90704842014-02-28 17:22:45 -08003190 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
3191 != android.net.Proxy.PROXY_VALID)
3192 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07003193 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003194 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07003195 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003196 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07003197 }
3198 }
3199 return null;
3200 }
3201
3202 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003203 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
3204 * HTTP proxies - they are generally network dependent. However if you're doing something
3205 * unusual like general internal filtering this may be useful. On a private network where the
3206 * proxy is not accessible, you may break HTTP using this.
3207 * <p>
3208 * This method requires the caller to be the device owner.
3209 * <p>
3210 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04003211 *
Jason Monk03bc9912014-05-13 09:44:57 -04003212 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003213 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3214 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
3215 * {@code null} value will clear the global HTTP proxy.
3216 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04003217 */
Robin Lee25e26452015-06-02 09:56:29 -07003218 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
3219 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003220 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04003221 if (mService != null) {
3222 try {
3223 mService.setRecommendedGlobalProxy(admin, proxyInfo);
3224 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003225 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04003226 }
3227 }
3228 }
3229
3230 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07003231 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07003232 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
3233 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08003234 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07003235 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003236 public @Nullable ComponentName getGlobalProxyAdmin() {
Oscar Montemayor69238c62010-08-03 10:51:06 -07003237 if (mService != null) {
3238 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003239 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07003240 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003241 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07003242 }
3243 }
3244 return null;
3245 }
3246
3247 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08003248 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003249 * indicating that encryption is not supported.
3250 */
3251 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
3252
3253 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08003254 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003255 * indicating that encryption is supported, but is not currently active.
3256 */
3257 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
3258
3259 /**
Robin Lee3795fb02015-02-16 14:17:23 +00003260 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003261 * indicating that encryption is not currently active, but is currently
3262 * being activated. This is only reported by devices that support
3263 * encryption of data and only when the storage is currently
3264 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
3265 * to become encrypted will never return this value.
3266 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08003267 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003268
3269 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08003270 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003271 * indicating that encryption is active.
Amith Yamasani75db1252016-07-11 14:41:01 -07003272 * <p>
3273 * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003274 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08003275 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003276
3277 /**
Robin Lee3795fb02015-02-16 14:17:23 +00003278 * Result code for {@link #getStorageEncryptionStatus}:
3279 * indicating that encryption is active, but an encryption key has not
3280 * been set by the user.
3281 */
3282 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
3283
3284 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08003285 * Result code for {@link #getStorageEncryptionStatus}:
Amith Yamasani75db1252016-07-11 14:41:01 -07003286 * indicating that encryption is active and the encryption key is tied to the user or profile.
3287 * <p>
3288 * This value is only returned to apps targeting API level 24 and above. For apps targeting
3289 * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
3290 * encryption key is specific to the user or profile.
Makoto Onukid4c9e542016-02-25 18:17:30 -08003291 */
3292 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
3293
3294 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003295 * Activity action: begin the process of encrypting data on the device. This activity should
3296 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
3297 * After resuming from this activity, use {@link #getStorageEncryption}
3298 * to check encryption status. However, on some devices this activity may never return, as
3299 * it may trigger a reboot and in some cases a complete data wipe of the device.
3300 */
3301 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3302 public static final String ACTION_START_ENCRYPTION
3303 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003304 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07003305 * Widgets are enabled in keyguard
3306 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07003307 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07003308
3309 /**
Jim Miller50e62182014-04-23 17:25:00 -07003310 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07003311 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07003312 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
3313
3314 /**
3315 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
3316 */
3317 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
3318
3319 /**
Jim Miller50e62182014-04-23 17:25:00 -07003320 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
3321 */
3322 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
3323
3324 /**
3325 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
3326 */
3327 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
3328
3329 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02003330 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07003331 * (e.g. PIN/Pattern/Password).
3332 */
3333 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
3334
3335 /**
Jim Miller06e34502014-07-17 14:46:05 -07003336 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
3337 */
3338 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
3339
3340 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08003341 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
3342 */
3343 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
3344
3345 /**
Jim Miller35207742012-11-02 15:33:20 -07003346 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07003347 */
3348 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07003349
3350 /**
Robin Leeacdeac62017-02-21 22:13:38 +00003351 * Keyguard features that when set on a managed profile that doesn't have its own challenge will
3352 * affect the profile's parent user. These can also be set on the managed profile's parent
3353 * {@link DevicePolicyManager} instance.
3354 *
3355 * @hide
3356 */
3357 public static final int PROFILE_KEYGUARD_FEATURES_AFFECT_OWNER =
3358 DevicePolicyManager.KEYGUARD_DISABLE_TRUST_AGENTS
3359 | DevicePolicyManager.KEYGUARD_DISABLE_FINGERPRINT;
3360
3361 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003362 * Called by an application that is administering the device to request that the storage system
3363 * be encrypted.
3364 * <p>
3365 * When multiple device administrators attempt to control device encryption, the most secure,
3366 * supported setting will always be used. If any device administrator requests device
3367 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
3368 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003369 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003370 * <p>
3371 * This policy controls encryption of the secure (application data) storage area. Data written
3372 * to other storage areas may or may not be encrypted, and this policy does not require or
3373 * control the encryption of any other storage areas. There is one exception: If
3374 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
3375 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
3376 * written to disk within the encrypted storage area.
3377 * <p>
3378 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
3379 * to create a device PIN or Password. In this case, the storage is encrypted, but the
3380 * encryption key may not be fully secured. For maximum security, the administrator should also
3381 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003382 *
3383 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3384 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08003385 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003386 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
3387 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
3388 * {@link #getStorageEncryptionStatus()} to query the actual device state.
3389 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3390 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003391 */
Robin Lee25e26452015-06-02 09:56:29 -07003392 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003393 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003394 if (mService != null) {
3395 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003396 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003397 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003398 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003399 }
3400 }
3401 return ENCRYPTION_STATUS_UNSUPPORTED;
3402 }
3403
3404 /**
3405 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08003406 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003407 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08003408 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
3409 * this will return the requested encryption setting as an aggregate of all active
3410 * administrators.
3411 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003412 */
Robin Lee25e26452015-06-02 09:56:29 -07003413 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003414 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003415 if (mService != null) {
3416 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003417 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003418 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003419 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003420 }
3421 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08003422 return false;
3423 }
3424
3425 /**
3426 * Called by an application that is administering the device to
3427 * determine the current encryption status of the device.
Amith Yamasani75db1252016-07-11 14:41:01 -07003428 * <p>
Andy Stadler22dbfda2011-01-17 12:47:31 -08003429 * Depending on the returned status code, the caller may proceed in different
3430 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
3431 * storage system does not support encryption. If the
3432 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
3433 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00003434 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
3435 * storage system has enabled encryption but no password is set so further action
Amith Yamasani75db1252016-07-11 14:41:01 -07003436 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
3437 * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
3438 * no further action is required.
Andy Stadler22dbfda2011-01-17 12:47:31 -08003439 *
Robin Lee7e678712014-07-24 16:41:31 +01003440 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08003441 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00003442 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
Amith Yamasani75db1252016-07-11 14:41:01 -07003443 * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08003444 */
3445 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003446 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003447 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003448 }
3449
3450 /** @hide per-user version */
3451 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08003452 if (mService != null) {
3453 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08003454 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08003455 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003456 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08003457 }
3458 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08003459 return ENCRYPTION_STATUS_UNSUPPORTED;
3460 }
3461
3462 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00003463 * Mark a CA certificate as approved by the device user. This means that they have been notified
3464 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
3465 * keep the certificate on the device.
3466 *
3467 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
3468 * this certificate.
3469 *
3470 * @hide
3471 */
3472 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
3473 if (mService != null) {
3474 try {
3475 return mService.approveCaCert(alias, userHandle, approval);
3476 } catch (RemoteException e) {
3477 throw e.rethrowFromSystemServer();
3478 }
3479 }
3480 return false;
3481 }
3482
3483 /**
3484 * Check whether a CA certificate has been approved by the device user.
3485 *
3486 * @hide
3487 */
3488 public boolean isCaCertApproved(String alias, int userHandle) {
3489 if (mService != null) {
3490 try {
3491 return mService.isCaCertApproved(alias, userHandle);
3492 } catch (RemoteException e) {
3493 throw e.rethrowFromSystemServer();
3494 }
3495 }
3496 return false;
3497 }
3498
3499 /**
Robin Lee7e678712014-07-24 16:41:31 +01003500 * Installs the given certificate as a user CA.
3501 *
Edman Anjosf9946772016-11-28 16:35:15 +01003502 * The caller must be a profile or device owner on that user, or a delegate package given the
3503 * {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a
3504 * security exception will be thrown.
3505 *
Robin Lee25e26452015-06-02 09:56:29 -07003506 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3507 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003508 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04003509 *
3510 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01003511 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003512 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3513 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003514 * @see #setDelegatedScopes
3515 * @see #DELEGATION_CERT_INSTALL
Maggie Benthallda51e682013-08-08 22:35:44 -04003516 */
Robin Lee25e26452015-06-02 09:56:29 -07003517 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003518 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04003519 if (mService != null) {
3520 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003521 return mService.installCaCert(admin, mContext.getPackageName(), certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04003522 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003523 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04003524 }
3525 }
3526 return false;
3527 }
3528
3529 /**
Robin Lee7e678712014-07-24 16:41:31 +01003530 * Uninstalls the given certificate from trusted user CAs, if present.
3531 *
Edman Anjosf9946772016-11-28 16:35:15 +01003532 * The caller must be a profile or device owner on that user, or a delegate package given the
3533 * {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a
3534 * security exception will be thrown.
3535 *
Robin Lee25e26452015-06-02 09:56:29 -07003536 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3537 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003538 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003539 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3540 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003541 * @see #setDelegatedScopes
3542 * @see #DELEGATION_CERT_INSTALL
Maggie Benthallda51e682013-08-08 22:35:44 -04003543 */
Robin Lee25e26452015-06-02 09:56:29 -07003544 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003545 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04003546 if (mService != null) {
3547 try {
Robin Lee306fe082014-06-19 14:04:24 +00003548 final String alias = getCaCertAlias(certBuffer);
Edman Anjosf9946772016-11-28 16:35:15 +01003549 mService.uninstallCaCerts(admin, mContext.getPackageName(), new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00003550 } catch (CertificateException e) {
3551 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04003552 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003553 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04003554 }
3555 }
3556 }
3557
3558 /**
Robin Lee7e678712014-07-24 16:41:31 +01003559 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
3560 * If a user has installed any certificates by other means than device policy these will be
3561 * included too.
3562 *
Robin Lee25e26452015-06-02 09:56:29 -07003563 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3564 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003565 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003566 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3567 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04003568 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003569 public @NonNull List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
3570 final List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01003571 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003572 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01003573 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003574 mService.enforceCanManageCaCerts(admin, mContext.getPackageName());
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003575 final TrustedCertificateStore certStore = new TrustedCertificateStore();
3576 for (String alias : certStore.userAliases()) {
3577 try {
3578 certs.add(certStore.getCertificate(alias).getEncoded());
3579 } catch (CertificateException ce) {
3580 Log.w(TAG, "Could not encode certificate: " + alias, ce);
3581 }
3582 }
3583 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003584 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01003585 }
3586 }
3587 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04003588 }
3589
3590 /**
Robin Lee7e678712014-07-24 16:41:31 +01003591 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
3592 * means other than device policy will also be removed, except for system CA certificates.
3593 *
Robin Lee25e26452015-06-02 09:56:29 -07003594 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3595 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003596 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3597 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01003598 */
Robin Lee25e26452015-06-02 09:56:29 -07003599 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003600 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01003601 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07003602 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003603 mService.uninstallCaCerts(admin, mContext.getPackageName(),
3604 new TrustedCertificateStore().userAliases() .toArray(new String[0]));
Robin Lee83881bd2015-06-09 16:04:38 -07003605 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003606 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01003607 }
3608 }
3609 }
3610
3611 /**
3612 * Returns whether this certificate is installed as a trusted CA.
3613 *
Robin Lee25e26452015-06-02 09:56:29 -07003614 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3615 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01003616 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003617 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3618 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04003619 */
Robin Lee25e26452015-06-02 09:56:29 -07003620 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003621 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003622 if (mService != null) {
3623 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003624 mService.enforceCanManageCaCerts(admin, mContext.getPackageName());
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003625 return getCaCertAlias(certBuffer) != null;
3626 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003627 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01003628 } catch (CertificateException ce) {
3629 Log.w(TAG, "Could not parse certificate", ce);
3630 }
Maggie Benthallda51e682013-08-08 22:35:44 -04003631 }
3632 return false;
3633 }
3634
3635 /**
Robin Leece3399f2016-02-24 12:08:32 +00003636 * Called by a device or profile owner, or delegated certificate installer, to install a
3637 * certificate and corresponding private key. All apps within the profile will be able to access
3638 * the certificate and use the private key, given direct user approval.
3639 *
3640 * <p>Access to the installed credentials will not be granted to the caller of this API without
3641 * direct user approval. This is for security - should a certificate installer become
3642 * compromised, certificates it had already installed will be protected.
3643 *
3644 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00003645 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003646 *
Robin Lee25e26452015-06-02 09:56:29 -07003647 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3648 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003649 * @param privKey The private key to install.
3650 * @param cert The certificate to install.
3651 * @param alias The private key alias under which to install the certificate. If a certificate
3652 * with that alias already exists, it will be overwritten.
3653 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003654 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3655 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003656 * @see #setDelegatedScopes
3657 * @see #DELEGATION_CERT_INSTALL
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003658 */
Robin Leefbc65642015-08-03 16:21:22 +01003659 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
3660 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00003661 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00003662 }
3663
3664 /**
3665 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00003666 * certificate chain and corresponding private key for the leaf certificate. All apps within the
3667 * profile will be able to access the certificate chain and use the private key, given direct
3668 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00003669 *
Robin Leea1b290e2016-03-09 14:38:36 +00003670 * <p>The caller of this API may grant itself access to the certificate and private key
3671 * immediately, without user approval. It is a best practice not to request this unless strictly
3672 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00003673 *
3674 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003675 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00003676 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00003677 * @param certs The certificate chain to install. The chain should start with the leaf
3678 * certificate and include the chain of trust in order. This will be returned by
3679 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00003680 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00003681 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00003682 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00003683 * credentials immediately. Otherwise, access to the credentials will be gated by user
3684 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00003685 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003686 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3687 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00003688 * @see android.security.KeyChain#getCertificateChain
Edman Anjosf9946772016-11-28 16:35:15 +01003689 * @see #setDelegatedScopes
3690 * @see #DELEGATION_CERT_INSTALL
Robin Leece3399f2016-02-24 12:08:32 +00003691 */
3692 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00003693 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003694 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003695 try {
Rubin Xub4365912016-03-23 12:13:22 +00003696 final byte[] pemCert = Credentials.convertToPem(certs[0]);
3697 byte[] pemChain = null;
3698 if (certs.length > 1) {
3699 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
3700 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01003701 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
3702 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Edman Anjosf9946772016-11-28 16:35:15 +01003703 return mService.installKeyPair(admin, mContext.getPackageName(), pkcs8Key, pemCert,
3704 pemChain, alias, requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003705 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003706 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01003707 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
3708 Log.w(TAG, "Failed to obtain private key material", e);
3709 } catch (CertificateException | IOException e) {
3710 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01003711 }
3712 return false;
3713 }
3714
3715 /**
Robin Leea1b290e2016-03-09 14:38:36 +00003716 * Called by a device or profile owner, or delegated certificate installer, to remove a
3717 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01003718 *
3719 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00003720 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01003721 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00003722 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003723 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
3724 * owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003725 * @see #setDelegatedScopes
3726 * @see #DELEGATION_CERT_INSTALL
Robin Leefbc65642015-08-03 16:21:22 +01003727 */
3728 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003729 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01003730 try {
Edman Anjosf9946772016-11-28 16:35:15 +01003731 return mService.removeKeyPair(admin, mContext.getPackageName(), alias);
Robin Leefbc65642015-08-03 16:21:22 +01003732 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003733 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01003734 }
Robin Leefbc65642015-08-03 16:21:22 +01003735 }
3736
3737 /**
Robin Lee25e26452015-06-02 09:56:29 -07003738 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00003739 * doesn't exist.
3740 */
3741 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
3742 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
3743 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
3744 new ByteArrayInputStream(certBuffer));
3745 return new TrustedCertificateStore().getCertificateAlias(cert);
3746 }
3747
3748 /**
Rubin Xuec32b562015-03-03 17:34:05 +00003749 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01003750 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00003751 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01003752 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00003753 * <p>
3754 * Delegated certificate installer is a per-user state. The delegated access is persistent until
3755 * it is later cleared by calling this method with a null value or uninstallling the certificate
3756 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003757 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00003758 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
3759 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003760 * supplied certificate installer package must be installed when calling this API, otherwise an
3761 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00003762 *
Robin Lee25e26452015-06-02 09:56:29 -07003763 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00003764 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003765 * access. If {@code null} is given the current package will be cleared.
3766 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003767 *
3768 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes}
3769 * with the {@link #DELEGATION_CERT_INSTALL} scope instead.
Rubin Xuec32b562015-03-03 17:34:05 +00003770 */
Edman Anjosf9946772016-11-28 16:35:15 +01003771 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07003772 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
3773 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003774 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003775 if (mService != null) {
3776 try {
Robin Lee25e26452015-06-02 09:56:29 -07003777 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00003778 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003779 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003780 }
3781 }
3782 }
3783
3784 /**
Edman Anjosf9946772016-11-28 16:35:15 +01003785 * Called by a profile owner or device owner to retrieve the certificate installer for the user,
3786 * or {@code null} if none is set. If there are multiple delegates this function will return one
3787 * of them.
Rubin Xuec32b562015-03-03 17:34:05 +00003788 *
Robin Lee25e26452015-06-02 09:56:29 -07003789 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003790 * @return The package name of the current delegated certificate installer, or {@code null} if
3791 * none is set.
3792 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01003793 *
3794 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages}
3795 * with the {@link #DELEGATION_CERT_INSTALL} scope instead.
Rubin Xuec32b562015-03-03 17:34:05 +00003796 */
Edman Anjosf9946772016-11-28 16:35:15 +01003797 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07003798 public @Nullable String getCertInstallerPackage(@NonNull ComponentName admin)
3799 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003800 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003801 if (mService != null) {
3802 try {
Robin Lee25e26452015-06-02 09:56:29 -07003803 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00003804 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003805 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003806 }
3807 }
3808 return null;
3809 }
3810
3811 /**
Edman Anjosf9946772016-11-28 16:35:15 +01003812 * Called by a profile owner or device owner to grant access to privileged APIs to another app.
3813 * Granted APIs are determined by {@code scopes}, which is a list of the {@code DELEGATION_*}
3814 * constants.
3815 * <p>
Edman Anjos9e62c312017-01-26 22:22:58 +01003816 * A broadcast with the {@link #ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED} action will be
3817 * sent to the {@code delegatePackage} with its new scopes in an {@code ArrayList<String>} extra
3818 * under the {@link #EXTRA_DELEGATION_SCOPES} key. The broadcast is sent with the
3819 * {@link Intent#FLAG_RECEIVER_REGISTERED_ONLY} flag.
3820 * <p>
Edman Anjosf9946772016-11-28 16:35:15 +01003821 * Delegated scopes are a per-user state. The delegated access is persistent until it is later
3822 * cleared by calling this method with an empty {@code scopes} list or uninstalling the
3823 * {@code delegatePackage}.
3824 *
3825 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3826 * @param delegatePackage The package name of the app which will be given access.
3827 * @param scopes The groups of privileged APIs whose access should be granted to
3828 * {@code delegatedPackage}.
3829 * @throws SecurityException if {@code admin} is not a device or a profile owner.
3830 */
3831 public void setDelegatedScopes(@NonNull ComponentName admin, @NonNull String delegatePackage,
3832 @NonNull List<String> scopes) {
3833 throwIfParentInstance("setDelegatedScopes");
3834 if (mService != null) {
3835 try {
3836 mService.setDelegatedScopes(admin, delegatePackage, scopes);
3837 } catch (RemoteException e) {
3838 throw e.rethrowFromSystemServer();
3839 }
3840 }
3841 }
3842
3843 /**
3844 * Called by a profile owner or device owner to retrieve a list of the scopes given to a
3845 * delegate package. Other apps can use this method to retrieve their own delegated scopes by
3846 * passing {@code null} for {@code admin} and their own package name as
3847 * {@code delegatedPackage}.
3848 *
3849 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
3850 * {@code null} if the caller is {@code delegatedPackage}.
3851 * @param delegatedPackage The package name of the app whose scopes should be retrieved.
3852 * @return A list containing the scopes given to {@code delegatedPackage}.
3853 * @throws SecurityException if {@code admin} is not a device or a profile owner.
3854 */
3855 @NonNull
Edman Anjos9e62c312017-01-26 22:22:58 +01003856 public List<String> getDelegatedScopes(@Nullable ComponentName admin,
Edman Anjosf9946772016-11-28 16:35:15 +01003857 @NonNull String delegatedPackage) {
3858 throwIfParentInstance("getDelegatedScopes");
3859 if (mService != null) {
3860 try {
3861 return mService.getDelegatedScopes(admin, delegatedPackage);
3862 } catch (RemoteException e) {
3863 throw e.rethrowFromSystemServer();
3864 }
3865 }
3866 return null;
3867 }
3868
3869 /**
3870 * Called by a profile owner or device owner to retrieve a list of delegate packages that were
3871 * granted a delegation scope.
3872 *
3873 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3874 * @param delegationScope The scope whose delegates should be retrieved.
3875 * @return A list of package names of the current delegated packages for
3876 {@code delegationScope}.
3877 * @throws SecurityException if {@code admin} is not a device or a profile owner.
3878 */
3879 @Nullable
3880 public List<String> getDelegatePackages(@NonNull ComponentName admin,
3881 @NonNull String delegationScope) {
3882 throwIfParentInstance("getDelegatePackages");
3883 if (mService != null) {
3884 try {
3885 return mService.getDelegatePackages(admin, delegationScope);
3886 } catch (RemoteException e) {
3887 throw e.rethrowFromSystemServer();
3888 }
3889 }
3890 return null;
3891 }
3892
3893 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003894 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003895 * specific application for the current user.
3896 *
3897 * @deprecated this version only exists for compability with previous developer preview builds.
3898 * TODO: delete once there are no longer any live references.
3899 * @hide
3900 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003901 @Deprecated
Robin Leedc679712016-05-03 13:23:03 +01003902 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3903 throws NameNotFoundException, UnsupportedOperationException {
3904 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3905 }
3906
3907 /**
3908 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003909 * specific application for the current user. This connection is automatically granted and
3910 * persisted after a reboot.
3911 * <p>
3912 * The designated package should declare a {@link android.net.VpnService} in its manifest
3913 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3914 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003915 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003916 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003917 * remove an existing always-on VPN configuration.
3918 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3919 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3920 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003921 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003922 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3923 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3924 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003925 */
Robin Leedc679712016-05-03 13:23:03 +01003926 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3927 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003928 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003929 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003930 if (mService != null) {
3931 try {
Robin Leedc679712016-05-03 13:23:03 +01003932 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003933 throw new NameNotFoundException(vpnPackage);
3934 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003935 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003936 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003937 }
3938 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003939 }
3940
3941 /**
3942 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003943 * always-on VPN connection for the current user. If there is no such package, or the always-on
3944 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003945 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003946 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3947 * is set.
3948 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003949 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07003950 public @Nullable String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003951 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003952 if (mService != null) {
3953 try {
3954 return mService.getAlwaysOnVpnPackage(admin);
3955 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003956 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003957 }
3958 }
3959 return null;
3960 }
3961
3962 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003963 * Called by an application that is administering the device to disable all cameras on the
3964 * device, for this user. After setting this, no applications running as this user will be able
3965 * to access any cameras on the device.
3966 * <p>
3967 * If the caller is device owner, then the restriction will be applied to all users.
3968 * <p>
3969 * The calling device admin must have requested
3970 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3971 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003972 *
3973 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3974 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003975 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3976 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003977 */
Robin Lee25e26452015-06-02 09:56:29 -07003978 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003979 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07003980 if (mService != null) {
3981 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003982 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003983 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003984 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003985 }
3986 }
3987 }
3988
3989 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003990 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003991 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003992 * @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 -07003993 * have disabled the camera
3994 */
Robin Lee25e26452015-06-02 09:56:29 -07003995 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003996 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003997 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003998 }
3999
4000 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004001 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07004002 if (mService != null) {
4003 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004004 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07004005 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004006 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07004007 }
4008 }
4009 return false;
4010 }
4011
4012 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004013 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004014 * <p>
Esteban Talaverad36dd152016-12-15 08:51:45 +00004015 * If the device contains secondary users or profiles, they must be affiliated with the device
4016 * owner user. Otherwise a {@link SecurityException} will be thrown. See
4017 * {@link #setAffiliationIds}.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004018 *
4019 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004020 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
4021 * wasn't triggered because a previous bugreport operation is still active (either the
4022 * bugreport is still running or waiting for the user to share or decline)
Esteban Talaverad36dd152016-12-15 08:51:45 +00004023 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
4024 * profile or secondary user that is not affiliated with the device owner user.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004025 */
4026 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004027 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004028 if (mService != null) {
4029 try {
4030 return mService.requestBugreport(admin);
4031 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004032 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00004033 }
4034 }
4035 return false;
4036 }
4037
4038 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07004039 * Determine whether or not creating a guest user has been disabled for the device
4040 *
4041 * @hide
4042 */
4043 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
4044 // Currently guest users can always be created if multi-user is enabled
4045 // TODO introduce a policy for guest user creation
4046 return false;
4047 }
4048
4049 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01004050 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
4051 * screen capture also prevents the content from being shown on display devices that do not have
4052 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
4053 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004054 * <p>
4055 * The calling device admin must be a device or profile owner. If it is not, a security
4056 * exception will be thrown.
4057 * <p>
4058 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
4059 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01004060 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004061 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004062 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004063 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004064 */
Robin Lee25e26452015-06-02 09:56:29 -07004065 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004066 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004067 if (mService != null) {
4068 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08004069 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004070 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004071 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004072 }
4073 }
4074 }
4075
4076 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004077 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004078 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07004079 * @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 +01004080 * have disabled screen capture.
4081 */
Robin Lee25e26452015-06-02 09:56:29 -07004082 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004083 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004084 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004085 }
4086
4087 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004088 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004089 if (mService != null) {
4090 try {
4091 return mService.getScreenCaptureDisabled(admin, userHandle);
4092 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004093 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01004094 }
4095 }
4096 return false;
4097 }
4098
4099 /**
Jason Parks841cb0a2017-01-17 15:25:17 -06004100 * Called by a device or profile owner to set whether auto time is required. If auto time is
4101 * 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 -07004102 * <p>
4103 * Note: if auto time is required the user can still manually set the time zone.
4104 * <p>
Jason Parks841cb0a2017-01-17 15:25:17 -06004105 * The calling device admin must be a device or profile owner. If it is not, a security
4106 * exception will be thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004107 *
4108 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4109 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004110 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004111 */
Robin Lee25e26452015-06-02 09:56:29 -07004112 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004113 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004114 if (mService != null) {
4115 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08004116 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004117 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004118 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004119 }
4120 }
4121 }
4122
4123 /**
4124 * @return true if auto time is required.
4125 */
4126 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004127 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004128 if (mService != null) {
4129 try {
4130 return mService.getAutoTimeRequired();
4131 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004132 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01004133 }
4134 }
4135 return false;
4136 }
4137
4138 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004139 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004140 * <p>
4141 * The system user is exempt from this policy - it is never ephemeral.
4142 * <p>
4143 * The calling device admin must be the device owner. If it is not, a security exception will be
4144 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004145 *
4146 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4147 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004148 * subsequently created users will be ephemeral.
4149 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004150 * @hide
4151 */
4152 public void setForceEphemeralUsers(
4153 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004154 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004155 if (mService != null) {
4156 try {
4157 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
4158 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004159 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004160 }
4161 }
4162 }
4163
4164 /**
4165 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004166 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004167 * @hide
4168 */
4169 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004170 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004171 if (mService != null) {
4172 try {
4173 return mService.getForceEphemeralUsers(admin);
4174 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004175 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01004176 }
4177 }
4178 return false;
4179 }
4180
4181 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07004182 * Called by an application that is administering the device to disable keyguard customizations,
4183 * such as widgets. After setting this, keyguard features will be disabled according to the
4184 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004185 * <p>
4186 * The calling device admin must have requested
4187 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4188 * if it has not, a security exception will be thrown.
4189 * <p>
4190 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
4191 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
4192 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00004193 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00004194 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004195 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00004196 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004197 * there is one, or the parent user otherwise.
4198 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
4199 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00004200 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00004201 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
4202 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004203 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
4204 * profile.
4205 * <p>
4206 * Requests to disable other features on a managed profile will be ignored.
4207 * <p>
4208 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00004209 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07004210 *
Jim Millerb8ec4702012-08-31 17:19:10 -07004211 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07004212 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004213 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
4214 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
4215 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
4216 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
4217 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
4218 * @throws SecurityException if {@code admin} is not an active administrator or does not user
4219 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07004220 */
Robin Lee25e26452015-06-02 09:56:29 -07004221 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07004222 if (mService != null) {
4223 try {
Esteban Talavera62399912016-01-11 15:37:55 +00004224 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07004225 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004226 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07004227 }
4228 }
4229 }
4230
4231 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004232 * Determine whether or not features have been disabled in keyguard either by the calling
Rubin Xud3609d42016-07-13 18:32:57 +01004233 * admin, if specified, or all admins that set restrictions on this user and its participating
Esteban Talaverac1c83592016-02-17 17:56:15 +00004234 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
4235 *
4236 * <p>This method can be called on the {@link DevicePolicyManager} instance
4237 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
4238 * restrictions on the parent profile.
4239 *
Esteban Talavera62399912016-01-11 15:37:55 +00004240 * @param admin The name of the admin component to check, or {@code null} to check whether any
4241 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07004242 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
4243 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07004244 */
Robin Lee25e26452015-06-02 09:56:29 -07004245 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004246 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004247 }
4248
4249 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004250 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07004251 if (mService != null) {
4252 try {
Esteban Talavera62399912016-01-11 15:37:55 +00004253 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07004254 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004255 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07004256 }
4257 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07004258 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07004259 }
4260
4261 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08004262 * @hide
4263 */
Robin Lee25e26452015-06-02 09:56:29 -07004264 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
4265 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004266 if (mService != null) {
4267 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01004268 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004269 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004270 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004271 }
4272 }
4273 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07004274
Dianne Hackbornd6847842010-01-12 18:14:19 -08004275 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01004276 * @hide
4277 */
Robin Lee25e26452015-06-02 09:56:29 -07004278 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004279 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01004280 }
4281
4282 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08004283 * @hide
4284 */
Robin Lee25e26452015-06-02 09:56:29 -07004285 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08004286 if (mService != null) {
4287 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004288 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08004289 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004290 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08004291 }
4292 }
4293 }
4294
4295 /**
4296 * @hide
4297 */
Andrew Scull5f9e6f32016-08-02 14:22:17 +01004298 public void setActivePasswordState(PasswordMetrics metrics, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004299 if (mService != null) {
4300 try {
Andrew Scull5f9e6f32016-08-02 14:22:17 +01004301 mService.setActivePasswordState(metrics, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004302 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004303 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004304 }
4305 }
4306 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07004307
Dianne Hackbornd6847842010-01-12 18:14:19 -08004308 /**
4309 * @hide
4310 */
Andrew Scull5daf2732016-11-14 15:02:45 +00004311 public void reportPasswordChanged(@UserIdInt int userId) {
4312 if (mService != null) {
4313 try {
4314 mService.reportPasswordChanged(userId);
4315 } catch (RemoteException e) {
4316 throw e.rethrowFromSystemServer();
4317 }
4318 }
4319 }
4320
4321 /**
4322 * @hide
4323 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004324 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004325 if (mService != null) {
4326 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004327 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004328 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004329 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004330 }
4331 }
4332 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07004333
Dianne Hackbornd6847842010-01-12 18:14:19 -08004334 /**
4335 * @hide
4336 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004337 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08004338 if (mService != null) {
4339 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07004340 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08004341 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004342 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08004343 }
4344 }
4345 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07004346
4347 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004348 * @hide
4349 */
4350 public void reportFailedFingerprintAttempt(int userHandle) {
4351 if (mService != null) {
4352 try {
4353 mService.reportFailedFingerprintAttempt(userHandle);
4354 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004355 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004356 }
4357 }
4358 }
4359
4360 /**
4361 * @hide
4362 */
4363 public void reportSuccessfulFingerprintAttempt(int userHandle) {
4364 if (mService != null) {
4365 try {
4366 mService.reportSuccessfulFingerprintAttempt(userHandle);
4367 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004368 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004369 }
4370 }
4371 }
4372
4373 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00004374 * Should be called when keyguard has been dismissed.
4375 * @hide
4376 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004377 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00004378 if (mService != null) {
4379 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004380 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00004381 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004382 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00004383 }
4384 }
4385 }
4386
4387 /**
4388 * Should be called when keyguard view has been shown to the user.
4389 * @hide
4390 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004391 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00004392 if (mService != null) {
4393 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00004394 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00004395 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004396 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00004397 }
4398 }
4399 }
4400
4401 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07004402 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00004403 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07004404 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
4405 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07004406 * @return whether the package was successfully registered as the device owner.
4407 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00004408 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07004409 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004410 public boolean setDeviceOwner(ComponentName who) {
4411 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004412 }
4413
4414 /**
4415 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07004416 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004417 public boolean setDeviceOwner(ComponentName who, int userId) {
4418 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07004419 }
4420
4421 /**
4422 * @hide
4423 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004424 public boolean setDeviceOwner(ComponentName who, String ownerName) {
4425 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07004426 }
4427
4428 /**
4429 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00004430 * Sets the given package as the device owner. The package must already be installed. There
4431 * must not already be a device owner.
4432 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
4433 * this method.
4434 * Calling this after the setup phase of the primary user has completed is allowed only if
4435 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07004436 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004437 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07004438 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004439 * @return whether the package was successfully registered as the device owner.
4440 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00004441 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004442 */
Makoto Onukia52562c2015-10-01 16:12:31 -07004443 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004444 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07004445 if (mService != null) {
4446 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07004447 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07004448 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004449 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07004450 }
4451 }
4452 return false;
4453 }
4454
4455 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004456 * Used to determine if a particular package has been registered as a Device Owner app.
4457 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07004458 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004459 * package is currently registered as the device owner app, pass in the package name from
4460 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07004461 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004462 * exact mechanism by which a device admin app is registered as a device owner app is defined by
4463 * the setup process.
4464 * @param packageName the package name of the app, to compare with the registered device owner
4465 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08004466 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07004467 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004468 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004469 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08004470 return isDeviceOwnerAppOnCallingUser(packageName);
4471 }
4472
4473 /**
4474 * @return true if a package is registered as device owner, only when it's running on the
4475 * calling user.
4476 *
4477 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
4478 * @hide
4479 */
4480 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
4481 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
4482 }
4483
4484 /**
4485 * @return true if a package is registered as device owner, even if it's running on a different
4486 * user.
4487 *
4488 * <p>Requires the MANAGE_USERS permission.
4489 *
4490 * @hide
4491 */
4492 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
4493 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
4494 }
4495
4496 /**
4497 * @return device owner component name, only when it's running on the calling user.
4498 *
4499 * @hide
4500 */
4501 public ComponentName getDeviceOwnerComponentOnCallingUser() {
4502 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
4503 }
4504
4505 /**
4506 * @return device owner component name, even if it's running on a different user.
4507 *
4508 * <p>Requires the MANAGE_USERS permission.
4509 *
4510 * @hide
4511 */
Polina Bondarenko23561db2016-12-16 11:47:28 +01004512 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08004513 public ComponentName getDeviceOwnerComponentOnAnyUser() {
4514 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
4515 }
4516
4517 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08004518 if (packageName == null) {
4519 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07004520 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08004521 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08004522 if (deviceOwner == null) {
4523 return false;
4524 }
4525 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07004526 }
4527
Makoto Onukic8a5a552015-11-19 14:29:12 -08004528 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
4529 if (mService != null) {
4530 try {
4531 return mService.getDeviceOwnerComponent(callingUserOnly);
4532 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004533 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08004534 }
4535 }
4536 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07004537 }
4538
Jason Monkb0dced82014-06-06 14:36:20 -04004539 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08004540 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
4541 * no device owner.
4542 *
4543 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07004544 *
4545 * @hide
4546 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08004547 public int getDeviceOwnerUserId() {
4548 if (mService != null) {
4549 try {
4550 return mService.getDeviceOwnerUserId();
4551 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004552 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08004553 }
4554 }
4555 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07004556 }
4557
4558 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004559 * Clears the current device owner. The caller must be the device owner. This function should be
4560 * 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 +00004561 * a part of device setup, before it completes.
4562 * <p>
4563 * While some policies previously set by the device owner will be cleared by this method, it is
4564 * a best-effort process and some other policies will still remain in place after the device
4565 * owner is cleared.
Jason Monk94d2cf92014-06-18 09:53:34 -04004566 *
4567 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004568 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
4569 * does not own the current device owner component.
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004570 *
4571 * @deprecated This method is expected to be used for testing purposes only. The device owner
4572 * will lose control of the device and its data after calling it. In order to protect any
4573 * sensitive data that remains on the device, it is advised that the device owner factory resets
4574 * the device instead of calling this method. See {@link #wipeData(int)}.
Jason Monkb0dced82014-06-06 14:36:20 -04004575 */
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004576 @Deprecated
Jason Monk94d2cf92014-06-18 09:53:34 -04004577 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004578 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04004579 if (mService != null) {
4580 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04004581 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04004582 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004583 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04004584 }
4585 }
4586 }
4587
Makoto Onukia52562c2015-10-01 16:12:31 -07004588 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08004589 * Returns the device owner package name, only if it's running on the calling user.
4590 *
4591 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07004592 *
4593 * @hide
4594 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004595 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004596 public @Nullable String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004597 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08004598 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
4599 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07004600 }
4601
4602 /**
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004603 * Called by the system to find out whether the device is managed by a Device Owner.
Makoto Onukic8a5a552015-11-19 14:29:12 -08004604 *
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004605 * @return whether the device is managed by a Device Owner.
4606 * @throws SecurityException if the caller is not the device owner, does not hold the
4607 * MANAGE_USERS permission and is not the system.
Makoto Onukia52562c2015-10-01 16:12:31 -07004608 *
4609 * @hide
4610 */
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004611 @SystemApi
4612 @TestApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08004613 public boolean isDeviceManaged() {
Bartosz Fabianowskidd7f8da2016-11-30 11:09:22 +01004614 try {
4615 return mService.hasDeviceOwner();
4616 } catch (RemoteException re) {
4617 throw re.rethrowFromSystemServer();
4618 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08004619 }
4620
4621 /**
4622 * Returns the device owner name. Note this method *will* return the device owner
4623 * name when it's running on a different user.
4624 *
4625 * <p>Requires the MANAGE_USERS permission.
4626 *
4627 * @hide
4628 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08004629 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08004630 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004631 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07004632 if (mService != null) {
4633 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07004634 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07004635 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004636 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04004637 }
4638 }
4639 return null;
4640 }
Adam Connors776c5552014-01-09 10:42:56 +00004641
4642 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04004643 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004644 * @deprecated Do not use
4645 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05004646 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004647 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05004648 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004649 public @Nullable String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05004650 return null;
4651 }
4652
4653 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004654 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004655 * @deprecated Do not use
4656 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004657 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04004658 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004659 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004660 public @Nullable ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04004661 return null;
4662 }
4663
Julia Reynolds20118f12015-02-11 12:34:08 -05004664 /**
Adam Connors776c5552014-01-09 10:42:56 +00004665 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004666 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304667 * Sets the given component as an active admin and registers the package as the profile
4668 * owner for this user. The package must already be installed and there shouldn't be
4669 * an existing profile owner registered for this user. Also, this method must be called
4670 * before the user setup has been completed.
4671 * <p>
4672 * This method can only be called by system apps that hold MANAGE_USERS permission and
4673 * MANAGE_DEVICE_ADMINS permission.
4674 * @param admin The component to register as an active admin and profile owner.
4675 * @param ownerName The user-visible name of the entity that is managing this user.
4676 * @return whether the admin was successfully registered as the profile owner.
4677 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
4678 * the user has already been set up.
4679 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004680 @Deprecated
Justin Morey80440cc2014-07-24 09:16:35 -05004681 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07004682 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304683 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004684 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304685 if (mService != null) {
4686 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004687 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304688 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004689 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304690 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004691 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05304692 }
4693 }
4694 return false;
4695 }
4696
4697 /**
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004698 * Clears the active profile owner. The caller must be the profile owner of this user, otherwise
4699 * a SecurityException will be thrown. This method is not available to managed profile owners.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004700 * <p>
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004701 * While some policies previously set by the profile owner will be cleared by this method, it is
4702 * a best-effort process and some other policies will still remain in place after the profile
4703 * owner is cleared.
Makoto Onuki5bf68022016-01-27 13:49:19 -08004704 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004705 * @param admin The component to remove as the profile owner.
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004706 * @throws SecurityException if {@code admin} is not an active profile owner, or the method is
4707 * being called from a managed profile.
4708 *
4709 * @deprecated This method is expected to be used for testing purposes only. The profile owner
4710 * will lose control of the user and its data after calling it. In order to protect any
4711 * sensitive data that remains on this user, it is advised that the profile owner deletes it
4712 * instead of calling this method. See {@link #wipeData(int)}.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004713 */
Esteban Talaveraa5b09632017-02-10 16:15:24 +00004714 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004715 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004716 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004717 if (mService != null) {
4718 try {
4719 mService.clearProfileOwner(admin);
4720 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004721 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004722 }
4723 }
4724 }
4725
4726 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05004727 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004728 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004729 */
4730 public boolean hasUserSetupCompleted() {
4731 if (mService != null) {
4732 try {
4733 return mService.hasUserSetupCompleted();
4734 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004735 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004736 }
4737 }
4738 return true;
4739 }
4740
4741 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004742 * @hide
4743 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00004744 * already be installed. There must not already be a profile owner for this user.
4745 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
4746 * this method.
4747 * Calling this after the setup phase of the specified user has completed is allowed only if:
4748 * - the caller is SYSTEM_UID.
4749 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004750 * @param admin the component name to be registered as profile owner.
4751 * @param ownerName the human readable name of the organisation associated with this DPM.
4752 * @param userHandle the userId to set the profile owner for.
4753 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00004754 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
4755 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004756 */
Robin Lee25e26452015-06-02 09:56:29 -07004757 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01004758 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004759 if (mService != null) {
4760 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004761 if (ownerName == null) {
4762 ownerName = "";
4763 }
4764 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00004765 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004766 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004767 }
4768 }
4769 return false;
4770 }
4771
4772 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004773 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004774 * <p>
4775 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004776 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004777 * <p>
4778 * If the device owner information contains only whitespaces then the message on the lock screen
4779 * will be blank and the user will not be allowed to change it.
4780 * <p>
4781 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00004782 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
4783 * and set a new version of this string accordingly.
4784 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004785 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004786 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004787 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004788 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004789 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004790 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004791 if (mService != null) {
4792 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004793 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004794 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004795 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004796 }
4797 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004798 }
4799
4800 /**
4801 * @return The device owner information. If it is not set returns {@code null}.
4802 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00004803 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004804 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004805 if (mService != null) {
4806 try {
4807 return mService.getDeviceOwnerLockScreenInfo();
4808 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004809 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00004810 }
4811 }
4812 return null;
4813 }
4814
4815 /**
Edman Anjos52088e42017-01-13 22:26:17 +01004816 * Called by device or profile owners to suspend packages for this user. This function can be
4817 * called by a device owner, profile owner, or by a delegate given the
4818 * {@link #DELEGATION_PACKAGE_ACCESS} scope via {@link #setDelegatedScopes}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004819 * <p>
4820 * A suspended package will not be able to start activities. Its notifications will be hidden,
4821 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
4822 * device.
4823 * <p>
4824 * The package must already be installed. If the package is uninstalled while suspended the
4825 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00004826 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004827 *
Edman Anjos52088e42017-01-13 22:26:17 +01004828 * @param admin The name of the admin component to check, or {@code null} if the caller is a
4829 * package access delegate.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004830 * @param packageNames The package names to suspend or unsuspend.
4831 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004832 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004833 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004834 * this method.
4835 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01004836 * @see #setDelegatedScopes
4837 * @see #DELEGATION_PACKAGE_ACCESS
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004838 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004839 public @NonNull String[] setPackagesSuspended(@NonNull ComponentName admin,
4840 @NonNull String[] packageNames, boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004841 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004842 if (mService != null) {
4843 try {
Edman Anjos52088e42017-01-13 22:26:17 +01004844 return mService.setPackagesSuspended(admin, mContext.getPackageName(), packageNames,
4845 suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004846 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004847 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004848 }
4849 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00004850 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004851 }
4852
4853 /**
Edman Anjos52088e42017-01-13 22:26:17 +01004854 * Determine if a package is suspended. This function can be called by a device owner, profile
4855 * owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
4856 * {@link #setDelegatedScopes}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004857 *
Edman Anjos52088e42017-01-13 22:26:17 +01004858 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
4859 * {@code null} if the caller is a package access delegate.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004860 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00004861 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004862 * suspended, could not be found or an error occurred.
4863 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004864 * @throws NameNotFoundException if the package could not be found.
Edman Anjos52088e42017-01-13 22:26:17 +01004865 * @see #setDelegatedScopes
4866 * @see #DELEGATION_PACKAGE_ACCESS
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004867 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004868 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
4869 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004870 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004871 if (mService != null) {
4872 try {
Edman Anjos52088e42017-01-13 22:26:17 +01004873 return mService.isPackageSuspended(admin, mContext.getPackageName(), packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004874 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004875 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00004876 } catch (IllegalArgumentException ex) {
4877 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00004878 }
4879 }
4880 return false;
4881 }
4882
4883 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004884 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
4885 * be used. Only the profile owner can call this.
4886 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01004887 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004888 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004889 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004890 */
Robin Lee25e26452015-06-02 09:56:29 -07004891 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004892 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004893 if (mService != null) {
4894 try {
4895 mService.setProfileEnabled(admin);
4896 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004897 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01004898 }
4899 }
4900 }
4901
4902 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004903 * Sets the name of the profile. In the device owner case it sets the name of the user which it
4904 * is called from. Only a profile owner or device owner can call this. If this is never called
4905 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004906 *
4907 * @see #isProfileOwnerApp
4908 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07004909 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004910 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004911 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004912 */
Robin Lee25e26452015-06-02 09:56:29 -07004913 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004914 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01004915 if (mService != null) {
4916 try {
Robin Lee25e26452015-06-02 09:56:29 -07004917 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004918 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004919 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004920 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004921 }
4922 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004923
4924 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004925 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08004926 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004927 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00004928 *
4929 * @param packageName The package name of the app to compare with the registered profile owner.
4930 * @return Whether or not the package is registered as the profile owner.
4931 */
4932 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004933 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00004934 if (mService != null) {
4935 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08004936 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01004937 return profileOwner != null
4938 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004939 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004940 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004941 }
4942 }
4943 return false;
4944 }
4945
4946 /**
4947 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004948 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004949 * owner has been set for that user.
4950 * @throws IllegalArgumentException if the userId is invalid.
4951 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004952 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004953 public @Nullable ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004954 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004955 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4956 }
4957
4958 /**
4959 * @see #getProfileOwner()
4960 * @hide
4961 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004962 public @Nullable ComponentName getProfileOwnerAsUser(final int userId)
4963 throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004964 if (mService != null) {
4965 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004966 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00004967 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004968 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004969 }
4970 }
4971 return null;
4972 }
4973
4974 /**
4975 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004976 * @return the human readable name of the organisation associated with this DPM or {@code null}
4977 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00004978 * @throws IllegalArgumentException if the userId is invalid.
4979 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07004980 public @Nullable String getProfileOwnerName() throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004981 if (mService != null) {
4982 try {
4983 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4984 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004985 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004986 }
4987 }
4988 return null;
4989 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004990
4991 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07004992 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08004993 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07004994 * @return the human readable name of the organisation associated with this profile owner or
4995 * null if one is not set.
4996 * @throws IllegalArgumentException if the userId is invalid.
4997 */
4998 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07004999 public @Nullable String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005000 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07005001 if (mService != null) {
5002 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02005003 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07005004 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005005 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07005006 }
5007 }
5008 return null;
5009 }
5010
5011 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005012 * Called by a profile owner or device owner to add a default intent handler activity for
5013 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005014 * handler even if the set of potential event handlers for the intent filter changes and if the
5015 * intent preferences are reset.
5016 * <p>
5017 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
5018 * When the activity is (re)installed, it is automatically reset as default intent handler for
5019 * the filter.
5020 * <p>
5021 * The calling device admin must be a profile owner or device owner. If it is not, a security
5022 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005023 *
5024 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5025 * @param filter The IntentFilter for which a default handler is added.
5026 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005027 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005028 */
Robin Lee25e26452015-06-02 09:56:29 -07005029 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
5030 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005031 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005032 if (mService != null) {
5033 try {
5034 mService.addPersistentPreferredActivity(admin, filter, activity);
5035 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005036 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005037 }
5038 }
5039 }
5040
5041 /**
5042 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00005043 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005044 * <p>
5045 * The calling device admin must be a profile owner. If it is not, a security exception will be
5046 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005047 *
5048 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5049 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005050 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005051 */
Robin Lee25e26452015-06-02 09:56:29 -07005052 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005053 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005054 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005055 if (mService != null) {
5056 try {
5057 mService.clearPackagePersistentPreferredActivities(admin, packageName);
5058 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005059 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00005060 }
5061 }
5062 }
Robin Lee66e5d962014-04-09 16:44:21 +01005063
5064 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00005065 * Called by a profile owner or device owner to grant permission to a package to manage
5066 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
5067 * {@link #getApplicationRestrictions}.
5068 * <p>
5069 * This permission is persistent until it is later cleared by calling this method with a
5070 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00005071 * <p>
5072 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00005073 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005074 *
5075 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5076 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005077 * APIs. If {@code null} is given the current package will be cleared.
5078 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00005079 * @throws NameNotFoundException if {@code packageName} is not found
Edman Anjosf9946772016-11-28 16:35:15 +01005080 *
5081 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes}
5082 * with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005083 */
Edman Anjosf9946772016-11-28 16:35:15 +01005084 @Deprecated
Esteban Talaverabf60f722015-12-10 16:26:44 +00005085 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00005086 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005087 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00005088 if (mService != null) {
5089 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00005090 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
5091 throw new NameNotFoundException(packageName);
5092 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00005093 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005094 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00005095 }
5096 }
5097 }
5098
5099 /**
5100 * Called by a profile owner or device owner to retrieve the application restrictions managing
Edman Anjosf9946772016-11-28 16:35:15 +01005101 * package for the current user, or {@code null} if none is set. If there are multiple
5102 * delegates this function will return one of them.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005103 *
5104 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5105 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005106 * {@code null} if none is set.
5107 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01005108 *
5109 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages}
5110 * with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005111 */
Edman Anjosf9946772016-11-28 16:35:15 +01005112 @Deprecated
5113 @Nullable
5114 public String getApplicationRestrictionsManagingPackage(
Makoto Onuki408e8e42016-10-25 12:10:27 -07005115 @NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005116 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00005117 if (mService != null) {
5118 try {
5119 return mService.getApplicationRestrictionsManagingPackage(admin);
5120 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005121 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00005122 }
5123 }
5124 return null;
5125 }
5126
5127 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00005128 * Called by any application to find out whether it has been granted permission via
5129 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
5130 * for the calling user.
5131 *
5132 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
5133 * that method.
Edman Anjosf9946772016-11-28 16:35:15 +01005134 *
5135 * @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatedScopes}
5136 * instead.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005137 */
Edman Anjosf9946772016-11-28 16:35:15 +01005138 @Deprecated
Esteban Talaverabf60f722015-12-10 16:26:44 +00005139 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005140 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00005141 if (mService != null) {
5142 try {
Edman Anjosf9946772016-11-28 16:35:15 +01005143 return mService.isCallerApplicationRestrictionsManagingPackage(
5144 mContext.getPackageName());
Esteban Talaverabf60f722015-12-10 16:26:44 +00005145 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005146 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00005147 }
5148 }
5149 return false;
5150 }
5151
5152 /**
5153 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005154 * <p>
5155 * 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 +01005156 * application restrictions via {@link #setDelegatedScopes} with the
5157 * {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005158 * <p>
5159 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01005160 * <ul>
5161 * <li>{@code boolean}
5162 * <li>{@code int}
5163 * <li>{@code String} or {@code String[]}
5164 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
5165 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005166 * <p>
5167 * If the restrictions are not available yet, but may be applied in the near future, the caller
5168 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00005169 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005170 * <p>
5171 * The application restrictions are only made visible to the target application via
5172 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
5173 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00005174 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01005175 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005176 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
5177 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00005178 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005179 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01005180 * @param packageName The name of the package to update restricted settings for.
5181 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005182 * set of active restrictions.
5183 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01005184 * @see #setDelegatedScopes
5185 * @see #DELEGATION_APP_RESTRICTIONS
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00005186 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01005187 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005188 @WorkerThread
Esteban Talaverabf60f722015-12-10 16:26:44 +00005189 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01005190 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005191 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01005192 if (mService != null) {
5193 try {
Edman Anjosf9946772016-11-28 16:35:15 +01005194 mService.setApplicationRestrictions(admin, mContext.getPackageName(), packageName,
5195 settings);
Robin Lee66e5d962014-04-09 16:44:21 +01005196 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005197 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01005198 }
5199 }
5200 }
5201
5202 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005203 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
5204 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
5205 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07005206 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005207 * <p>
5208 * The calling device admin must have requested
5209 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
5210 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01005211 * <p>
5212 * This method can be called on the {@link DevicePolicyManager} instance returned by
5213 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
5214 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07005215 *
5216 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07005217 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005218 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
5219 * strictly disabled according to the state of the
5220 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
5221 * <p>
5222 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
5223 * admins, then it's up to the TrustAgent itself to aggregate the values from all
5224 * device admins.
5225 * <p>
5226 * Consult documentation for the specific TrustAgent to determine legal options
5227 * parameters.
5228 * @throws SecurityException if {@code admin} is not an active administrator or does not use
5229 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07005230 */
Robin Lee25e26452015-06-02 09:56:29 -07005231 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
5232 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07005233 if (mService != null) {
5234 try {
Tony Mak089d8402016-04-05 17:42:55 +01005235 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07005236 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005237 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07005238 }
5239 }
5240 }
5241
5242 /**
Jim Millere303bf42014-08-26 17:12:29 -07005243 * Gets configuration for the given trust agent based on aggregating all calls to
5244 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
5245 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01005246 * <p>
5247 * This method can be called on the {@link DevicePolicyManager} instance returned by
5248 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
5249 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07005250 *
Jim Millerb5db57a2015-01-14 18:17:19 -08005251 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
5252 * this function returns a list of configurations for all admins that declare
5253 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
5254 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
5255 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
5256 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07005257 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07005258 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07005259 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005260 public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
5261 @Nullable ComponentName admin, @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005262 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07005263 }
5264
5265 /** @hide per-user version */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005266 public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
5267 @Nullable ComponentName admin, @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07005268 if (mService != null) {
5269 try {
Tony Mak089d8402016-04-05 17:42:55 +01005270 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
5271 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07005272 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005273 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07005274 }
5275 }
Jim Millere303bf42014-08-26 17:12:29 -07005276 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07005277 }
5278
5279 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005280 * Called by a profile owner of a managed profile to set whether caller-Id information from the
5281 * managed profile will be shown in the parent profile, for incoming calls.
5282 * <p>
5283 * The calling device admin must be a profile owner. If it is not, a security exception will be
5284 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01005285 *
Robin Lee25e26452015-06-02 09:56:29 -07005286 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01005287 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005288 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01005289 */
Robin Lee25e26452015-06-02 09:56:29 -07005290 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005291 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01005292 if (mService != null) {
5293 try {
Robin Lee25e26452015-06-02 09:56:29 -07005294 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01005295 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005296 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01005297 }
5298 }
5299 }
5300
5301 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005302 * Called by a profile owner of a managed profile to determine whether or not caller-Id
5303 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005304 * <p>
5305 * The calling device admin must be a profile owner. If it is not, a security exception will be
5306 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01005307 *
Robin Lee25e26452015-06-02 09:56:29 -07005308 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005309 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01005310 */
Robin Lee25e26452015-06-02 09:56:29 -07005311 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005312 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01005313 if (mService != null) {
5314 try {
Robin Lee25e26452015-06-02 09:56:29 -07005315 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01005316 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005317 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01005318 }
5319 }
5320 return false;
5321 }
5322
5323 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07005324 * Determine whether or not caller-Id information has been disabled.
5325 *
5326 * @param userHandle The user for whom to check the caller-id permission
5327 * @hide
5328 */
5329 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
5330 if (mService != null) {
5331 try {
5332 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
5333 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005334 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07005335 }
5336 }
5337 return false;
5338 }
5339
5340 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005341 * Called by a profile owner of a managed profile to set whether contacts search from the
5342 * managed profile will be shown in the parent profile, for incoming calls.
5343 * <p>
5344 * The calling device admin must be a profile owner. If it is not, a security exception will be
5345 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00005346 *
5347 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5348 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005349 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00005350 */
5351 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
5352 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005353 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00005354 if (mService != null) {
5355 try {
5356 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
5357 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005358 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00005359 }
5360 }
5361 }
5362
5363 /**
5364 * Called by a profile owner of a managed profile to determine whether or not contacts search
5365 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005366 * <p>
5367 * The calling device admin must be a profile owner. If it is not, a security exception will be
5368 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00005369 *
5370 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005371 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00005372 */
5373 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005374 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00005375 if (mService != null) {
5376 try {
5377 return mService.getCrossProfileContactsSearchDisabled(admin);
5378 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005379 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00005380 }
5381 }
5382 return false;
5383 }
5384
5385
5386 /**
5387 * Determine whether or not contacts search has been disabled.
5388 *
5389 * @param userHandle The user for whom to check the contacts search permission
5390 * @hide
5391 */
5392 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
5393 if (mService != null) {
5394 try {
5395 return mService
5396 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
5397 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005398 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00005399 }
5400 }
5401 return false;
5402 }
5403
5404 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005405 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00005406 *
Makoto Onuki1040da12015-03-19 11:24:00 -07005407 * @hide
5408 */
5409 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00005410 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07005411 if (mService != null) {
5412 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00005413 mService.startManagedQuickContact(actualLookupKey, actualContactId,
5414 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07005415 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005416 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07005417 }
5418 }
5419 }
5420
5421 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005422 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00005423 * @hide
5424 */
5425 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
5426 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00005427 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00005428 originalIntent);
5429 }
5430
5431 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005432 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
5433 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01005434 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005435 * The calling device admin must be a profile owner. If it is not, a security exception will be
5436 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01005437 * <p>
5438 * This API works on managed profile only.
5439 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005440 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5441 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
5442 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01005443 */
Robin Lee25e26452015-06-02 09:56:29 -07005444 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005445 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01005446 if (mService != null) {
5447 try {
Robin Lee25e26452015-06-02 09:56:29 -07005448 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01005449 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005450 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01005451 }
5452 }
5453 }
5454
5455 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005456 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
5457 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01005458 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005459 * The calling device admin must be a profile owner. If it is not, a security exception will be
5460 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01005461 * <p>
5462 * This API works on managed profile only.
5463 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005464 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5465 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01005466 */
Robin Lee25e26452015-06-02 09:56:29 -07005467 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005468 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01005469 if (mService != null) {
5470 try {
Robin Lee25e26452015-06-02 09:56:29 -07005471 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01005472 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005473 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01005474 }
5475 }
5476 return true;
5477 }
5478
5479 /**
5480 * Determine whether or not Bluetooth devices cannot access contacts.
5481 * <p>
5482 * This API works on managed profile UserHandle only.
5483 *
5484 * @param userHandle The user for whom to check the caller-id permission
5485 * @hide
5486 */
5487 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
5488 if (mService != null) {
5489 try {
5490 return mService.getBluetoothContactSharingDisabledForUser(userHandle
5491 .getIdentifier());
5492 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005493 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01005494 }
5495 }
5496 return true;
5497 }
5498
5499 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005500 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005501 * profile can also be resolved in the parent, or vice versa. Only activity intents are
5502 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00005503 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005504 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01005505 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005506 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01005507 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005508 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
5509 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005510 */
Robin Lee25e26452015-06-02 09:56:29 -07005511 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005512 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005513 if (mService != null) {
5514 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01005515 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005516 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005517 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005518 }
5519 }
5520 }
5521
5522 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005523 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
5524 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01005525 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005526 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005527 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005528 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005529 */
Robin Lee25e26452015-06-02 09:56:29 -07005530 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005531 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005532 if (mService != null) {
5533 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01005534 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005535 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005536 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00005537 }
5538 }
5539 }
5540
5541 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005542 * Called by a profile or device owner to set the permitted accessibility services. When set by
5543 * a device owner or profile owner the restriction applies to all profiles of the user the
5544 * device owner or profile owner is an admin for. By default the user can use any accessiblity
5545 * service. When zero or more packages have been added, accessiblity services that are not in
5546 * the list and not part of the system can not be enabled by the user.
5547 * <p>
5548 * Calling with a null value for the list disables the restriction so that all services can be
5549 * used, calling with an empty list only allows the builtin system's services.
5550 * <p>
5551 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005552 *
5553 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5554 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005555 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
5556 * accessibility services enabled, that are not in the list.
5557 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005558 */
Robin Lee25e26452015-06-02 09:56:29 -07005559 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005560 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005561 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005562 if (mService != null) {
5563 try {
5564 return mService.setPermittedAccessibilityServices(admin, packageNames);
5565 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005566 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005567 }
5568 }
5569 return false;
5570 }
5571
5572 /**
5573 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005574 * <p>
5575 * An empty list means no accessibility services except system services are allowed. Null means
5576 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005577 *
5578 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5579 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005580 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005581 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005582 public @Nullable List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005583 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005584 if (mService != null) {
5585 try {
5586 return mService.getPermittedAccessibilityServices(admin);
5587 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005588 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005589 }
5590 }
5591 return null;
5592 }
5593
5594 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00005595 * Called by the system to check if a specific accessibility service is disabled by admin.
5596 *
5597 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5598 * @param packageName Accessibility service package name that needs to be checked.
5599 * @param userHandle user id the admin is running as.
5600 * @return true if the accessibility service is permitted, otherwise false.
5601 *
5602 * @hide
5603 */
5604 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
5605 @NonNull String packageName, int userHandle) {
5606 if (mService != null) {
5607 try {
5608 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
5609 userHandle);
5610 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005611 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00005612 }
5613 }
5614 return false;
5615 }
5616
5617 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005618 * Returns the list of accessibility services permitted by the device or profiles
5619 * owners of this user.
5620 *
5621 * <p>Null means all accessibility services are allowed, if a non-null list is returned
5622 * it will contain the intersection of the permitted lists for any device or profile
5623 * owners that apply to this user. It will also include any system accessibility services.
5624 *
5625 * @param userId which user to check for.
5626 * @return List of accessiblity service package names.
5627 * @hide
5628 */
5629 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07005630 public @Nullable List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005631 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005632 if (mService != null) {
5633 try {
5634 return mService.getPermittedAccessibilityServicesForUser(userId);
5635 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005636 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005637 }
5638 }
5639 return null;
5640 }
5641
5642 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005643 * Called by a profile or device owner to set the permitted input methods services. When set by
5644 * a device owner or profile owner the restriction applies to all profiles of the user the
5645 * device owner or profile owner is an admin for. By default the user can use any input method.
5646 * When zero or more packages have been added, input method that are not in the list and not
5647 * part of the system can not be enabled by the user. This method will fail if it is called for
5648 * a admin that is not for the foreground user or a profile of the foreground user.
5649 * <p>
5650 * Calling with a null value for the list disables the restriction so that all input methods can
5651 * be used, calling with an empty list disables all but the system's own input methods.
5652 * <p>
5653 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005654 *
5655 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5656 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005657 * @return true if setting the restriction succeeded. It will fail if there are one or more
5658 * non-system input methods currently enabled that are not in the packageNames list.
5659 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005660 */
Robin Lee25e26452015-06-02 09:56:29 -07005661 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005662 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005663 if (mService != null) {
5664 try {
5665 return mService.setPermittedInputMethods(admin, packageNames);
5666 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005667 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005668 }
5669 }
5670 return false;
5671 }
5672
5673
5674 /**
5675 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005676 * <p>
5677 * An empty list means no input methods except system input methods are allowed. Null means all
5678 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005679 *
5680 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5681 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005682 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005683 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005684 public @Nullable List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005685 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005686 if (mService != null) {
5687 try {
5688 return mService.getPermittedInputMethods(admin);
5689 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005690 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005691 }
5692 }
5693 return null;
5694 }
5695
5696 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00005697 * Called by the system to check if a specific input method is disabled by admin.
5698 *
5699 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5700 * @param packageName Input method package name that needs to be checked.
5701 * @param userHandle user id the admin is running as.
5702 * @return true if the input method is permitted, otherwise false.
5703 *
5704 * @hide
5705 */
5706 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
5707 @NonNull String packageName, int userHandle) {
5708 if (mService != null) {
5709 try {
5710 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
5711 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005712 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00005713 }
5714 }
5715 return false;
5716 }
5717
5718 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005719 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08005720 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005721 *
5722 * <p>Null means all input methods are allowed, if a non-null list is returned
5723 * it will contain the intersection of the permitted lists for any device or profile
5724 * owners that apply to this user. It will also include any system input methods.
5725 *
5726 * @return List of input method package names.
5727 * @hide
5728 */
5729 @SystemApi
Makoto Onuki408e8e42016-10-25 12:10:27 -07005730 public @Nullable List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005731 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005732 if (mService != null) {
5733 try {
5734 return mService.getPermittedInputMethodsForCurrentUser();
5735 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005736 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01005737 }
5738 }
5739 return null;
5740 }
5741
5742 /**
Edman Anjos52088e42017-01-13 22:26:17 +01005743 * Get the list of apps to keep around as APKs even if no user has currently installed it. This
5744 * function can be called by a device owner or by a delegate given the
5745 * {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}.
5746 * <p>
5747 * Please note that packages returned in this method are not automatically pre-cached.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005748 *
Edman Anjos52088e42017-01-13 22:26:17 +01005749 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
5750 * {@code null} if the caller is a keep uninstalled packages delegate.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005751 * @return List of package names to keep cached.
Edman Anjos52088e42017-01-13 22:26:17 +01005752 * @see #setDelegatedScopes
5753 * @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005754 * @hide
5755 */
Edman Anjos52088e42017-01-13 22:26:17 +01005756 public @Nullable List<String> getKeepUninstalledPackages(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005757 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005758 if (mService != null) {
5759 try {
Edman Anjos52088e42017-01-13 22:26:17 +01005760 return mService.getKeepUninstalledPackages(admin, mContext.getPackageName());
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005761 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005762 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005763 }
5764 }
5765 return null;
5766 }
5767
5768 /**
Edman Anjos52088e42017-01-13 22:26:17 +01005769 * Set a list of apps to keep around as APKs even if no user has currently installed it. This
5770 * function can be called by a device owner or by a delegate given the
5771 * {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005772 *
5773 * <p>Please note that setting this policy does not imply that specified apps will be
5774 * automatically pre-cached.</p>
5775 *
Edman Anjos52088e42017-01-13 22:26:17 +01005776 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
5777 * {@code null} if the caller is a keep uninstalled packages delegate.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005778 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005779 * @throws SecurityException if {@code admin} is not a device owner.
Edman Anjos52088e42017-01-13 22:26:17 +01005780 * @see #setDelegatedScopes
5781 * @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005782 * @hide
5783 */
Edman Anjos52088e42017-01-13 22:26:17 +01005784 public void setKeepUninstalledPackages(@Nullable ComponentName admin,
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005785 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005786 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005787 if (mService != null) {
5788 try {
Edman Anjos52088e42017-01-13 22:26:17 +01005789 mService.setKeepUninstalledPackages(admin, mContext.getPackageName(), packageNames);
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005790 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005791 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08005792 }
5793 }
5794 }
5795
5796 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04005797 * Called by a device owner to create a user with the specified name. The UserHandle returned
5798 * by this method should not be persisted as user handles are recycled as users are removed and
5799 * created. If you need to persist an identifier for this user, use
5800 * {@link UserManager#getSerialNumberForUser}.
5801 *
5802 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5803 * @param name the user's name
5804 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07005805 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5806 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01005807 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005808 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01005809 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04005810 */
Kenny Guy14f48e52015-06-29 15:12:36 +01005811 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07005812 public @Nullable UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04005813 return null;
5814 }
5815
5816 /**
Jason Monk03978a42014-06-10 15:05:30 -04005817 * Called by a device owner to create a user with the specified name. The UserHandle returned
5818 * by this method should not be persisted as user handles are recycled as users are removed and
5819 * created. If you need to persist an identifier for this user, use
5820 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
5821 * immediately.
5822 *
5823 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
5824 * as registered as an active admin on the new user. The profile owner package will be
5825 * installed on the new user if it already is installed on the device.
5826 *
5827 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
5828 * profileOwnerComponent when onEnable is called.
5829 *
5830 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5831 * @param name the user's name
5832 * @param ownerName the human readable name of the organisation associated with this DPM.
5833 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
5834 * the user.
5835 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
5836 * on the new user.
5837 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07005838 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5839 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01005840 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005841 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01005842 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04005843 */
Kenny Guy14f48e52015-06-29 15:12:36 +01005844 @Deprecated
Makoto Onuki408e8e42016-10-25 12:10:27 -07005845 public @Nullable UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
Robin Lee25e26452015-06-02 09:56:29 -07005846 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04005847 return null;
5848 }
5849
5850 /**
phweissa92e1212016-01-25 17:14:10 +01005851 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01005852 */
5853 public static final int SKIP_SETUP_WIZARD = 0x0001;
5854
5855 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01005856 * Flag used by {@link #createAndManageUser} to specify that the user should be created
5857 * ephemeral.
5858 * @hide
5859 */
5860 public static final int MAKE_USER_EPHEMERAL = 0x0002;
5861
5862 /**
phweissa92e1212016-01-25 17:14:10 +01005863 * Called by a device owner to create a user with the specified name and a given component of
5864 * the calling package as profile owner. The UserHandle returned by this method should not be
5865 * persisted as user handles are recycled as users are removed and created. If you need to
5866 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
5867 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005868 * <p>
5869 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
5870 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
5871 * be registered as an active admin on the new user. The profile owner package will be installed
5872 * on the new user.
5873 * <p>
5874 * If the adminExtras are not null, they will be stored on the device until the user is started
5875 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01005876 *
5877 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5878 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01005879 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005880 * same package as admin, otherwise no user is created and an
5881 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01005882 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005883 * user.
phweissa92e1212016-01-25 17:14:10 +01005884 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01005885 * @see UserHandle
5886 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
5887 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005888 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01005889 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07005890 public @Nullable UserHandle createAndManageUser(@NonNull ComponentName admin,
5891 @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01005892 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
5893 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005894 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01005895 try {
phweissa92e1212016-01-25 17:14:10 +01005896 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01005897 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005898 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01005899 }
phweiss343fb332016-01-25 14:48:59 +01005900 }
5901
5902 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005903 * Called by a device owner to remove a user and all associated data. The primary user can not
5904 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04005905 *
5906 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5907 * @param userHandle the user to remove.
5908 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005909 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04005910 */
Robin Lee25e26452015-06-02 09:56:29 -07005911 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005912 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04005913 try {
5914 return mService.removeUser(admin, userHandle);
5915 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005916 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04005917 }
5918 }
5919
5920 /**
Jason Monk582d9112014-07-09 19:57:08 -04005921 * Called by a device owner to switch the specified user to the foreground.
5922 *
5923 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5924 * @param userHandle the user to switch to; null will switch to primary.
5925 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005926 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04005927 * @see Intent#ACTION_USER_FOREGROUND
5928 */
Robin Lee25e26452015-06-02 09:56:29 -07005929 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005930 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04005931 try {
5932 return mService.switchUser(admin, userHandle);
5933 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005934 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04005935 }
5936 }
5937
5938 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00005939 * Retrieves the application restrictions for a given target application running in the calling
5940 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005941 * <p>
5942 * 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 +01005943 * application restrictions via {@link #setDelegatedScopes} with the
5944 * {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01005945 *
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005946 * <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
5947 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00005948 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005949 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01005950 * @param packageName The name of the package to fetch restricted settings of.
5951 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005952 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
5953 * {@link Bundle} if no restrictions have been set.
5954 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosf9946772016-11-28 16:35:15 +01005955 * @see #setDelegatedScopes
5956 * @see #DELEGATION_APP_RESTRICTIONS
Robin Lee66e5d962014-04-09 16:44:21 +01005957 */
Fyodor Kupolov4e9af062016-07-18 16:59:11 -07005958 @WorkerThread
Makoto Onuki408e8e42016-10-25 12:10:27 -07005959 public @NonNull Bundle getApplicationRestrictions(
5960 @Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005961 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01005962 if (mService != null) {
5963 try {
Edman Anjosf9946772016-11-28 16:35:15 +01005964 return mService.getApplicationRestrictions(admin, mContext.getPackageName(),
5965 packageName);
Robin Lee66e5d962014-04-09 16:44:21 +01005966 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005967 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01005968 }
5969 }
5970 return null;
5971 }
Amith Yamasanibe465322014-04-24 13:45:17 -07005972
5973 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005974 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005975 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005976 * The calling device admin must be a profile or device owner; if it is not, a security
5977 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005978 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005979 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5980 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5981 * for the list of keys.
5982 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005983 */
Robin Lee25e26452015-06-02 09:56:29 -07005984 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005985 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005986 if (mService != null) {
5987 try {
5988 mService.setUserRestriction(admin, key, true);
5989 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005990 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005991 }
5992 }
5993 }
5994
5995 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005996 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005997 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005998 * The calling device admin must be a profile or device owner; if it is not, a security
5999 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07006000 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006001 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6002 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
6003 * for the list of keys.
6004 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07006005 */
Robin Lee25e26452015-06-02 09:56:29 -07006006 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006007 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07006008 if (mService != null) {
6009 try {
6010 mService.setUserRestriction(admin, key, false);
6011 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006012 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07006013 }
6014 }
6015 }
Adam Connors010cfd42014-04-16 12:48:13 +01006016
6017 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006018 * Called by a profile or device owner to get user restrictions set with
6019 * {@link #addUserRestriction(ComponentName, String)}.
6020 * <p>
6021 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006022 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006023 * {@link UserManager#getUserRestrictions()}.
6024 *
6025 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006026 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006027 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006028 public @NonNull Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006029 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07006030 Bundle ret = null;
6031 if (mService != null) {
6032 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07006033 ret = mService.getUserRestrictions(admin);
6034 } catch (RemoteException e) {
6035 throw e.rethrowFromSystemServer();
6036 }
6037 }
6038 return ret == null ? new Bundle() : ret;
6039 }
6040
6041 /**
phweiss73145f42017-01-17 19:06:38 +01006042 * Called by any app to display a support dialog when a feature was disabled by an admin.
6043 * This returns an intent that can be used with {@link Context#startActivity(Intent)} to
6044 * display the dialog. It will tell the user that the feature indicated by {@code restriction}
6045 * was disabled by an admin, and include a link for more information. The default content of
6046 * the dialog can be changed by the restricting admin via
6047 * {@link #setShortSupportMessage(ComponentName, CharSequence)}. If the restriction is not
6048 * set (i.e. the feature is available), then the return value will be {@code null}.
6049 * @param restriction Indicates for which feature the dialog should be displayed. Can be a
6050 * user restriction from {@link UserManager}, e.g.
6051 * {@link UserManager#DISALLOW_ADJUST_VOLUME}, or one of the constants
6052 * {@link #POLICY_DISABLE_CAMERA} or {@link #POLICY_DISABLE_SCREEN_CAPTURE}.
6053 * @return Intent An intent to be used to start the dialog-activity if the restriction is
6054 * set by an admin, or null if the restriction does not exist or no admin set it.
6055 */
6056 public Intent createAdminSupportIntent(@NonNull String restriction) {
6057 throwIfParentInstance("createAdminSupportIntent");
6058 if (mService != null) {
6059 try {
6060 return mService.createAdminSupportIntent(restriction);
6061 } catch (RemoteException e) {
6062 throw e.rethrowFromSystemServer();
6063 }
6064 }
6065 return null;
6066 }
6067
6068 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006069 * Hide or unhide packages. When a package is hidden it is unavailable for use, but the data and
6070 * actual package file remain. This function can be called by a device owner, profile owner, or
6071 * by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
6072 * {@link #setDelegatedScopes}.
Julia Reynolds966881e2014-05-14 12:23:08 -04006073 *
Edman Anjos52088e42017-01-13 22:26:17 +01006074 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6075 * {@code null} if the caller is a package access delegate.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006076 * @param packageName The name of the package to hide or unhide.
6077 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006078 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006079 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006080 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006081 * @see #setDelegatedScopes
6082 * @see #DELEGATION_PACKAGE_ACCESS
Julia Reynolds966881e2014-05-14 12:23:08 -04006083 */
Robin Lee25e26452015-06-02 09:56:29 -07006084 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006085 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006086 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04006087 if (mService != null) {
6088 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006089 return mService.setApplicationHidden(admin, mContext.getPackageName(), packageName,
6090 hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04006091 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006092 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04006093 }
6094 }
6095 return false;
6096 }
6097
6098 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006099 * Determine if a package is hidden. This function can be called by a device owner, profile
6100 * owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
6101 * {@link #setDelegatedScopes}.
Julia Reynolds966881e2014-05-14 12:23:08 -04006102 *
Edman Anjos52088e42017-01-13 22:26:17 +01006103 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6104 * {@code null} if the caller is a package access delegate.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07006105 * @param packageName The name of the package to retrieve the hidden status of.
6106 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006107 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006108 * @see #setDelegatedScopes
6109 * @see #DELEGATION_PACKAGE_ACCESS
Julia Reynolds966881e2014-05-14 12:23:08 -04006110 */
Robin Lee25e26452015-06-02 09:56:29 -07006111 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006112 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04006113 if (mService != null) {
6114 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006115 return mService.isApplicationHidden(admin, mContext.getPackageName(), packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04006116 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006117 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04006118 }
6119 }
6120 return false;
6121 }
6122
6123 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006124 * Re-enable a system app that was disabled by default when the user was initialized. This
6125 * function can be called by a device owner, profile owner, or by a delegate given the
6126 * {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}.
Adam Connors655be2a2014-07-14 09:01:25 +00006127 *
Edman Anjos52088e42017-01-13 22:26:17 +01006128 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6129 * {@code null} if the caller is an enable system app delegate.
Makoto Onuki32b30572015-12-11 14:29:51 -08006130 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006131 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006132 * @see #setDelegatedScopes
6133 * @see #DELEGATION_PACKAGE_ACCESS
Adam Connors655be2a2014-07-14 09:01:25 +00006134 */
Robin Lee25e26452015-06-02 09:56:29 -07006135 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006136 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00006137 if (mService != null) {
6138 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006139 mService.enableSystemApp(admin, mContext.getPackageName(), packageName);
Adam Connors655be2a2014-07-14 09:01:25 +00006140 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006141 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00006142 }
6143 }
6144 }
6145
6146 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006147 * Re-enable system apps by intent that were disabled by default when the user was initialized.
6148 * This function can be called by a device owner, profile owner, or by a delegate given the
6149 * {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}.
Adam Connors655be2a2014-07-14 09:01:25 +00006150 *
Edman Anjos52088e42017-01-13 22:26:17 +01006151 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6152 * {@code null} if the caller is an enable system app delegate.
Adam Connors655be2a2014-07-14 09:01:25 +00006153 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006154 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00006155 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006156 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjos52088e42017-01-13 22:26:17 +01006157 * @see #setDelegatedScopes
6158 * @see #DELEGATION_PACKAGE_ACCESS
Adam Connors655be2a2014-07-14 09:01:25 +00006159 */
Robin Lee25e26452015-06-02 09:56:29 -07006160 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006161 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00006162 if (mService != null) {
6163 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006164 return mService.enableSystemAppWithIntent(admin, mContext.getPackageName(), intent);
Adam Connors655be2a2014-07-14 09:01:25 +00006165 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006166 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00006167 }
6168 }
6169 return 0;
6170 }
6171
6172 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00006173 * Called by a device owner or profile owner to disable account management for a specific type
6174 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006175 * <p>
6176 * The calling device admin must be a device owner or profile owner. If it is not, a security
6177 * exception will be thrown.
6178 * <p>
6179 * When account management is disabled for an account type, adding or removing an account of
6180 * that type will not be possible.
6181 * <p>
6182 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00006183 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
6184 * management for a specific type is disabled.
6185 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01006186 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6187 * @param accountType For which account management is disabled or enabled.
6188 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006189 * enabled (false).
6190 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01006191 */
Robin Lee25e26452015-06-02 09:56:29 -07006192 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01006193 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006194 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01006195 if (mService != null) {
6196 try {
6197 mService.setAccountManagementDisabled(admin, accountType, disabled);
6198 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006199 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01006200 }
6201 }
6202 }
6203
6204 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006205 * Gets the array of accounts for which account management is disabled by the profile owner.
6206 *
6207 * <p> Account management can be disabled/enabled by calling
6208 * {@link #setAccountManagementDisabled}.
6209 *
6210 * @return a list of account types for which account management has been disabled.
6211 *
6212 * @see #setAccountManagementDisabled
6213 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006214 public @Nullable String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006215 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07006216 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01006217 }
6218
6219 /**
6220 * @see #getAccountTypesWithManagementDisabled()
6221 * @hide
6222 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006223 public @Nullable String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006224 if (mService != null) {
6225 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01006226 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006227 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006228 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01006229 }
6230 }
6231
6232 return null;
6233 }
justinzhang511e0d82014-03-24 16:09:24 -04006234
6235 /**
Jason Monkd7b86212014-06-16 13:15:38 -04006236 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006237 * <p>
Esteban Talaverabdcada92017-02-01 14:20:06 +00006238 * Any packages that share uid with an allowed package will also be allowed to activate lock
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006239 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
Esteban Talaverabdcada92017-02-01 14:20:06 +00006240 * package list results in locked tasks belonging to those packages to be finished.
6241 * <p>
6242 * This function can only be called by the device owner or by a profile owner of a user/profile
6243 * that is affiliated with the device owner user. See {@link #setAffiliationIds}. Any packages
6244 * set via this method will be cleared if the user becomes unaffiliated.
Jason Monkd7b86212014-06-16 13:15:38 -04006245 *
Jason Monkd7b86212014-06-16 13:15:38 -04006246 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04006247 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Esteban Talaverabdcada92017-02-01 14:20:06 +00006248 * @throws SecurityException if {@code admin} is not the device owner, or the profile owner of
6249 * an affiliated user or profile.
Jason Monkd7b86212014-06-16 13:15:38 -04006250 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00006251 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
6252 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04006253 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04006254 */
Esteban Talaverabdcada92017-02-01 14:20:06 +00006255 public void setLockTaskPackages(@NonNull ComponentName admin, @NonNull String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04006256 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006257 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04006258 if (mService != null) {
6259 try {
Jason Monk48aacba2014-08-13 16:29:08 -04006260 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04006261 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006262 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04006263 }
6264 }
6265 }
6266
6267 /**
Esteban Talaverabdcada92017-02-01 14:20:06 +00006268 * Returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04006269 *
Esteban Talaverabdcada92017-02-01 14:20:06 +00006270 * @throws SecurityException if {@code admin} is not the device owner, or the profile owner of
6271 * an affiliated user or profile.
6272 * @see #setLockTaskPackages
justinzhang511e0d82014-03-24 16:09:24 -04006273 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006274 public @NonNull String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006275 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04006276 if (mService != null) {
6277 try {
Jason Monk48aacba2014-08-13 16:29:08 -04006278 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04006279 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006280 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04006281 }
6282 }
Esteban Talaverabdcada92017-02-01 14:20:06 +00006283 return new String[0];
justinzhang511e0d82014-03-24 16:09:24 -04006284 }
6285
6286 /**
6287 * This function lets the caller know whether the given component is allowed to start the
6288 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04006289 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04006290 */
Jason Monkd7b86212014-06-16 13:15:38 -04006291 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006292 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04006293 if (mService != null) {
6294 try {
Jason Monkd7b86212014-06-16 13:15:38 -04006295 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04006296 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006297 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04006298 }
6299 }
6300 return false;
6301 }
Julia Reynoldsda551652014-05-14 17:15:16 -04006302
6303 /**
6304 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
6305 * 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 -07006306 * <p>
6307 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006308 * <ul>
6309 * <li>{@link Settings.Global#ADB_ENABLED}</li>
6310 * <li>{@link Settings.Global#AUTO_TIME}</li>
6311 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006312 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006313 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006314 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006315 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
6316 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
6317 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
6318 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
6319 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006320 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006321 * <p>
6322 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006323 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006324 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
6325 * {@link android.bluetooth.BluetoothAdapter#enable()} and
6326 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006327 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006328 * <li>{@link Settings.Global#MODE_RINGER}. Use
6329 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006330 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006331 * <li>{@link Settings.Global#WIFI_ON}. Use
6332 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01006333 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04006334 *
6335 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6336 * @param setting The name of the setting to update.
6337 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006338 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04006339 */
Robin Lee25e26452015-06-02 09:56:29 -07006340 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006341 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04006342 if (mService != null) {
6343 try {
6344 mService.setGlobalSetting(admin, setting, value);
6345 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006346 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04006347 }
6348 }
6349 }
6350
6351 /**
6352 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
6353 * that the value of the setting is in the correct form for the setting type should be performed
6354 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006355 * <p>
6356 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04006357 * <ul>
6358 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
6359 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
6360 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006361 * <p>
6362 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04006363 * <ul>
6364 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
6365 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006366 *
Suprabh Shukla0b1356f2017-02-21 14:33:50 -08006367 * <strong>Note: Starting from Android O, apps should no longer call this method with the
6368 * setting {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS}, which is
6369 * deprecated. Instead, device owners or profile owners should use the restriction
6370 * {@link UserManager#DISALLOW_INSTALL_UNKNOWN_SOURCES}.
6371 * If any app targeting {@link android.os.Build.VERSION_CODES#O} or higher calls this method
6372 * with {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS},
6373 * an {@link UnsupportedOperationException} is thrown.
6374 * </strong>
6375 *
Julia Reynoldsda551652014-05-14 17:15:16 -04006376 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6377 * @param setting The name of the setting to update.
6378 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006379 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04006380 */
Robin Lee25e26452015-06-02 09:56:29 -07006381 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006382 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04006383 if (mService != null) {
6384 try {
6385 mService.setSecureSetting(admin, setting, value);
6386 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006387 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04006388 }
6389 }
6390 }
6391
Amith Yamasanif20d6402014-05-24 15:34:37 -07006392 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006393 * Designates a specific service component as the provider for making permission requests of a
6394 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07006395 * <p/>
6396 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006397 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07006398 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07006399 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006400 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
6401 * provider previously assigned.
6402 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07006403 */
Robin Lee25e26452015-06-02 09:56:29 -07006404 public void setRestrictionsProvider(@NonNull ComponentName admin,
6405 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006406 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07006407 if (mService != null) {
6408 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07006409 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07006410 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006411 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07006412 }
6413 }
6414 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04006415
6416 /**
6417 * Called by profile or device owners to set the master volume mute on or off.
Nicolas Prevotaef3ce22016-09-22 12:00:25 +01006418 * This has no effect when set on a managed profile.
Julia Reynolds4a21b252014-06-04 11:11:43 -04006419 *
6420 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6421 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006422 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04006423 */
Robin Lee25e26452015-06-02 09:56:29 -07006424 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006425 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04006426 if (mService != null) {
6427 try {
6428 mService.setMasterVolumeMuted(admin, on);
6429 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006430 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04006431 }
6432 }
6433 }
6434
6435 /**
6436 * Called by profile or device owners to check whether the master volume mute is on or off.
6437 *
6438 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6439 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006440 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04006441 */
Robin Lee25e26452015-06-02 09:56:29 -07006442 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006443 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04006444 if (mService != null) {
6445 try {
6446 return mService.isMasterVolumeMuted(admin);
6447 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006448 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04006449 }
6450 }
6451 return false;
6452 }
Kenny Guyc13053b2014-05-29 14:17:17 +01006453
6454 /**
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006455 * Change whether a user can uninstall a package. This function can be called by a device owner,
6456 * profile owner, or by a delegate given the {@link #DELEGATION_BLOCK_UNINSTALL} scope via
6457 * {@link #setDelegatedScopes}.
Kenny Guyc13053b2014-05-29 14:17:17 +01006458 *
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006459 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
6460 * {@code null} if the caller is a block uninstall delegate.
Kenny Guyc13053b2014-05-29 14:17:17 +01006461 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01006462 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006463 * @throws SecurityException if {@code admin} is not a device or profile owner.
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006464 * @see #setDelegatedScopes
6465 * @see #DELEGATION_BLOCK_UNINSTALL
Kenny Guyc13053b2014-05-29 14:17:17 +01006466 */
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006467 public void setUninstallBlocked(@Nullable ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01006468 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006469 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01006470 if (mService != null) {
6471 try {
Edman Anjosa5f2fb12016-12-19 11:25:54 -08006472 mService.setUninstallBlocked(admin, mContext.getPackageName(), packageName,
6473 uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01006474 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006475 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01006476 }
6477 }
6478 }
6479
6480 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08006481 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00006482 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00006483 * <p>
6484 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006485 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
6486 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
6487 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01006488 *
Robin Lee25e26452015-06-02 09:56:29 -07006489 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006490 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01006491 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00006492 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006493 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01006494 */
Robin Lee25e26452015-06-02 09:56:29 -07006495 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006496 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01006497 if (mService != null) {
6498 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01006499 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01006500 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006501 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01006502 }
6503 }
6504 return false;
6505 }
Svetoslav976e8bd2014-07-16 15:12:03 -07006506
6507 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006508 * Called by the profile owner of a managed profile to enable widget providers from a given
6509 * package to be available in the parent profile. As a result the user will be able to add
6510 * widgets from the white-listed package running under the profile to a widget host which runs
6511 * under the parent profile, for example the home screen. Note that a package may have zero or
6512 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07006513 * <p>
6514 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07006515 *
6516 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6517 * @param packageName The package from which widget providers are white-listed.
6518 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006519 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07006520 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
6521 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
6522 */
Robin Lee25e26452015-06-02 09:56:29 -07006523 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006524 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07006525 if (mService != null) {
6526 try {
6527 return mService.addCrossProfileWidgetProvider(admin, packageName);
6528 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006529 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07006530 }
6531 }
6532 return false;
6533 }
6534
6535 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07006536 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006537 * package to be available in the parent profile. For this method to take effect the package
6538 * should have been added via
6539 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07006540 * <p>
6541 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07006542 *
6543 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006544 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07006545 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006546 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07006547 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
6548 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
6549 */
Esteban Talavera62399912016-01-11 15:37:55 +00006550 public boolean removeCrossProfileWidgetProvider(
6551 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006552 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07006553 if (mService != null) {
6554 try {
6555 return mService.removeCrossProfileWidgetProvider(admin, packageName);
6556 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006557 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07006558 }
6559 }
6560 return false;
6561 }
6562
6563 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07006564 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07006565 * available in the parent profile.
6566 *
6567 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6568 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07006569 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
6570 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006571 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07006572 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006573 public @NonNull List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006574 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07006575 if (mService != null) {
6576 try {
6577 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
6578 if (providers != null) {
6579 return providers;
6580 }
6581 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006582 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07006583 }
6584 }
6585 return Collections.emptyList();
6586 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006587
6588 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08006589 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006590 *
6591 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6592 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006593 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006594 */
Robin Lee25e26452015-06-02 09:56:29 -07006595 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006596 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006597 try {
6598 mService.setUserIcon(admin, icon);
6599 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006600 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05006601 }
6602 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04006603
6604 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01006605 * Called by device owners to set a local system update policy. When a new policy is set,
6606 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00006607 *
Robin Lee25e26452015-06-02 09:56:29 -07006608 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006609 * components in the device owner package can set system update policies and the most
6610 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07006611 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006612 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01006613 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00006614 */
Robin Lee25e26452015-06-02 09:56:29 -07006615 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006616 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00006617 if (mService != null) {
6618 try {
Robin Lee25e26452015-06-02 09:56:29 -07006619 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00006620 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006621 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00006622 }
6623 }
6624 }
6625
6626 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01006627 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00006628 *
Robin Lee25e26452015-06-02 09:56:29 -07006629 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00006630 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006631 public @Nullable SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006632 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00006633 if (mService != null) {
6634 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01006635 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00006636 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006637 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00006638 }
6639 }
6640 return null;
6641 }
Benjamin Franze36087e2015-04-07 16:40:34 +01006642
6643 /**
6644 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006645 * <p>
6646 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
6647 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
6648 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
6649 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01006650 *
6651 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01006652 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01006653 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006654 * place. {@code true} otherwise.
6655 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01006656 */
Robin Lee25e26452015-06-02 09:56:29 -07006657 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006658 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01006659 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01006660 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01006661 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006662 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01006663 }
6664 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00006665
6666 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01006667 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006668 * notifications, quick settings and other screen overlays that allow escaping from a single use
6669 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00006670 *
6671 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01006672 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006673 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
6674 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00006675 */
Robin Lee25e26452015-06-02 09:56:29 -07006676 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006677 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00006678 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01006679 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00006680 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006681 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00006682 }
6683 }
Rubin Xudc105cc2015-04-14 23:38:01 +01006684
6685 /**
Charles Hedea0c3b2017-01-13 10:04:12 +00006686 * Called by the system update service to notify device and profile owners of pending system
6687 * updates.
Rubin Xudc105cc2015-04-14 23:38:01 +01006688 *
Charles Hedea0c3b2017-01-13 10:04:12 +00006689 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
6690 * permission. This method should only be used when it is unknown whether the pending system
6691 * update is a security patch. Otherwise, use
6692 * {@link #notifyPendingSystemUpdate(long, boolean)}.
6693 *
6694 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()}
6695 * indicating when the current pending update was first available. {@code -1} if no
6696 * update is available.
6697 * @see #notifyPendingSystemUpdate(long, boolean)
Rubin Xudc105cc2015-04-14 23:38:01 +01006698 * @hide
6699 */
6700 @SystemApi
6701 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006702 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01006703 if (mService != null) {
6704 try {
Charles Hedea0c3b2017-01-13 10:04:12 +00006705 mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime));
6706 } catch (RemoteException re) {
6707 throw re.rethrowFromSystemServer();
6708 }
6709 }
6710 }
6711
6712 /**
6713 * Called by the system update service to notify device and profile owners of pending system
6714 * updates.
6715 *
6716 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
6717 * permission. This method should be used instead of {@link #notifyPendingSystemUpdate(long)}
6718 * when it is known whether the pending system update is a security patch.
6719 *
6720 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()}
6721 * indicating when the current pending update was first available. {@code -1} if no
6722 * update is available.
6723 * @param isSecurityPatch {@code true} if this system update is purely a security patch;
6724 * {@code false} if not.
6725 * @see #notifyPendingSystemUpdate(long)
6726 * @hide
6727 */
6728 @SystemApi
6729 public void notifyPendingSystemUpdate(long updateReceivedTime, boolean isSecurityPatch) {
6730 throwIfParentInstance("notifyPendingSystemUpdate");
6731 if (mService != null) {
6732 try {
6733 mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime,
6734 isSecurityPatch));
Rubin Xudc105cc2015-04-14 23:38:01 +01006735 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006736 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01006737 }
6738 }
6739 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04006740
6741 /**
Pavel Grafovd65799e2016-12-02 11:21:45 +00006742 * Called by device or profile owners to get information about a pending system update.
6743 *
6744 * @param admin Which profile or device owner this request is associated with.
6745 * @return Information about a pending system update or {@code null} if no update pending.
6746 * @throws SecurityException if {@code admin} is not a device or profile owner.
6747 * @see DeviceAdminReceiver#onSystemUpdatePending(Context, Intent, long)
6748 */
6749 public @Nullable SystemUpdateInfo getPendingSystemUpdate(@NonNull ComponentName admin) {
6750 throwIfParentInstance("getPendingSystemUpdate");
6751 try {
6752 return mService.getPendingSystemUpdate(admin);
6753 } catch (RemoteException re) {
6754 throw re.rethrowFromSystemServer();
6755 }
6756 }
6757
6758 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006759 * Set the default response for future runtime permission requests by applications. This
6760 * function can be called by a device owner, profile owner, or by a delegate given the
6761 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
6762 * The policy can allow for normal operation which prompts the user to grant a permission, or
6763 * can allow automatic granting or denying of runtime permission requests by an application.
6764 * This also applies to new permissions declared by app updates. When a permission is denied or
6765 * granted this way, the effect is equivalent to setting the permission * grant state via
6766 * {@link #setPermissionGrantState}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006767 * <p/>
6768 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07006769 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01006770 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07006771 * @param admin Which profile or device owner this request is associated with.
6772 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006773 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
6774 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01006775 * @see #setPermissionGrantState
Edman Anjos52088e42017-01-13 22:26:17 +01006776 * @see #setDelegatedScopes
6777 * @see #DELEGATION_PERMISSION_GRANT
Amith Yamasanid49489b2015-04-28 14:00:26 -07006778 */
Robin Lee25e26452015-06-02 09:56:29 -07006779 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006780 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07006781 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006782 mService.setPermissionPolicy(admin, mContext.getPackageName(), policy);
Amith Yamasanid49489b2015-04-28 14:00:26 -07006783 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006784 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07006785 }
6786 }
6787
6788 /**
6789 * Returns the current runtime permission policy set by the device or profile owner. The
6790 * default is {@link #PERMISSION_POLICY_PROMPT}.
Edman Anjos52088e42017-01-13 22:26:17 +01006791 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07006792 * @param admin Which profile or device owner this request is associated with.
6793 * @return the current policy for future permission requests.
6794 */
Esteban Talavera28b95702015-06-24 15:23:42 +01006795 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006796 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07006797 try {
6798 return mService.getPermissionPolicy(admin);
6799 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006800 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07006801 }
6802 }
6803
6804 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006805 * Sets the grant state of a runtime permission for a specific application. The state can be
6806 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
6807 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
6808 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
6809 * the permission is granted and the user cannot manage it through the UI. This might affect all
6810 * permissions in a group that the runtime permission belongs to. This method can only be called
Edman Anjos52088e42017-01-13 22:26:17 +01006811 * by a profile owner, device owner, or a delegate given the
6812 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006813 * <p/>
6814 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
6815 * the permission. It retains the previous grant, if any.
6816 * <p/>
6817 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07006818 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07006819 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07006820 * @param admin Which profile or device owner this request is associated with.
6821 * @param packageName The application to grant or revoke a permission to.
6822 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006823 * @param grantState The permission grant state which is one of
6824 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
6825 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07006826 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006827 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07006828 * @see #PERMISSION_GRANT_STATE_DENIED
6829 * @see #PERMISSION_GRANT_STATE_DEFAULT
6830 * @see #PERMISSION_GRANT_STATE_GRANTED
Edman Anjos52088e42017-01-13 22:26:17 +01006831 * @see #setDelegatedScopes
6832 * @see #DELEGATION_PERMISSION_GRANT
Amith Yamasanid49489b2015-04-28 14:00:26 -07006833 */
Robin Lee25e26452015-06-02 09:56:29 -07006834 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07006835 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006836 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07006837 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006838 return mService.setPermissionGrantState(admin, mContext.getPackageName(), packageName,
6839 permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07006840 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006841 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07006842 }
6843 }
Amith Yamasani184b3752015-05-22 13:00:51 -07006844
6845 /**
Edman Anjos52088e42017-01-13 22:26:17 +01006846 * Returns the current grant state of a runtime permission for a specific application. This
6847 * function can be called by a device owner, profile owner, or by a delegate given the
6848 * {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
Amith Yamasani184b3752015-05-22 13:00:51 -07006849 *
Edman Anjos52088e42017-01-13 22:26:17 +01006850 * @param admin Which profile or device owner this request is associated with, or {@code null}
6851 * if the caller is a permission grant delegate.
Amith Yamasani184b3752015-05-22 13:00:51 -07006852 * @param packageName The application to check the grant state for.
6853 * @param permission The permission to check for.
6854 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006855 * has not set a grant state, the return value is
6856 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
6857 * permission is currently granted for the package.
6858 * <p/>
6859 * If a grant state was set by the profile or device owner, then the return value will
6860 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
6861 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
6862 * currently denied or granted.
6863 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07006864 * @see #setPermissionGrantState(ComponentName, String, String, int)
6865 * @see PackageManager#checkPermission(String, String)
Edman Anjos52088e42017-01-13 22:26:17 +01006866 * @see #setDelegatedScopes
6867 * @see #DELEGATION_PERMISSION_GRANT
Amith Yamasani184b3752015-05-22 13:00:51 -07006868 */
Bartosz Fabianowski4b0624f2017-01-16 11:47:28 +01006869 public int getPermissionGrantState(@Nullable ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07006870 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006871 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07006872 try {
Edman Anjos52088e42017-01-13 22:26:17 +01006873 return mService.getPermissionGrantState(admin, mContext.getPackageName(), packageName,
6874 permission);
Amith Yamasani184b3752015-05-22 13:00:51 -07006875 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006876 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07006877 }
6878 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006879
6880 /**
Esteban Talavera01576862016-12-15 11:16:44 +00006881 * Returns whether it is possible for the caller to initiate provisioning of a managed profile
6882 * or device, setting itself as the device or profile owner.
6883 *
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006884 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
6885 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Esteban Talavera01576862016-12-15 11:16:44 +00006886 * @return whether provisioning a managed profile or device is possible.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006887 * @throws IllegalArgumentException if the supplied action is not valid.
6888 */
Esteban Talavera01576862016-12-15 11:16:44 +00006889 public boolean isProvisioningAllowed(@NonNull String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006890 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006891 try {
Esteban Talavera01576862016-12-15 11:16:44 +00006892 return mService.isProvisioningAllowed(action, mContext.getPackageName());
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006893 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006894 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00006895 }
6896 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006897
6898 /**
Esteban Talavera01576862016-12-15 11:16:44 +00006899 * Checks whether it is possible to initiate provisioning a managed device,
6900 * profile or user, setting the given package as owner.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00006901 *
6902 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
6903 * {@link #ACTION_PROVISION_MANAGED_PROFILE},
6904 * {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE},
6905 * {@link #ACTION_PROVISION_MANAGED_USER}
Esteban Talavera01576862016-12-15 11:16:44 +00006906 * @param packageName The package of the component that would be set as device, user, or profile
6907 * owner.
6908 * @return A {@link ProvisioningPreCondition} value indicating whether provisioning is allowed.
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00006909 * @hide
6910 */
Esteban Talavera01576862016-12-15 11:16:44 +00006911 public @ProvisioningPreCondition int checkProvisioningPreCondition(
6912 String action, @NonNull String packageName) {
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00006913 try {
Esteban Talavera01576862016-12-15 11:16:44 +00006914 return mService.checkProvisioningPreCondition(action, packageName);
Mahaver Chopra849fd6f2016-11-03 20:28:10 +00006915 } catch (RemoteException re) {
6916 throw re.rethrowFromSystemServer();
6917 }
6918 }
6919
6920 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006921 * Return if this user is a managed profile of another user. An admin can become the profile
6922 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01006923 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006924 * @param admin Which profile owner this request is associated with.
6925 * @return if this user is a managed profile of another user.
6926 */
6927 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006928 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006929 try {
6930 return mService.isManagedProfile(admin);
6931 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006932 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006933 }
6934 }
6935
6936 /**
6937 * @hide
6938 * Return if this user is a system-only user. An admin can manage a device from a system only
6939 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
6940 * @param admin Which device owner this request is associated with.
6941 * @return if this user is a system-only user.
6942 */
6943 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
6944 try {
6945 return mService.isSystemOnlyUser(admin);
6946 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006947 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00006948 }
6949 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006950
6951 /**
6952 * Called by device owner to get the MAC address of the Wi-Fi device.
6953 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08006954 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006955 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
6956 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
6957 * <p>
6958 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
6959 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006960 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07006961 public @Nullable String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006962 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006963 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08006964 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006965 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006966 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08006967 }
6968 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006969
6970 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00006971 * Called by device owner to reboot the device. If there is an ongoing call on the device,
6972 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006973 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00006974 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006975 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00006976 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006977 */
6978 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006979 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006980 try {
6981 mService.reboot(admin);
6982 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006983 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00006984 }
6985 }
Kenny Guy06de4e72015-12-22 12:07:39 +00006986
6987 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006988 * Called by a device admin to set the short support message. This will be displayed to the user
6989 * in settings screens where funtionality has been disabled by the admin. The message should be
6990 * limited to a short statement such as "This setting is disabled by your administrator. Contact
6991 * someone@example.com for support." If the message is longer than 200 characters it may be
6992 * truncated.
6993 * <p>
6994 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006995 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6996 * and set a new version of this string accordingly.
6997 *
Kenny Guy06de4e72015-12-22 12:07:39 +00006998 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00006999 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007000 * @param message Short message to be displayed to the user in settings or null to clear the
7001 * existing message.
7002 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007003 */
7004 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007005 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007006 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007007 if (mService != null) {
7008 try {
7009 mService.setShortSupportMessage(admin, message);
7010 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007011 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007012 }
7013 }
7014 }
7015
7016 /**
7017 * Called by a device admin to get the short support message.
7018 *
7019 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007020 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
7021 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007022 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007023 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007024 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007025 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007026 if (mService != null) {
7027 try {
7028 return mService.getShortSupportMessage(admin);
7029 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007030 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007031 }
7032 }
7033 return null;
7034 }
7035
7036 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007037 * Called by a device admin to set the long support message. This will be displayed to the user
7038 * in the device administators settings screen.
7039 * <p>
7040 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007041 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
7042 * and set a new version of this string accordingly.
7043 *
Kenny Guy06de4e72015-12-22 12:07:39 +00007044 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00007045 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007046 * @param message Long message to be displayed to the user in settings or null to clear the
7047 * existing message.
7048 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007049 */
7050 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007051 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007052 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007053 if (mService != null) {
7054 try {
7055 mService.setLongSupportMessage(admin, message);
7056 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007057 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007058 }
7059 }
7060 }
7061
7062 /**
7063 * Called by a device admin to get the long support message.
7064 *
7065 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007066 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
7067 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007068 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00007069 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007070 public @Nullable CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007071 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00007072 if (mService != null) {
7073 try {
7074 return mService.getLongSupportMessage(admin);
7075 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007076 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007077 }
7078 }
7079 return null;
7080 }
7081
7082 /**
7083 * Called by the system to get the short support message.
7084 *
7085 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7086 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007087 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00007088 *
7089 * @hide
7090 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007091 public @Nullable CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007092 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00007093 if (mService != null) {
7094 try {
7095 return mService.getShortSupportMessageForUser(admin, userHandle);
7096 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007097 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007098 }
7099 }
7100 return null;
7101 }
7102
7103
7104 /**
7105 * Called by the system to get the long support message.
7106 *
7107 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7108 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07007109 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00007110 *
7111 * @hide
7112 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007113 public @Nullable CharSequence getLongSupportMessageForUser(
7114 @NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00007115 if (mService != null) {
7116 try {
7117 return mService.getLongSupportMessageForUser(admin, userHandle);
7118 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007119 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00007120 }
7121 }
7122 return null;
7123 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007124
7125 /**
Esteban Talavera62399912016-01-11 15:37:55 +00007126 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
7127 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01007128 *
7129 * <p>The following methods are supported for the parent instance, all other methods will
7130 * throw a SecurityException when called on the parent instance:
7131 * <ul>
7132 * <li>{@link #getPasswordQuality}</li>
7133 * <li>{@link #setPasswordQuality}</li>
7134 * <li>{@link #getPasswordMinimumLength}</li>
7135 * <li>{@link #setPasswordMinimumLength}</li>
7136 * <li>{@link #getPasswordMinimumUpperCase}</li>
7137 * <li>{@link #setPasswordMinimumUpperCase}</li>
7138 * <li>{@link #getPasswordMinimumLowerCase}</li>
7139 * <li>{@link #setPasswordMinimumLowerCase}</li>
7140 * <li>{@link #getPasswordMinimumLetters}</li>
7141 * <li>{@link #setPasswordMinimumLetters}</li>
7142 * <li>{@link #getPasswordMinimumNumeric}</li>
7143 * <li>{@link #setPasswordMinimumNumeric}</li>
7144 * <li>{@link #getPasswordMinimumSymbols}</li>
7145 * <li>{@link #setPasswordMinimumSymbols}</li>
7146 * <li>{@link #getPasswordMinimumNonLetter}</li>
7147 * <li>{@link #setPasswordMinimumNonLetter}</li>
7148 * <li>{@link #getPasswordHistoryLength}</li>
7149 * <li>{@link #setPasswordHistoryLength}</li>
7150 * <li>{@link #getPasswordExpirationTimeout}</li>
7151 * <li>{@link #setPasswordExpirationTimeout}</li>
7152 * <li>{@link #getPasswordExpiration}</li>
Charles He8c760562016-10-25 16:36:53 +01007153 * <li>{@link #getPasswordMaximumLength}</li>
Benjamin Franz66b45f02016-04-05 19:12:39 +01007154 * <li>{@link #isActivePasswordSufficient}</li>
7155 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
7156 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
7157 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
7158 * <li>{@link #getMaximumTimeToLock}</li>
7159 * <li>{@link #setMaximumTimeToLock}</li>
7160 * <li>{@link #lockNow}</li>
7161 * <li>{@link #getKeyguardDisabledFeatures}</li>
7162 * <li>{@link #setKeyguardDisabledFeatures}</li>
7163 * <li>{@link #getTrustAgentConfiguration}</li>
7164 * <li>{@link #setTrustAgentConfiguration}</li>
Michal Karpinskia20d8bb2016-11-23 12:09:08 +00007165 * <li>{@link #getRequiredStrongAuthTimeout}</li>
7166 * <li>{@link #setRequiredStrongAuthTimeout}</li>
Benjamin Franz66b45f02016-04-05 19:12:39 +01007167 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007168 *
7169 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007170 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007171 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007172 public @NonNull DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007173 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007174 try {
7175 if (!mService.isManagedProfile(admin)) {
7176 throw new SecurityException("The current user does not have a parent profile.");
7177 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06007178 return new DevicePolicyManager(mContext, mService, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007179 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007180 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007181 }
7182 }
7183
7184 /**
Esteban Talaverad36dd152016-12-15 08:51:45 +00007185 * Called by device owner to control the security logging feature.
Michal Karpinski6235a942016-03-15 12:07:23 +00007186 *
7187 * <p> Security logs contain various information intended for security auditing purposes.
7188 * See {@link SecurityEvent} for details.
7189 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007190 * <p><strong>Note:</strong> The device owner won't be able to retrieve security logs if there
7191 * are unaffiliated secondary users or profiles on the device, regardless of whether the
7192 * feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for
7193 * all users to become affiliated. Therefore it's recommended that affiliation ids are set for
7194 * new users as soon as possible after provisioning via {@link #setAffiliationIds}.
Michal Karpinskib58e4962016-03-01 14:55:10 +00007195 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007196 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00007197 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007198 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00007199 * @see #retrieveSecurityLogs
7200 */
7201 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007202 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00007203 try {
7204 mService.setSecurityLoggingEnabled(admin, enabled);
7205 } catch (RemoteException re) {
7206 throw re.rethrowFromSystemServer();
7207 }
7208 }
7209
7210 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00007211 * Return whether security logging is enabled or not by the device owner.
7212 *
7213 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
7214 * thrown.
7215 *
7216 * @param admin Which device owner this request is associated with.
7217 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
7218 * @throws SecurityException if {@code admin} is not a device owner.
7219 */
Bartosz Fabianowski0ec00002017-03-24 14:22:24 +01007220 public boolean isSecurityLoggingEnabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007221 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007222 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00007223 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007224 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007225 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007226 }
7227 }
7228
7229 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00007230 * Called by device owner to retrieve all new security logging entries since the last call to
7231 * this API after device boots.
7232 *
7233 * <p> Access to the logs is rate limited and it will only return new logs after the device
7234 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
7235 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007236 * <p>If there is any other user or profile on the device, it must be affiliated with the
7237 * device owner. Otherwise a {@link SecurityException} will be thrown. See
7238 * {@link #setAffiliationIds}
Michal Karpinskib58e4962016-03-01 14:55:10 +00007239 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007240 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00007241 * @return the new batch of security logs which is a list of {@link SecurityEvent},
7242 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007243 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
7244 * profile or secondary user that is not affiliated with the device owner user.
7245 * @see DeviceAdminReceiver#onSecurityLogsAvailable
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007246 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007247 public @Nullable List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007248 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007249 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00007250 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007251 if (list != null) {
7252 return list.getList();
7253 } else {
7254 // Rate limit exceeded.
7255 return null;
7256 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007257 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007258 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00007259 }
7260 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00007261
7262 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00007263 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
7264 * profile.
7265 *
7266 * @hide
7267 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007268 public @NonNull DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00007269 mContext.checkSelfPermission(
7270 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
7271 if (!uInfo.isManagedProfile()) {
7272 throw new SecurityException("The user " + uInfo.id
7273 + " does not have a parent profile.");
7274 }
Jeff Sharkey49ca5292016-05-10 12:54:45 -06007275 return new DevicePolicyManager(mContext, mService, true);
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00007276 }
7277
7278 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007279 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007280 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01007281 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
7282 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
7283 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
7284 * about data corruption when parsing. </strong>
Esteban Talaverad36dd152016-12-15 08:51:45 +00007285 *
7286 * <p>If there is any other user or profile on the device, it must be affiliated with the
7287 * device owner. Otherwise a {@link SecurityException} will be thrown. See
7288 * {@link #setAffiliationIds}
Michal Karpinskib58e4962016-03-01 14:55:10 +00007289 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007290 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01007291 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
7292 * is not supported on the device.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007293 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
7294 * profile or secondary user that is not affiliated with the device owner user.
7295 * @see #retrieveSecurityLogs
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007296 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007297 public @Nullable List<SecurityEvent> retrievePreRebootSecurityLogs(
7298 @NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007299 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007300 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00007301 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01007302 if (list != null) {
7303 return list.getList();
7304 } else {
7305 return null;
7306 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007307 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007308 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00007309 }
7310 }
7311
7312 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007313 * Called by a profile owner of a managed profile to set the color used for customization. This
7314 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01007315 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007316 * <p>
7317 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00007318 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
7319 *
7320 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01007321 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007322 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00007323 */
7324 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007325 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00007326 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01007327 // always enforce alpha channel to have 100% opacity
7328 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00007329 mService.setOrganizationColor(admin, color);
7330 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007331 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00007332 }
7333 }
7334
7335 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007336 * @hide
7337 *
7338 * Sets the color used for customization.
7339 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01007340 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007341 * @param userId which user to set the color to.
7342 * @RequiresPermission(allOf = {
7343 * Manifest.permission.MANAGE_USERS,
7344 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
7345 */
7346 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
7347 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01007348 // always enforce alpha channel to have 100% opacity
7349 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007350 mService.setOrganizationColorForUser(color, userId);
7351 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007352 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00007353 }
7354 }
7355
7356 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00007357 * Called by a profile owner of a managed profile to retrieve the color used for customization.
7358 * This color is used as background color of the confirm credentials screen for that user.
7359 *
7360 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01007361 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007362 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00007363 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01007364 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007365 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00007366 try {
7367 return mService.getOrganizationColor(admin);
7368 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007369 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00007370 }
7371 }
7372
7373 /**
7374 * @hide
7375 * Retrieve the customization color for a given user.
7376 *
7377 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01007378 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00007379 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01007380 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00007381 try {
7382 return mService.getOrganizationColorForUser(userHandle);
7383 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007384 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00007385 }
7386 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007387
7388 /**
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007389 * Called by the device owner or profile owner to set the name of the organization under
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007390 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007391 * <p>
7392 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007393 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
7394 * and set a new version of this string accordingly.
7395 *
7396 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7397 * @param title The organization name or {@code null} to clear a previously set name.
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007398 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007399 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01007400 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007401 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007402 try {
7403 mService.setOrganizationName(admin, title);
7404 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007405 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007406 }
7407 }
7408
7409 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007410 * Called by a profile owner of a managed profile to retrieve the name of the organization under
7411 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007412 *
7413 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7414 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07007415 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007416 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007417 public @Nullable CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007418 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007419 try {
7420 return mService.getOrganizationName(admin);
7421 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007422 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007423 }
7424 }
7425
7426 /**
Bartosz Fabianowski365a3db2016-11-30 18:28:10 +01007427 * Called by the system to retrieve the name of the organization managing the device.
7428 *
7429 * @return The organization name or {@code null} if none is set.
7430 * @throws SecurityException if the caller is not the device owner, does not hold the
7431 * MANAGE_USERS permission and is not the system.
7432 *
7433 * @hide
7434 */
7435 @SystemApi
7436 @TestApi
7437 public @Nullable CharSequence getDeviceOwnerOrganizationName() {
7438 try {
7439 return mService.getDeviceOwnerOrganizationName();
7440 } catch (RemoteException re) {
7441 throw re.rethrowFromSystemServer();
7442 }
7443 }
7444
7445 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007446 * Retrieve the default title message used in the confirm credentials screen for a given user.
7447 *
7448 * @param userHandle The user id of the user we're interested in.
7449 * @return The organization name or {@code null} if none is set.
7450 *
7451 * @hide
7452 */
Makoto Onuki408e8e42016-10-25 12:10:27 -07007453 public @Nullable CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007454 try {
7455 return mService.getOrganizationNameForUser(userHandle);
7456 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007457 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00007458 }
7459 }
7460
7461 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00007462 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
7463 * return {@link #STATE_USER_UNMANAGED}
7464 * @hide
7465 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00007466 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00007467 @UserProvisioningState
7468 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007469 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00007470 if (mService != null) {
7471 try {
7472 return mService.getUserProvisioningState();
7473 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007474 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00007475 }
7476 }
7477 return STATE_USER_UNMANAGED;
7478 }
7479
7480 /**
7481 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
7482 *
7483 * @param state to store
7484 * @param userHandle for user
7485 * @hide
7486 */
7487 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
7488 if (mService != null) {
7489 try {
7490 mService.setUserProvisioningState(state, userHandle);
7491 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007492 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00007493 }
7494 }
7495 }
7496
7497 /**
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007498 * Indicates the entity that controls the device or profile owner. Two users/profiles are
7499 * affiliated if the set of ids set by their device or profile owners intersect.
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007500 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007501 * <p><strong>Note:</strong> Features that depend on user affiliation (such as security logging
7502 * or {@link #bindDeviceAdminServiceAsUser}) won't be available when a secondary user or profile
7503 * is created, until it becomes affiliated. Therefore it is recommended that the appropriate
7504 * affiliation ids are set by its profile owner as soon as possible after the user/profile is
7505 * created.
7506 *
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007507 * @param admin Which profile or device owner this request is associated with.
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007508 * @param ids A list of opaque non-empty affiliation ids. Duplicate elements will be ignored.
7509 *
7510 * @throws NullPointerException if {@code ids} is null or contains null elements.
7511 * @throws IllegalArgumentException if {@code ids} contains an empty string.
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007512 */
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007513 public void setAffiliationIds(@NonNull ComponentName admin, @NonNull List<String> ids) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007514 throwIfParentInstance("setAffiliationIds");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007515 try {
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007516 mService.setAffiliationIds(admin, ids);
7517 } catch (RemoteException e) {
7518 throw e.rethrowFromSystemServer();
7519 }
7520 }
7521
7522 /**
7523 * Returns the list of affiliation ids previously set via {@link #setAffiliationIds}, or an
7524 * empty list if none have been set.
7525 */
7526 public @NonNull List<String> getAffiliationIds(@NonNull ComponentName admin) {
7527 throwIfParentInstance("getAffiliationIds");
7528 try {
7529 return mService.getAffiliationIds(admin);
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007530 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007531 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007532 }
7533 }
7534
7535 /**
7536 * @hide
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007537 * Returns whether this user/profile is affiliated with the device.
7538 * <p>
7539 * By definition, the user that the device owner runs on is always affiliated with the device.
7540 * Any other user/profile is considered affiliated with the device if the set specified by its
7541 * profile owner via {@link #setAffiliationIds} intersects with the device owner's.
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007542 *
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007543 */
7544 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01007545 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007546 try {
Esteban Talaverac9bb3782016-11-11 15:41:14 +00007547 return mService.isAffiliatedUser();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007548 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007549 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01007550 }
7551 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08007552
7553 /**
7554 * @hide
7555 * Returns whether the uninstall for {@code packageName} for the current user is in queue
7556 * to be started
7557 * @param packageName the package to check for
7558 * @return whether the uninstall intent for {@code packageName} is pending
7559 */
7560 public boolean isUninstallInQueue(String packageName) {
7561 try {
7562 return mService.isUninstallInQueue(packageName);
7563 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007564 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08007565 }
7566 }
7567
7568 /**
7569 * @hide
7570 * @param packageName the package containing active DAs to be uninstalled
7571 */
7572 public void uninstallPackageWithActiveAdmins(String packageName) {
7573 try {
7574 mService.uninstallPackageWithActiveAdmins(packageName);
7575 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07007576 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08007577 }
7578 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01007579
Kenny Guy38dcca52016-04-19 13:09:18 +01007580 /**
7581 * @hide
7582 * Remove a test admin synchronously without sending it a broadcast about being removed.
7583 * If the admin is a profile owner or device owner it will still be removed.
7584 *
7585 * @param userHandle user id to remove the admin for.
7586 * @param admin The administration compononent to remove.
7587 * @throws SecurityException if the caller is not shell / root or the admin package
7588 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
7589 */
7590 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
7591 try {
7592 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
7593 } catch (RemoteException re) {
7594 throw re.rethrowFromSystemServer();
7595 }
7596 }
7597
Mahaver Chopra790d1982016-07-07 16:06:49 +01007598 /**
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007599 * Returns whether the device has been provisioned.
7600 *
7601 * <p>Not for use by third-party applications.
7602 *
Mahaver Chopra790d1982016-07-07 16:06:49 +01007603 * @hide
Mahaver Chopra790d1982016-07-07 16:06:49 +01007604 */
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007605 @SystemApi
Mahaver Chopra790d1982016-07-07 16:06:49 +01007606 public boolean isDeviceProvisioned() {
7607 try {
7608 return mService.isDeviceProvisioned();
7609 } catch (RemoteException re) {
7610 throw re.rethrowFromSystemServer();
7611 }
7612 }
7613
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007614 /**
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007615 * Writes that the provisioning configuration has been applied.
7616 *
7617 * <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS}
7618 * permission.
7619 *
7620 * <p>Not for use by third-party applications.
7621 *
7622 * @hide
7623 */
7624 @SystemApi
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007625 public void setDeviceProvisioningConfigApplied() {
7626 try {
7627 mService.setDeviceProvisioningConfigApplied();
7628 } catch (RemoteException re) {
7629 throw re.rethrowFromSystemServer();
7630 }
7631 }
7632
7633 /**
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007634 * Returns whether the provisioning configuration has been applied.
7635 *
7636 * <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS} permission.
7637 *
7638 * <p>Not for use by third-party applications.
7639 *
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007640 * @return whether the provisioning configuration has been applied.
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007641 *
7642 * @hide
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007643 */
Lenka Trochtova5291ee72016-11-28 16:38:23 +01007644 @SystemApi
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01007645 public boolean isDeviceProvisioningConfigApplied() {
7646 try {
7647 return mService.isDeviceProvisioningConfigApplied();
7648 } catch (RemoteException re) {
7649 throw re.rethrowFromSystemServer();
7650 }
7651 }
7652
Victor Chang9bfc65f2016-08-15 12:27:09 +01007653 /**
7654 * @hide
Victor Chang3577ed22016-08-25 18:49:26 +01007655 * Force update user setup completed status. This API has no effect on user build.
7656 * @throws {@link SecurityException} if the caller has no
Esteban Talavera01576862016-12-15 11:16:44 +00007657 * {@code android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS} or the caller is
7658 * not {@link UserHandle#SYSTEM_USER}
Victor Chang9bfc65f2016-08-15 12:27:09 +01007659 */
7660 public void forceUpdateUserSetupComplete() {
7661 try {
7662 mService.forceUpdateUserSetupComplete();
7663 } catch (RemoteException re) {
7664 throw re.rethrowFromSystemServer();
7665 }
7666 }
7667
Benjamin Franzbc33c822016-04-15 08:57:52 +01007668 private void throwIfParentInstance(String functionName) {
7669 if (mParentInstance) {
7670 throw new SecurityException(functionName + " cannot be called on the parent instance");
7671 }
7672 }
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007673
7674 /**
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007675 * Allows the device owner to enable or disable the backup service.
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007676 *
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007677 * <p> Backup service manages all backup and restore mechanisms on the device. Setting this to
7678 * false will prevent data from being backed up or restored.
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007679 *
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007680 * <p> Backup service is off by default when device owner is present.
7681 *
7682 * @throws SecurityException if {@code admin} is not a device owner.
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007683 */
7684 public void setBackupServiceEnabled(@NonNull ComponentName admin, boolean enabled) {
Esteban Talavera5b7f2d02017-02-17 09:45:24 +00007685 throwIfParentInstance("setBackupServiceEnabled");
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007686 try {
7687 mService.setBackupServiceEnabled(admin, enabled);
7688 } catch (RemoteException re) {
7689 throw re.rethrowFromSystemServer();
7690 }
7691 }
7692
7693 /**
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007694 * Return whether the backup service is enabled by the device owner.
7695 *
7696 * <p> Backup service manages all backup and restore mechanisms on the device.
7697 *
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007698 * @return {@code true} if backup service is enabled, {@code false} otherwise.
Michal Karpinskib71fedc2017-01-05 15:21:38 +00007699 * @see #setBackupServiceEnabled
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007700 */
7701 public boolean isBackupServiceEnabled(@NonNull ComponentName admin) {
Esteban Talavera5b7f2d02017-02-17 09:45:24 +00007702 throwIfParentInstance("isBackupServiceEnabled");
Vladislav Kuzkokova8202522016-08-18 19:01:27 +02007703 try {
7704 return mService.isBackupServiceEnabled(admin);
7705 } catch (RemoteException re) {
7706 throw re.rethrowFromSystemServer();
7707 }
7708 }
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007709
7710 /**
Esteban Talaverad36dd152016-12-15 08:51:45 +00007711 * Called by a device owner to control the network logging feature.
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007712 *
Robin Leea40a2fb2017-02-08 17:07:06 +00007713 * <p> Network logs contain DNS lookup and connect() library call events. The following library
7714 * functions are recorded while network logging is active:
7715 * <ul>
7716 * <li>{@code getaddrinfo()}</li>
7717 * <li>{@code gethostbyname()}</li>
7718 * <li>{@code connect()}</li>
7719 * </ul>
7720 *
7721 * <p> Network logging is a low-overhead tool for forensics but it is not guaranteed to use
7722 * full system call logging; event reporting is enabled by default for all processes but not
7723 * strongly enforced.
7724 * Events from applications using alternative implementations of libc, making direct kernel
7725 * calls, or deliberately obfuscating traffic may not be recorded.
7726 *
7727 * <p> Some common network events may not be reported. For example:
7728 * <ul>
7729 * <li>Applications may hardcode IP addresses to reduce the number of DNS lookups, or use
7730 * an alternative system for name resolution, and so avoid calling
7731 * {@code getaddrinfo()} or {@code gethostbyname}.</li>
7732 * <li>Applications may use datagram sockets for performance reasons, for example
7733 * for a game client. Calling {@code connect()} is unnecessary for this kind of
7734 * socket, so it will not trigger a network event.</li>
7735 * </ul>
7736 *
7737 * <p> It is possible to directly intercept layer 3 traffic leaving the device using an
7738 * always-on VPN service.
7739 * See {@link #setAlwaysOnVpnPackage(ComponentName, String, boolean)}
7740 * and {@link android.net.VpnService} for details.
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007741 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007742 * <p><strong>Note:</strong> The device owner won't be able to retrieve network logs if there
7743 * are unaffiliated secondary users or profiles on the device, regardless of whether the
7744 * feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for
7745 * all users to become affiliated. Therefore it's recommended that affiliation ids are set for
7746 * new users as soon as possible after provisioning via {@link #setAffiliationIds}.
7747 *
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007748 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7749 * @param enabled whether network logging should be enabled or not.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007750 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007751 * @see #retrieveNetworkLogs
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007752 */
7753 public void setNetworkLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
7754 throwIfParentInstance("setNetworkLoggingEnabled");
7755 try {
7756 mService.setNetworkLoggingEnabled(admin, enabled);
7757 } catch (RemoteException re) {
7758 throw re.rethrowFromSystemServer();
7759 }
7760 }
7761
7762 /**
7763 * Return whether network logging is enabled by a device owner.
7764 *
phweissa4e169e2016-11-24 16:20:57 +01007765 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Can only
7766 * be {@code null} if the caller has MANAGE_USERS permission.
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007767 * @return {@code true} if network logging is enabled by device owner, {@code false} otherwise.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007768 * @throws SecurityException if {@code admin} is not a device owner and caller has
phweissa4e169e2016-11-24 16:20:57 +01007769 * no MANAGE_USERS permission
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007770 */
phweissa4e169e2016-11-24 16:20:57 +01007771 public boolean isNetworkLoggingEnabled(@Nullable ComponentName admin) {
Michal Karpinskidd9bb4f2016-10-12 14:59:26 +01007772 throwIfParentInstance("isNetworkLoggingEnabled");
7773 try {
7774 return mService.isNetworkLoggingEnabled(admin);
7775 } catch (RemoteException re) {
7776 throw re.rethrowFromSystemServer();
7777 }
7778 }
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007779
7780 /**
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007781 * Called by device owner to retrieve the most recent batch of network logging events.
7782 * A device owner has to provide a batchToken provided as part of
7783 * {@link DeviceAdminReceiver#onNetworkLogsAvailable} callback. If the token doesn't match the
7784 * token of the most recent available batch of logs, {@code null} will be returned.
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007785 *
7786 * <p> {@link NetworkEvent} can be one of {@link DnsEvent} or {@link ConnectEvent}.
7787 *
7788 * <p> The list of network events is sorted chronologically, and contains at most 1200 events.
7789 *
7790 * <p> Access to the logs is rate limited and this method will only return a new batch of logs
7791 * after the device device owner has been notified via
7792 * {@link DeviceAdminReceiver#onNetworkLogsAvailable}.
7793 *
Esteban Talaverad36dd152016-12-15 08:51:45 +00007794 * <p>If a secondary user or profile is created, calling this method will throw a
7795 * {@link SecurityException} until all users become affiliated again. It will also no longer be
7796 * possible to retrieve the network logs batch with the most recent batchToken provided
7797 * by {@link DeviceAdminReceiver#onNetworkLogsAvailable}. See
7798 * {@link DevicePolicyManager#setAffiliationIds}.
7799 *
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007800 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007801 * @param batchToken A token of the batch to retrieve
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007802 * @return A new batch of network logs which is a list of {@link NetworkEvent}. Returns
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007803 * {@code null} if the batch represented by batchToken is no longer available or if
7804 * logging is disabled.
Esteban Talaverad36dd152016-12-15 08:51:45 +00007805 * @throws SecurityException if {@code admin} is not a device owner, or there is at least one
7806 * profile or secondary user that is not affiliated with the device owner user.
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007807 * @see DeviceAdminReceiver#onNetworkLogsAvailable
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007808 */
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007809 public @Nullable List<NetworkEvent> retrieveNetworkLogs(@NonNull ComponentName admin,
7810 long batchToken) {
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007811 throwIfParentInstance("retrieveNetworkLogs");
7812 try {
Michal Karpinskia9ff2062016-11-03 15:46:17 +00007813 return mService.retrieveNetworkLogs(admin, batchToken);
Michal Karpinskif77ee4f2016-10-12 16:40:06 +01007814 } catch (RemoteException re) {
7815 throw re.rethrowFromSystemServer();
7816 }
7817 }
Tony Mak46aabe52016-11-14 12:53:06 +00007818
7819 /**
Esteban Talavera2f897912017-01-26 10:30:48 +00007820 * Called by a device owner to bind to a service from a profile owner or vice versa.
7821 * See {@link #getBindDeviceAdminTargetUsers} for a definition of which
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007822 * device/profile owners are allowed to bind to services of another profile/device owner.
7823 * <p>
Tony Mak46aabe52016-11-14 12:53:06 +00007824 * The service must be unexported. Note that the {@link Context} used to obtain this
7825 * {@link DevicePolicyManager} instance via {@link Context#getSystemService(Class)} will be used
7826 * to bind to the {@link android.app.Service}.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007827 *
Tony Mak46aabe52016-11-14 12:53:06 +00007828 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
7829 * @param serviceIntent Identifies the service to connect to. The Intent must specify either an
7830 * explicit component name or a package name to match an
7831 * {@link IntentFilter} published by a service.
Tony Makbf9928d2016-12-22 11:02:45 +00007832 * @param conn Receives information as the service is started and stopped in main thread. This
7833 * must be a valid {@link ServiceConnection} object; it must not be {@code null}.
Tony Mak46aabe52016-11-14 12:53:06 +00007834 * @param flags Operation options for the binding operation. See
7835 * {@link Context#bindService(Intent, ServiceConnection, int)}.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007836 * @param targetUser Which user to bind to. Must be one of the users returned by
7837 * {@link #getBindDeviceAdminTargetUsers}, otherwise a {@link SecurityException} will
7838 * be thrown.
Tony Mak46aabe52016-11-14 12:53:06 +00007839 * @return If you have successfully bound to the service, {@code true} is returned;
7840 * {@code false} is returned if the connection is not made and you will not
7841 * receive the service object.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007842 *
Tony Mak46aabe52016-11-14 12:53:06 +00007843 * @see Context#bindService(Intent, ServiceConnection, int)
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007844 * @see #getBindDeviceAdminTargetUsers(ComponentName)
Tony Mak46aabe52016-11-14 12:53:06 +00007845 */
7846 public boolean bindDeviceAdminServiceAsUser(
7847 @NonNull ComponentName admin, Intent serviceIntent, @NonNull ServiceConnection conn,
7848 @Context.BindServiceFlags int flags, @NonNull UserHandle targetUser) {
7849 throwIfParentInstance("bindDeviceAdminServiceAsUser");
7850 // Keep this in sync with ContextImpl.bindServiceCommon.
7851 try {
Tony Makbf9928d2016-12-22 11:02:45 +00007852 final IServiceConnection sd = mContext.getServiceDispatcher(
7853 conn, mContext.getMainThreadHandler(), flags);
Tony Mak46aabe52016-11-14 12:53:06 +00007854 serviceIntent.prepareToLeaveProcess(mContext);
7855 return mService.bindDeviceAdminServiceAsUser(admin,
7856 mContext.getIApplicationThread(), mContext.getActivityToken(), serviceIntent,
7857 sd, flags, targetUser.getIdentifier());
7858 } catch (RemoteException re) {
7859 throw re.rethrowFromSystemServer();
7860 }
7861 }
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007862
7863 /**
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007864 * Returns the list of target users that the calling device or profile owner can use when
7865 * calling {@link #bindDeviceAdminServiceAsUser}.
7866 * <p>
Esteban Talavera2f897912017-01-26 10:30:48 +00007867 * A device owner can bind to a service from a profile owner and vice versa, provided that:
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007868 * <ul>
7869 * <li>Both belong to the same package name.
Esteban Talavera2f897912017-01-26 10:30:48 +00007870 * <li>Both users are affiliated. See {@link #setAffiliationIds}.
Esteban Talaverafc291bc2016-11-21 13:52:03 +00007871 * </ul>
7872 */
7873 public @NonNull List<UserHandle> getBindDeviceAdminTargetUsers(@NonNull ComponentName admin) {
7874 throwIfParentInstance("getBindDeviceAdminTargetUsers");
7875 try {
7876 return mService.getBindDeviceAdminTargetUsers(admin);
7877 } catch (RemoteException re) {
7878 throw re.rethrowFromSystemServer();
7879 }
7880 }
7881
7882 /**
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007883 * Called by the system to get the time at which the device owner last retrieved security
7884 * logging entries.
7885 *
7886 * @return the time at which the device owner most recently retrieved security logging entries,
7887 * in milliseconds since epoch; -1 if security logging entries were never retrieved.
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007888 * @throws SecurityException if the caller is not the device owner, does not hold the
7889 * MANAGE_USERS permission and is not the system.
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007890 *
7891 * @hide
7892 */
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007893 @TestApi
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007894 public long getLastSecurityLogRetrievalTime() {
7895 try {
7896 return mService.getLastSecurityLogRetrievalTime();
7897 } catch (RemoteException re) {
7898 throw re.rethrowFromSystemServer();
7899 }
7900 }
7901
7902 /**
7903 * Called by the system to get the time at which the device owner last requested a bug report.
7904 *
7905 * @return the time at which the device owner most recently requested a bug report, in
7906 * milliseconds since epoch; -1 if a bug report was never requested.
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007907 * @throws SecurityException if the caller is not the device owner, does not hold the
7908 * MANAGE_USERS permission and is not the system.
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007909 *
7910 * @hide
7911 */
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007912 @TestApi
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007913 public long getLastBugReportRequestTime() {
7914 try {
7915 return mService.getLastBugReportRequestTime();
7916 } catch (RemoteException re) {
7917 throw re.rethrowFromSystemServer();
7918 }
7919 }
7920
7921 /**
7922 * Called by the system to get the time at which the device owner last retrieved network logging
7923 * events.
7924 *
7925 * @return the time at which the device owner most recently retrieved network logging events, in
7926 * milliseconds since epoch; -1 if network logging events were never retrieved.
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007927 * @throws SecurityException if the caller is not the device owner, does not hold the
7928 * MANAGE_USERS permission and is not the system.
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007929 *
7930 * @hide
7931 */
Bartosz Fabianowski8d76e722016-11-25 12:36:20 +01007932 @TestApi
Bartosz Fabianowskib21b2412016-11-17 04:53:33 +01007933 public long getLastNetworkLogRetrievalTime() {
7934 try {
7935 return mService.getLastNetworkLogRetrievalTime();
7936 } catch (RemoteException re) {
7937 throw re.rethrowFromSystemServer();
7938 }
7939 }
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007940
7941 /**
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007942 * Called by the system to find out whether the current user's IME was set by the device/profile
7943 * owner or the user.
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007944 *
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007945 * @return {@code true} if the user's IME was set by the device or profile owner, {@code false}
7946 * otherwise.
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007947 * @throws SecurityException if the caller is not the device owner/profile owner.
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007948 *
7949 * @hide
7950 */
7951 @TestApi
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007952 public boolean isCurrentInputMethodSetByOwner() {
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007953 try {
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007954 return mService.isCurrentInputMethodSetByOwner();
Bartosz Fabianowskiaff5e9c2017-01-25 06:09:13 +01007955 } catch (RemoteException re) {
7956 throw re.rethrowFromSystemServer();
7957 }
7958 }
Bartosz Fabianowski05dc9f72017-02-22 23:41:14 +01007959
Bartosz Fabianowski05dc9f72017-02-22 23:41:14 +01007960 /**
7961 * Called by the system to get a list of CA certificates that were installed by the device or
7962 * profile owner.
7963 *
Bartosz Fabianowski172f7802017-03-06 12:07:57 +01007964 * <p> The caller must be the target user's device owner/profile Owner or hold the
Bartosz Fabianowski05dc9f72017-02-22 23:41:14 +01007965 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS_FULL} permission.
7966 *
7967 * @param user The user for whom to retrieve information.
7968 * @return list of aliases identifying CA certificates installed by the device or profile owner
7969 * @throws SecurityException if the caller does not have permission to retrieve information
7970 * about the given user's CA certificates.
7971 *
7972 * @hide
7973 */
7974 @TestApi
7975 public List<String> getOwnerInstalledCaCerts(@NonNull UserHandle user) {
7976 try {
7977 return mService.getOwnerInstalledCaCerts(user).getList();
7978 } catch (RemoteException re) {
7979 throw re.rethrowFromSystemServer();
7980 }
7981 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08007982}