secure-preferences - GitLite

KO | EN

gitlite — search

#javascript #ai #typescript #go #machine-learning #macos #awesome #cli #kubernetes #awesome-list #security #ios #mcp #openai

secure-preferences

(★ 337)

Android secure shared preferences using Android Keystore system

File Explorer

Download Latest Version (.zip)

- - gradle-wrapper.jar
  - gradle-wrapper.properties
- .gitignore
- build.gradle
- proguard-rules.pro
- README.md
- .gitignore
- build.gradle
- proguard-rules.pro
.gitignore
.travis.yml
build.gradle
checkstyle.gradle
checkstyle.xml
checkstyle_android_library.gradle
gradle.properties
gradlew
gradlew.bat
libraries.gradle
LICENSE.txt
README.md
settings.gradle
test_script.sh
version.gradle

# Installation Guide

1. Get the code

git clone https://github.com/ophio/secure-preferences

Downloads the entire project code from GitHub to your computer.

cd secure-preferences

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

./gradlew clean check connectedAndroidTest

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://travis-ci.org/ophio/secure-preferences.svg?branch=develop)](https://travis-ci.org/ophio/secure-preferences)
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-secure--preferences-green.svg)](https://android-arsenal.com/details/1/2051)

For securing your `SharedPreferences` information.

## Why Secure `SharedPreferences`?
`SharedPreferences` are accessible to anybody if your device is compromised. It is recommended to obscure the information saved in `SharedPreferences` before you store them. One of the solutions is to encrypt the informaiton (See [`ObscuredSharedPreferences`] (library/src/main/java/in/co/ophio/secure/core/ObscuredSharedPreferences.java)). Still the `key` that is used for encryption can be recovered by a simple decompilation procedure if it is hard-coded in the app.

## Solution
In addition to encrypting the information stored in `SharedPreferences,`  store your encryption key in the [`Android Keystore System`] (https://developer.android.com/training/articles/keystore.html#UsingAndroidKeyStore) by using our [`KeyGenerator`](library/src/main/java/in/co/ophio/secure/core/KeyStoreKeyGenerator.java)

## Android Keystore System
The Android Keystore system lets you store private keys in a container to make it more difficult to extract from the device. Once keys are in the keystore, they can be used for cryptographic operations with the private key material remaining non-exportable.

The Keystore system is used by the [`KeyChain`](https://developer.android.com/reference/android/security/KeyChain.html) API as well as the Android Keystore provider feature that was introduced in Android 4.3 (API level 18).

### Disadvantages of using Android Keystore System
If we create a key pair with the `KeyPairGenerator` and store it, then on changing the screen lock, our key pairs are deleted as the new Keystore is empty. See the following links for more details:

- [Issue](https://code.google.com/p/android/issues/detail?id=61989)
- [Explanation](http://doridori.github.io/android-security-the%20forgetful-keystore/#sthash.1opaRvjY.dpbs)

There are some changes to the Keystore in the new Android M Developer Preview regarding this mentioned [here](https://developer.android.com/preview/behavior-changes.html#behavior-keystore).

# Download
Using Gradle:

```
compile "in.co.ophio:secure-preferences:0.1.3"
```

Using Maven:

```
<dependency>
  <groupId>in.co.ophio</groupId>
  <artifactId>secure-preferences</artifactId>
  <version>0.1.3</version>
</dependency>
```

# Usage

* Generate a key using [`KeyGenerator`](library/src/main/java/in/co/ophio/secure/core/KeyStoreKeyGenerator.java):

```
	String key = KeyStoreKeyGenerator.get(getApplication(),
					KeystoreApplication.getAppContext().getPackageName())
						.loadOrGenerateKeys();
```

* Obtain an instance of [`ObscuredSharedPreferences`] (library/src/main/java/in/co/ophio/secure/core/ObscuredSharedPreferences.java) using [`ObscuredPreferencesBuilder`](library/src/main/java/in/co/ophio/secure/core/ObscuredPreferencesBuilder.java) as follows:

```
SharedPreferences sharedPreferences = new ObscuredPreferencesBuilder()
                .setApplication(KeystoreApplication.getAppContext())
                .obfuscateValue(true)
                .obfuscateKey(true)
                .setSharePrefFileName(PREFS_NAME)
                .setSecret(key)		//secret key we generated in step 1.
                .createSharedPrefs();
```

* For more information on usage see the sample application [implementation](sample/src/main/java/in/co/ophio/secure/sample/util/KeystoreAccountUtils.java):
* For more information on library see the [library page](library/).

# Contributing

Before sending pull requests

* Setup your `Preferences -> File And Code Templates -> Includes -> ` `File Header` as follows:

```
/**
 * @author ${USER} (your email address)
 */
```
*  Run the following command on your computer.

```
./gradlew clean check connectedAndroidTest
```

# License

```
Copyright 2015 Ophio.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

# NOTE

The maintainer has very little time to work on it, so this is no longer actively maintained. Also note that the library has not been updated after Android version 23, so a few API's used in this library are now deprecated in new versions of Android and new security related changes are not available.