status-im/sqlcipher
2
0
Fork 0
mirror of https://github.com/status-im/sqlcipher.git synced 2025-02-23 09:18:11 +00:00
Code Issues Projects Releases Wiki Activity

updated documentation on how to build and use sqlite-cipher in README

Browse Source
This commit is contained in:
Stephen Lombardo 2008-07-30 21:47:23 -04:00
parent b185f3b2ed
commit 5b4d50c488
1 changed files with 47 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README
View File

@ -1,22 +1,59 @@
== SQLite Cipher Introduction ==
== SQLite Cipher ==
SQLite Cipher is an SQLite extension that provides transparent 256 bit AES encryption of database files.
Pages are encrypted before being written to disk and are decrypted when read back.
Encryption is provided by the OpenSSL crypto library.
Static linking (replace /opt/local/lib with the path to libcrypto.a)
./configure --disable-amalgamation CFLAGS="-DSQLITE_HAS_CODEC" LDFLAGS="/opt/local/lib/libcrypto.a"
make
Dynamic linking
./configure --disable-amalgamation CFLAGS="-DSQLITE_HAS_CODEC -lcrypto"
make
SQLite Cipher was developed by Stephen Lombardo at Zetetic LLC.
sjlombardo at zetetic.net
http://zetetic.net
[Compiling]
Building SQLite Cipher is almost the same as compiling a regular version of SQLite with three small exceptions:
1. building via 'amalgamation' isn't supported (where all sqlite source is merged into one file)
2. you must define SQLITE_HAS_CODEC
3. You need to link against a OpenSSL's libcrypto with sha256 support compiled in
Example Static linking (replace /opt/local/lib with the path to libcrypto.a)
./configure --disable-amalgamation CFLAGS="-DSQLITE_HAS_CODEC" LDFLAGS="/opt/local/lib/libcrypto.a"
make
Example Dynamic linking
./configure --disable-amalgamation CFLAGS="-DSQLITE_HAS_CODEC -lcrypto"
make
[Encrypting a database]
To specify an encryption passphrase for the database you can use a pragma. The passphrase
you enter is hashed using sha256 and the result is used as 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.
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.
Note: It is not currently possible to change the encryption key once a database is created. We're
working on implementing rekey functionality.
[License]
This code is released under the same public domain terms as SQLite itself.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
@ -27,7 +64,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
== End Introduction ==
== End SQLite Cipher ==
This directory contains source code to