✔️ Secure, simple key-value storage for Android

Thanks for creating this.

I am trying to use Hawk in one of my projects but getting the bellow error on some Samsung devices:

java.lang.RuntimeException: java.security.NoSuchAlgorithmException: SecretKeyFactory PBKDF2WithHmacSHA1 implementation not found

Any workaround for that?. Thanks.

The goal

CRUD one object in secure way and super fast.

Hawk should do only and only one thing and it should do it best.

Known Issues

• Startup time is quite long and this creates frictions
• Selecting right encryption option is complex, Strong, medium, no encryption etc creates confusion.
• Some devices don't have required encryption packages
• Serialization/Deserialization problems. Usually object is saved but .get() function returns null.
• Performance issues
• Singleton

Hawk 2.0

• [x] Use only one mode as default. Fast and secure persistency.
• [x] Reduce the startup time, therefore users won't need async operation for initialization. Better, find a way to remove init operation.
• [x] Reduce the time for the CRUD operations. Async operation should be only used for very big data.
• [x] Async utility is up to the client, therefore everything should be sync
• [x] Use only one storage provider and keep it pluggable. Currently sqlite and sharedpreferences are both supported but Hawk should not be used for a lot of data already. Most probably only sharedpref will be supported as built-in.
• [ ] Hawk.init() should be optional.
• [x] Provide pluggable logger abstraction. Implementation should be up to client. Therefore remove LogLevel
• [x] Remove chain option.
• [x] Provide pluggable storage.
• [x] Provide pluggable converter

// Initialization
Hawk.init(context);

// Save any data
Hawk.put(key, T);

// Get the original data
T t = Hawk.get(key);

// Delete 
Hawk.delete(key);

// Contains
boolean value = Hawk.contains(key);

// Total count
int count = Hawk.count();

// Delete all entries
Hawk.deleteAll();

// intercept logs
Hawk.init(context).interceptLog(new LogInterceptor(){
   @Override public void onLog(String message){
    }
});

// plug converter
Hawk.init(context).addConverter(new YourCustomConverter());

// plug storage
Hawk.init(context).addStorage(new YourCustomStorage());

To be continued

I am using version 1.17,

We are getting this error on some of the devices, (HUAWEI Y300-0100, VS930 4G, GT-18552, LG-F100L). Affected operating systems are(Android 4.1.1 and 4.1.2). Locale is all "en". This is our full error stacktrace

at android.app.ActivityThread.handleBindApplication(ActivityThread.java:4247) at android.app.ActivityThread.access$1300(ActivityThread.java:137) at android.app.ActivityThread$H.handleMessage(ActivityThread.java:1270) at android.os.Handler.dispatchMessage(Handler.java:99) at android.os.Looper.loop(Looper.java:137)
at android.app.ActivityThread.main(ActivityThread.java:4838) at java.lang.reflect.Method.invokeNative(Native Method) at java.lang.reflect.Method.invoke(Method.java:511) at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:875) at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:642) at dalvik.system.NativeStart.main(Native Method) Caused by: java.lang.IllegalArgumentException: Cannot parse iv:ciphertext:mac at com.orhanobut.hawk.AesCbcWithIntegrity$CipherTextIvMac.(AesCbcWithIntegrity.java:538) at com.orhanobut.hawk.AesEncryption.getCipherTextIvMac(AesEncryption.java:77) at com.orhanobut.hawk.AesEncryption.decrypt(AesEncryption.java:62) at com.orhanobut.hawk.Hawk.get(Hawk.java:132)

Thanks

I am receiving some crash logs which I suspect is related to Hawk. Here's the log:

java.lang.ArrayIndexOutOfBoundsException: src.length=75 srcPos=0 dst.length=0 dstPos=0 length=57
       at java.lang.System.arraycopy(System.java)
       at java.lang.String.getChars(String.java:889)
       at com.android.internal.util.FastXmlSerializer.append(FastXmlSerializer.java:89)
       at com.android.internal.util.FastXmlSerializer.append(FastXmlSerializer.java:113)
       at com.android.internal.util.FastXmlSerializer.startDocument(FastXmlSerializer.java:326)
       at com.android.internal.util.XmlUtils.writeMapXml(XmlUtils.java:183)
       at android.app.SharedPreferencesImpl.writeToFile(SharedPreferencesImpl.java:598)
       at android.app.SharedPreferencesImpl.access$800(SharedPreferencesImpl.java:52)
       at android.app.SharedPreferencesImpl$2.run(SharedPreferencesImpl.java:513)
       at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1080)
       at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:573)
       at java.lang.Thread.run(Thread.java:838)

In all of the crashes src.length is 75 and length is 57. Maybe it's the salt or some other key that is stored by Hawk? Crashes occurred on devices like: HUAWEI Y320-U30, HUAWEI Y511-U30. I also can tell that this crashes occurs on the startup of the application. Any idea why this is happening?

