xref: /aosp_15_r20/developers/build/prebuilts/gradle/BasicAndroidKeyStore/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid BasicAndroidKeyStore Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiAn advanced sample displaying the creation and usage of data integrity mechanisms
6*d353a188SXin Li
7*d353a188SXin LiIntroduction
8*d353a188SXin Li------------
9*d353a188SXin Li
10*d353a188SXin LiThis sample demonstrates how to use the Android [KeyStore][1] to safely create and store
11*d353a188SXin Liencryption keys that only your application can access.
12*d353a188SXin Li
13*d353a188SXin LiA [KeyPair][2] consisting of a [PrivateKey][3] and a [PublicKey][4] is being generated.
14*d353a188SXin LiThe private key then is being used to sign and verify a String.
15*d353a188SXin Li
16*d353a188SXin LiBelow Android M, this sample uses a [KeyPairGeneratorSpec][5] to generate a key pair.
17*d353a188SXin LiOn newer versions of Android, a [KeyGenParameterSpec][6] generates a key pair with
18*d353a188SXin Liadditional restrictions and properties.
19*d353a188SXin Li
20*d353a188SXin Li
21*d353a188SXin LiNext to that appropriate exception handling for potential errors is being displayed.
22*d353a188SXin Li
23*d353a188SXin Li[1]: https://developer.android.com/reference/java/security/KeyStore.html
24*d353a188SXin Li[2]: https://developer.android.com/reference/java/security/KeyPair.html
25*d353a188SXin Li[3]: https://developer.android.com/reference/java/security/PrivateKey.html
26*d353a188SXin Li[4]: https://developer.android.com/reference/java/security/PublicKey.html
27*d353a188SXin Li[5]: https://developer.android.com/reference/android/security/KeyPairGeneratorSpec.html
28*d353a188SXin Li[6]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.html
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/screenshot1.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot2.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot3.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot4.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot5.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-BasicAndroidKeyStore
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