Windows/Mac 平台 SQLCipher 编译过程

源代码:

• OpenSSL
• SQLCipher

Windows 上编译 SqlCipher

准备工作

• Visual Studio 任意一个版本, 这里使用的是 VS 2017
• ActiveState ActivePerl
• Mingw, 安装 minimum installer 即可
• nasm
• ActiveState ActiveTcl

编译 OpenSSL

1. 使用管理员权限, 打开 x86 Native Tools Command Prompt for VS 2017 工具.

2. 切换到 OpenSSL 目录下

3. 执行以下命令

   # perl Configure VC-WIN32 -static --prefix=你的安装位置 // 以静态库方式进行编译
   perl Configure VC-WIN32 --prefix=你的安装位置 // 以动态库方式进行编译
   nmake
   nmake test  // 测试. 如果全部成功, 会输出 All tests successful
   nmake install // lib 安装到了你指定的位置上
   

   一般情况下, nmake 执行完成后, 没有错误出现

4. 在目录下已经生成了文件

   静态库

   • libcrypto.lib
   • libssl.lib

   动态库

   • libcrypto.lib
   • libcrypto_1-1.dll
   • libssl.lib
   • libssl.dll

注意: 这里说的编译过程使用的是 OpenSSL V1.1.1 版本, 其他版本的编译方式略有不同. 具体参看源代码目录下的 INSTALL 文件(后面可能跟着 OS 版本). 比如, 1.0.2n 的编译方式就不一样.

编译 SQLCipher

方式一

1. 进入工程目录，打开 Makefile.msc 文件

2. 将 -DSQLITE_TEMP_STORE 从 1 改为 2。 注意：此处 TCC 与 TCC 一起改动

3. 添加 -DSQLITE_HAS_CODEC, -DSQLCIPHER_CRYPTO_OPENSSL, -DSQLITE_ENABLE_FTS4, -DSQLITE_ENABLE_JSON1, -DSQLITE_ENABLE_FTS3, -DSQLITE_ENABLE_FTS3_PARENTHESIS, -DSQLITE_ENABLE_FTS5, -DNOCRYPT 到 TCC 与 RCC 中

   TCC = $(TCC) -DSQLITE_TEMP_STORE=2
   RCC = $(RCC) -DSQLITE_TEMP_STORE=2
   
   # Add DSQLITE_TEMP_STORE to gcc & rcc
   TCC = $(TCC) -DSQLITE_HAS_CODEC
   RCC = $(RCC) -DSQLITE_HAS_CODEC
   
   TCC = $(TCC) -DSQLITE_ENABLE_FTS4
   RCC = $(RCC) -DSQLITE_ENABLE_FTS4
   
   TCC = $(TCC) -DSQLITE_ENABLE_JSON1
   RCC = $(RCC) -DSQLITE_ENABLE_JSON1
   
   TCC = $(TCC) -DSQLITE_ENABLE_FTS3
   RCC = $(RCC) -DSQLITE_ENABLE_FTS3
   
   TCC = $(TCC) -DSQLITE_ENABLE_FTS3_PARENTHESIS
   RCC = $(RCC) -DSQLITE_ENABLE_FTS3_PARENTHESIS
   
   TCC = $(TCC) -DSQLITE_ENABLE_FTS5
   RCC = $(RCC) -DSQLITE_ENABLE_FTS5
   
   TCC = $(TCC) -DNOCRYPT
   RCC = $(RCC) -DNOCRYPT
   
   TCC = $(TCC) -DSQLCIPHER_CRYPTO_OPENSSL
   RCC = $(RCC) -DSQLCIPHER_CRYPTO_OPENSSL 
   

4. 添加 h 文件搜索路径

   TCC = $(TCC) -IC:\Users\lma\Desktop\Sqlcipher\opemssl_install_1.1.1\include
   RCC = $(RCC) -IC:\Users\lma\Desktop\Sqlcipher\opemssl_install_1.1.1\include
   

5. 添加 link 文件路径

   LTLIBPATHS = $(LTLIBPATHS) /LIBPATH:C:\Users\lma\Desktop\Sqlcipher\opemssl_install_1.1.1\lib
   LTLIBS = $(LTLIBS) libcrypto.lib
   

6. 打开 VS 自带的本机编译工具，执行 nmake /f Makefile.msc sqlite3.c

方式二

1. 运行 mingw-get.exe 程序, 根据需要安装 SQLCipher 编译环境.

2. 使用管理员权限运行 mingw\msys\1.0\msys.bat, 进入 msys shell 命令环境

3. 切换目录到 SQLCipher 源代码目录

4. 使用以下命令配置

   ./configure --enable-tempstore=yes --with-crypto-lib=none --disable-tcl CFLAGS="-DSQLITE_HAS_CODEC -DSQLITE_TEMP_STORE=2 -DSQLCIPHER_CRYPTO_OPENSSL -DSQLITE_ENABLE_FTS4 -DSQLITE_ENABLE_JSON1 -DSQLITE_ENABLE_FTS3 -DSQLITE_ENABLE_FTS3_PARENTHESIS -DSQLITE_ENABLE_FTS5 -DNOCRYPT -lcrypto -I/e/SQLiteWithCipher/openssl/include -L/e/SQLiteWithCipher/sqlcipher/ -static-libgcc" LDFLAGS="libcrypto.lib"
   

