xref: /aosp_15_r20/developers/build/prebuilts/gradle/ConfirmCredential/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid Confirm Credential Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiA sample that demonstrates how to use device credentials (PIN, Pattern, Password) in your app
6*d353a188SXin Li
7*d353a188SXin LiIntroduction
8*d353a188SXin Li------------
9*d353a188SXin Li
10*d353a188SXin LiThis sample demonstrates how you can use device credentials (PIN, Pattern, Password) in your app
11*d353a188SXin Lito authenticate the user before they are trying to complete some actions.
12*d353a188SXin Li
13*d353a188SXin LiFirst you need to create a symmetric key in the Android Key Store using [KeyGenerator][1]
14*d353a188SXin Liwhich can be only be used after the user has authenticated after the user is authenticated
15*d353a188SXin Liwith their device credentials and pass [KeyGenParameterSpec][2].
16*d353a188SXin Li
17*d353a188SXin LiBy setting an integer value to the
18*d353a188SXin Li[KeyGenParameterSpec.Builder.setUserAuthenticationValidityDurationSeconds][3], you can consider the
19*d353a188SXin Liuser as authenticated if the user has been authenticated with the device credentials
20*d353a188SXin Liwithin the last x seconds.
21*d353a188SXin Li
22*d353a188SXin LiThen by calling [KeyguardManager.createConfirmDeviceCredentialIntent][4], you can show a screen
23*d353a188SXin Lito confirm device credentials to the user.
24*d353a188SXin Li
25*d353a188SXin Li[1]: https://developer.android.com/reference/javax/crypto/KeyGenerator.html
26*d353a188SXin Li[2]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.html
27*d353a188SXin Li[3]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.Builder.html#setUserAuthenticationValidityDurationSeconds%28int%29
28*d353a188SXin Li[4]: https://developer.android.com/reference/android/app/KeyguardManager.html#createConfirmDeviceCredentialIntent%28java.lang.CharSequence,%20java.lang.CharSequence%29
29*d353a188SXin Li
30*d353a188SXin LiPre-requisites
31*d353a188SXin Li--------------
32*d353a188SXin Li
33*d353a188SXin Li- Android SDK 27
34*d353a188SXin Li- Android Build Tools v27.0.2
35*d353a188SXin Li- Android Support Repository
36*d353a188SXin Li
37*d353a188SXin LiScreenshots
38*d353a188SXin Li-------------
39*d353a188SXin Li
40*d353a188SXin Li<img src="screenshots/1-purchase.png" height="400" alt="Screenshot"/> <img src="screenshots/2-show-confirm-credential.png" height="400" alt="Screenshot"/> <img src="screenshots/3-already-authenticated.png" height="400" alt="Screenshot"/>
41*d353a188SXin Li
42*d353a188SXin LiGetting Started
43*d353a188SXin Li---------------
44*d353a188SXin Li
45*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
46*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
47*d353a188SXin Li
48*d353a188SXin LiSupport
49*d353a188SXin Li-------
50*d353a188SXin Li
51*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
52*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
53*d353a188SXin Li
54*d353a188SXin LiIf you've found an error in this sample, please file an issue:
55*d353a188SXin Lihttps://github.com/googlesamples/android-Confirm Credential
56*d353a188SXin Li
57*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
58*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
59*d353a188SXin Li
60*d353a188SXin LiLicense
61*d353a188SXin Li-------
62*d353a188SXin Li
63*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
64*d353a188SXin Li
65*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
66*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
67*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
68*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
69*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
70*d353a188SXin Lithe License at
71*d353a188SXin Li
72*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
73*d353a188SXin Li
74*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
75*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
76*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
77*d353a188SXin LiLicense for the specific language governing permissions and limitations under
78*d353a188SXin Lithe License.
79