SQLCipher integration with API for storing Session Pro revocations and account seed

.gitmodules

@@ -25,3 +25,6 @@
 [submodule "external/simdutf"]
 	path = external/simdutf
 	url = https://github.com/simdutf/simdutf.git
+[submodule "external/sqlcipher"]
+	path = external/sqlcipher
+	url = https://github.com/sqlcipher/sqlcipher

CMakeLists.txt

@@ -84,6 +84,9 @@ option(USE_LTO "Use Link-Time Optimization" ${use_lto_default})
 # Provide this as an option for now because GMP and Desktop are sometimes unhappy with each other.
 option(ENABLE_ONIONREQ "Build with onion request functionality" ON)
 
+# Provide this as an option for now so clients that don't use any database logic can exclude it.
+option(ENABLE_DATABASE "Build with database functionality" ON)
+
 if(USE_LTO)
   include(CheckIPOSupported)
   check_ipo_supported(RESULT IPO_ENABLED OUTPUT ipo_error)
@@ -136,10 +139,6 @@ endif()
 add_subdirectory(src)
 add_subdirectory(proto)
 
-if (BUILD_STATIC_DEPS)
-    include(StaticBuild)
-endif()
-
 if(STATIC_BUNDLE)
 
     include(combine_archives)

README.md

@@ -3,33 +3,47 @@
 ## Build
 
 ```
+# Pre-requisites
+apt install cmake build-essential git libssl-dev m4 pkg-config ninja-build
+
 # Configure the build
 #
 # Options
-#   Enable APIs for creating onion-requests with:
+#   - Build libsession with its dependencies statically linked into the library (default: ON)
+#
+#     -D BUILD_STATIC_DEPS=ON
+#
+#     This currently influences top-level dependencies and forces OpenSSL on Linux/Windows to be
+#     statically linked into SQLCipher for database support.
+#
+#   - Enable APIs for creating onion-requests with (default: ON)
+#
+#     -D ENABLE_ONIONREQ=ON
+#
+#   - Enable SQLCipher database support (default: ON)
 #
-#     -D ENABLE_ONIONERQ
+#     -D ENABLE_DATABASE=ON
 #
-#   Enable testing of a Session Pro Backend by defining on the configure line:
+#   - Enable testing of a Session Pro Backend by defining on the configure line (default: OFF)
 #
-#     -D TEST_PRO_BACKEND_WITH_DEV_SERVER=1
+#     -D TEST_PRO_BACKEND_WITH_DEV_SERVER=ON
 #
-#   These tests require the Session Pro Backend running in development mode (SESH_PRO_BACKEND_DEV=1)
-#   to be running and tests the request and response flow of registering, updating and revoking
-#   Session Pro from the development backend. You must also have a libcurl available such that
-#   `find_package(CURL)` succeeds (e.g. a system installed libcurl) for this to compile
-#   successfully.
+#     These tests require the Session Pro Backend running in development mode
+#     (SESH_PRO_BACKEND_DEV=1) to be running and tests the request and response flow of registering,
+#     updating and revoking Session Pro from the development backend. You must also have a libcurl
+#     available such that `find_package(CURL)` succeeds (e.g. a system installed libcurl) for this
+#     to compile successfully.
 #
-#   By default, it contacts http://127.0.0.1:5000 but this URL can be changed using the CLI arg
-#   --pro-backend-dev-server-url="<url>" when invoking the test suite.
+#     These tests do not run by default, they can be invoked by passing the dev server URL in the
+#     CLI arg --pro-backend-dev-server-url="<url>" when invoking the test suite.
 #
 cmake -G Ninja -S . -B Build
 
-# Regenerate protobuf files
-cmake --build Build --target regen-protobuf --parallel --verbose
-
 # Build
 cmake --build Build --parallel --verbose
+
+# Regenerate protobuf files
+cmake --build Build --target regen-protobuf --parallel --verbose
 ```
 
 ## Docs