Android資料儲存之SQLCipher資料庫加密

總李寫程式碼發表於2016-07-30

前言：

最近研究了Android Sqlite資料庫（文章地址：Android資料儲存之Sqlite的介紹及使用）以及ContentProvider程式間資料共享（Android探索之ContentProvider熟悉而又陌生的元件），我們清晰的知道Sqlite資料庫預設存放位置data/data/pakage/database目錄下，對於已經ROOT的手機來說的沒有任何安全性可以，一旦被利用將會導致資料庫資料的洩漏，所以我們該如何避免這種事情的發生呢？我們嘗試這對資料庫進行加密。

選擇加密方案：

1.）第一種方案

我們可以對資料的資料庫名，表名，列名就行md5，對儲存的資料進行加密，例如進行aes加密（Android資料加密之Aes加密），查詢的時候再對資料進行解密，這種方式不能說不好，但是使用起來可以想象一下其帶來的麻煩程度。

2.）第二種方案

採用第三方加密開源庫，查詢了很多種Android 資料庫加密方案，最終選定SQLCipher這個開源框架，接下來看下SqlCipher如何使用。

SQLCipher簡介：

SQLCipher是一個在SQLite基礎之上進行擴充套件的開源資料庫，SQLCipher具有佔地面積小、效能因此它非常適合嵌入式應用的資料庫保護，非常適合於移動開發。

優勢：

加密效能高、開銷小，只要5-15%的開銷用於加密
完全做到資料庫100%加密
採用良好的加密方式（CBC加密模式）
使用方便，做到應用級別加密
採用OpenSSL加密庫提供的演算法

SQLCipher使用方式：

1.）在build.gradle文中新增如下程式碼,當前使用的是最新版本3.4.0

dependencies {

    compile 'net.zetetic:android-database-sqlcipher:3.4.0'

}

2.）建立一個SQLiteOpenHelper 注意接下來所以有關Sqlite相關類全部引用net.sqlcipher.database的類

import android.content.Context;
import android.util.Log;
import net.sqlcipher.SQLException;
import net.sqlcipher.database.SQLiteDatabase;
import net.sqlcipher.database.SQLiteOpenHelper;


public class DBCipherHelper extends SQLiteOpenHelper {
    private static final String TAG = "DatabaseHelper";
    private static final String DB_NAME = "test_cipher_db";//資料庫名字
    public static final String DB_PWD="whoislcj";//資料庫密碼
    public static String TABLE_NAME = "person";// 表名
    public static String FIELD_ID = "id";// 列名
    public static String  FIELD_NAME= "name";// 列名
    private static final int DB_VERSION = 1;   // 資料庫版本

    public DBCipherHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version) {
        super(context, name, factory, version);
        //不可忽略的 進行so庫載入
        SQLiteDatabase.loadLibs(context);
    }

    public DBCipherHelper(Context context) {
        this(context, DB_NAME, null, DB_VERSION);
    }

    /**
     * 建立資料庫
     * @param db
     */
    @Override
    public void onCreate(SQLiteDatabase db) {
        //建立表
        createTable(db);
    }

    private void createTable(SQLiteDatabase db){
        String  sql = "CREATE TABLE " + TABLE_NAME + "(" + FIELD_ID + " integer primary key autoincrement , " + FIELD_NAME + " text not null);";
        try {
            db.execSQL(sql);
        } catch (SQLException e) {
            Log.e(TAG, "onCreate " + TABLE_NAME + "Error" + e.toString());
            return;
        }
    }

    /**
     * 資料庫升級
     * @param db
     * @param oldVersion
     * @param newVersion
     */
    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
    }

}

注意：SQLiteDatabase.loadLibs(context);這個千萬別忘記呼叫

3.)建立一個DBCipherManager資料庫管理

具體實現傳統的SQLiteOpenHelper都是完全相同的，不同的地方在獲取資料庫控制程式碼的地方

傳統方式：

       //獲取可寫資料庫
        SQLiteDatabase db = dbHelper.getWritableDatabase();

        //獲取可讀資料庫
        SQLiteDatabase db = dbHelper.getReadableDatabase();