On some devices with old updates, PRNG is broken, causing crashes. For example Nokia XL with Android 4.1. In latest updates to AesCbcWithIntegrity this flag is introduced:

private static final boolean ALLOW_BROKEN_PRNG = false;

which if set to true will prevent SecurityException on such devices in places like:

if (!rng2.getProvider().getClass().getSimpleName().equals("LinuxPRNGSecureRandomProvider")) {
    if (ALLOW_BROKEN_PRNG) {
            Log.w(PrngFixes.class.getSimpleName(),
                    "SecureRandom.getInstance(\"SHA1PRNG\") backed by wrong" + " Provider: "
                    + rng2.getProvider().getClass());
            return;
    } else {
            throw new SecurityException(
                "SecureRandom.getInstance(\"SHA1PRNG\") backed by wrong" + " Provider: "
                + rng2.getProvider().getClass());
    }
}

Without that on some devices crashes like this will occur as stated above:

java.lang.SecurityException: SecureRandom.getInstance("SHA1PRNG") backed by wrong Provider: class org.apache.harmony.security.provider.crypto.CryptoProvider
       at com.c.a.c.d(AesCbcWithIntegrity.java:718)
       at com.c.a.c.a(AesCbcWithIntegrity.java:642)
       at com.c.a.a.d(AesCbcWithIntegrity.java:313)
       at com.c.a.a.a(AesCbcWithIntegrity.java:219)
       at com.c.a.a.c(AesCbcWithIntegrity.java:215)
       at com.c.a.a.a(AesCbcWithIntegrity.java:289)
       at com.c.a.g.a(AesEncryption.java:45)
       at com.c.a.n.b(Hawk.java:218)
       at com.c.a.n.a(Hawk.java:174)
       ...

I think as an encrypted storage library, Hawk should allow broken PRNG. I also don't see why Hawk is not using the latest version of AesCbcWithIntegrity. Are there any conflicts? I suggest updating to the latest AesCbcWithIntegrity and setting that flag to true. I can send a pull request with these changes if that's ok. Just let me know.

Caused by: java.lang.NullPointerException at com.orhanobut.hawk.AesCbcWithIntegrity.decrypt(AesCbcWithIntegrity.java:368) at com.orhanobut.hawk.AesEncryption.decrypt(AesEncryption.java:61) at com.orhanobut.hawk.Hawk.get(Hawk.java:220) at com.orhanobut.hawk.Hawk.get(Hawk.java:237)

First of all, great start to this library- I sense a real need for a solid encrypted key/value store in the Android ecosystem.

I'm working on a use case that requires a set of encrypted stores, where one is semi-secure (encrypted by a secret in the app binary) and another is encrypted using a value inputted from the user. Hawk has most of the features I need but I think its singleton nature is a limitation here.

Some ideas:

• Add a public constructor to Hawk
• All Hawk.java getter/setter methods become instance methods

Questions for you:

• Do you still see the need for a singleton instance of Hawk? Is it good enough to let users create one with new Hawk() and manage that object themselves? Or maybe have 1 global instance (Hawk.getInstance()) as well as a public constructor?
• Logger becomes an issue if Hawk is no longer a singleton, because the Logger instance must be passed down the object hierarchy.

I've already started some of this, but was interested in your feedback.

I've created a "status" field for Hawk. In this way the dev can know if Hawk is ready to be used and Hawk itself avoid operations if it has not been initialised

StrictMode showed that .build() was doing a lot of work on the main thread, even with the callback setup. I tried to wrap the callback with Rx, but I was having issue with Schedulers, Looper, Handler and so on. I have just created a new method that wraps the synchronous .startbuild(), and exposes an Observable version of build().

Hi there, I defined a Class named Foo.

public class Foo {

    private String carSeries;
    private Uri carImageUri;
    private String carType;


    public String getCarSeries() {
        return carSeries;
    }

    public void setCarSeries(String carSeries) {
        this.carSeries = carSeries;
    }

    public Uri getCarImageUri() {
        return carImageUri;
    }

    public void setCarImageUri(Uri carImageUri) {
        this.carImageUri = carImageUri;
    }

    public String getCarType() {
        return carType;
    }

    public void setCarType(String carType) {
        this.carType = carType;
    }

    @Override
    public String toString() {
        return "Foo{" +
            "carSeries='" + carSeries + '\'' +
            ", carImageUri=" + carImageUri +
            ", carType='" + carType + '\'' +
            '}';
    }
}

List<Foo> foos = new ArrayList<Foo>();
foos.add(new Foo());
foos.add(new Foo());
Hawk.put(Constant.PREF_FOO, foos);

but Hawk.get(Constant.PREF_FOO, new ArrayList<Foo>()); always return list which size is 0(default value).

