转载一篇关于QSqlite加密的文章

Qt 已经内置了一个SQLite 数据库，方便我们开发桌面应用。但是这个SQLite 是官方提供的开源版本，这意味着这个版本的 SQLite 实际是没有加密功能的。对于一般的桌面应用，数据库加密有时是比较重要的，特别是当你需要对所存储的数据必须保密的时候——比如密码，或者用户个人隐私信息等。
　　其实，SQLite已经为我们预留了接口sqlite3_key()函数。但是，这个函数其实是没有实现的。也就是说，如果我们能够提供该函数的实现，就可以实现SQLite数据库的加密。顺着这个思路，我们这里给出一种处理方案，为Qt提供一个有加密功能的SQLite插件。
　　为了兼容Qt的跨平台特性，我们实现sqlite3_key()函数的时候也不会考虑平台相关的API。因此，我们不会使用win32API进行此类操作。好在我们可以找到许多开源的跨平台加密算法库供我们使用。这里，我们选择的是wxsqlite3的相关实现。
　　首先，我们到这里下载wxsqlite3的源代码（当前最新版本是3.0.0.1）。解压之后，我们可以在sqlite3/secure/src这里找到我们所需要的文件。请注意找到以下文件：
　　codec.c
　　codec.h
　　rijndael.c
　　rijndael.h
　　codecext.c
　　sqlite3secure.c
　　（这里说明一点，如果你按照我们这里提供的地址下载，需要修改codeext.c中的一行代码。具体是在codecext.c的第305行，将sqlite3BtreeRollback(pbt);改写为sqlite3BtreeRollback(pbt,SQLITE_OK);。这应该是由于wxsqlite3使用的旧版本SQLite，与我们下面要使用的最新版有所区别。如果直接从文末所列出的地址下载，则不会有这个问题。）
　　然后，到SQLite官方站点下载SQLite的源代码文件。注意，我们需要下载的是sqlite-amalgamation-xxxx.zip文件（当前最新版本是3071300）。这是将SQLite源文件集中到一个.c文件中，方便我们后面编译。之所以不直接使用wxsqlite3中提供的SQLite源文件，是因为我们希望使用官方发布的最新版本，以便获得更好的性能以及更多的特性。
　　下面我们可以进行编译了。新建一个文件夹，把我们所需要的文件全部复制到该文件夹中。我们所需要的是：前面所说的codec.c、codec.h、rijndael.c、rijndael.h、codecext.c和sqlite3secure.c；以及下载的sqlite-amalgamation-xxxx.zip解压之后获得的所有文件：shell.c、sqlite3.c、sqlite3.h和sqlite3ext.h。接下来建立一个makefile：

1. all:libsqlite.a
   
2.         @echo All Done
   
3. libsqlite.a:sqlite3secure.o
   
4.         ar -r libsqlite.a sqlite3secure.o
   
5. sqlite3secure.o:sqlite3secure.c sqlite3.c sqlite3.h codec.c codec.h rijndael.h rijndael.c codecext.c
   
6.         gcc -c -D SQLITE_HAS_CODEC sqlite3secure.c -o sqlite3secure.o
   
7. clean:
   
8.         del *.o *.a *.obj *.gch

复制代码这里我们不再赘述这个makefile的具体内容以及格式。如果有不明白的地方，请自行解决;-P需要注意的是，必须增加宏定义SQLITE_HAS_CODEC。
　　如果使用VS系列IDE，则需要新建一个库工程（可以设置为静态库），把这些文件全部添加到工程，同样必须添加预处理，最主要的是增加宏SQLITE_HAS_CODEC=1。
　　现在就可以编译了。不出意外的话，我们将可以获得libsqlite.a（gcc）或者sqlite.lib（VC）。
　　如果你是在自己的项目中使用带有加密功能的SQLite，现在就可以使用了。不过，如果你使用的是Qt（当然，你也可以直接在Qt程序中调用SQLiteAPI），那么我们还有一些额外的工作，以便以一种更方便的形式在Qt中使用SQLite。
　　我们知道，Qt提供了一个SQLite插件，用于SQLite操作。但这个插件是没有加密功能的。我们则直接在此基础之上重新创建一个Qt插件。为达这一目的，你必须下载Qt源代码（如果你使用QtSDK安装，默认是没有安装源代码的，需要自己从git获取）。
　　假设你已经获取Qt源代码，那么直接来到src/plugins/sqldrivers文件夹，可以看到有个sqlite目录。下面我们仿此新建一个文件夹sqlitecipher。在此文件夹中新建一个文件smain.cpp：

1. #include <qsqldriverplugin.h>
   
2. #include <qstringlist.h>
   
3. #include "qsql_sqlite.h"
   
4. 
   
5. QT_BEGIN_NAMESPACE
   
6. 
   
7. class SqliteCipherDriverPlugin : public QSqlDriverPlugin
   
8. {
   
9. public:
   
10.     SqliteCipherDriverPlugin();
    
11. 
    
12.     QSqlDriver* create(const QString &);
    
13.     QStringList keys() const;
    
14. };
    
15. 
    
16. SqliteCipherDriverPlugin::SqliteCipherDriverPlugin()
    
17.     : QSqlDriverPlugin()
    
18. {
    
19. }
    
20. 
    
21. QSqlDriver* SqliteCipherDriverPlugin::create(const QString &name)
    