現在的方式：需要傳入一個password，這個password就是用於加密的祕鑰

         //獲取寫資料庫
        SQLiteDatabase db = dbHelper.getWritableDatabase(DBCipherHelper.DB_PWD);
        //獲取可讀資料庫
        SQLiteDatabase db = dbHelper.getReadableDatabase(DBCipherHelper.DB_PWD);

接下來就是具體實現：

import android.content.ContentValues;
import android.content.Context;
import android.util.Log;
import net.sqlcipher.Cursor;
import net.sqlcipher.SQLException;
import net.sqlcipher.database.SQLiteDatabase;


/**
 * 資料庫管理者 - 提供資料庫封裝
 *
 */
public class DBCipherManager {
    private static final String TAG = "DatabaseManager";
    // 靜態引用
    private volatile static DBCipherManager mInstance;
    // DatabaseHelper
    private DBCipherHelper dbHelper;

    private DBCipherManager(Context context) {
        dbHelper = new DBCipherHelper(context.getApplicationContext());
    }

    /**
     * 獲取單例引用
     *
     * @param context
     * @return
     */
    public static DBCipherManager getInstance(Context context) {
        DBCipherManager inst = mInstance;
        if (inst == null) {
            synchronized (DBCipherManager.class) {
                inst = mInstance;
                if (inst == null) {
                    inst = new DBCipherManager(context);
                    mInstance = inst;
                }
            }
        }
        return inst;
    }

    /**
     * 插入資料
     */
    public void insertData(String name) {
        //獲取寫資料庫
        SQLiteDatabase db = dbHelper.getWritableDatabase(DBCipherHelper.DB_PWD);
        //生成要修改或者插入的鍵值
        ContentValues cv = new ContentValues();
        cv.put(DBCipherHelper.FIELD_NAME, name);
        // insert 操作
        db.insert(DBCipherHelper.TABLE_NAME, null, cv);
        //關閉資料庫
        db.close();
    }

    /**
     * 未開啟事務批量插入
     * @param testCount
     */
    public void insertDatasByNomarl(int testCount){
        //獲取寫資料庫
        SQLiteDatabase db = dbHelper.getWritableDatabase(DBCipherHelper.DB_PWD);
        for(int i =0;i<testCount;i++ ){
            //生成要修改或者插入的鍵值
            ContentValues cv = new ContentValues();
            cv.put(DBCipherHelper.FIELD_NAME, String.valueOf(i));
            // insert 操作
            db.insert(DBCipherHelper.TABLE_NAME, null, cv);
            Log.e(TAG, "insertDatasByNomarl");
        }
        //關閉資料庫
        db.close();
    }

    /**
     * 測試開啟事務批量插入
     * @param testCount
     */
    public void insertDatasByTransaction(int testCount){
        //獲取寫資料庫
        SQLiteDatabase db = dbHelper.getWritableDatabase(DBCipherHelper.DB_PWD);
        db.beginTransaction();  //手動設定開始事務
        try{
            //批量處理操作
            for(int i =0;i<testCount;i++ ){
                //生成要修改或者插入的鍵值
                ContentValues cv = new ContentValues();
                cv.put(DBCipherHelper.FIELD_NAME, String.valueOf(i));
                // insert 操作
                db.insert(DBCipherHelper.TABLE_NAME, null, cv);
                Log.e(TAG, "insertDatasByTransaction");
            }
            db.setTransactionSuccessful(); //設定事務處理成功，不設定會自動回滾不提交
        }catch(Exception e){

        }finally{
            db.endTransaction(); //處理完成
            //關閉資料庫
            db.close();
        }
    }

    /**
     * 刪除資料
     */
    public void deleteData(String name) {
        //生成條件語句
        StringBuffer whereBuffer = new StringBuffer();
        whereBuffer.append(DBCipherHelper.FIELD_NAME).append(" = ").append("'").append(name).append("'");
        //獲取寫資料庫
        SQLiteDatabase db = dbHelper.getWritableDatabase(DBCipherHelper.DB_PWD);
        // delete 操作
        db.delete(DBCipherHelper.TABLE_NAME, whereBuffer.toString(), null);
        //關閉資料庫
        db.close();
    }

