SQLCipher is an SQLite extension that provides 256 bit AES encryption of database files.
C Tcl Shell M4 Makefile Yacc Other
Latest commit df092f0 Dec 28, 2016 @developernotes developernotes Update changelog
Permalink
Failed to load latest commit information.
.github Initial contributing, issue, and pull request template for Github Feb 24, 2016
art track 3.7.12 May 15, 2012
autoconf Snapshot of upstream SQLite 3.15.2 Dec 5, 2016
contrib track 3.7.6.2 May 6, 2011
doc Snapshot of upstream SQLite 3.15.2 Dec 5, 2016
ext Snapshot of upstream SQLite 3.15.2 Dec 5, 2016
macosx Fixed build related issues with included files and umbrella header. Nov 18, 2015
mptest Snapshot of upstream SQLite 3.11.0 Feb 23, 2016
sqlcipher.xcodeproj Fixed build related issues with included files and umbrella header. Nov 18, 2015
src Default page size to 1024 Dec 22, 2016
test Update cipher_version test to 3.4.1 Dec 22, 2016
tool Merge sqlite-release(3.15.2) into prerelease-integration Dec 6, 2016
vsixtest Snapshot of upstream SQLite 3.15.2 Dec 5, 2016
.gitignore Add PRAGMA cipher_profile support Apr 7, 2014
CHANGELOG.md Update changelog Dec 28, 2016
LICENSE add a prominent LICENSE file (to help make sure terms are clear) Jan 13, 2012
Makefile.in Merge sqlite-release(3.15.2) into prerelease-integration Dec 6, 2016
Makefile.linux-gcc Snapshot of upstream SQLite 3.11.0 Feb 23, 2016
Makefile.msc Merge sqlite-release(3.15.2) into prerelease-integration Dec 6, 2016
README.md Link to SQLite in README May 9, 2016
VERSION Snapshot of upstream SQLite 3.15.2 Dec 5, 2016
aclocal.m4 Update from autoreconf Feb 22, 2016
config.guess commit of sqlite 3.6.0 Jul 30, 2008
config.h.in Merge sqlite-release(3.15.2) into prerelease-integration Dec 6, 2016
config.sub commit of sqlite 3.6.0 Jul 30, 2008
configure Merge sqlite-release(3.15.2) into prerelease-integration Dec 6, 2016
configure.ac Merge sqlite-release(3.15.2) into prerelease-integration Dec 6, 2016
install-sh commit of sqlite 3.6.0 Jul 30, 2008
ltmain.sh Update from autoreconf Feb 22, 2016
magic.txt Snapshot of upstream SQLite 3.8.6 Sep 30, 2014
main.mk Snapshot of upstream SQLite 3.15.2 Dec 5, 2016
manifest Snapshot of upstream SQLite 3.15.2 Dec 5, 2016
manifest.uuid Snapshot of upstream SQLite 3.15.2 Dec 5, 2016
mkso.sh update baseline to sqlite version 3.6.1 Aug 19, 2008
spec.template commit of sqlite 3.6.0 Jul 30, 2008
sqlcipher-1.1.8-testkey.db Adjust sqlite3_test_control_pending_byte to test larger files Sep 23, 2013
sqlcipher-2.0-be-testkey.db Adjust sqlcipher-2.0-be-testkey.db to 1 MB in size Sep 23, 2013
sqlcipher-2.0-beta-testkey.db Bumping file size of sqlcipher-2.0-beta-testkey.db to 1 MB Sep 23, 2013
sqlcipher-2.0-le-testkey.db Adjust file size of sqlcipher-2.0-le-testkey.db to over 1 MB Sep 23, 2013
sqlcipher-3.0-testkey.db Adjust file size of sqlcipher-3.0-testkey.db to 1 MB Sep 23, 2013
sqlcipher.1 Merge sqlite-release(3.8.8.3) into prerelease-integration Mar 20, 2015
sqlcipher.pc.in SQLCipher headers are installed into ${includedir}/sqlcipher Oct 17, 2014
sqlite.pc.in track sqlite 3.6.11 Feb 20, 2009

README.md

SQLCipher

SQLCipher extends the SQLite database library to add security enhancements that make it more suitable for encrypted local data storage such as on-the-fly encryption, tamper evidence, and key derivation. Based on SQLite, SQLCipher closely tracks SQLite and periodically integrates stable SQLite release features.

SQLCipher is maintained by Zetetic, LLC, the official site can be found here.

Features

  • Fast performance with as little as 5-15% overhead for encryption on many operations
  • 100% of data in the database file is encrypted
  • Good security practices (CBC mode, HMAC, key derivation)
  • Zero-configuration and application level cryptography
  • Algorithms provided by the peer reviewed OpenSSL crypto library.
  • Configurable crypto providers

Contributions

We welcome contributions, to contribute to SQLCipher, a contributor agreement needs to be submitted. All submissions should be based on the prerelease branch.

Compiling

Building SQLCipher is almost the same as compiling a regular version of SQLite with two small exceptions:

  1. You must define SQLITE_HAS_CODEC and SQLITE_TEMP_STORE=2 when building sqlcipher.
  2. If compiling against the default OpenSSL crypto provider, you will need to link libcrypto

Example Static linking (replace /opt/local/lib with the path to libcrypto.a). Note in this example, --enable-tempstore=yes is setting SQLITE_TEMP_STORE=2 for the build.

$ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
	LDFLAGS="/opt/local/lib/libcrypto.a"
$ make

Example Dynamic linking

$ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
	LDFLAGS="-lcrypto"
$ make

Encrypting a database

To specify an encryption passphrase for the database via the SQL interface you use a pragma. The passphrase you enter is passed through PBKDF2 key derivation to obtain the encryption key for the database

PRAGMA key = 'passphrase';

Alternately, you can specify an exact byte sequence using a blob literal. If you use this method it is your responsibility to ensure that the data you provide a 64 character hex string, which will be converted directly to 32 bytes (256 bits) of key data without key derivation.

PRAGMA key = "x'2DD29CA851E7B56E4697B0E1F08507293D761A05CE4D1B628663F411A8086D99'";

To encrypt a database programatically you can use the sqlite3_key function. The data provided in pKey is converted to an encryption key according to the same rules as PRAGMA key.

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

PRAGMA key or sqlite3_key should be called as the first operation when a database is open.

Changing a database key

To change the encryption passphrase for an existing database you may use the rekey pragma after you've supplied the correct database password;

PRAGMA key = 'passphrase'; -- start with the existing database passphrase
PRAGMA rekey = 'new-passphrase'; -- rekey will reencrypt with the new passphrase

The hex rekey pragma may be used to rekey to a specific binary value

PRAGMA rekey = "x'2DD29CA851E7B56E4697B0E1F08507293D761A05CE4D1B628663F411A8086D99'";

This can be accomplished programtically by using sqlite3_rekey;

sqlite3_rekey(sqlite3 *db, const void *pKey, int nKey)

Support

The primary avenue for support and discussions is the SQLCipher discuss site:

https://discuss.zetetic.net/c/sqlcipher

Issues or support questions on using SQLCipher should be entered into the GitHub Issue tracker:

https://github.com/sqlcipher/sqlcipher/issues

Please DO NOT post issues, support questions, or other problems to blog posts about SQLCipher as we do not monitor them frequently.

If you are using SQLCipher in your own software please let us know at support@zetetic.net!

License

Copyright (c) 2016, ZETETIC LLC All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the ZETETIC LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ZETETIC LLC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ZETETIC LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.