22. {
    
23.     if (name == QLatin1String("SQLITECIPHER")) {
    
24.         QSQLiteDriver* driver = new QSQLiteDriver();
    
25.         return driver;
    
26.     }
    
27.     return 0;
    
28. }
    
29. 
    
30. QStringList SqliteCipherDriverPlugin::keys() const
    
31. {
    
32.     QStringList l;
    
33.     l  << QLatin1String("SQLITECIPHER");
    
34.     return l;
    
35. }
    
36. 
    
37. Q_EXPORT_STATIC_PLUGIN(SqliteCipherDriverPlugin)
    
38. Q_EXPORT_PLUGIN2(qsqlite, SqliteCipherDriverPlugin)
    
39. 
    
40. QT_END_NAMESPACE

复制代码这里需要注意的是SQLITECIPHER这个字符串。这其实就是这个数据库驱动的名字。如果曾经使用过Qt的数据库驱动，则会有类似下面的语句：

1. QSqlDatabase db = QSqlDatabase::addDatabase("SQLITECIPHER");

复制代码这里的数据库驱动名字SQLITECIPHER就是我们在plugin中指定的那个字符串。
　　我们来看一下：当使用上面SQLITECIPHER作为名字创建数据库的时候，我们的插件返回的是QSQLiteDriver。这暗示了，我们必须要修改QSQLiteDriver的源代码，才能替换其原本的操作。好在我们并不需要修改很多代码。
　　从Qt源代码的src/sql/drivers/sqlite中可以找到我们需要的qsql_sqlite.h和qsql_sqlite.cpp。将这两个文件复制到我们创建的sqlitecipher文件夹中。打开qsql_sqlite.cpp，找到open()函数，修改如下：

1. bool QSQLiteDriver::open(const QString & db,
   
2.                          const QString &,
   
3.                          const QString &,
   
4.                          const QString &,
   
5.                          int,
   
6.                          const QString &conOpts)
   
7. {
   
8.     // ...
   
9.     if (sqlite3_open_v2(db.toUtf8().constData(),
   
10.                         &d->access, openMode, NULL) == SQLITE_OK) {
    
11.         sqlite3_busy_timeout(d->access, timeOut);
    
12.         setOpen(true);
    
13.         setOpenError(false);
    
14.         // 增加下面一行代码：
    
15.         sqlite3_key(d->access, "YOUR_KEY", 8);
    
16.         return true;
    
17.     } else {
    
18.         setLastError(qMakeError(d->access, tr("Error opening database"),
    
19.                      QSqlError::ConnectionError));
    
20.         setOpenError(true);
    
21.         return false;
    
22.     }
    
23. }

复制代码我们增加的是sqlite3_key();函数。该函数的签名是：

1. int sqlite3_key(sqlite3 *db, const void *pKey, int nKey);

复制代码其中，db是指定的数据库，pKey是密钥，nKey是密钥长度。例如，sqlite3_key(db,“abc”,3);。我们需要将前面代码中的YOUR_KEY以及后面的长度8修改成你的真实密钥（应该将长度使用strlen()函数计算获得，并且最好能将密钥作为可配置项。不过，为简单起见，我们就不作这些设计了）。
　　至此，所需要的内容已经准备好，下面在sqlitecipher中增加.pro文件：

1. TARGET = sqlitecipher
   
2. 
   
3. HEADERS  = qsql_sqlite.h sqlite3.h
   
4. SOURCES  = smain.cpp qsql_sqlite.cpp
   
5. 
   
6. !system-sqlite:!contains( LIBS, .*sqlite.* ) {
   
7.     CONFIG(release, debug|release):DEFINES *= NDEBUG
   
8.     DEFINES     += SQLITE_OMIT_LOAD_EXTENSION SQLITE_OMIT_COMPLETE SQLITE_HAS_CODEC
   
9.     INCLUDEPATH += include
   
10.     LIBS        += ./lib/libsqlite.a
    
11. } else {
    
12.     LIBS *= $QT_LFLAGS_SQLITE
    
13.     QMAKE_CXXFLAGS *= $QT_CFLAGS_SQLITE
    
14. }
    
15. 
    
16. include(../qsqldriverbase.pri)

复制代码这里不准备对这个文件作过多讲解，只需要注意几个事项：
　　HEADERS必须有sqlite3.h一项，因此，我们必须将这个文件复制到我们的sqlitecipher文件夹中；
　　DEFINES必须有SQLITE_HAS_CODEC一项（还记得我们在前面编译SQLite说过的吗？）；
　　LIBS中的内容看到了吗？这意味着，我们必须将前面生成的libsqlite.a复制到sqlitecipher/lib文件夹中（如果你不想，那么就自己修改这个路径吧！）。
　　接下来就是同一般Qt程序没什么区别的qmake以及make。之后，我们就可以在debug或者release文件夹下找到sqlitecipher.dll或者sqlitecipherd.dll这两个文件。简单地说，将其复制到QtSDK的Desktop/Qt/4.8.0/mingw/plugins/sqldrivers中，我们就可以在我们的程序中使用这个插件了。还记得这个插件的名字吗？SQLITECIPHER!
　　如果懒得去找那一堆文件，贴子下面的附件中有已经打包好的所有文件。解压之后将会有两个目录：SQLite_cipher和sqlitecipher。前者用于编译libsqlite.a，后者用于编译Qt插件。当然，你必须将前面编译出的.a放到后者的lib文件夹下。