    /**
     * 刪除所有資料
     */
    public void deleteDatas()
    {
        String sql="delete from "+ DBCipherHelper.TABLE_NAME;
        execSQL(sql);
    }

    /**
     * 更新資料
     */
    public void updateData(String name) {
        //生成條件語句
        StringBuffer whereBuffer = new StringBuffer();
        whereBuffer.append(DBCipherHelper.FIELD_NAME).append(" = ").append("'").append(name).append("'");
        //生成要修改或者插入的鍵值
        ContentValues cv = new ContentValues();
        cv.put(DBCipherHelper.FIELD_NAME, name+name);
        //獲取寫資料庫
        SQLiteDatabase db = dbHelper.getWritableDatabase(DBCipherHelper.DB_PWD);
        // update 操作
        db.update(DBCipherHelper.TABLE_NAME, cv, whereBuffer.toString(), null);
        //關閉資料庫
        db.close();
    }

    /**
     * 指定條件查詢資料
     */
    public void queryDatas(String name){
        //生成條件語句
        StringBuffer whereBuffer = new StringBuffer();
        whereBuffer.append(DBCipherHelper.FIELD_NAME).append(" = ").append("'").append(name).append("'");
        //指定要查詢的是哪幾列資料
        String[] columns = {DBCipherHelper.FIELD_NAME};
        //獲取可讀資料庫
        SQLiteDatabase db = dbHelper.getReadableDatabase(DBCipherHelper.DB_PWD);
        //查詢資料庫
        Cursor cursor = null;
        try {
            cursor = db.query(DBCipherHelper.TABLE_NAME, columns, whereBuffer.toString(), null, null, null, null);
            while (cursor.moveToNext()) {
                int count = cursor.getColumnCount();
                String columName = cursor.getColumnName(0);
                String  tname = cursor.getString(0);
                Log.e(TAG, "count = " + count + " columName = " + columName + "  name =  " +tname);
            }
            if (cursor != null) {
                cursor.close();
            }
        } catch (SQLException e) {
            Log.e(TAG, "queryDatas" + e.toString());
        }
        //關閉資料庫
        db.close();
    }

    /**
     * 查詢全部資料
     */
    public void queryDatas(){
        //指定要查詢的是哪幾列資料
        String[] columns = {DBCipherHelper.FIELD_NAME};
        //獲取可讀資料庫
        SQLiteDatabase db = dbHelper.getReadableDatabase(DBCipherHelper.DB_PWD);
        //查詢資料庫
        Cursor cursor = null;
        try {
            cursor = db.query(DBCipherHelper.TABLE_NAME, columns, null, null, null, null, null);//獲取資料遊標
            while (cursor.moveToNext()) {
                int count = cursor.getColumnCount();
                String columeName = cursor.getColumnName(0);//獲取表結構列名
                String  name = cursor.getString(0);//獲取表結構列資料
                Log.e(TAG, "count = " + count + " columName = " + columeName + "  name =  " +name);
            }
            //關閉遊標防止記憶體洩漏
            if (cursor != null) {
                cursor.close();
            }
        } catch (SQLException e) {
            Log.e(TAG, "queryDatas" + e.toString());
        }
        //關閉資料庫
        db.close();
    }

    /**
     * 執行sql語句
     */
    private void execSQL(String sql){
        //獲取寫資料庫
        SQLiteDatabase db = dbHelper.getWritableDatabase(DBCipherHelper.DB_PWD);
        //直接執行sql語句
        db.execSQL(sql);//或者
        //關閉資料庫
        db.close();
    }

}

