Updates README.md with new build instructions and required CFLAGS

sjlombardo · sjlombardo · commit 57d38556213b · 2025-03-17T12:44:29.000-04:00
diff --git a/README.md b/README.md
@@ -17,8 +17,7 @@ SQLCipher is maintained by Zetetic, LLC, and additional information and document
 - 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
+- Support for multiple cryptographic providers
 
 ## Compatibility
 
@@ -32,26 +31,18 @@ The SQLCipher team welcomes contributions to the core library. All contributions
 
 ## Compiling
 
-Building SQLCipher is similar to compiling a regular version of SQLite from source, with a couple of small exceptions:
+Building SQLCipher is similar to compiling a regular version of SQLite from source, with a few small exceptions. You must:
 
- 1. You *must* define `SQLITE_HAS_CODEC` and either `SQLITE_TEMP_STORE=2` or `SQLITE_TEMP_STORE=3`
- 2. You will need to link against a support cryptographic provider (OpenSSL, LibTomCrypt, CommonCrypto/Security.framework, or NSS)
+ 1. define `SQLITE_HAS_CODEC`
+ 2. define `SQLITE_TEMP_STORE=2` or `SQLITE_TEMP_STORE=3` (or use `configure`'s --with-tempstore=yes option)
+ 3. define `SQLITE_EXTRA_INIT=sqlcipher_extra_init` and `SQLITE_EXTRA_SHUTDOWN=sqlcipher_extra_shutdown`
+ 4. define `SQLITE_THREADSAFE` to `1` or `2` (enabled automatically by `configure`)
+ 2. compile and link with a supported cryptographic provider (OpenSSL, LibTomCrypt, CommonCrypto/Security.framework, or NSS)
  
-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, `--with-tempstore=yes` is setting `SQLITE_TEMP_STORE=2` for the build.
-
-```
-$ ./configure --with-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
-	LDFLAGS="/opt/local/lib/libcrypto.a"
-$ make
-```
-
-Example 2. Dynamic linking
+The following examples demonstrate use of OpenSSL, which is a readily available provider on most Unix-like systems. Note that, in this example, `--with-tempstore=yes` is setting `SQLITE_TEMP_STORE=2` for the build, and `SQLITE_THREADSAFE` has a default value of `1`.
 
 ```
-$ ./configure --with-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
+$ ./configure --with-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC -DSQLITE_EXTRA_INIT=sqlcipher_extra_init -DSQLITE_EXTRA_SHUTDOWN=sqlcipher_extra_shutdown" \
 	LDFLAGS="-lcrypto"
 $ make
 ```
@@ -65,7 +56,7 @@ As a result, the SQLCipher package includes it's own independent tests that exer
 To run SQLCipher specific tests, configure as described here and run the following to execute the tests and receive a report of the results:
 
 ```
-$ ./configure --with-tempstore=yes --enable-fts5 CFLAGS="-DSQLITE_HAS_CODEC -DSQLCIPHER_TEST" \
+$ ./configure --with-tempstore=yes --enable-fts5 CFLAGS="-DSQLITE_HAS_CODEC -DSQLITE_EXTRA_INIT=sqlcipher_extra_init -DSQLITE_EXTRA_SHUTDOWN=sqlcipher_extra_shutdown -DSQLCIPHER_TEST" \
 	LDFLAGS="-lcrypto"
 $ make testfixture
 $ ./testfixture test/sqlcipher.test
@@ -133,7 +124,7 @@ support@zetetic.net!
 
 ## Community Edition Open Source License
 
-Copyright (c) 2020, ZETETIC LLC
+Copyright (c) 2025, ZETETIC LLC
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
