#Hawk Secure, simple key-value storage for android
Hawk uses:
- AES for the crypto
- SharedPreferences or Sqlite for the storage
- Gson for parsing
Hawk provides:
- Secure data persistence
- Save any type
###Add dependency
compile 'com.orhanobut:hawk:1.17'
If you want to have Rx features, make sure to add Rx dependency
Hawk.init(this)
.setEncryptionMethod(HawkBuilder.EncryptionMethod.MEDIUM)
.setStorage(HawkBuilder.newSqliteStorage(this))
.setLogLevel(LogLevel.FULL)
.build();
You can use highest secure crypto approach, init might take 36-400ms. You also need to provide password
Hawk.init(this)
.setEncryptionMethod(HawkBuilder.EncryptionMethod.HIGHEST)
.setStorage(HawkBuilder.newSqliteStorage(this))
.setLogLevel(LogLevel.FULL)
.build();
You can use no-crypto mode if you don't want encryption. This mode will be automatically used if the device does not support AES, PBE algorithm.
Hawk.init(context)
.setEncryptionMethod(HawkBuilder.EncryptionMethod.NO_ENCRYPTION)
.build();
Select the storage, you can either use sharedpreferences or sqlite to store data
.setStorage(HawkBuilder.newSqliteStorage(this))
or
.setStorage(HawkBuilder.newSharedPrefStorage(this))
You may want to use async solution for init. Add a callback to init and it will work asynchronous.
Hawk.init(this)
.setEncryptionMethod(HawkBuilder.EncryptionMethod.HIGHEST)
.setPassword("password")
.setStorage(HawkBuilder.newSqliteStorage(this))
.setLogLevel(LogLevel.FULL)
.setCallback(new HawkBuilder.Callback() {
@Override
public void onSuccess() {
}
@Override
public void onFail(Exception e) {
}
})
.build();
put method accept any type such as list, map, primitive...
Hawk.put(key, T); // Returns the result as boolean
You can also store multiple items at once by using chain feature. Remember to use commit() at the end. Either all of them will be saved or none.
// Returns the result as boolean
Hawk.chain()
.put(KEY_LIST, List<T>)
.put(KEY_ANOTHER,"test")
.commit();
Observable<Boolean> result = Hawk.putObservable(key, T); // Returns the result as boolean
example usage
Hawk.putObservable(KEY, new Foo())
.observeOn(Schedulers.io())
.subscribeOn(AndroidSchedulers.mainThread())
.subscribe(new Subscriber<Boolean>() {
@Override
public void onCompleted() {
}
@Override
public void onError(Throwable e) {
}
@Override
public void onNext(Boolean s) {
}
});
T result = Hawk.get(key);
or with default value
T result = Hawk.get(key, T);
To be able to use rx support, you need to add the dependency.
Observable<T> result = Hawk.getObservable(key);
or with default value
Observable<T> result = Hawk.getObservable(key, T);
example usage
Hawk.<Foo>getObservable(KEY)
.observeOn(Schedulers.io())
.subscribeOn(AndroidSchedulers.mainThread())
.subscribe(new Subscriber<Foo>() {
@Override
public void onCompleted() {
Log.d("rxtest", "completed");
}
@Override
public void onError(Throwable e) {
Log.d("rxtest", "error");
}
@Override
public void onNext(Foo s) {
Log.d("rxtest", s.toString());
}
});
Hawk.remove(key); // Returns the result as boolean
or you can remove multiple items at once
Hawk.remove(KEY_LIST, KEY_NAME); // Returns the result as boolean
boolean contains = Hawk.contains(key);
Hawk.init(context,PASSWORD, LogLevel.FULL); // as default it is NONE
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
Hawk.put("key", Map<Foo,Foo>); // save map
Hawk.put("key", Set<Foo>); // save set
Hawk.put("key", 1234); // save numbers
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);
Map<String,Foo> value = Hawk.get(key);
Set<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>);
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.
| Hawk (ms) | init | security| Primitive | Object | List | Map | Set | | | | level | PUT/GET | PUT/GET| PUT/GET | PUT/GET | PUT/SET | |------------------|------|---------|-----------|--------|---------|---------|---------| | With password | 24 | high | 26 | 2 | 14 | 1 | 20 | 36 | 12 | 4 | 15 | 3 | | Without password | 16 | less | 14 | 2 | 8 | 1 | 20 | 30 | 12 | 3 | 9 | 3 | | No encryption | 14 | none | 9 | 2 | 8 | 1 | 20 | 30 | 11 | 3 | 9 | 3 | | Prefs | 5 | none | 8 | 1 | 10 | 1 | 30 | 9 | 14 | 2 | 17 | 2 |
- Password should be provided by the user, we try to find better solution for this.
- 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.
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/
- Wasp All-in-one network solution
- Bee QA/Debug tool
- DialogPlus Easy,simple dialog solution
- SimpleListView Simple basic listview implementation with linearlayout
- Logger Simple, pretty and advanced logger
###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.