Documentation for integration with Room, proguard rules are missing in this repository

[UKMIITB]

Can you please add documentation for the following in this repository

1. Integration with room
2. proguard rules that are required

Also can you elaborate a bit more on External dependencies section of readme.
I am using this dependency for integration with room for encryption. Do I have to carry out the steps posted in External dependencies section before publishing the app ?

[developernotes]

Hi @UKMIITB,

Thank you for your interest in SQLCipher for Android. We will look into clarifying the documentation around integration with the Room API. Currently we note the library includes a SupportOpenHelperFactory within our migration guide ¹. Additionally, we include a sample Room integration within the test suite here ². In terms of the external dependencies, that is detailed here ³. Our next public release will include ProGuard support. The external dependencies section ⁴ is only relevant when building sqlcipher-android from source where you would be required to provide an Android-compatible OpenSSL library for linking.

Footnotes

1. https://www.zetetic.net/sqlcipher/sqlcipher-for-android-migration/#room-api ↩

2. https://github.com/sqlcipher/sqlcipher-android/blob/master/sqlcipher/src/androidTest/java/net/zetetic/database/sqlcipher_cts/SupportAPIRoomTest.java ↩

3. https://www.zetetic.net/sqlcipher/sqlcipher-for-android/#community-edition-integration ↩

4. https://github.com/sqlcipher/sqlcipher-android#external-dependencies ↩

[UKMIITB]

@developernotes
Just to add one point, System.loadLibrary("sqlcipher") is not much helpful. And it causes crash in some devices with .so file not found exception when we go to production.

What helped us was SplitInstallHelper.loadLibrary(context, "sqlcipher")
Would be good if this part is added in documentation as well

[developernotes]

Hi @UKMIITB,

Are you deploying your application Android App Bundles by chance?

[UKMIITB]

@developernotes
Yes we are using aab for deploying.
I think now aab is the recommended way for publishing app on play store

[developernotes]

Hi @UKMIITB,

I am circling back to this ticket to see if you are interested in evaluating a new beta build of SQLCipher for Android which includes improved consumer ProGuard rules. We have shared additional information about this in #78. Please feel free to reach out if you're interested in evaluating the new build.

Thank you,