aboutsummaryrefslogtreecommitdiffstats
path: root/src/contrib/sqlite/readme.txt
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2016-11-05 22:07:02 -0400
committerJack Lloyd <[email protected]>2016-11-05 22:16:28 -0400
commit750902b7832792a74d073b4973e6b60a9731977b (patch)
tree03f9810f1eb8ad7343adeaf479336408509f9cf0 /src/contrib/sqlite/readme.txt
parentaf7af14fb97299fc70a2a1f8590288fbf91f271b (diff)
Revert "Move contrib/sqlite to github.com/randombit/botan-sqlite"
This reverts commit cfb12bf77940c566de1e6de4a79db6fe0d02ef1e. tl;dr monorepo is better, especially for a project this small.
Diffstat (limited to 'src/contrib/sqlite/readme.txt')
-rw-r--r--src/contrib/sqlite/readme.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/src/contrib/sqlite/readme.txt b/src/contrib/sqlite/readme.txt
new file mode 100644
index 000000000..4971fd44b
--- /dev/null
+++ b/src/contrib/sqlite/readme.txt
@@ -0,0 +1,35 @@
+Build instructions for BotanSqlite3
+---
+
+Requirements:
+ 1. Botan 1.9.0 or later
+ 2. SQLite3 amalgamation source, version 3.7.12.1 or later (previous versions may work, some will need minor changes)
+
+
+Building:
+
+1. Extract sqlite3 amalgamation to a directory and add BotanSqlite3 source files
+
+ If desired, codec.h can be modified to tweak the encryption algothrithms and parameters. (Defaults to Twofish/XTS with 256 bit key)
+
+2. Apply the patch "sqlite3.diff":
+ $ patch -p0 < sqlite3-amalgamation.patch
+
+ If the patching fails for some reason (ie, changes in SQLite3), it should be trivial to do it manually.
+
+3. Compile the sqlite3 library with Botan encryption support:
+ $ gcc -c sqlite3.c -o botansqlite3.o && gcc -c codec.cpp -o codec.o `pkg-config --cflags botan-1.10` && ar rcs libbotansqlite3.a botansqlite3.o codec.o
+
+ (replace "botan-1.10" with appropriate version)
+
+Testing:
+
+1. Build the test:
+ $ g++ test_sqlite.cpp -o test_sqlite `botan-config-1.10 --libs` ./libbotansqlite3.a
+
+ (replace botan-config-1.10 w/ appropriate version)
+
+2. Run the test
+ $ ./test_sqlite
+
+3. Look for "All seems good"