带有加密功能的 SQLite Qt 插件

版本更新

2016.05.20 v0.5
2013.01.10 v0.2

Qt 已经内置了一个 SQLite 数据库,方便我们开发桌面应用。但是这个 SQLite 是官方提供的开源版本,这意味着这个版本的 SQLite 实际是没有加密功能的。对于一般的桌面应用,数据库加密有时是比较重要的,特别是当你需要对所存储的数据必须保密的时候——比如密码,或者用户个人隐私信息等。

其实,SQLite 已经为我们预留了接口 sqlite3_key()函数。但是,这个函数其实是没有实现的。也就是说,如果我们能够提供该函数的实现,就可以实现 SQLite 数据库的加密。顺着这个思路,我们这里给出一种处理方案,为 Qt 提供一个有加密功能的 SQLite 插件。

为了兼容 Qt 的跨平台特性,我们实现sqlite3_key()函数的时候也不会考虑平台相关的 API。因此,我们不会使用 win32 API 进行此类操作。好在我们可以找到许多开源的跨平台加密算法库供我们使用。这里,我们选择的是 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:

all:libsqlite.a
	@echo All Done
libsqlite.a:sqlite3secure.o
	ar -r libsqlite.a sqlite3secure.o
sqlite3secure.o:sqlite3secure.c sqlite3.c sqlite3.h codec.c codec.h rijndael.h rijndael.c codecext.c
	gcc -c -D SQLITE_HAS_CODEC sqlite3secure.c -o sqlite3secure.o
clean:
	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 程序中调用 SQLite API),那么我们还有一些额外的工作,以便以一种更方便的形式在 Qt 中使用 SQLite。

我们知道,Qt 提供了一个 SQLite 插件,用于 SQLite 操作。但这个插件是没有加密功能的。我们则直接在此基础之上重新创建一个 Qt 插件。为达这一目的,你必须下载 Qt 源代码(如果你使用 QtSDK 安装,默认是没有安装源代码的,需要自己从 git 获取)。

假设你已经获取 Qt 源代码,那么直接来到 src/plugins/sqldrivers 文件夹,可以看到有个 sqlite 目录。下面我们仿此新建一个文件夹 sqlitecipher。在此文件夹中新建一个文件 smain.cpp:

#include <qsqldriverplugin.h>
#include <qstringlist.h>
#include "qsql_sqlite.h"

QT_BEGIN_NAMESPACE

class SqliteCipherDriverPlugin : public QSqlDriverPlugin
{
public:
    SqliteCipherDriverPlugin();

    QSqlDriver* create(const QString &);
    QStringList keys() const;
};

SqliteCipherDriverPlugin::SqliteCipherDriverPlugin()
    : QSqlDriverPlugin()
{
}

QSqlDriver* SqliteCipherDriverPlugin::create(const QString &name)
{
    if (name == QLatin1String("SQLITECIPHER")) {
        QSQLiteDriver* driver = new QSQLiteDriver();
        return driver;
    }
    return 0;
}

QStringList SqliteCipherDriverPlugin::keys() const
{
    QStringList l;
    l  << QLatin1String("SQLITECIPHER");
    return l;
}

Q_EXPORT_STATIC_PLUGIN(SqliteCipherDriverPlugin)
Q_EXPORT_PLUGIN2(qsqlite, SqliteCipherDriverPlugin)

QT_END_NAMESPACE

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

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() 函数,修改如下:

bool QSQLiteDriver::open(const QString & db,
                         const QString &,
                         const QString &,
                         const QString &,
                         int,
                         const QString &conOpts)
{
    // ...
    if (sqlite3_open_v2(db.toUtf8().constData(),
                        &d->access, openMode, NULL) == SQLITE_OK) {
        sqlite3_busy_timeout(d->access, timeOut);
        setOpen(true);
        setOpenError(false);
        // 增加下面一行代码:
        sqlite3_key(d->access, "YOUR_KEY", 8);
        return true;
    } else {
        setLastError(qMakeError(d->access, tr("Error opening database"),
                     QSqlError::ConnectionError));
        setOpenError(true);
        return false;
    }
}

我们增加的是sqlite3_key();函数。该函数的签名是:

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

其中,db 是指定的数据库,pKey 是密钥,nKey 是密钥长度。例如,sqlite3_key( db, “abc”, 3);。我们需要将前面代码中的 YOUR_KEY 以及后面的长度 8 修改成你的真实密钥(应该将长度使用 strlen() 函数计算获得,并且最好能将密钥作为可配置项。不过,为简单起见,我们就不作这些设计了)。

至此,所需要的内容已经准备好,下面在 sqlitecipher 中增加 .pro 文件:

TARGET = sqlitecipher

HEADERS  = qsql_sqlite.h sqlite3.h
SOURCES  = smain.cpp qsql_sqlite.cpp

!system-sqlite:!contains( LIBS, .*sqlite.* ) {
    CONFIG(release, debug|release):DEFINES *= NDEBUG
    DEFINES     += SQLITE_OMIT_LOAD_EXTENSION SQLITE_OMIT_COMPLETE SQLITE_HAS_CODEC
    INCLUDEPATH += include
    LIBS        += ./lib/libsqlite.a
} else {
    LIBS *= $$QT_LFLAGS_SQLITE
    QMAKE_CXXFLAGS *= $$QT_CFLAGS_SQLITE
}

include(../qsqldriverbase.pri)

这里不准备对这个文件作过多讲解,只需要注意几个事项:

  1. HEADERS 必须有 sqlite3.h 一项,因此,我们必须将这个文件复制到我们的 sqlitecipher 文件夹中;
  2. DEFINES 必须有 SQLITE_HAS_CODEC 一项(还记得我们在前面编译 SQLite 说过的吗?);
  3. 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 文件夹下。

如果对此插件感兴趣,欢迎一起探讨。现在已经将项目源代码放置在 github 上面。

39 Comments

  1. Qter 2012年9月7日
    • DevBean 2012年9月8日
  2. vintx 2012年9月26日
    • DevBean 2012年9月27日
      • vintx 2012年10月10日
  3. qt小子 2012年10月18日
  4. qt小子 2012年10月18日
    • DevBean 2012年10月19日
  5. qt小子 2012年10月19日
  6. qt小子 2012年10月19日
  7. qt小子 2012年10月20日
    • DevBean 2012年10月21日
  8. vintx 2013年1月9日
    • 豆子 2013年1月10日
  9. wangbq 2013年7月9日
    • 豆子 2013年7月10日
      • wangbq 2013年7月10日
        • wangbq 2013年7月10日
          • 豆子 2013年7月10日
          • wangbq 2013年7月10日
          • 豆子 2013年7月12日
  10. Evans 2014年11月8日
    • Evans 2014年11月8日
      • FranklinFoong 2016年5月10日
        • 喻纹东 2016年5月26日
  11. qt小妹 2016年6月4日
    • qt小妹 2016年6月4日
  12. qt小妹 2016年6月4日
    • 豆子 2016年6月5日
      • qt小妹 2016年6月5日
        • 豆子 2016年6月6日
          • qt小妹 2016年6月6日
          • qt小妹 2016年6月6日
          • 豆子 2016年6月6日
  13. qt小妹 2016年6月6日
  14. qt小妹 2016年6月6日
    • 豆子 2016年6月6日
      • qt小妹 2016年6月6日

Leave a Reply