├── .gitignore
├── LICENSE
├── README.md
├── app
├── .gitignore
├── build.gradle
├── proguard-rules.pro
└── src
│ ├── androidTest
│ └── java
│ │ └── com
│ │ └── epam
│ │ └── securestorage
│ │ ├── CipherReadWriteInstrumentedTest.java
│ │ └── ThemisReadWriteInstrumentedTest.java
│ ├── main
│ ├── AndroidManifest.xml
│ ├── java
│ │ └── com
│ │ │ └── epam
│ │ │ └── securestorage
│ │ │ ├── SecureStorage.java
│ │ │ ├── core
│ │ │ ├── KeyStoreHelper.java
│ │ │ ├── SecureStorageCallback.java
│ │ │ ├── SecureStorageException.java
│ │ │ └── SecurityProvider.java
│ │ │ └── providers
│ │ │ ├── cipher
│ │ │ └── CipherEncryptionProvider.java
│ │ │ └── themis
│ │ │ └── ThemisEncryptionProvider.java
│ └── res
│ │ ├── drawable-v24
│ │ └── ic_launcher_foreground.xml
│ │ ├── drawable
│ │ └── ic_launcher_background.xml
│ │ ├── mipmap-anydpi-v26
│ │ ├── ic_launcher.xml
│ │ └── ic_launcher_round.xml
│ │ ├── mipmap-hdpi
│ │ ├── ic_launcher.png
│ │ └── ic_launcher_round.png
│ │ ├── mipmap-mdpi
│ │ ├── ic_launcher.png
│ │ └── ic_launcher_round.png
│ │ ├── mipmap-xhdpi
│ │ ├── ic_launcher.png
│ │ └── ic_launcher_round.png
│ │ ├── mipmap-xxhdpi
│ │ ├── ic_launcher.png
│ │ └── ic_launcher_round.png
│ │ ├── mipmap-xxxhdpi
│ │ ├── ic_launcher.png
│ │ └── ic_launcher_round.png
│ │ └── values
│ │ └── strings.xml
│ └── test
│ └── java
│ └── com
│ └── epam
│ └── securestorage
│ └── ExampleUnitTest.java
├── build.gradle
├── demo
├── .gitignore
├── build.gradle
├── demoKeystore
├── proguard-rules.pro
└── src
│ └── main
│ ├── AndroidManifest.xml
│ ├── java
│ └── com
│ │ └── epam
│ │ └── demo
│ │ └── MainActivity.java
│ └── res
│ ├── drawable-v24
│ └── ic_launcher_foreground.xml
│ ├── drawable
│ └── ic_launcher_background.xml
│ ├── layout
│ └── activity_main.xml
│ ├── mipmap-anydpi-v26
│ ├── ic_launcher.xml
│ └── ic_launcher_round.xml
│ ├── mipmap-hdpi
│ ├── ic_launcher.png
│ └── ic_launcher_round.png
│ ├── mipmap-mdpi
│ ├── ic_launcher.png
│ └── ic_launcher_round.png
│ ├── mipmap-xhdpi
│ ├── ic_launcher.png
│ └── ic_launcher_round.png
│ ├── mipmap-xxhdpi
│ ├── ic_launcher.png
│ └── ic_launcher_round.png
│ ├── mipmap-xxxhdpi
│ ├── ic_launcher.png
│ └── ic_launcher_round.png
│ └── values
│ ├── colors.xml
│ ├── strings.xml
│ └── styles.xml
├── gradle.properties
├── gradle
└── wrapper
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── keystore.properties
├── settings.gradle
└── themis
└── build.gradle
/.gitignore:
--------------------------------------------------------------------------------
1 | # Built application files
2 | *.apk
3 | *.ap_
4 | *.aab
5 |
6 | # Files for the ART/Dalvik VM
7 | *.dex
8 |
9 | # Java class files
10 | *.class
11 |
12 | # Generated files
13 | bin/
14 | gen/
15 | out/
16 |
17 | # Gradle files
18 | .gradle/
19 | build/
20 |
21 | # Local configuration file (sdk path, etc)
22 | local.properties
23 |
24 | # Proguard folder generated by Eclipse
25 | proguard/
26 |
27 | # Log Files
28 | *.log
29 |
30 | # Android Studio Navigation editor temp files
31 | .navigation/
32 |
33 | # Android Studio captures folder
34 | captures/
35 |
36 | # IntelliJ
37 | .idea/
38 | *.iml
39 | .idea/workspace.xml
40 | .idea/tasks.xml
41 | .idea/gradle.xml
42 | .idea/assetWizardSettings.xml
43 | .idea/dictionaries
44 | .idea/libraries
45 | .idea/caches
46 |
47 | # Keystore files
48 | # Uncomment the following lines if you do not want to check your keystore files in.
49 | #*.jks
50 | #*.keystore
51 |
52 | # External native build folder generated in Android Studio 2.2 and later
53 | .externalNativeBuild
54 |
55 | # Google Services (e.g. APIs or Firebase)
56 | # google-services.json
57 |
58 | # Freeline
59 | freeline.py
60 | freeline/
61 | freeline_project_description.json
62 |
63 | # fastlane
64 | fastlane/report.xml
65 | fastlane/Preview.html
66 | fastlane/screenshots
67 | fastlane/test_output
68 | fastlane/readme.md
69 |
70 | # Version control
71 | vcs.xml
72 |
73 | # lint
74 | lint/intermediates/
75 | lint/generated/
76 | lint/outputs/
77 | lint/tmp/
78 | # lint/reports/
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | # Android-Secure-Storage
3 | **SecureStorage** is used to keep private information in a safe mode without requiring a password or a fingerprint.
4 | There are two types of encryption providers: CIPHER and [THEMIS](https://github.com/cossacklabs/themis). Which provide different level of encryption.
5 | *THEMIS is stronger then CIPHER and should be used to keep sensitive data like passwords and etc.*
6 |
7 | ## KOTLIN
8 |
9 | **1. In order to initialize the SecureStorage choose one of the following encryption providers:**
10 |
11 | **CIPHER** encryption:
12 | ```kotlin
13 | val storage = new SecureStorage(context, SecurityProvider.Type.CIPHER)
14 | ```
15 |
16 | **THEMIS** encryption:
17 | ```kotlin
18 | val storage = new SecureStorage(context, SecurityProvider.Type.THEMIS)
19 | ```
20 |
21 | **SecureStorage EVENTS**:
22 | To subscribe to SecureStorage Events, please initialize in the following way
23 |
24 | ```kotlin
25 | val storage = SecureStorage(context, SecurityProvider.Type.CIPHER, object : SecureStorageCallback {
26 | override fun onComplete(actionType: SecureStorageCallback.ActionType) {
27 | Log.d("CIPHER_PROVIDER", actionType.toString())
28 | }
29 | override fun onError(actionType: SecureStorageCallback.ActionType, e: Exception) {
30 | Log.d("CIPHER_PROVIDER_ERROR", actionType.toString(), e)
31 | }
32 | })
33 | ```
34 |
35 | **2. Main methods to work with the SecureStorage**
36 | To **SAVE** data:
37 |
38 | ```kotlin
39 | storage.save(key, value)
40 | ```
41 | To **GET** data:
42 |
43 | ```kotlin
44 | storage.get(key)
45 | ```
46 | To **REMOVE** specific data:
47 |
48 | ```kotlin
49 | storage.remove(key)
50 | ```
51 | To **ERASE** all data:
52 |
53 | ```kotlin
54 | storage.erase()
55 | ```
56 |
57 | ## JAVA
58 |
59 | **1. In order to initialize the SecureStorage choose one of the following encryption providers:**
60 |
61 | **CIPHER** encryption:
62 | ```java
63 | SecureStorage storage = new SecureStorage(context, SecurityProvider.Type.CIPHER);
64 | ```
65 |
66 | **THEMIS** encryption:
67 | ```java
68 | SecureStorage storage = new SecureStorage(context, SecurityProvider.Type.THEMIS);
69 | ```
70 |
71 | **SecureStorage EVENTS**:
72 | To subscribe to SecureStorage Events, please initialize in the following way
73 |
74 | ```java
75 | SecureStorage storage = new SecureStorage(this, SecurityProvider.Type.CIPHER, new SecureStorageCallback() {
76 | @Override
77 | public void onComplete(ActionType actionType) {
78 | if(actionType == ActionType.SAVE){
79 | Log.d("CIPHER_PROVIDER", actionType.toString());
80 | }
81 | }
82 |
83 | @Override
84 | public void onError(ActionType actionType, Exception e) {
85 | if(actionType == ActionType.SAVE){
86 | Log.d("CIPHER_PROVIDER_ERROR", actionType.toString(), e);
87 | }
88 | }
89 | });
90 | ```
91 |
92 | **2. Main methods to work with the SecureStorage**
93 | To **SAVE** data:
94 |
95 | ```java
96 | storage.save(key, value)
97 | ```
98 | To **GET** data:
99 |
100 | ```java
101 | storage.get(key)
102 | ```
103 | To **REMOVE** specific data:
104 |
105 | ```java
106 | storage.remove(key)
107 | ```
108 | To **ERASE** all data:
109 |
110 | ```java
111 | storage.erase()
112 | ```
113 |
--------------------------------------------------------------------------------
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/app/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'com.android.library'
2 | apply plugin: 'com.jfrog.artifactory'
3 | apply plugin: 'maven-publish'
4 |
5 | def keystorePropertiesFile = rootProject.file("keystore.properties")
6 | /*
7 | you should create file keystore.properties and fields like this
8 | username=Andre_Gus@epam.com
9 | password=""
10 | */
11 | def keystoreProperties = new Properties()
12 | keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
13 | android {
14 | compileSdkVersion 27
15 | defaultConfig {
16 | minSdkVersion 21
17 | targetSdkVersion 27
18 | versionCode 1
19 | versionName "1.0"
20 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
21 | }
22 | buildTypes {
23 | release {
24 | minifyEnabled false
25 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
26 | }
27 | }
28 | }
29 | publishing {
30 | publications {
31 | aar(MavenPublication) {
32 | def packageName = 'com.epam.securestorage'
33 | def libraryVersion = '1.0.0'
34 | groupId packageName
35 | version = libraryVersion
36 | artifactId project.getName()
37 |
38 | // Tell maven to prepare the generated "*.aar" file for publishing
39 | artifact("$buildDir/outputs/aar/${project.getName()}-release.aar")
40 | }
41 | }
42 | }
43 |
44 | artifactory {
45 | contextUrl = 'https://artifactory.epam.com/artifactory'
46 | publish {
47 | repository {
48 | // The Artifactory repository key to publish to
49 | repoKey = 'libs-release-local'
50 |
51 | username = keystoreProperties['username']
52 | password = keystoreProperties['password']
53 | }
54 | defaults {
55 | // Tell the Artifactory Plugin which artifacts should be published to Artifactory.
56 | publications('aar')
57 | publishArtifacts = true
58 |
59 | // Properties to be attached to the published artifacts.
60 | properties = ['qa.level': 'basic', 'dev.team': 'core']
61 | // Publish generated POM files to Artifactory (true by default)
62 | publishPom = true
63 | }
64 | }
65 | }
66 |
67 | dependencies {
68 | implementation fileTree(include: ['*.jar'], dir: 'libs')
69 | implementation 'com.android.support:support-annotations:28.0.0'
70 | testImplementation 'junit:junit:4.12'
71 | androidTestImplementation 'com.android.support.test:runner:1.0.2'
72 | androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
73 |
74 | //Themis
75 | implementation 'com.cossacklabs.com:themis:0.10.0'
76 | }
77 |
--------------------------------------------------------------------------------
/app/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
22 |
--------------------------------------------------------------------------------
/app/src/androidTest/java/com/epam/securestorage/CipherReadWriteInstrumentedTest.java:
--------------------------------------------------------------------------------
1 | package com.epam.securestorage;
2 |
3 | import android.content.Context;
4 | import android.support.test.InstrumentationRegistry;
5 | import android.support.test.runner.AndroidJUnit4;
6 |
7 | import com.epam.securestorage.core.SecurityProvider;
8 |
9 | import org.junit.Before;
10 | import org.junit.Test;
11 | import org.junit.runner.RunWith;
12 |
13 | import static org.junit.Assert.assertEquals;
14 | import static org.junit.Assert.assertNotEquals;
15 | import static org.junit.Assert.assertNull;
16 |
17 | /**
18 | * Instrumented test, which will execute on an Android device.
19 | * This test need launch in two devices for 18 - 22 and 23-27 version API
20 | *
21 | * @see Testing documentation
22 | */
23 | @RunWith(AndroidJUnit4.class)
24 | public class CipherReadWriteInstrumentedTest {
25 | private SecureStorage storage;
26 |
27 | @Before
28 | public void before() {
29 | Context context = InstrumentationRegistry.getTargetContext();
30 | storage = new SecureStorage(context, SecurityProvider.Type.CIPHER);
31 | }
32 |
33 | @Test
34 | public void shouldGetNullValueIfNotSet() {
35 | String value = storage.get("blabla");
36 | assertNull(value);
37 | }
38 |
39 | @Test
40 | public void shouldSaveValue() {
41 | storage.save("key", "passWORD");
42 | assertEquals("passWORD", storage.get("key"));
43 | }
44 |
45 | @Test
46 | public void shouldSaveOtherKeyValue() {
47 | storage.save("key1", "passWORD");
48 | assertEquals("passWORD", storage.get("key1"));
49 | }
50 |
51 | @Test
52 | public void shouldSaveOtherKeyValue2() {
53 | storage.save("key1", "passWORD");
54 | assertEquals("passWORD", storage.get("key1"));
55 | storage.save("key2", "passWORD");
56 | assertEquals("passWORD", storage.get("key2"));
57 | assertEquals("passWORD", storage.get("key1"));
58 | storage.get("key1");
59 | assertEquals("passWORD", storage.get("key2"));
60 | assertEquals("passWORD", storage.get("key1"));
61 | }
62 |
63 | @Test
64 | public void shouldClearStorage() {
65 | storage.save("key12", "1");
66 | assertEquals("1", storage.get("key12"));
67 | storage.remove("key12");
68 | assertNull(storage.get("key12"));
69 | }
70 |
71 | @Test
72 | public void shouldEraseValues() {
73 | storage.save("key123", "12093qqwoiejqow812312312123poqj[ 9wpe7nrpwiercwe9rucpn[w9e7rnc;lwiehr pb8ry");
74 | assertEquals("12093qqwoiejqow812312312123poqj[ 9wpe7nrpwiercwe9rucpn[w9e7rnc;lwiehr pb8ry", storage.get("key123"));
75 | storage.erase();
76 | assertNotEquals("12093qqwoiejqow812312312123poqj[ 9wpe7nrpwiercwe9rucpn[w9e7rnc;lwiehr pb8ry", storage.get("key123"));
77 | assertNull(storage.get("key123"));
78 | }
79 |
80 | @Test
81 | public void shouldReturnNullIfNoKeyWithWhitespaces() {
82 | assertNull(storage.get("bad key"));
83 | }
84 |
85 | @Test
86 | public void shouldSaveValueForKeyWithWhitespaces() {
87 | storage.save("KEY", "@");
88 | assertNull(storage.get("bad key"));
89 | }
90 |
91 | @Test
92 | public void shouldClearForKey() {
93 | storage.save("KEY", "@");
94 | storage.remove("KEY");
95 | assertNull(storage.get("KEY"));
96 | }
97 |
98 | @Test
99 | public void shouldClearKeys() {
100 | storage.save("KEY", "1");
101 | storage.save("KEY2", "2");
102 | storage.remove("KEY");
103 | assertEquals("2", storage.get("KEY2"));
104 | storage.erase();
105 | assertNull(storage.get("KEY2"));
106 | }
107 | }
108 |
--------------------------------------------------------------------------------
/app/src/androidTest/java/com/epam/securestorage/ThemisReadWriteInstrumentedTest.java:
--------------------------------------------------------------------------------
1 | package com.epam.securestorage;
2 |
3 | import android.content.Context;
4 | import android.support.test.InstrumentationRegistry;
5 | import android.support.test.runner.AndroidJUnit4;
6 |
7 | import com.epam.securestorage.core.SecurityProvider;
8 |
9 | import org.junit.Before;
10 | import org.junit.Test;
11 | import org.junit.runner.RunWith;
12 |
13 | import static org.junit.Assert.assertEquals;
14 | import static org.junit.Assert.assertNotEquals;
15 | import static org.junit.Assert.assertNull;
16 |
17 | /**
18 | * Instrumented test, which will execute on an Android device.
19 | * This test need launch in two devices for 18 - 22 and 23-27 version API
20 | *
21 | * @see Testing documentation
22 | */
23 | @RunWith(AndroidJUnit4.class)
24 | public class ThemisReadWriteInstrumentedTest {
25 | private SecureStorage storage;
26 |
27 | @Before
28 | public void before() {
29 | Context context = InstrumentationRegistry.getTargetContext();
30 | storage = new SecureStorage(context, SecurityProvider.Type.THEMIS);
31 | }
32 |
33 | @Test
34 | public void shouldGetNullValueIfNotSet() {
35 | String value = storage.get("blabla");
36 | assertNull(value);
37 | }
38 |
39 | @Test
40 | public void shouldSaveValue() {
41 | storage.save("key", "passWORD");
42 | assertEquals("passWORD", storage.get("key"));
43 | }
44 |
45 | @Test
46 | public void shouldSaveOtherKeyValue() {
47 | storage.save("key", "value");
48 | storage.save("key", "value1");
49 | storage.save("key", "value2");
50 | assertEquals("value2", storage.get("key"));
51 | }
52 |
53 | @Test
54 | public void shouldSaveOtherKeyValue2() {
55 | storage.save("key1", "passWORD");
56 | assertEquals("passWORD", storage.get("key1"));
57 | storage.save("key2", "passWORD");
58 | assertEquals("passWORD", storage.get("key2"));
59 | assertEquals("passWORD", storage.get("key1"));
60 | storage.get("key1");
61 | assertEquals("passWORD", storage.get("key2"));
62 | assertEquals("passWORD", storage.get("key1"));
63 | }
64 |
65 | @Test
66 | public void shouldClearStorage() {
67 | storage.save("key12", "1");
68 | assertEquals("1", storage.get("key12"));
69 | storage.remove("key12");
70 | assertNull(storage.get("key12"));
71 | storage.save("key13", "3456");
72 | storage.save("key14", "abc");
73 | storage.remove("key14");
74 | assertNull(storage.get("key14"));
75 | assertEquals("3456", storage.get("key13"));
76 | }
77 |
78 | @Test
79 | public void shouldEraseValues() {
80 | storage.save("key123", "12093qqwoiejqow812312312123poqj[ 9wpe7nrpwiercwe9rucpn[w9e7rnc;lwiehr pb8ry");
81 | assertEquals("12093qqwoiejqow812312312123poqj[ 9wpe7nrpwiercwe9rucpn[w9e7rnc;lwiehr pb8ry", storage.get("key123"));
82 | storage.erase();
83 | assertNotEquals("12093qqwoiejqow812312312123poqj[ 9wpe7nrpwiercwe9rucpn[w9e7rnc;lwiehr pb8ry", storage.get("key123"));
84 | assertNull(storage.get("key123"));
85 | }
86 |
87 | @Test
88 | public void shouldReturnNullIfNoKeyWithWhitespaces() {
89 | assertNull(storage.get("bad key"));
90 | }
91 |
92 | @Test
93 | public void shouldSaveValueForKeyWithWhitespaces() {
94 | storage.save("KEY", "@");
95 | assertNull(storage.get("bad key"));
96 | }
97 |
98 | @Test
99 | public void shouldClearForKey() {
100 | storage.save("KEY", "@");
101 | storage.remove("KEY");
102 | assertNull(storage.get("KEY"));
103 | }
104 |
105 | @Test
106 | public void shouldClearKeys() {
107 | storage.save("KEY", "1");
108 | storage.save("KEY2", "2");
109 | storage.save("KEY3", "3");
110 | storage.save("KEY4", "4");
111 | storage.remove("KEY");
112 | assertEquals("2", storage.get("KEY2"));
113 | storage.erase();
114 | assertNull(storage.get("KEY2"));
115 | assertNull(storage.get("KEY2"));
116 | assertNull(storage.get("KEY3"));
117 | assertNull(storage.get("KEY4"));
118 | }
119 | }
120 |
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
9 |
10 |
--------------------------------------------------------------------------------
/app/src/main/java/com/epam/securestorage/SecureStorage.java:
--------------------------------------------------------------------------------
1 | package com.epam.securestorage;
2 |
3 | import android.content.Context;
4 | import android.support.annotation.NonNull;
5 |
6 | import com.epam.securestorage.core.SecureStorageCallback;
7 | import com.epam.securestorage.core.SecurityProvider;
8 | import com.epam.securestorage.core.SecurityProvider.Type;
9 | import com.epam.securestorage.providers.cipher.CipherEncryptionProvider;
10 | import com.epam.securestorage.providers.themis.ThemisEncryptionProvider;
11 |
12 | /**
13 | *
Main encryption manager class
14 | * Description:
15 | * The SecureStorage provides an ability to
16 | * encrypt/decrypt any data based on K, V logic. To instantiate
17 | * the class, Context and SecurityProviderType need to be provided.
18 | * There are two main SecurityProviders: Themis and Cipher.
19 | *
20 | * @author Denys Mokhrin
21 | */
22 | public class SecureStorage {
23 |
24 | private SecurityProvider securityProvider;
25 |
26 | /**
27 | * Forbids default instance
28 | */
29 | private SecureStorage() {
30 | }
31 |
32 | /**
33 | * Description: Main method to instantiate SecureStorage
34 | *
35 | * @param context provides app context
36 | * @param securityProviderType constant value, need to be
37 | * chosen from the enum
38 | * SecurityProvider.Type
39 | * @return SecureStore Instance
40 | */
41 | public SecureStorage(@NonNull Context context, @NonNull Type securityProviderType) {
42 | initProvider(context, securityProviderType, null);
43 | }
44 |
45 | /**
46 | * Description: Main method to instantiate SecureStorage
47 | * with a operation status callback
48 | *
49 | * @param context provides app context
50 | * @param securityProviderType constant value, need to be
51 | * chosen from the enum
52 | * SecurityProvider.Type
53 | * @return SecureStore Instance
54 | */
55 | public SecureStorage(@NonNull Context context, @NonNull Type securityProviderType, SecureStorageCallback callback) {
56 | initProvider(context, securityProviderType, callback);
57 | }
58 |
59 | private void initProvider(Context context, Type securityProviderType, SecureStorageCallback callback) {
60 | if (context != null && securityProviderType != null) {
61 | switch (securityProviderType) {
62 | case CIPHER:
63 | try {
64 | securityProvider = new CipherEncryptionProvider(context, callback);
65 | } catch (Exception e) {
66 | e.printStackTrace();
67 | }
68 | break;
69 | case THEMIS:
70 | securityProvider = new ThemisEncryptionProvider(context, callback);
71 | break;
72 | }
73 | }
74 | }
75 |
76 | /**
77 | * Description: Saves data using an encryption algorithm
78 | *
79 | * @param key provides access to store data
80 | * @param value data that need to be encrypted
81 | * @return SecureStore Instance
82 | */
83 | public void save(String key, String value) {
84 | securityProvider.save(key, value);
85 | }
86 |
87 | /**
88 | * Description: Returns decrypted data
89 | *
90 | * @param key is used to find encrypted data
91 | * @return Decrypted Data in a String format
92 | */
93 | public String get(@NonNull String key) {
94 | return securityProvider.get(key);
95 | }
96 |
97 | /**
98 | * Description: Returns decrypted data
99 | *
100 | * @param key is used to find stored data for further removal
101 | */
102 | public void remove(@NonNull String key) {
103 | securityProvider.remove(key);
104 | }
105 |
106 | /**
107 | * Description: Removes all data from storage
108 | */
109 | public void erase() {
110 | securityProvider.erase();
111 | }
112 | }
113 |
--------------------------------------------------------------------------------
/app/src/main/java/com/epam/securestorage/core/KeyStoreHelper.java:
--------------------------------------------------------------------------------
1 | package com.epam.securestorage.core;
2 |
3 | import android.content.Context;
4 | import android.os.Build;
5 | import android.security.KeyPairGeneratorSpec;
6 | import android.security.keystore.KeyGenParameterSpec;
7 | import android.security.keystore.KeyProperties;
8 | import android.support.annotation.RequiresApi;
9 |
10 | import java.io.IOException;
11 | import java.math.BigInteger;
12 | import java.security.InvalidAlgorithmParameterException;
13 | import java.security.KeyPairGenerator;
14 | import java.security.KeyStore;
15 | import java.security.KeyStoreException;
16 | import java.security.NoSuchAlgorithmException;
17 | import java.security.NoSuchProviderException;
18 | import java.security.cert.CertificateException;
19 | import java.util.Calendar;
20 |
21 | import javax.crypto.KeyGenerator;
22 | import javax.crypto.SecretKey;
23 | import javax.security.auth.x500.X500Principal;
24 |
25 | /**
26 | *