wjie2014/hawk

#Hawk Secure, simple key-value storage for android

Hawk uses:

AES for the crypto
SharedPreferences for the storage
Gson for parsing

Hawk provides:

Secure data persistence
Save any type
Save list of any type

###Add dependency

repositories {
    maven { url "https://oss.sonatype.org/content/repositories/snapshots/"}
}
dependencies {
    compile 'com.orhanobut:hawk:1.4-SNAPSHOT'
}

Initialize the hawk

Hawk.init(context, PASSWORD);

Save

Hawk.put(key, T);

Hawk.put(key, List<T>);

Get

T result = Hawk.get(key);

or with default value

T result = Hawk.get(key, T);

Remove

Hawk.remove(key);

Contains

boolean contains = Hawk.contains(key);

Set the log output (optional)

Hawk.init(context,PASSWORD, LogLevel.FULL); // as default it is NONE

More samples for save

Hawk.put("key", "something"); // Save string
Hawk.put("key", true); // save boolean
Hawk.put("key", new Foo()); // save an object
Hawk.put("key", List<String>); // save list
Hawk.put("key", List<Foo>); // save list of any type
Hawk.put("key", 1234); // save numbers

More samples for get

String value = Hawk.get(key);
int value = Hawk.get(key);
Foo value = Hawk.get(key);
boolean value = Hawk.get(key);
List<String> value = Hawk.get(key);
List<Foo> value = Hawk.get(key);

or with the defaults

String value = Hawk.get(key, "");
int value = Hawk.get(key, 0);
Foo value = Hawk.get(key, new Foo());
boolean value = Hawk.get(key, false);
List<String> value = Hawk.get(key, Collections.emptyList());
List<Foo> value = Hawk.get(key, new ArrayList<Foo>);

Benchmark result (ms)

Done with Nexus 4, Android L. Note that this is not certain values, I just made a few runs and show it to give you an idea.

How Hawk works

Notes

Password should be provided by the user, we try to find better solution for this.
Hawk.init() takes around 200-500ms depends on the phone.
Salt key is stored plain text in the storage currently. We are checking to find a better solution for this. Any contribution about this will be great help as well.

Credits

I use the following implementation for the crypto and I believe it should get more attention. Thanks for this great hard work. https://github.com/tozny/java-aes-crypto and a great article about it : http://tozny.com/blog/encrypting-strings-in-android-lets-make-better-mistakes/

###License

Copyright 2015 Orhan Obut

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.

wjie2014 / hawk