5. 执行编译命令

   • make clean 清理
   • make sqlite3.c 生成 sqlite3.c
   • make 生成可执行文件 sqlite3.exe
   • make dll 生成库文件 sqlite3.dll
   • lib /def:sqlite3.def 生成 sqlite3.lib

6. 如果需要静态库, 根据生成的 sqlite3.c 等文件自己建立一个工程, 生成 .lib 文件即可.

错误

• It looks like you don't have either nmake.exe or dmake.exe on your PATH,

  It looks like you don't have either nmake.exe or dmake.exe on your PATH, so you will not be able to execute the commands from a Makefile.
  You can install dmake.exe with the Perl Package Manager by running:
  
  ppm install dmake
  

  直接按照提示安装 dmake 即可

• nmake test 过程中出现 Dubious, test returned 255 (wstat 65280, 0xff00) 问题

  更换 OpenSSL 到无中文路径的目录下, 重新编译测试.

Mac 上编译 SqlCipher

编译 OpenSSL

1. 打开终端

2. 进入 OpenSSL 源代码目录下

3. 执行以下命令

   # ./Configure darwin64-x86_64-cc --prefix=yourlibdir CPPFLAGS="-mmacosx-version-min=10.7"
   # make
   # make test  // 测试. 如果全部成功, 会输出 All tests successful
   # make install_sw // 将生成的库放到 yourlibdir 中
   

   darwin-i386-cc 是 32 位编译, darwin64-x86_64-cc 是 64 位编译.

   yourlibdir 是最终安装的绝对路径

4. 在 yourlibdir 目录下已经生成了文件

   • libcrypto.1.1.dylib
   • libcrypto.a
   • libssl.1.1.dylib
   • libssl.a

编译 SQLCipher

1. 打开终端

2. 切换目录到 SQLCipher 源代码目录

3. 使用以下命令配置

   ./configure --enable-tempstore=yes --disable-tcl --with-crypto-lib=none CFLAGS="-mmacosx-version-min=10.7 -DSQLITE_HAS_CODEC -DSQLITE_TEMP_STORE=2 -DSQLCIPHER_CRYPTO_OPENSSL -DSQLITE_ENABLE_FTS4 -DSQLITE_ENABLE_JSON1 -DSQLITE_ENABLE_FTS3 -DSQLITE_ENABLE_FTS3_PARENTHESIS -DSQLITE_ENABLE_FTS5 -DNOCRYPT -I/openssllib/include" LDFLAGS="/openssllib/lib/libcrypto.a" CC=clang --prefix=yourlibdir
   

4. 执行编译命令

   • make clean 清理
   • make 生成可执行文件 sqlcipher, sqlite3.c 等文件
   • make install // 将生成的库放到 yourlibdir 中

错误

1. error C2220: 警告被视为错误 - 没有生成“object”文件

   我是在 Windows 上遇到这个问题. 这是由于 OpenSSL 1.0.2n 版本编译的时候警告级别的问题. 只需要降低警告级别就可以了，打开 ntdll.mak 文件，大概在第19行附近，将 CFLAG 参数中的 /W3 改成 /W0 就可以了

2. file was built for archive which is not the architecture being linked

   由于在 sqlcipher 编译过程中, 将 crypto.a 文件打包进入了 sqlitecipher.a 文件中, 导致了编译 node-sqlite3 的时候, 内嵌 sqlitecipher.a 文件的时候出现了错误. 截取了部分 sqlcipher 编译的输出:

   libtool: link: (cd ".libs" && rm -f "libsqlcipher.dylib" && ln -s "libsqlcipher.0.dylib" "libsqlcipher.dylib")
   libtool: link: ar cru .libs/libsqlcipher.a /Users/jack/Desktop/SQLiteWithCipher/lib/openssl/lib/libcrypto.a  sqlite3.o
   libtool: link: ranlib .libs/libsqlcipher.a
   

   在上面我们看到, 连接的时候直接把 .a 与 .o 写入了 libsqlcipher.a 中. 那么来验证一下我们的猜想:

    $ ar t libsqlcipher.a
   __.SYMDEF SORTED
   libcrypto.a
   sqlite3.o
   

   .a 文件, 其实就是 .o 文件的组合包. 但是里面混入了 .a 文件, 那么其他程序链接的时候就会出现错误. 这个时候有两种解决办法.

   1. 将 .a 解包获取 .o 文件(如果有源代码的话, 直接把 .o 文件拷贝过来), 使用. ot 文件重新打包.

      rm **.a
      ar rcs **.a 11.o 22.o
      clang -o test **.a test.o
      

   2. 修改上面的命令, 重新打包不包含 .a 文件的静态库.

参考

Building SQLCipher for node.js on Raspberry Pi 2

cross-sqlcipher

Linker complains “file was built for archive which is not the architecture being linked”

Node Sqlite3