iOS数据库加密完全手册——FMDB+SQLCipher

这篇文章介绍如何对数据库文件进行加密,基于FMDB+SQLCipher,标明踩过的坑,留给同样掉进坑里的小伙伴参考。


1、下载支持SQLCipher的FMDB分支

FMDB官方库地址:https://github.com/ccgus/fmdb

SQLCipher官网:https://www.zetetic.net/sqlcipher/

作者做了一个支持SQLCipher的仓库,为我们节约了大量编译和工程配置时间,感谢!

修改Podfile:

pod 'FMDB'

替换为

pod 'FMDB/SQLCipher'

更新一下Pod即可得到支持SQLCipher的FMDB。


2、加密方法的使用

- (BOOL)setKey:(NSString*)key;

方法很简单,关键是使用的位置:

2.1、直接使用FMDatabase

每次调用

[db open]

的时候调用一次

2.2、使用FMDatabaseQueue

调用

+ (instancetype)databaseQueueWithPath:(NSString*)aPath

的时候调用一次 ,例如:

self.dbQueue = [FMDatabaseQueue databaseQueueWithPath:dbPath]

[self.dbQueue inDatabase:^(FMDatabase*db) {

    [db setKey:kDBEncryptedKey]

}];

这里有个坑:不是每次调用

- (void)inDatabase:(void(^)(FMDatabase*db))block

的时候都要在block里调用

- (BOOL)setKey:(NSString*)key

只需要在初始化FMDatabaseQueue完的时候调用一次即可,而且要保证最先调用,不然任何数据库操作都是非法的!


3、非加密数据库<->加密数据库

如何将现有非加密数据库在保存数据的情况下转换为加密数据库?

又如何将加密数据库保留数据还原为非加密数据库?

这里需要用到sqlcipher_export()方法。

3.1、创建全新的加密数据库

如果待创建的数据库是全新的,按照上面说的方法直接调用

- (BOOL)setKey:(NSString*)key

即可得到加密数据库。

3.2、将现有非加密数据库转换为加密数据库

如果你的数据库开始是没有加密的,按照上面介绍的方法调用

- (BOOL)setKey:(NSString*)key

并不会将现有数据库转换为加密数据库,只会得到一大堆报错。

下面是一段从SQLCipher拷贝来的例子:

Example 1: Encrypt a Plaintext Database

$ ./sqlcipher plaintext.db

sqlite> ATTACH DATABASE 'encrypted.db' AS encrypted KEY 'testkey';

sqlite> SELECT sqlcipher_export('encrypted');

sqlite> DETACH DATABASE encrypted;

我们只需要执行三个SQL语句即可将非加密数据库拷贝到加密数据库,是不是很简单?但是这里又有个坑:

1、sqlite> ATTACH DATABASE 'encrypted.db' AS encrypted KEY 'testkey';

这句话中的'encrypted.db',代表待创建的加密数据库的全路径,并不只是数据库的名称;

2、sqlite> SELECT sqlcipher_export('encrypted');

这句话中的'encrypted',代表一个关键字!!!并不是什么待创建的数据库的全路径也不是什么数据库名称!或许真的是我太单纯了...

3、sqlite> DETACH DATABASE encrypted;

没错,这里的encrypted也是一个关键字

使用代码封装一下:

#define kDBEncryptedKey@"abcdefg"

NSString *encryptedDBPath = @"Your/DB/Path/encryptedDB.db"

NSString *plainttextDBPath = @"Your/DB/Path/plainttextDB.db"

const char *sql = [[NSString stringWithFormat:@"ATTACH DATABASE '%@' AS encrypted KEY '%@';", encryptedDBPath, kDBEncryptedKey] UTF8String];

const char *exportSql = [[NSString stringWithFormat:@"SELECT sqlcipher_export('encrypted');"] UTF8String];

const char *detachSql = [[NSString stringWithFormat:@"DETACH DATABASE encrypted;"] UTF8String];

sqlite3 *unencrypted_DB = NULL;

if(sqlite3_open([plainttextDBPath UTF8String], &unencrypted_DB) ==SQLITE_OK)

{

    int rc;

    char *errmsg = NULL;

    rc =sqlite3_exec(unencrypted_DB, sql,NULL,NULL, &errmsg);

    rc =sqlite3_exec(unencrypted_DB, exportSql,NULL,NULL, &errmsg);

    rc =sqlite3_exec(unencrypted_DB, detachSql,NULL,NULL, &errmsg);

    sqlite3_close(unencrypted_DB);

}

else

{

    sqlite3_close(unencrypted_DB);

    NSAssert1(NO,@"Failed to open database with message '%s'.", sqlite3_errmsg(unencrypted_DB));

}

通过上面的代码可以从非加密数据库拷贝一份保留数据的加密数据库,加密数据库生成后记得删除旧数据库。

3.3、将加密数据库转换为非加密数据库

下面又是一段从SQLCipher拷贝来的例子:

Example 2: Decrypt a SQLCipher database to a Plaintext Database

$ ./sqlcipher encrypted.db

sqlite> PRAGMA key = 'testkey';

sqlite> ATTACH DATABASE 'plaintext.db' AS plaintext KEY '';  -- empty key will disable encryption

sqlite> SELECT sqlcipher_export('plaintext');

sqlite> DETACH DATABASE plaintext;

记得上面说的坑:

'plaintext.db'是待创建的未加密数据的全路径;

'plaintext'是关键字,不是路径也不是去掉后缀的数据库名称;

plaintext是关键字;

使用代码封装一下:

#define kDBEncryptedKey@"abcdefg"

NSString *encryptedDBPath = @"Your/DB/Path/encryptedDB.db"

NSString *plaintextDBPath = @"Your/DB/Path/plainttextDB.db"

const char *sql = [[NSStringstringWithFormat:@"PRAGMA key = '%@';", kDBEncryptedKey] UTF8String];

const char *attachSql = [[NSString stringWithFormat:@"ATTACH DATABASE '%@' AS plaintext KEY '';", plaintextDBPath] UTF8String];

const char *exportSql = [[NSStringstringWithFormat:@"SELECT sqlcipher_export('plaintext');"] UTF8String];

const char *detachSql = [[NSStringstringWithFormat:@"DETACH DATABASE plaintext;"] UTF8String];

sqlite3*encrypted_DB =NULL;

if(sqlite3_open([encryptedDBPathUTF8String], &encrypted_DB) ==SQLITE_OK)

{

    int rc;

    char *errmsg = NULL;

    rc = sqlite3_exec(encrypted_DB, sql,NULL,NULL, &errmsg);

    rc =sqlite3_exec(encrypted_DB, attachSql,NULL,NULL, &errmsg);

    rc =sqlite3_exec(encrypted_DB, exportSql,NULL,NULL, &errmsg);

    rc =sqlite3_exec(encrypted_DB, detachSql,NULL,NULL, &errmsg); 

    sqlite3_close(encrypted_DB);

}

else

{

    sqlite3_close(encrypted_DB);

    NSAssert1(NO,@"Failed to open database with message '%s'.", sqlite3_errmsg(encrypted_DB));

}

使用上面的代码就可以将加密后的数据库还原成未加密数据库,同样记得删除旧数据库。


坑:转换后的数据库除了保留了数据外,并没有保留以前的数据库附加信息,例如userVersion,记得将老数据库的userVersion赋给新数据库,不然数据库升级可能要有麻烦了!

关键代码都在这里,大家根据个人需要自由组合,例子我就不写了,因为懒。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容