status-im
/
sqlcipher
mirror of https://github.com/status-im/sqlcipher.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

improvements to the readme

This commit is contained in:
Stephen Lombardo 2020-04-30 10:14:04 -04:00
parent 005ea9d083
commit acfd5c62ce
1 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1,6 +1,13 @@
## SQLCipher ## SQLCipher
SQLCipher extends the [SQLite](https://www.sqlite.org) 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 extends the [SQLite](https://www.sqlite.org) database library to add security enhancements that make it more suitable for encrypted local data storage like:
- on-the-fly encryption
- tamper detection
- memory sanitization
- strong key derivation
SQLCipher is based on SQLite and stable upstream release features are periodically integrated.
SQLCipher is maintained by Zetetic, LLC, and additional information and documentation is available on the official [SQLCipher site](https://www.zetetic.net/sqlcipher/). SQLCipher is maintained by Zetetic, LLC, and additional information and documentation is available on the official [SQLCipher site](https://www.zetetic.net/sqlcipher/).
@ -21,33 +28,38 @@ SQLCipher is also compatible with standard SQLite databases. When a key is not p
## Contributions ## Contributions
The SQLCipher team welcomes contributions to the core library. All contributions including pull requests and patches should be based on the `prerelease` branch, and must be accompanied by a [contributor agreement](https://www.zetetic.net/contributions/). For large changes we strongly encourage [discussion](https://discuss.zetetic.net/c/sqlcipher) of the proposed change prior to development and submission. The SQLCipher team welcomes contributions to the core library. All contributions including pull requests and patches should be based on the `prerelease` branch, and must be accompanied by a [contributor agreement](https://www.zetetic.net/contributions/). We strongly encourage [discussion](https://discuss.zetetic.net/c/sqlcipher) of the proposed change prior to development and submission.
## Compiling ## Compiling
Building SQLCipher is almost the same as compiling a regular version of Building SQLCipher is similar to compiling a regular version of SQLite from source a couple small exceptions:
SQLite with two small exceptions:
1. You *must* define `SQLITE_HAS_CODEC` and `SQLITE_TEMP_STORE=2` when building sqlcipher. 1. You *must* define `SQLITE_HAS_CODEC` and either `SQLITE_TEMP_STORE=2` or SQLITE_TEMP_STORE=3`
2. If compiling against the default OpenSSL crypto provider, you will need to link libcrypto 2. You will need to link against a support cryptograpic provider (OpenSSL, LibTomCrypt, CommonCrypto/Security.framework, or NSS)
Example Static linking (replace /opt/local/lib with the path to libcrypto.a). Note in this The following examples demonstrate linking against OpenSSL, which is a readily available provider on most Unix-like systems.
Example 1. 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. example, `--enable-tempstore=yes` is setting `SQLITE_TEMP_STORE=2` for the build.
```
$ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \ $ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
LDFLAGS="/opt/local/lib/libcrypto.a" LDFLAGS="/opt/local/lib/libcrypto.a"
$ make $ make
```
Example Dynamic linking Example 2. Dynamic linking
```
$ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \ $ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
LDFLAGS="-lcrypto" LDFLAGS="-lcrypto"
$ make $ make
```
## Encrypting a database ## Encrypting a database
To specify an encryption passphrase for the database via the SQL interface you 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 use a PRAGMA. The passphrase you enter is passed through PBKDF2 key derivation to
obtain the encryption key for the database obtain the encryption key for the database
PRAGMA key = 'passphrase'; PRAGMA key = 'passphrase';
@ -69,7 +81,7 @@ same rules as `PRAGMA key`.
## Changing a database key ## Changing a database key
To change the encryption passphrase for an existing database you may use the rekey pragma To change the encryption passphrase for an existing database you may use the rekey PRAGMA
after you've supplied the correct database password; after you've supplied the correct database password;
PRAGMA key = 'passphrase'; -- start with the existing database passphrase PRAGMA key = 'passphrase'; -- start with the existing database passphrase
@ -85,6 +97,10 @@ This can be accomplished programmatically by using sqlite3_rekey;
## Support ## Support
The primary source for complete SQLCipher documentation is the SQLCipher website:
https://www.zetetic.net/sqlcipher/documentation
The primary avenue for support and discussions is the SQLCipher discuss site: The primary avenue for support and discussions is the SQLCipher discuss site:
https://discuss.zetetic.net/c/sqlcipher https://discuss.zetetic.net/c/sqlcipher
@ -100,9 +116,9 @@ posts about SQLCipher as we do not monitor them frequently.
If you are using SQLCipher in your own software please let us know at If you are using SQLCipher in your own software please let us know at
support@zetetic.net! support@zetetic.net!
## License ## Community Edition Open Source License
Copyright (c) 2016, ZETETIC LLC Copyright (c) 2020, ZETETIC LLC
All rights reserved. All rights reserved.
Redistribution and use in source and binary forms, with or without Redistribution and use in source and binary forms, with or without