Android?Room數(shù)據(jù)庫加密詳解
更新時間：2022年01月17日 11:56:08 作者：最萌小熊貓
這篇文章主要為大家詳細介紹了Android?Room數(shù)據(jù)庫加密，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
本文實例為大家分享了Android Room之數(shù)據(jù)庫加密的具體實現(xiàn)，供大家參考，具體內(nèi)容如下
一、需求背景
Android平臺自帶的SQLite有一個致命的缺陷：不支持加密。這就導致存儲在SQLite中的數(shù)據(jù)可以被任何人用任何文本編輯器查看到。如果是普通的數(shù)據(jù)還好，但是當涉及到一些賬號密碼，或者聊天內(nèi)容的時候，我們的應用就會面臨嚴重的安全漏洞隱患。
二、加密方案
1、在數(shù)據(jù)存儲之前進行加密，在加載數(shù)據(jù)之后再進行解密，這種方法大概是最容易想的到，而且也不能說這種方式不好，就是有些比較繁瑣。 如果項目有特殊需求的話，可能還需要對數(shù)據(jù)庫的表明，列明也進行加密。
2、對數(shù)據(jù)庫整個文件進行加密，好處就是就是無需在插入之前對數(shù)據(jù)加密，也無需在查詢數(shù)據(jù)之后再解密。比較出名的第三方庫就是SQLCipher，它采用的方式就是對數(shù)據(jù)庫文件進行加密，只需在打開數(shù)據(jù)庫的時候輸入密碼，之后的操作更正常操作沒有區(qū)別。
三、Hook Room實現(xiàn)方式
前面說了，加密的方式一比較繁瑣的地方是需要在存儲數(shù)據(jù)之前加密，在檢索數(shù)據(jù)之后解密，那么是否有一種方式在Room操作數(shù)據(jù)庫的過程中，自動對數(shù)據(jù)加密解密，答案是有的。
Dao編譯之后的代碼是這樣的：
@Override
public long saveCache(final CacheTest cache) {
? __db.assertNotSuspendingTransaction();
? __db.beginTransaction();
? try {
? //核心代碼，綁定數(shù)據(jù)
? ? long _result = __insertionAdapterOfCacheTest.insertAndReturnId(cache);
? ? __db.setTransactionSuccessful();
? ? return _result;
? } finally {
? ? __db.endTransaction();
? }
}__insertionAdapterOfCacheTest 是在CacheDaoTest_Impl 的構(gòu)造方法里面創(chuàng)建的一個匿名內(nèi)部類，這個匿名內(nèi)部類實現(xiàn)了bind 方法
public CacheDaoTest_Impl(RoomDatabase __db) {
? this.__db = __db;
? this.__insertionAdapterOfCacheTest = new EntityInsertionAdapter<CacheTest>(__db) {
? ? @Override
? ? public String createQuery() {
? ? ? return "INSERT OR REPLACE INTO `table_cache` (`key`,`name`) VALUES (?,?)";
? ? }
? ? @Override
? ? public void bind(SupportSQLiteStatement stmt, CacheTest value) {
? ? ? if (value.getKey() == null) {
? ? ? ? stmt.bindNull(1);
? ? ? } else {
? ? ? ? stmt.bindString(1, value.getKey());
? ? ? }
? ? ? if (value.getName() == null) {
? ? ? ? stmt.bindNull(2);
? ? ? } else {
? ? ? ? stmt.bindString(2, value.getName());
? ? ? }
? ? }
? };
}關于SQLiteStatement 不清楚的同學可以百度一下，簡單說他就代表一句sql語句，bind 方法就是綁定sql語句所需要的參數(shù)，現(xiàn)在的問題是我們可否自定義一個SupportSQLiteStatement ，然后在bind的時候加密參數(shù)呢。
我們看一下SupportSQLiteStatement 的創(chuàng)建過程。
public SupportSQLiteStatement acquire() {
? ? ?assertNotMainThread();
? ? ?return getStmt(mLock.compareAndSet(false, true));
?}
?
?private SupportSQLiteStatement getStmt(boolean canUseCached) {
? ? ?final SupportSQLiteStatement stmt;
? ? ?//代碼有刪減
? ? ? ? stmt = createNewStatement();
? ? ?return stmt;
?}
kotlin
?private SupportSQLiteStatement createNewStatement() {
? ? ?String query = createQuery();
? ? ?return mDatabase.compileStatement(query);
?}可以看到SupportSQLiteStatement 最終來自RoomDataBase的compileStatement 方法，這就給我們hook 提供了接口，我們只要自定義一個SupportSQLiteStatement 類來代理原來的SupportSQLiteStatement 就可以了。
encoder 就是用來加密數(shù)據(jù)的。
加密數(shù)據(jù)之后剩余的就是解密數(shù)據(jù)了，解密數(shù)據(jù)我們需要在哪里Hook呢？
我們知道數(shù)據(jù)庫檢索返回的數(shù)據(jù)一般都是通過Cursor 傳遞給用戶，這里我們就可以通過代理數(shù)據(jù)庫返回的這個Cursor 進而實現(xiàn)解密數(shù)據(jù)。
@Database(entities = [CacheTest::class], version = 3)
abstract class TestDb : RoomDatabase() {
? ? abstract fun testDao(): CacheDaoTest
? ? companion object {
? ? ? ? val MIGRATION_2_1: Migration = object : Migration(2, 1) {
? ? ? ? ? ? override fun migrate(database: SupportSQLiteDatabase) {
? ? ? ? ? ? }
? ? ? ? }
? ? ? ? val MIGRATION_2_3: Migration = object : Migration(2, 3) {
? ? ? ? ? ? override fun migrate(database: SupportSQLiteDatabase) {
? ? ? ? ? ? }
? ? ? ? }
? ? ? ? val MIGRATION_3_4: Migration = object : Migration(3,4) {
? ? ? ? ? ? override fun migrate(database: SupportSQLiteDatabase) {
? ? ? ? ? ? }
? ? ? ? }
? ? ? ? val MIGRATION_2_4: Migration = object : Migration(2, 4) {
? ? ? ? ? ? override fun migrate(database: SupportSQLiteDatabase) {
? ? ? ? ? ? }
? ? ? ? }
? ? }
? ? private val encoder: IEncode = TestEncoder()
? ? override fun query(query: SupportSQLiteQuery): Cursor {
? ? ? ? var cusrosr = super.query(query)
? ? ? ? println("開始查詢1")
? ? ? ? return DencodeCursor(cusrosr, encoder)
? ? }
? ? override fun query(query: String, args: Array<out Any>?): Cursor {
? ? ? ? var cusrosr = super.query(query, args)
? ? ? ? println("開始查詢2")
? ? ? ? return DencodeCursor(cusrosr, encoder)
? ? }
? ? override fun query(query: SupportSQLiteQuery, signal: CancellationSignal?): Cursor {
? ? ? ? println("開始查詢3")
? ? ? ? return DencodeCursor(super.query(query, signal), encoder)
? ? }
}我們這里重寫了RoomDatabase 的是query 方法，代理了原先的Cursor 。
class DencodeCursor(val delete: Cursor, val encoder: IEncode) : Cursor {
//代碼有刪減
? ? override fun getString(columnIndex: Int): String {
? ? ? ? return encoder.decodeString(delete.getString(columnIndex))
? ? }
}如上，最終加密解密的都被hook在了Room框架中間。但是這種有兩個個缺陷
加密解密的過程中不可以改變數(shù)據(jù)的類型，也就是整型在加密之后還必須是整型，整型在解密之后也必須是整型。同時有些字段可能不需要加密也不需要解密，例如自增長的整型的primary key。其實這種方式也比較好解決，可以規(guī)定key 為整數(shù)型，其余的數(shù)據(jù)一律是字符串。這樣所有的樹數(shù)字類型的數(shù)據(jù)都不需要參與加密解密的過程。
sql 與的參數(shù)必須是動態(tài)綁定的，而不是在sql語句中靜態(tài)指定。
@Query("select * from table_cache where `key`=:primaryKey")
fun getCache(primaryKey: String): LiveData<CacheTest>@Query("select * from table_cache where `key`= '123' ")
fun getCache(): LiveData<CacheTest>四、SQLCipher方式
SQLCipher 仿照官方的架構(gòu)自己重寫了一套代碼，官方提供的各種數(shù)據(jù)庫相關的類在SQLCipher 里面也是存在的而且名字都一樣除了包名不同。
SQLCipher 與Room的結(jié)合方式同上面的情形是類似，也是通過代理的方式實現(xiàn)。由于Room需要的類跟SQLCipher 提供的類包名不一致，所以這里需要對SQLCipher 提供的類進行一下代理然后傳遞給Room架構(gòu)使用就可以了。
fun init(context: Context) {
? val ?mDataBase1 = Room.databaseBuilder(
? ? ? ? context.applicationContext,
? ? ? ? TestDb::class.java,
? ? ? ? "user_login_info_db"
? ? ).openHelperFactory(SafeHelperFactory("".toByteArray()))
? ? ? .build()
}這里主要需要自定義一個SupportSQLiteOpenHelper.Factory也就是SafeHelperFactory 這個SafeHelperFactory 完全是仿照Room架構(gòu)默認的Factory 也就是FrameworkSQLiteOpenHelperFactory 實現(xiàn)。主要是用戶創(chuàng)建一個用于打開數(shù)據(jù)庫的SQLiteOpenHelper，主要的區(qū)別是自定義的Facttory 需要一個用于加密與解密的密碼。
我們首先需要定義一個自己的OpenHelperFactory
public class SafeHelperFactory implements SupportSQLiteOpenHelper.Factory {
? public static final String POST_KEY_SQL_MIGRATE = "PRAGMA cipher_migrate;";
? public static final String POST_KEY_SQL_V3 = "PRAGMA cipher_compatibility = 3;";
? final private byte[] passphrase;
? final private Options options;
?
? public SafeHelperFactory(byte[] passphrase, Options options) {
? ? this.passphrase = passphrase;
? ? this.options = options;
? }
? /**
? ?* {@inheritDoc}
? ?*/
? @Override
? public SupportSQLiteOpenHelper create(
? ? SupportSQLiteOpenHelper.Configuration configuration) {
? ? return(create(configuration.context, configuration.name,
? ? ? configuration.callback));
? }
? public SupportSQLiteOpenHelper create(Context context, String name,
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? SupportSQLiteOpenHelper.Callback callback) {
? ? ?//創(chuàng)建一個Helper
? ? return(new Helper(context, name, callback, passphrase, options));
? }
? private void clearPassphrase(char[] passphrase) {
? ? for (int i = 0; i < passphrase.length; i++) {
? ? ? passphrase[i] = (byte) 0;
? ? }
? }SafeHelperFactory 的create創(chuàng)建了一個Helper，這個Helper實現(xiàn)了Room框架的SupportSQLiteOpenHelper ，實際這個Helper 是個代理類被代理的類為OpenHelper ，OpenHelper 用于操作SQLCipher 提供的數(shù)據(jù)庫類。
class Helper implements SupportSQLiteOpenHelper {
? private final OpenHelper delegate;
? private final byte[] passphrase;
? private final boolean clearPassphrase;
? Helper(Context context, String name, Callback callback, byte[] passphrase,
? ? ? ? ?SafeHelperFactory.Options options) {
? ? SQLiteDatabase.loadLibs(context);
? ? clearPassphrase=options.clearPassphrase;
? ? delegate=createDelegate(context, name, callback, options);
? ? this.passphrase=passphrase;
? }
? private OpenHelper createDelegate(Context context, String name,
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? final Callback callback, SafeHelperFactory.Options options) {
? ? final Database[] dbRef = new Database[1];
? ? return(new OpenHelper(context, name, dbRef, callback, options));
? }
? /**
? ?* {@inheritDoc}
? ?*/
? @Override
? synchronized public String getDatabaseName() {
? ? return delegate.getDatabaseName();
? }
? /**
? ?* {@inheritDoc}
? ?*/
? @Override
? @RequiresApi(api = Build.VERSION_CODES.JELLY_BEAN)
? synchronized public void setWriteAheadLoggingEnabled(boolean enabled) {
? ? delegate.setWriteAheadLoggingEnabled(enabled);
? }
? @Override
? synchronized public SupportSQLiteDatabase getWritableDatabase() {
? ? SupportSQLiteDatabase result;
? ? try {
? ? ? result = delegate.getWritableSupportDatabase(passphrase);
? ? }
? ? catch (SQLiteException e) {
? ? ? if (passphrase != null) {
? ? ? ? boolean isCleared = true;
? ? ? ? for (byte b : passphrase) {
? ? ? ? ? isCleared = isCleared && (b == (byte) 0);
? ? ? ? }
? ? ? ? if (isCleared) {
? ? ? ? ? throw new IllegalStateException("The passphrase appears to be cleared. This happens by" +
? ? ? ? ? ? ? "default the first time you use the factory to open a database, so we can remove the" +
? ? ? ? ? ? ? "cleartext passphrase from memory. If you close the database yourself, please use a" +
? ? ? ? ? ? ? "fresh SafeHelperFactory to reopen it. If something else (e.g., Room) closed the" +
? ? ? ? ? ? ? "database, and you cannot control that, use SafeHelperFactory.Options to opt out of" +
? ? ? ? ? ? ? "the automatic password clearing step. See the project README for more information.");
? ? ? ? }
? ? ? }
? ? ? throw e;
? ? }
? ? if (clearPassphrase && passphrase != null) {
? ? ? for (int i = 0; i < passphrase.length; i++) {
? ? ? ? passphrase[i] = (byte) 0;
? ? ? }
? ? }
? ? return(result);
? }
? /**
? ?* {@inheritDoc}
? ?*
? ?* NOTE: this implementation delegates to getWritableDatabase(), to ensure
? ?* that we only need the passphrase once
? ?*/
? @Override
? public SupportSQLiteDatabase getReadableDatabase() {
? ? return(getWritableDatabase());
? }
? /**
? ?* {@inheritDoc}
? ?*/
? @Override
? synchronized public void close() {
? ? delegate.close();
? }
? static class OpenHelper extends SQLiteOpenHelper {
? ? private final Database[] dbRef;
? ? private volatile Callback callback;
? ? private volatile boolean migrated;
}真正操作數(shù)據(jù)庫的類OpenHelper，OpenHelper 繼承的SQLiteOpenHelper 是net.sqlcipher.database 包下的
static class OpenHelper extends SQLiteOpenHelper {
? ? private final Database[] dbRef;
? ? private volatile Callback callback;
? ? private volatile boolean migrated;
?OpenHelper(Context context, String name, final Database[] dbRef, final Callback callback,
? ? ? ? ? ? ? ?final SafeHelperFactory.Options options) {
? ? ? super(context, name, null, callback.version, new SQLiteDatabaseHook() {
? ? ? ? @Override
? ? ? ? public void preKey(SQLiteDatabase database) {
? ? ? ? ? if (options!=null && options.preKeySql!=null) {
? ? ? ? ? ? database.rawExecSQL(options.preKeySql);
? ? ? ? ? }
? ? ? ? }
? ? ? ? @Override
? ? ? ? public void postKey(SQLiteDatabase database) {
? ? ? ? ? if (options!=null && options.postKeySql!=null) {
? ? ? ? ? ? database.rawExecSQL(options.postKeySql);
? ? ? ? ? }
? ? ? ? }
? ? ? }, new DatabaseErrorHandler() {
? ? ? ? @Override
? ? ? ? public void onCorruption(SQLiteDatabase dbObj) {
? ? ? ? ? Database db = dbRef[0];
? ? ? ? ? if (db != null) {
? ? ? ? ? ? callback.onCorruption(db);
? ? ? ? ? }
? ? ? ? }
? ? ? });
? ? ? this.dbRef = dbRef;
? ? ? this.callback=callback;
? ? }
? ? synchronized SupportSQLiteDatabase getWritableSupportDatabase(byte[] passphrase) {
? ? ? migrated = false;
? ? ? SQLiteDatabase db=super.getWritableDatabase(passphrase);
? ? ? if (migrated) {
? ? ? ? close();
? ? ? ? return getWritableSupportDatabase(passphrase);
? ? ? }
? ? ? return getWrappedDb(db);
? ? }
? ? synchronized Database getWrappedDb(SQLiteDatabase db) {
? ? ? Database wrappedDb = dbRef[0];
? ? ? if (wrappedDb == null) {
? ? ? ? wrappedDb = new Database(db);
? ? ? ? dbRef[0] = wrappedDb;
? ? ? }
? ? ? return(dbRef[0]);
? ? }
? ? /**
? ? ?* {@inheritDoc}
? ? ?*/
? ? @Override
? ? public void onCreate(SQLiteDatabase sqLiteDatabase) {
? ? ? callback.onCreate(getWrappedDb(sqLiteDatabase));
? ? }
? ? /**
? ? ?* {@inheritDoc}
? ? ?*/
? ? @Override
? ? public void onUpgrade(SQLiteDatabase sqLiteDatabase, int oldVersion, int newVersion) {
? ? ? migrated = true;
? ? ? callback.onUpgrade(getWrappedDb(sqLiteDatabase), oldVersion, newVersion);
? ? }
? ? /**
? ? ?* {@inheritDoc}
? ? ?*/
? ? @Override
? ? public void onConfigure(SQLiteDatabase db) {
? ? ? callback.onConfigure(getWrappedDb(db));
? ? }
? ? /**
? ? ?* {@inheritDoc}
? ? ?*/
? ? @Override
? ? public void onDowngrade(SQLiteDatabase db, int oldVersion, int newVersion) {
? ? ? migrated = true;
? ? ? callback.onDowngrade(getWrappedDb(db), oldVersion, newVersion);
? ? }
? ? /**
? ? ?* {@inheritDoc}
? ? ?*/
? ? @Override
? ? public void onOpen(SQLiteDatabase db) {
? ? ? if (!migrated) {
? ? ? ? // from Google: "if we've migrated, we'll re-open the db so we ?should not call the callback."
? ? ? ? callback.onOpen(getWrappedDb(db));
? ? ? }
? ? }
? ? /**
? ? ?* {@inheritDoc}
? ? ?*/
? ? @Override
? ? public synchronized void close() {
? ? ? super.close();
? ? ? dbRef[0] = null;
? ? }
? }這里的OpenHelper 完全是仿照Room 框架下的OpenHelper 實現(xiàn)的。
以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。
相關文章
這篇文章主要為大家介紹了Android數(shù)據(jù)存儲方式操作模式解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-08-08
flutter中有默認的Route組件，叫做MaterialPageRoute，但是MaterialPageRoute太普通了，如果我們想要做點不同的跳轉(zhuǎn)特效應該如何處理呢？一起來看看吧2023-04-04
Android 中對JSON數(shù)據(jù)解析實例代碼
這篇文章主要介紹了Android 中對JSON數(shù)據(jù)解析實例代碼的相關資料,需要的朋友可以參考下2017-03-03
Android應用程序是通過消息來驅(qū)動的，系統(tǒng)為每一個應用程序維護一個消息隊例，應用程序的主線程不斷地從這個消息隊例中獲取消息（Looper），然后對這些消息進行處理（Handler），這樣就實現(xiàn)了通過消息來驅(qū)動應用程序的執(zhí)行，本文將詳細分析Android應用程序的消息處理機制2014-09-09
分析Android App中內(nèi)置換膚功能的實現(xiàn)方式
這篇文章主要介紹了Android App中內(nèi)置換膚功能的實現(xiàn)方式,文中舉了一個類似QQ空間中換膚方式的例子作為說明,需要的朋友可以參考下2016-02-02
這篇文章主要為大家詳細介紹了Android自定義控件實現(xiàn)餅狀圖，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-12-12
Android AAPT(Android Asset Packaging Too
AAPT - Android Asset Packaging Tool作用AAPT基本命令AAPT編譯資源源碼解析AAPT打包和系統(tǒng)不一致的資源2024-04-04
Android 中menu同時顯示圖標和文字的實現(xiàn)
這篇文章主要介紹了Android 中menu同時顯示圖標和文字的實現(xiàn)的相關資料,希望通過本文能幫助到大家實現(xiàn)這樣的功能，需要的朋友可以參考下2017-10-10
Flutter List數(shù)組避免插入重復數(shù)據(jù)的實現(xiàn)
這篇文章主要介紹了Flutter List數(shù)組避免插入重復數(shù)據(jù)的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-09-09
這篇文章主要為大家詳細介紹了Flutter實現(xiàn)滑動塊驗證碼功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-03-03