Hi there, I have been having a crash when the app returns from background, specifically after a few hours. It seems Hawk instance is removed and it becomes null. Throwing exception

java.lang.NullPointerException: Attempt to invoke interface method 'java.lang.Object com.orhanobut.hawk.Storage.get(java.lang.String)' on a null object reference at com.orhanobut.hawk.Hawk.get

I have tried re-initializing Hawk onResume but does'nt seem to help.

Any suggestions?

Thanks

Please try to fill all questions below before submitting an issue.

• [x] On which android versions do you have this issue? : Android 10
• [x] On which phones do you have this issue? : Redmi note 7 pro
• [x] Which hawk version are you using? : "com.orhanobut:hawk:2.0.1"
• [x] Does this issue happen always or is it flaky? : always
• [ ] Can you write failing test? :
• [x] Is the data you are trying to save it huge or small? : small
• [x] If it is Hawk.put and Hawk.get issue, can you write down which data you were trying to save and get it back? List<StickerPack> packs = Hawk.get("sticker_packs", new ArrayList<StickerPack>());

app stored 158 sticker packs and whatsapp can access those sticker packs. But when I tried to access it withing class it give only one item which last added item while Hawk.count() gives proper count. I saw there is syntax for single or multiple items retrieval. But when I pass second argument as boolean it gives error that it accepts (key, type).

Please try to fill all questions below before submitting an issue.

• [x] On which android versions do you have this issue? : android > 11
• [x] On which phones do you have this issue? : Samsung & vivo
• [x] Which hawk version are you using? : 2.0.1
• [x] Does this issue happen always or is it flaky? : yes
• [x] Can you write failing test? : It's hard to test since in my emulator everything looks normal.
• [ ] If it is Hawk.put and Hawk.get issue, can you write down which data you were trying to save and get it back? : Issue only happened when device state in background. It's causing ANR and there is no user journey detecting in Crashlytics
• [ ] Is the data you are trying to save it huge or small?

Log Error

main (runnable): tid=1 systid=31973 
       at com.google.gson.FieldNamingPolicy.<init>(FieldNamingPolicy.java)
       at com.google.gson.FieldNamingPolicy.<init>(FieldNamingPolicy.java)
       at com.google.gson.FieldNamingPolicy$1.<init>(FieldNamingPolicy.java)
       at com.google.gson.FieldNamingPolicy.<clinit>(FieldNamingPolicy.java)
       at com.google.gson.Gson.<init>(Gson.java)
       at com.orhanobut.hawk.HawkBuilder.getParser(HawkBuilder.java)
       at com.orhanobut.hawk.HawkBuilder.getConverter(HawkBuilder.java)
       at com.orhanobut.hawk.DefaultHawkFacade.<init>(DefaultHawkFacade.java)
       at com.orhanobut.hawk.Hawk.build(Hawk.java)
       at com.orhanobut.hawk.HawkBuilder.build(HawkBuilder.java)
       at com.tribunnews.app.TribunNewsApplication.onCreate(TribunNewsApplication.java)
       at android.app.Instrumentation.callApplicationOnCreate(Instrumentation.java:1192)
       at android.app.ActivityThread.handleBindApplication(ActivityThread.java:7593)
       at android.app.ActivityThread.access$1500(ActivityThread.java:301)
       at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2177)
       at android.os.Handler.dispatchMessage(Handler.java:106)
       at android.os.Looper.loop(Looper.java:246)
       at android.app.ActivityThread.main(ActivityThread.java:8653)
       at java.lang.reflect.Method.invoke(Method.java)
       at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:602)
       at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1130)

Incremental compilation. Gradle recompile only the classes that were affected by a change. This feature is the default since Gradle 4.10. For an older versions, we can activate it by setting options.incremental = true.

===================== If there are any inappropriate modifications in this PR, please give me a reply and I will change them.

Please try to fill all questions below before submitting an issue.

• [ ] On which android versions do you have this issue? : every version
• [ ] On which phones do you have this issue? : xiaomi 8 lite
• [ ] Which hawk version are you using? : 2.0.1
• [ ] Does this issue happen always or is it flaky? : no
• [ ] Can you write failing test? : no
• [ ] If it is Hawk.put and Hawk.get issue, can you write down which data you were trying to save and get it back?no
• [ ] Is the data you are trying to save it huge or small? small

i am using Hawk in a project (A), it's publishing in google play. Now, i created another project (B), I let the appId of 2 projects overlap, I increased the version code and version name on B, B can override A but B can't get data in A.

in project A, i saved String by Hawk, when B override A, B can read this data, but when i save object in A, B can't read it. What have i do?

Thanks

Hi I new in kotlin and when use Hawk.get(key), get error below: Classifier 'Hawk' does not have a companion object, and thus must be initialized here

please help me