realm-encryption-helper

A lightweight library for generate encrypt key and save to KeyStore for Realm

License	The MIT License
Categories	Realm Data Databases
GroupId	com.github.tntkhang
ArtifactId	realm-encryption-helper
Last Version	1.0.0
Release Date	Dec 28, 2017
Type	aar
Description	realm-encryption-helper A lightweight library for generate encrypt key and save to KeyStore for Realm
Project URL	https://github.com/tntkhang/realm-encryption-helper
Source Code Management	https://github.com/tntkhang/realm-encryption-helper

Download realm-encryption-helper

Filename	Size
realm-encryption-helper-1.0.0.pom
realm-encryption-helper-1.0.0.aar	19 KB
realm-encryption-helper-1.0.0-sources.jar	2 KB
realm-encryption-helper-1.0.0-javadoc.jar	19 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.tntkhang/realm-encryption-helper/ -->
<dependency>
    <groupId>com.github.tntkhang</groupId>
    <artifactId>realm-encryption-helper</artifactId>
    <version>1.0.0</version>
    <type>aar</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.tntkhang/realm-encryption-helper/
implementation 'com.github.tntkhang:realm-encryption-helper:1.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.tntkhang/realm-encryption-helper/
implementation ("com.github.tntkhang:realm-encryption-helper:1.0.0")

Apache Buildr

'com.github.tntkhang:realm-encryption-helper:aar:1.0.0'

Apache Ivy

<dependency org="com.github.tntkhang" name="realm-encryption-helper" rev="1.0.0">
  <artifact name="realm-encryption-helper" type="aar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.tntkhang', module='realm-encryption-helper', version='1.0.0')
)

Scala SBT

libraryDependencies += "com.github.tntkhang" % "realm-encryption-helper" % "1.0.0"

Leiningen

[com.github.tntkhang/realm-encryption-helper "1.0.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

realm-encryption-helper

This is a lightweight library to generate a 64-bit random key and using AES Algorithm to encrypt/decrypt that random number to get a Secret Key and save it to Key Store.

This library especially supports for Realm Encryption. That means when using you don't have to care about how to get a random key, where to save that key for safe,... this library will take it.

Support all android version

Setup and using

1. Add library to your build.gradle in app level

implementation 'com.github.tntkhang:realm-encryption-helper:1.0.2'

2.In your CustomeApplication where you init your Realm

// Config RealmEncryptionHelper
RealmEncryptionHelper realmEncryptionHelper = RealmEncryptionHelper.initHelper(this, getString(R.string.app_name));

// Config Realm
Realm.init(this);
RealmConfiguration config = new RealmConfiguration.Builder()
         .name("realm_encrypt.realm")
         .encryptionKey(realmEncryptionHelper.getEncryptKey()) // Call realmEncryptionHelper to get encrypt key
         .build();
 Realm.setDefaultConfiguration(config);

with this code

realmEncryptionHelper.getEncryptKey()

The library will check and generate a new key if your app doesn't contain the key in Key Store before and then save it to Key Store, otherwise, it will be got from Key Store.

DEMO

Download and run project for simple demo

That is, let's enjoy!

Versions

Version
1.0.0 Dec 28, 2017