4.）具體怎麼呼叫

               //清空資料
                DBCipherManager.getInstance(MainActivity.this).deleteDatas();
                //插入資料
                for (int i = 0; i < 10; i++) {
                    DBCipherManager.getInstance(MainActivity.this).insertData(String.valueOf(i));
                }
                //刪除資料
                DBCipherManager.getInstance(MainActivity.this).deleteData(String.valueOf(5));
                //更新資料
                DBCipherManager.getInstance(MainActivity.this).updateData(String.valueOf(3));
                //查詢資料
                DBCipherManager.getInstance(MainActivity.this).queryDatas();

5.）事務支援和傳統方式一樣

  //獲取寫資料庫
        SQLiteDatabase db = dbHelper.getWritableDatabase();
        db.beginTransaction();  //手動設定開始事務
        try{
            //在此處理批量操作
            for(int i =0;i<testCount;i++ ){
                //生成要修改或者插入的鍵值
                ContentValues cv = new ContentValues();
                cv.put(DBHelper.FIELD_NAME, String.valueOf(i));
                // insert 操作
                db.insert(DBHelper.TABLE_NAME, null, cv);
            }
            db.setTransactionSuccessful(); //設定事務處理成功，不設定會自動回滾不提交
        }catch(Exception e){

        }finally{
            db.endTransaction(); //處理完成
            //關閉資料庫
            db.close();
        }

總結：

SQLCipher使用總結到此結束。

C++編譯SQLite資料庫以及如何使用加密資料庫SQLCipher
2018-05-22
C++編譯SQLite資料庫加密
IOS資料儲存之Sqlite資料庫
2016-05-12
iOSSQLite資料庫
IOS資料儲存之FMDB資料庫
2016-05-14
iOS資料庫
【Android】資料儲存（三）資料庫（SQLite）
2016-05-31
Android資料庫SQLite
Flutter持久化儲存之資料庫儲存
2019-03-08
Flutter持久化資料庫
Android中的資料儲存之檔案儲存
2020-03-11
Android
《資料儲存》之《分庫，分表》
2021-07-20
greenDAO資料庫之修改儲存地址
2018-05-20
資料庫
Android資料儲存之SharedPreferences及如何安全儲存
2016-05-15
Android
【資料庫】資料庫儲存過程(一)
2019-09-05
資料庫儲存過程
列式儲存資料庫
2015-04-20
資料庫
Android資料加密之Aes加密
2016-07-30
Android加密
Android資料加密之Rsa加密
2016-05-08
Android加密
Android資料加密之Des加密
2016-06-13
Android加密
Hive之資料儲存
2017-09-18
Hive
資料庫表設計之儲存引擎
2021-06-28
資料庫儲存引擎
Android中的資料儲存之SharedPreferences
2020-03-12
Android
Android資料儲存之GreenDao 3.0 詳解
2016-07-08
Android
Docker最全教程——資料庫容器化之持久儲存資料（十一）
2021-09-09
Docker資料庫
MySQL 資料庫儲存引擎
2015-11-11
MySql資料庫儲存引擎
MySQL 更改資料庫資料儲存目錄
2018-11-05
MySql資料庫
明解資料庫------資料庫儲存演變史
2023-03-08
資料庫
【資料庫】資料庫儲存元素型別基礎
2017-10-26
資料庫型別
儲存資料之SharedPreference
2019-02-28
IOS資料儲存之NSUserDefaults
2016-05-10
iOS
Android中的資料儲存
2016-06-02
Android
33.Android資料儲存
2024-04-20
Android
Android 程式設計日誌之資料儲存
2016-06-30
Android程式設計
Android資料儲存之Content Providers薦
2011-01-14
AndroidIDE
Android之SharedPreference輕量級資料儲存
2012-07-18
Android
儲存過程呼叫不同資料庫的資料
2012-12-07
儲存過程資料庫
Android資料加密之MD5加密
2016-09-20
Android加密
報表資料分庫儲存
2019-12-10
MySql資料庫——儲存過程
2021-09-09
MySql資料庫儲存過程
MySQL資料庫操作、儲存引擎
2020-10-05
MySql資料庫儲存引擎
gitlab資料庫儲存位置
2018-06-15
Gitlab資料庫
使用Room持久庫儲存資料
2017-12-14
OOM
管理資料庫儲存結構
2010-05-11
資料庫