README.md
1
2 Android BasicAndroidKeyStore Sample
3 ===================================
4
5 An advanced sample displaying the creation and usage of data integrity mechanisms
6
7 Introduction
8 ------------
9
10 This sample demonstrates how to use the Android [KeyStore][1] to safely create and store
11 encryption keys that only your application can access.
12
13 A [KeyPair][2] consisting of a [PrivateKey][3] and a [PublicKey][4] is being generated.
14 The private key then is being used to sign and verify a String.
15
16 Below Android M, this sample uses a [KeyPairGeneratorSpec][5] to generate a key pair.
17 On newer versions of Android, a [KeyGenParameterSpec][6] generates a key pair with
18 additional restrictions and properties.
19
20
21 Next to that appropriate exception handling for potential errors is being displayed.
22
23 [1]: https://developer.android.com/reference/java/security/KeyStore.html
24 [2]: https://developer.android.com/reference/java/security/KeyPair.html
25 [3]: https://developer.android.com/reference/java/security/PrivateKey.html
26 [4]: https://developer.android.com/reference/java/security/PublicKey.html
27 [5]: https://developer.android.com/reference/android/security/KeyPairGeneratorSpec.html
28 [6]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.html
29
30 Pre-requisites
31 --------------
32
33 - Android SDK 25
34 - Android Build Tools v25.0.3
35 - Android Support Repository
36
37 Screenshots
38 -------------
39
40 <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
42 Getting Started
43 ---------------
44
45 This sample uses the Gradle build system. To build this project, use the
46 "gradlew build" command or use "Import Project" in Android Studio.
47
48 Support
49 -------
50
51 - Google+ Community: https://plus.google.com/communities/105153134372062985968
52 - Stack Overflow: http://stackoverflow.com/questions/tagged/android
53
54 If you've found an error in this sample, please file an issue:
55 https://github.com/googlesamples/android-BasicAndroidKeyStore
56
57 Patches are encouraged, and may be submitted by forking this project and
58 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
59
60 License
61 -------
62
63 Copyright 2017 The Android Open Source Project, Inc.
64
65 Licensed to the Apache Software Foundation (ASF) under one or more contributor
66 license agreements. See the NOTICE file distributed with this work for
67 additional information regarding copyright ownership. The ASF licenses this
68 file to you under the Apache License, Version 2.0 (the "License"); you may not
69 use this file except in compliance with the License. You may obtain a copy of
70 the License at
71
72 http://www.apache.org/licenses/LICENSE-2.0
73
74 Unless required by applicable law or agreed to in writing, software
75 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
76 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
77 License for the specific language governing permissions and limitations under
78 the License.
79