The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2007 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 | |
| 17 | package android.app; |
| 18 | |
Tor Norbye | 672055e | 2015-04-23 17:30:56 -0700 | [diff] [blame] | 19 | import android.Manifest; |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 20 | import android.annotation.NonNull; |
| 21 | import android.annotation.Nullable; |
Tor Norbye | 672055e | 2015-04-23 17:30:56 -0700 | [diff] [blame] | 22 | import android.annotation.RequiresPermission; |
Adrian Roos | 4f3ba35 | 2017-12-14 15:12:40 +0100 | [diff] [blame] | 23 | import android.annotation.SystemApi; |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 24 | import android.annotation.SystemService; |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 25 | import android.annotation.UnsupportedAppUsage; |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 26 | import android.app.trust.ITrustManager; |
| 27 | import android.content.Context; |
Jim Miller | 66093a9 | 2014-08-13 14:47:47 -0700 | [diff] [blame] | 28 | import android.content.Intent; |
Nancy Zheng | 43f166d | 2016-11-18 18:15:09 -0800 | [diff] [blame] | 29 | import android.content.pm.PackageManager; |
Nancy Zheng | e256a18 | 2016-11-21 15:46:08 -0800 | [diff] [blame] | 30 | import android.content.pm.ResolveInfo; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 31 | import android.os.Binder; |
Mathew Inwood | 45d2c25 | 2018-09-14 12:35:36 +0100 | [diff] [blame] | 32 | import android.os.Build; |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 33 | import android.os.Handler; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 34 | import android.os.IBinder; |
Nancy Zheng | e256a18 | 2016-11-21 15:46:08 -0800 | [diff] [blame] | 35 | import android.os.RemoteException; |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 36 | import android.os.ServiceManager; |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 37 | import android.os.ServiceManager.ServiceNotFoundException; |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 38 | import android.os.UserHandle; |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 39 | import android.provider.Settings; |
| 40 | import android.service.persistentdata.IPersistentDataBlockService; |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 41 | import android.util.Log; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 42 | import android.view.IOnKeyguardExitResult; |
Nancy Zheng | e256a18 | 2016-11-21 15:46:08 -0800 | [diff] [blame] | 43 | import android.view.IWindowManager; |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 44 | import android.view.WindowManager.LayoutParams; |
Jeff Brown | 98365d7 | 2012-08-19 20:30:52 -0700 | [diff] [blame] | 45 | import android.view.WindowManagerGlobal; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 46 | |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 47 | import com.android.internal.policy.IKeyguardDismissCallback; |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 48 | import com.android.internal.widget.LockPatternUtils; |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 49 | |
Nancy Zheng | e256a18 | 2016-11-21 15:46:08 -0800 | [diff] [blame] | 50 | import java.util.List; |
| 51 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 52 | /** |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 53 | * Class that can be used to lock and unlock the keyboard. The |
Jean-Michel Trivi | 37fde0a | 2012-05-24 17:13:06 -0700 | [diff] [blame] | 54 | * actual class to control the keyboard locking is |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 55 | * {@link android.app.KeyguardManager.KeyguardLock}. |
| 56 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 57 | @SystemService(Context.KEYGUARD_SERVICE) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 58 | public class KeyguardManager { |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 59 | |
| 60 | private static final String TAG = "KeyguardManager"; |
| 61 | |
| 62 | private final Context mContext; |
| 63 | private final IWindowManager mWM; |
| 64 | private final IActivityManager mAm; |
| 65 | private final ITrustManager mTrustManager; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 66 | |
| 67 | /** |
Jim Miller | 66093a9 | 2014-08-13 14:47:47 -0700 | [diff] [blame] | 68 | * Intent used to prompt user for device credentials. |
| 69 | * @hide |
| 70 | */ |
| 71 | public static final String ACTION_CONFIRM_DEVICE_CREDENTIAL = |
| 72 | "android.app.action.CONFIRM_DEVICE_CREDENTIAL"; |
| 73 | |
| 74 | /** |
Clara Bayarri | b3987bd | 2015-11-18 16:39:34 -0800 | [diff] [blame] | 75 | * Intent used to prompt user for device credentials. |
| 76 | * @hide |
| 77 | */ |
| 78 | public static final String ACTION_CONFIRM_DEVICE_CREDENTIAL_WITH_USER = |
| 79 | "android.app.action.CONFIRM_DEVICE_CREDENTIAL_WITH_USER"; |
| 80 | |
| 81 | /** |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 82 | * Intent used to prompt user for factory reset credentials. |
| 83 | * @hide |
| 84 | */ |
| 85 | public static final String ACTION_CONFIRM_FRP_CREDENTIAL = |
| 86 | "android.app.action.CONFIRM_FRP_CREDENTIAL"; |
| 87 | |
| 88 | /** |
Jim Miller | 66093a9 | 2014-08-13 14:47:47 -0700 | [diff] [blame] | 89 | * A CharSequence dialog title to show to the user when used with a |
| 90 | * {@link #ACTION_CONFIRM_DEVICE_CREDENTIAL}. |
| 91 | * @hide |
| 92 | */ |
| 93 | public static final String EXTRA_TITLE = "android.app.extra.TITLE"; |
| 94 | |
| 95 | /** |
| 96 | * A CharSequence description to show to the user when used with |
| 97 | * {@link #ACTION_CONFIRM_DEVICE_CREDENTIAL}. |
| 98 | * @hide |
| 99 | */ |
| 100 | public static final String EXTRA_DESCRIPTION = "android.app.extra.DESCRIPTION"; |
| 101 | |
| 102 | /** |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 103 | * A CharSequence description to show to the user on the alternate button when used with |
| 104 | * {@link #ACTION_CONFIRM_FRP_CREDENTIAL}. |
| 105 | * @hide |
| 106 | */ |
| 107 | public static final String EXTRA_ALTERNATE_BUTTON_LABEL = |
| 108 | "android.app.extra.ALTERNATE_BUTTON_LABEL"; |
| 109 | |
| 110 | /** |
| 111 | * Result code returned by the activity started by |
| 112 | * {@link #createConfirmFactoryResetCredentialIntent} indicating that the user clicked the |
| 113 | * alternate button. |
| 114 | * |
| 115 | * @hide |
| 116 | */ |
| 117 | public static final int RESULT_ALTERNATE = 1; |
| 118 | |
| 119 | /** |
Jim Miller | 66093a9 | 2014-08-13 14:47:47 -0700 | [diff] [blame] | 120 | * Get an intent to prompt the user to confirm credentials (pin, pattern or password) |
| 121 | * for the current user of the device. The caller is expected to launch this activity using |
| 122 | * {@link android.app.Activity#startActivityForResult(Intent, int)} and check for |
| 123 | * {@link android.app.Activity#RESULT_OK} if the user successfully completes the challenge. |
| 124 | * |
| 125 | * @return the intent for launching the activity or null if no password is required. |
| 126 | **/ |
Jim Miller | bde3d18 | 2014-08-26 19:53:17 -0700 | [diff] [blame] | 127 | public Intent createConfirmDeviceCredentialIntent(CharSequence title, CharSequence description) { |
Clara Bayarri | b3987bd | 2015-11-18 16:39:34 -0800 | [diff] [blame] | 128 | if (!isDeviceSecure()) return null; |
Jim Miller | 66093a9 | 2014-08-13 14:47:47 -0700 | [diff] [blame] | 129 | Intent intent = new Intent(ACTION_CONFIRM_DEVICE_CREDENTIAL); |
| 130 | intent.putExtra(EXTRA_TITLE, title); |
| 131 | intent.putExtra(EXTRA_DESCRIPTION, description); |
Nancy Zheng | e256a18 | 2016-11-21 15:46:08 -0800 | [diff] [blame] | 132 | |
| 133 | // explicitly set the package for security |
| 134 | intent.setPackage(getSettingsPackageForIntent(intent)); |
Jim Miller | 66093a9 | 2014-08-13 14:47:47 -0700 | [diff] [blame] | 135 | return intent; |
| 136 | } |
| 137 | |
| 138 | /** |
Clara Bayarri | b3987bd | 2015-11-18 16:39:34 -0800 | [diff] [blame] | 139 | * Get an intent to prompt the user to confirm credentials (pin, pattern or password) |
| 140 | * for the given user. The caller is expected to launch this activity using |
| 141 | * {@link android.app.Activity#startActivityForResult(Intent, int)} and check for |
| 142 | * {@link android.app.Activity#RESULT_OK} if the user successfully completes the challenge. |
| 143 | * |
| 144 | * @return the intent for launching the activity or null if no password is required. |
| 145 | * |
| 146 | * @hide |
| 147 | */ |
| 148 | public Intent createConfirmDeviceCredentialIntent( |
| 149 | CharSequence title, CharSequence description, int userId) { |
| 150 | if (!isDeviceSecure(userId)) return null; |
| 151 | Intent intent = new Intent(ACTION_CONFIRM_DEVICE_CREDENTIAL_WITH_USER); |
| 152 | intent.putExtra(EXTRA_TITLE, title); |
| 153 | intent.putExtra(EXTRA_DESCRIPTION, description); |
| 154 | intent.putExtra(Intent.EXTRA_USER_ID, userId); |
Nancy Zheng | e256a18 | 2016-11-21 15:46:08 -0800 | [diff] [blame] | 155 | |
| 156 | // explicitly set the package for security |
| 157 | intent.setPackage(getSettingsPackageForIntent(intent)); |
| 158 | |
Clara Bayarri | b3987bd | 2015-11-18 16:39:34 -0800 | [diff] [blame] | 159 | return intent; |
| 160 | } |
| 161 | |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 162 | /** |
| 163 | * Get an intent to prompt the user to confirm credentials (pin, pattern or password) |
| 164 | * for the previous owner of the device. The caller is expected to launch this activity using |
| 165 | * {@link android.app.Activity#startActivityForResult(Intent, int)} and check for |
| 166 | * {@link android.app.Activity#RESULT_OK} if the user successfully completes the challenge. |
| 167 | * |
| 168 | * @param alternateButtonLabel if not empty, a button is provided with the given label. Upon |
| 169 | * clicking this button, the activity returns |
| 170 | * {@link #RESULT_ALTERNATE} |
| 171 | * |
Adrian Roos | b237594 | 2018-01-19 22:31:28 +0100 | [diff] [blame] | 172 | * @return the intent for launching the activity or null if the previous owner of the device |
| 173 | * did not set a credential. |
| 174 | * @throws UnsupportedOperationException if the device does not support factory reset |
| 175 | * credentials |
| 176 | * @throws IllegalStateException if the device has already been provisioned |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 177 | * @hide |
| 178 | */ |
Adrian Roos | 4f3ba35 | 2017-12-14 15:12:40 +0100 | [diff] [blame] | 179 | @SystemApi |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 180 | public Intent createConfirmFactoryResetCredentialIntent( |
| 181 | CharSequence title, CharSequence description, CharSequence alternateButtonLabel) { |
Adrian Roos | 2adc263 | 2017-09-05 17:01:42 +0200 | [diff] [blame] | 182 | if (!LockPatternUtils.frpCredentialEnabled(mContext)) { |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 183 | Log.w(TAG, "Factory reset credentials not supported."); |
Adrian Roos | b237594 | 2018-01-19 22:31:28 +0100 | [diff] [blame] | 184 | throw new UnsupportedOperationException("not supported on this device"); |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | // Cannot verify credential if the device is provisioned |
| 188 | if (Settings.Global.getInt(mContext.getContentResolver(), |
| 189 | Settings.Global.DEVICE_PROVISIONED, 0) != 0) { |
| 190 | Log.e(TAG, "Factory reset credential cannot be verified after provisioning."); |
Adrian Roos | b237594 | 2018-01-19 22:31:28 +0100 | [diff] [blame] | 191 | throw new IllegalStateException("must not be provisioned yet"); |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 192 | } |
| 193 | |
| 194 | // Make sure we have a credential |
| 195 | try { |
| 196 | IPersistentDataBlockService pdb = IPersistentDataBlockService.Stub.asInterface( |
| 197 | ServiceManager.getService(Context.PERSISTENT_DATA_BLOCK_SERVICE)); |
| 198 | if (pdb == null) { |
| 199 | Log.e(TAG, "No persistent data block service"); |
Adrian Roos | b237594 | 2018-01-19 22:31:28 +0100 | [diff] [blame] | 200 | throw new UnsupportedOperationException("not supported on this device"); |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 201 | } |
Adrian Roos | b237594 | 2018-01-19 22:31:28 +0100 | [diff] [blame] | 202 | // The following will throw an UnsupportedOperationException if the device does not |
| 203 | // support factory reset credentials (or something went wrong retrieving it). |
Adrian Roos | 7374d3a | 2017-03-31 14:14:53 -0700 | [diff] [blame] | 204 | if (!pdb.hasFrpCredentialHandle()) { |
| 205 | Log.i(TAG, "The persistent data block does not have a factory reset credential."); |
| 206 | return null; |
| 207 | } |
| 208 | } catch (RemoteException e) { |
| 209 | throw e.rethrowFromSystemServer(); |
| 210 | } |
| 211 | |
| 212 | Intent intent = new Intent(ACTION_CONFIRM_FRP_CREDENTIAL); |
| 213 | intent.putExtra(EXTRA_TITLE, title); |
| 214 | intent.putExtra(EXTRA_DESCRIPTION, description); |
| 215 | intent.putExtra(EXTRA_ALTERNATE_BUTTON_LABEL, alternateButtonLabel); |
| 216 | |
| 217 | // explicitly set the package for security |
| 218 | intent.setPackage(getSettingsPackageForIntent(intent)); |
| 219 | |
| 220 | return intent; |
| 221 | } |
| 222 | |
Nancy Zheng | e256a18 | 2016-11-21 15:46:08 -0800 | [diff] [blame] | 223 | private String getSettingsPackageForIntent(Intent intent) { |
| 224 | List<ResolveInfo> resolveInfos = mContext.getPackageManager() |
| 225 | .queryIntentActivities(intent, PackageManager.MATCH_SYSTEM_ONLY); |
| 226 | for (int i = 0; i < resolveInfos.size(); i++) { |
| 227 | return resolveInfos.get(i).activityInfo.packageName; |
| 228 | } |
| 229 | |
| 230 | return "com.android.settings"; |
| 231 | } |
| 232 | |
Clara Bayarri | b3987bd | 2015-11-18 16:39:34 -0800 | [diff] [blame] | 233 | /** |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 234 | * @deprecated Use {@link LayoutParams#FLAG_DISMISS_KEYGUARD} |
| 235 | * and/or {@link LayoutParams#FLAG_SHOW_WHEN_LOCKED} |
Dianne Hackborn | 9567a66 | 2011-04-19 18:44:03 -0700 | [diff] [blame] | 236 | * instead; this allows you to seamlessly hide the keyguard as your application |
| 237 | * moves in and out of the foreground and does not require that any special |
| 238 | * permissions be requested. |
| 239 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 240 | * Handle returned by {@link KeyguardManager#newKeyguardLock} that allows |
| 241 | * you to disable / reenable the keyguard. |
| 242 | */ |
Aurimas Liutikas | 514c5ef | 2016-05-24 15:22:55 -0700 | [diff] [blame] | 243 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 244 | public class KeyguardLock { |
Kenny Root | d7d2d43 | 2014-05-09 10:33:29 -0700 | [diff] [blame] | 245 | private final IBinder mToken = new Binder(); |
| 246 | private final String mTag; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 247 | |
| 248 | KeyguardLock(String tag) { |
| 249 | mTag = tag; |
| 250 | } |
| 251 | |
| 252 | /** |
| 253 | * Disable the keyguard from showing. If the keyguard is currently |
| 254 | * showing, hide it. The keyguard will be prevented from showing again |
| 255 | * until {@link #reenableKeyguard()} is called. |
| 256 | * |
| 257 | * A good place to call this is from {@link android.app.Activity#onResume()} |
| 258 | * |
Jim Miller | 66093a9 | 2014-08-13 14:47:47 -0700 | [diff] [blame] | 259 | * Note: This call has no effect while any {@link android.app.admin.DevicePolicyManager} |
Jim Miller | cb52cb5 | 2010-06-07 21:19:16 -0700 | [diff] [blame] | 260 | * is enabled that requires a password. |
Jim Miller | d6b5705 | 2010-06-07 17:52:42 -0700 | [diff] [blame] | 261 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 262 | * @see #reenableKeyguard() |
| 263 | */ |
Tor Norbye | 672055e | 2015-04-23 17:30:56 -0700 | [diff] [blame] | 264 | @RequiresPermission(Manifest.permission.DISABLE_KEYGUARD) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 265 | public void disableKeyguard() { |
| 266 | try { |
| 267 | mWM.disableKeyguard(mToken, mTag); |
| 268 | } catch (RemoteException ex) { |
| 269 | } |
| 270 | } |
| 271 | |
| 272 | /** |
| 273 | * Reenable the keyguard. The keyguard will reappear if the previous |
Jean-Michel Trivi | 37fde0a | 2012-05-24 17:13:06 -0700 | [diff] [blame] | 274 | * call to {@link #disableKeyguard()} caused it to be hidden. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 275 | * |
Jim Miller | d6b5705 | 2010-06-07 17:52:42 -0700 | [diff] [blame] | 276 | * A good place to call this is from {@link android.app.Activity#onPause()} |
| 277 | * |
Jim Miller | cb52cb5 | 2010-06-07 21:19:16 -0700 | [diff] [blame] | 278 | * Note: This call has no effect while any {@link android.app.admin.DevicePolicyManager} |
| 279 | * is enabled that requires a password. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 280 | * |
| 281 | * @see #disableKeyguard() |
| 282 | */ |
Tor Norbye | 672055e | 2015-04-23 17:30:56 -0700 | [diff] [blame] | 283 | @RequiresPermission(Manifest.permission.DISABLE_KEYGUARD) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 284 | public void reenableKeyguard() { |
| 285 | try { |
| 286 | mWM.reenableKeyguard(mToken); |
| 287 | } catch (RemoteException ex) { |
| 288 | } |
| 289 | } |
| 290 | } |
| 291 | |
| 292 | /** |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 293 | * @deprecated Use {@link KeyguardDismissCallback} |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 294 | * Callback passed to {@link KeyguardManager#exitKeyguardSecurely} to notify |
| 295 | * caller of result. |
| 296 | */ |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 297 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 298 | public interface OnKeyguardExitResult { |
| 299 | |
| 300 | /** |
| 301 | * @param success True if the user was able to authenticate, false if |
| 302 | * not. |
| 303 | */ |
| 304 | void onKeyguardExitResult(boolean success); |
| 305 | } |
| 306 | |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 307 | /** |
Jeff Sharkey | 67f9d50 | 2017-08-05 13:49:13 -0600 | [diff] [blame] | 308 | * Callback passed to |
| 309 | * {@link KeyguardManager#requestDismissKeyguard(Activity, KeyguardDismissCallback)} |
| 310 | * to notify caller of result. |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 311 | */ |
| 312 | public static abstract class KeyguardDismissCallback { |
| 313 | |
| 314 | /** |
| 315 | * Called when dismissing Keyguard is currently not feasible, i.e. when Keyguard is not |
| 316 | * available, not showing or when the activity requesting the Keyguard dismissal isn't |
| 317 | * showing or isn't showing behind Keyguard. |
| 318 | */ |
| 319 | public void onDismissError() { } |
| 320 | |
| 321 | /** |
| 322 | * Called when dismissing Keyguard has succeeded and the device is now unlocked. |
| 323 | */ |
| 324 | public void onDismissSucceeded() { } |
| 325 | |
| 326 | /** |
| 327 | * Called when dismissing Keyguard has been cancelled, i.e. when the user cancelled the |
| 328 | * operation or the bouncer was hidden for some other reason. |
| 329 | */ |
| 330 | public void onDismissCancelled() { } |
| 331 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 332 | |
Nancy Zheng | 40cd8e4 | 2016-11-21 12:58:16 -0800 | [diff] [blame] | 333 | KeyguardManager(Context context) throws ServiceNotFoundException { |
Nancy Zheng | 43f166d | 2016-11-18 18:15:09 -0800 | [diff] [blame] | 334 | mContext = context; |
Jeff Brown | 98365d7 | 2012-08-19 20:30:52 -0700 | [diff] [blame] | 335 | mWM = WindowManagerGlobal.getWindowManagerService(); |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 336 | mAm = ActivityManager.getService(); |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 337 | mTrustManager = ITrustManager.Stub.asInterface( |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 338 | ServiceManager.getServiceOrThrow(Context.TRUST_SERVICE)); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 339 | } |
| 340 | |
| 341 | /** |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 342 | * @deprecated Use {@link LayoutParams#FLAG_DISMISS_KEYGUARD} |
| 343 | * and/or {@link LayoutParams#FLAG_SHOW_WHEN_LOCKED} |
Dianne Hackborn | 9567a66 | 2011-04-19 18:44:03 -0700 | [diff] [blame] | 344 | * instead; this allows you to seamlessly hide the keyguard as your application |
| 345 | * moves in and out of the foreground and does not require that any special |
| 346 | * permissions be requested. |
| 347 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 348 | * Enables you to lock or unlock the keyboard. Get an instance of this class by |
Jim Miller | 66093a9 | 2014-08-13 14:47:47 -0700 | [diff] [blame] | 349 | * calling {@link android.content.Context#getSystemService(java.lang.String) Context.getSystemService()}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 350 | * This class is wrapped by {@link android.app.KeyguardManager KeyguardManager}. |
| 351 | * @param tag A tag that informally identifies who you are (for debugging who |
| 352 | * is disabling he keyguard). |
| 353 | * |
| 354 | * @return A {@link KeyguardLock} handle to use to disable and reenable the |
| 355 | * keyguard. |
| 356 | */ |
Dianne Hackborn | 9567a66 | 2011-04-19 18:44:03 -0700 | [diff] [blame] | 357 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 358 | public KeyguardLock newKeyguardLock(String tag) { |
| 359 | return new KeyguardLock(tag); |
| 360 | } |
| 361 | |
| 362 | /** |
Mike Lockwood | 520d8bc | 2011-02-18 13:23:13 -0500 | [diff] [blame] | 363 | * Return whether the keyguard is currently locked. |
| 364 | * |
Jean-Michel Trivi | 37fde0a | 2012-05-24 17:13:06 -0700 | [diff] [blame] | 365 | * @return true if keyguard is locked. |
Mike Lockwood | 520d8bc | 2011-02-18 13:23:13 -0500 | [diff] [blame] | 366 | */ |
| 367 | public boolean isKeyguardLocked() { |
| 368 | try { |
Mike Lockwood | 5053124 | 2011-02-26 11:23:49 -0500 | [diff] [blame] | 369 | return mWM.isKeyguardLocked(); |
Mike Lockwood | 520d8bc | 2011-02-18 13:23:13 -0500 | [diff] [blame] | 370 | } catch (RemoteException ex) { |
| 371 | return false; |
| 372 | } |
| 373 | } |
| 374 | |
| 375 | /** |
Adrian Roos | c39b4fc | 2015-04-28 15:48:00 -0700 | [diff] [blame] | 376 | * Return whether the keyguard is secured by a PIN, pattern or password or a SIM card |
| 377 | * is currently locked. |
Mike Lockwood | 520d8bc | 2011-02-18 13:23:13 -0500 | [diff] [blame] | 378 | * |
Adrian Roos | c39b4fc | 2015-04-28 15:48:00 -0700 | [diff] [blame] | 379 | * <p>See also {@link #isDeviceSecure()} which ignores SIM locked states. |
| 380 | * |
| 381 | * @return true if a PIN, pattern or password is set or a SIM card is locked. |
Mike Lockwood | 520d8bc | 2011-02-18 13:23:13 -0500 | [diff] [blame] | 382 | */ |
| 383 | public boolean isKeyguardSecure() { |
| 384 | try { |
| 385 | return mWM.isKeyguardSecure(); |
| 386 | } catch (RemoteException ex) { |
| 387 | return false; |
| 388 | } |
| 389 | } |
| 390 | |
| 391 | /** |
Siarhei Vishniakou | 5f13cf0 | 2017-10-12 16:50:06 -0700 | [diff] [blame] | 392 | * @deprecated Use {@link #isKeyguardLocked()} instead. |
| 393 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 394 | * If keyguard screen is showing or in restricted key input mode (i.e. in |
| 395 | * keyguard password emergency screen). When in such mode, certain keys, |
| 396 | * such as the Home key and the right soft keys, don't work. |
| 397 | * |
| 398 | * @return true if in keyguard restricted input mode. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 399 | */ |
| 400 | public boolean inKeyguardRestrictedInputMode() { |
Siarhei Vishniakou | 5f13cf0 | 2017-10-12 16:50:06 -0700 | [diff] [blame] | 401 | return isKeyguardLocked(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 402 | } |
| 403 | |
| 404 | /** |
Adrian Roos | 50bfeec | 2014-11-20 16:21:11 +0100 | [diff] [blame] | 405 | * Returns whether the device is currently locked and requires a PIN, pattern or |
| 406 | * password to unlock. |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 407 | * |
Adrian Roos | 50bfeec | 2014-11-20 16:21:11 +0100 | [diff] [blame] | 408 | * @return true if unlocking the device currently requires a PIN, pattern or |
| 409 | * password. |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 410 | */ |
Adrian Roos | 50bfeec | 2014-11-20 16:21:11 +0100 | [diff] [blame] | 411 | public boolean isDeviceLocked() { |
Jeff Sharkey | ad357d1 | 2018-02-02 13:25:31 -0700 | [diff] [blame] | 412 | return isDeviceLocked(mContext.getUserId()); |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 413 | } |
| 414 | |
| 415 | /** |
Adrian Roos | c39b4fc | 2015-04-28 15:48:00 -0700 | [diff] [blame] | 416 | * Per-user version of {@link #isDeviceLocked()}. |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 417 | * |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 418 | * @hide |
| 419 | */ |
Mathew Inwood | 45d2c25 | 2018-09-14 12:35:36 +0100 | [diff] [blame] | 420 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023) |
Adrian Roos | 50bfeec | 2014-11-20 16:21:11 +0100 | [diff] [blame] | 421 | public boolean isDeviceLocked(int userId) { |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 422 | try { |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 423 | return mTrustManager.isDeviceLocked(userId); |
Adrian Roos | bcd0765 | 2014-10-22 16:57:16 +0200 | [diff] [blame] | 424 | } catch (RemoteException e) { |
| 425 | return false; |
| 426 | } |
| 427 | } |
| 428 | |
| 429 | /** |
Adrian Roos | 8289368 | 2015-04-02 16:17:46 +0200 | [diff] [blame] | 430 | * Returns whether the device is secured with a PIN, pattern or |
| 431 | * password. |
| 432 | * |
Adrian Roos | c39b4fc | 2015-04-28 15:48:00 -0700 | [diff] [blame] | 433 | * <p>See also {@link #isKeyguardSecure} which treats SIM locked states as secure. |
| 434 | * |
Adrian Roos | 8289368 | 2015-04-02 16:17:46 +0200 | [diff] [blame] | 435 | * @return true if a PIN, pattern or password was set. |
| 436 | */ |
| 437 | public boolean isDeviceSecure() { |
Jeff Sharkey | ad357d1 | 2018-02-02 13:25:31 -0700 | [diff] [blame] | 438 | return isDeviceSecure(mContext.getUserId()); |
Adrian Roos | 8289368 | 2015-04-02 16:17:46 +0200 | [diff] [blame] | 439 | } |
| 440 | |
| 441 | /** |
Adrian Roos | c39b4fc | 2015-04-28 15:48:00 -0700 | [diff] [blame] | 442 | * Per-user version of {@link #isDeviceSecure()}. |
Adrian Roos | 8289368 | 2015-04-02 16:17:46 +0200 | [diff] [blame] | 443 | * |
Adrian Roos | 8289368 | 2015-04-02 16:17:46 +0200 | [diff] [blame] | 444 | * @hide |
| 445 | */ |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 446 | @UnsupportedAppUsage |
Adrian Roos | 8289368 | 2015-04-02 16:17:46 +0200 | [diff] [blame] | 447 | public boolean isDeviceSecure(int userId) { |
| 448 | try { |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 449 | return mTrustManager.isDeviceSecure(userId); |
Adrian Roos | 8289368 | 2015-04-02 16:17:46 +0200 | [diff] [blame] | 450 | } catch (RemoteException e) { |
| 451 | return false; |
| 452 | } |
| 453 | } |
| 454 | |
Jeff Sharkey | 000ce80 | 2017-04-29 13:13:27 -0600 | [diff] [blame] | 455 | /** @removed */ |
Jorim Jaggi | f41e766 | 2017-04-27 14:30:39 +0200 | [diff] [blame] | 456 | @Deprecated |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 457 | public void dismissKeyguard(@NonNull Activity activity, |
| 458 | @Nullable KeyguardDismissCallback callback, @Nullable Handler handler) { |
Jorim Jaggi | f41e766 | 2017-04-27 14:30:39 +0200 | [diff] [blame] | 459 | requestDismissKeyguard(activity, callback); |
| 460 | } |
| 461 | |
| 462 | /** |
| 463 | * If the device is currently locked (see {@link #isKeyguardLocked()}, requests the Keyguard to |
| 464 | * be dismissed. |
| 465 | * <p> |
| 466 | * If the Keyguard is not secure or the device is currently in a trusted state, calling this |
| 467 | * method will immediately dismiss the Keyguard without any user interaction. |
| 468 | * <p> |
| 469 | * If the Keyguard is secure and the device is not in a trusted state, this will bring up the |
| 470 | * UI so the user can enter their credentials. |
chaviw | 59b9885 | 2017-06-13 12:05:44 -0700 | [diff] [blame] | 471 | * <p> |
| 472 | * If the value set for the {@link Activity} attr {@link android.R.attr#turnScreenOn} is true, |
| 473 | * the screen will turn on when the keyguard is dismissed. |
Jorim Jaggi | f41e766 | 2017-04-27 14:30:39 +0200 | [diff] [blame] | 474 | * |
| 475 | * @param activity The activity requesting the dismissal. The activity must be either visible |
| 476 | * by using {@link LayoutParams#FLAG_SHOW_WHEN_LOCKED} or must be in a state in |
| 477 | * which it would be visible if Keyguard would not be hiding it. If that's not |
| 478 | * the case, the request will fail immediately and |
| 479 | * {@link KeyguardDismissCallback#onDismissError} will be invoked. |
| 480 | * @param callback The callback to be called if the request to dismiss Keyguard was successful |
| 481 | * or {@code null} if the caller isn't interested in knowing the result. The |
| 482 | * callback will not be invoked if the activity was destroyed before the |
| 483 | * callback was received. |
| 484 | */ |
| 485 | public void requestDismissKeyguard(@NonNull Activity activity, |
| 486 | @Nullable KeyguardDismissCallback callback) { |
Lucas Dupin | c80c67e | 2017-12-04 14:29:10 -0800 | [diff] [blame] | 487 | requestDismissKeyguard(activity, null /* message */, callback); |
| 488 | } |
| 489 | |
| 490 | /** |
| 491 | * If the device is currently locked (see {@link #isKeyguardLocked()}, requests the Keyguard to |
| 492 | * be dismissed. |
| 493 | * <p> |
| 494 | * If the Keyguard is not secure or the device is currently in a trusted state, calling this |
| 495 | * method will immediately dismiss the Keyguard without any user interaction. |
| 496 | * <p> |
| 497 | * If the Keyguard is secure and the device is not in a trusted state, this will bring up the |
| 498 | * UI so the user can enter their credentials. |
| 499 | * <p> |
| 500 | * If the value set for the {@link Activity} attr {@link android.R.attr#turnScreenOn} is true, |
| 501 | * the screen will turn on when the keyguard is dismissed. |
| 502 | * |
| 503 | * @param activity The activity requesting the dismissal. The activity must be either visible |
| 504 | * by using {@link LayoutParams#FLAG_SHOW_WHEN_LOCKED} or must be in a state in |
| 505 | * which it would be visible if Keyguard would not be hiding it. If that's not |
| 506 | * the case, the request will fail immediately and |
| 507 | * {@link KeyguardDismissCallback#onDismissError} will be invoked. |
| 508 | * @param message A message that will be shown in the keyguard explaining why the user |
| 509 | * would want to dismiss it. |
| 510 | * @param callback The callback to be called if the request to dismiss Keyguard was successful |
| 511 | * or {@code null} if the caller isn't interested in knowing the result. The |
| 512 | * callback will not be invoked if the activity was destroyed before the |
| 513 | * callback was received. |
| 514 | * @hide |
| 515 | */ |
| 516 | @RequiresPermission(Manifest.permission.SHOW_KEYGUARD_MESSAGE) |
| 517 | @SystemApi |
| 518 | public void requestDismissKeyguard(@NonNull Activity activity, @Nullable CharSequence message, |
| 519 | @Nullable KeyguardDismissCallback callback) { |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 520 | try { |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 521 | mAm.dismissKeyguard(activity.getActivityToken(), new IKeyguardDismissCallback.Stub() { |
| 522 | @Override |
| 523 | public void onDismissError() throws RemoteException { |
Jorim Jaggi | f41e766 | 2017-04-27 14:30:39 +0200 | [diff] [blame] | 524 | if (callback != null && !activity.isDestroyed()) { |
| 525 | activity.mHandler.post(callback::onDismissError); |
| 526 | } |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 527 | } |
| 528 | |
| 529 | @Override |
| 530 | public void onDismissSucceeded() throws RemoteException { |
Jorim Jaggi | f41e766 | 2017-04-27 14:30:39 +0200 | [diff] [blame] | 531 | if (callback != null && !activity.isDestroyed()) { |
| 532 | activity.mHandler.post(callback::onDismissSucceeded); |
| 533 | } |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 534 | } |
| 535 | |
| 536 | @Override |
| 537 | public void onDismissCancelled() throws RemoteException { |
Jorim Jaggi | f41e766 | 2017-04-27 14:30:39 +0200 | [diff] [blame] | 538 | if (callback != null && !activity.isDestroyed()) { |
| 539 | activity.mHandler.post(callback::onDismissCancelled); |
| 540 | } |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 541 | } |
Lucas Dupin | c80c67e | 2017-12-04 14:29:10 -0800 | [diff] [blame] | 542 | }, message); |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 543 | } catch (RemoteException e) { |
Lucas Dupin | ef88654 | 2018-01-03 16:03:07 -0800 | [diff] [blame] | 544 | throw e.rethrowFromSystemServer(); |
Clara Bayarri | 56878a9 | 2015-10-29 15:43:55 +0000 | [diff] [blame] | 545 | } |
Clara Bayarri | 56878a9 | 2015-10-29 15:43:55 +0000 | [diff] [blame] | 546 | } |
| 547 | |
Adrian Roos | 8289368 | 2015-04-02 16:17:46 +0200 | [diff] [blame] | 548 | /** |
Jorim Jaggi | 241ae10 | 2016-11-02 21:57:33 -0700 | [diff] [blame] | 549 | * @deprecated Use {@link LayoutParams#FLAG_DISMISS_KEYGUARD} |
| 550 | * and/or {@link LayoutParams#FLAG_SHOW_WHEN_LOCKED} |
Dianne Hackborn | 9567a66 | 2011-04-19 18:44:03 -0700 | [diff] [blame] | 551 | * instead; this allows you to seamlessly hide the keyguard as your application |
| 552 | * moves in and out of the foreground and does not require that any special |
| 553 | * permissions be requested. |
| 554 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 555 | * Exit the keyguard securely. The use case for this api is that, after |
| 556 | * disabling the keyguard, your app, which was granted permission to |
| 557 | * disable the keyguard and show a limited amount of information deemed |
| 558 | * safe without the user getting past the keyguard, needs to navigate to |
| 559 | * something that is not safe to view without getting past the keyguard. |
| 560 | * |
| 561 | * This will, if the keyguard is secure, bring up the unlock screen of |
| 562 | * the keyguard. |
| 563 | * |
| 564 | * @param callback Let's you know whether the operation was succesful and |
| 565 | * it is safe to launch anything that would normally be considered safe |
| 566 | * once the user has gotten past the keyguard. |
| 567 | */ |
Dianne Hackborn | 9567a66 | 2011-04-19 18:44:03 -0700 | [diff] [blame] | 568 | @Deprecated |
Tor Norbye | 672055e | 2015-04-23 17:30:56 -0700 | [diff] [blame] | 569 | @RequiresPermission(Manifest.permission.DISABLE_KEYGUARD) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 570 | public void exitKeyguardSecurely(final OnKeyguardExitResult callback) { |
| 571 | try { |
| 572 | mWM.exitKeyguardSecurely(new IOnKeyguardExitResult.Stub() { |
| 573 | public void onKeyguardExitResult(boolean success) throws RemoteException { |
Jim Miller | a999d46 | 2013-10-30 13:58:11 -0700 | [diff] [blame] | 574 | if (callback != null) { |
| 575 | callback.onKeyguardExitResult(success); |
| 576 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 577 | } |
| 578 | }); |
| 579 | } catch (RemoteException e) { |
| 580 | |
| 581 | } |
| 582 | } |
| 583 | } |