Skip to content

Commit 3848d53

Browse files
Adjust README with notes on OpenSSL build
1 parent 1117df7 commit 3848d53

2 files changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ To manage the logging produced from SQLCipher core, please review the runtime co
106106

107107
### Building
108108

109-
This project and it's dependencies can be built directly within Android Studio. Currently, SQLCipher for Android uses NDK version "25.2.9519653". The repository includes a submodule for SQLCipher core, and LibTomCrypt as external dependencies. When cloning the repository, please execute the following command at the root of the project:
109+
This project and it's dependencies can be built directly within Android Studio. Currently, SQLCipher for Android uses NDK version "25.2.9519653". The repository includes a submodule for SQLCipher core, and LibTomCrypt as external dependencies. When cloning the repository, please execute the following command at the root of the project (the build phase will check for this on your behalf):
110110

111111
```
112112
git submodule update --init
@@ -115,6 +115,12 @@ git submodule update --init
115115
To build the AAR package, either build directly within Android Studio, or from the command line:
116116

117117
```
118-
./gradlew -PsqlcipherAndroidVerison="4.14.0" assembleRelease
118+
./gradlew assembleRelease
119119
```
120120

121+
#### Using OpenSSL
122+
123+
By default, SQLCipher for Android uses LibTomCrypt as the default crypto provider. Alternatively, you may build SQLCipher for Android linked with OpenSSL. Instructions for building OpenSSL to target Android-specific ABI's are outside the scope of this project. Below are the integration steps necessary for the project to utilize the OpenSSL libraries during the build phase.
124+
125+
1. Place your ABI-specific `libcrypto.a` files and `include` directory in `sqlcipher/src/main/jni/sqlcipher/android-libs`
126+
2. Specify all required SQLCipher Core `CFLAGS` within the environment variable `SQLCIPHER_CFLAGS` including `-DSQLCIPHER_CRYPTO_OPENSSL` and `-DSQLITE_HAS_CODEC`

README.md.template

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ To manage the logging produced from SQLCipher core, please review the runtime co
106106

107107
### Building
108108

109-
This project and it's dependencies can be built directly within Android Studio. Currently, SQLCipher for Android uses NDK version "<%=androidNdkVersion%>". The repository includes a submodule for SQLCipher core, and LibTomCrypt as external dependencies. When cloning the repository, please execute the following command at the root of the project:
109+
This project and it's dependencies can be built directly within Android Studio. Currently, SQLCipher for Android uses NDK version "<%=androidNdkVersion%>". The repository includes a submodule for SQLCipher core, and LibTomCrypt as external dependencies. When cloning the repository, please execute the following command at the root of the project (the build phase will check for this on your behalf):
110110

111111
```
112112
git submodule update --init
@@ -115,6 +115,12 @@ git submodule update --init
115115
To build the AAR package, either build directly within Android Studio, or from the command line:
116116

117117
```
118-
./gradlew -PsqlcipherAndroidVerison="<%=libraryVersion%>" assembleRelease
118+
./gradlew assembleRelease
119119
```
120120

121+
#### Using OpenSSL
122+
123+
By default, SQLCipher for Android uses LibTomCrypt as the default crypto provider. Alternatively, you may build SQLCipher for Android linked with OpenSSL. Instructions for building OpenSSL to target Android-specific ABI's are outside the scope of this project. Below are the integration steps necessary for the project to utilize the OpenSSL libraries during the build phase.
124+
125+
1. Place your ABI-specific `libcrypto.a` files and `include` directory in `sqlcipher/src/main/jni/sqlcipher/android-libs`
126+
2. Specify all required SQLCipher Core `CFLAGS` within the environment variable `SQLCIPHER_CFLAGS` including `-DSQLCIPHER_CRYPTO_OPENSSL` and `-DSQLITE_HAS_CODEC`

0 commit comments

Comments
 (0)