Visitar URL original
Update README for 5.0.0-beta.1 · sqlcipher/sqlcipher-android@92ebdcb · GitHub
Skip to content

Commit 92ebdcb

Browse files
developernotesdevelopernotes
committed
Update README for 5.0.0-beta.1
1 parent 0c027e1 commit 92ebdcb

2 files changed

Lines changed: 22 additions & 16 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@
33
SQLCipher for Android provides a library replacement for `android.database.sqlite` on the Android platform for use on [SQLCipher](https://github.com/sqlcipher/sqlcipher) databases. This library is based on the upstream [Android Bindings](https://www.sqlite.org/android/doc/trunk/www/index.wiki) project and aims to be a long-term replacement for the original [SQLCipher for Android](https://github.com/sqlcipher/android-database-sqlcipher) library.
44

55
> [!CAUTION]
6-
> ## SQLCipher 5.0.0-beta details
6+
> ## SQLCipher 5.0.0-beta.1 details
77
> Summary:
8-
> - Changes architecture to use VFS shims
9-
> - Uses AEAD Encryption with AES-256-GCM
10-
> - Increases KDF iteration increase to 512K
11-
> - Increase default page size to 8192 bytes
12-
> - Adds encryption and decryption support to PRAGMA rekey
13-
> - **BREAKING CHANGES** - see [CHANGELOG.md](https://github.com/sqlcipher/sqlcipher/blob/v5.0.0-beta/CHANGELOG.md#500-beta----2026---500-beta-changes) and [release announcement](https://www.zetetic.net/blog/2026/09/15/sqlcipher-5.0.0-beta/)
8+
> - Changes architecture to use codec
9+
> - Adjusts KDF iteration back to 256K
10+
> - Rekey support for databases in WAL mode with concurrent connections
11+
> - Journal spill behavior is now locked down to prevent plaintext writes
12+
> - Fixed a bug where cipher_hmac_fast_kdf could write the page HMAC past the reserved area
13+
> - Improved error handling and reporting for rekey failures
14+
> - Fixed shared cache connections for encrypted databases
15+
> - Added PRAGMA cipher_selftest for verifying internal implementations
16+
> - **BREAKING CHANGES** - see [CHANGELOG.md](https://github.com/sqlcipher/sqlcipher/blob/beta/CHANGELOG.md#500-beta1---oct-2026---500-beta1-changes) and [release announcement](https://www.zetetic.net/blog/2026/10/22/sqlcipher-5.0.0-beta.1/)
1417
1518
### Compatibility
1619

@@ -129,7 +132,7 @@ There are two different compile-specific options available to alter the logging
129132
To manage the logging produced from SQLCipher core, please review the runtime configurations: [`PRAGMA cipher_log`](https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log),
130133
[`PRAGMA cipher_log_level`](https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log_level), and [`PRAGMA cipher_log_source`](https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log_source).
131134

132-
### Building
135+
### Building
133136

134137
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):
135138

‎README.md.template‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@
33
SQLCipher for Android provides a library replacement for `android.database.sqlite` on the Android platform for use on [SQLCipher](https://github.com/sqlcipher/sqlcipher) databases. This library is based on the upstream [Android Bindings](https://www.sqlite.org/android/doc/trunk/www/index.wiki) project and aims to be a long-term replacement for the original [SQLCipher for Android](https://github.com/sqlcipher/android-database-sqlcipher) library.
44

55
> [!CAUTION]
6-
> ## SQLCipher 5.0.0-beta details
6+
> ## SQLCipher 5.0.0-beta.1 details
77
> Summary:
8-
> - Changes architecture to use VFS shims
9-
> - Uses AEAD Encryption with AES-256-GCM
10-
> - Increases KDF iteration increase to 512K
11-
> - Increase default page size to 8192 bytes
12-
> - Adds encryption and decryption support to PRAGMA rekey
13-
> - **BREAKING CHANGES** - see [CHANGELOG.md](https://github.com/sqlcipher/sqlcipher/blob/v5.0.0-beta/CHANGELOG.md#500-beta----2026---500-beta-changes) and [release announcement](https://www.zetetic.net/blog/2026/09/15/sqlcipher-5.0.0-beta/)
8+
> - Changes architecture to use codec
9+
> - Adjusts KDF iteration back to 256K
10+
> - Rekey support for databases in WAL mode with concurrent connections
11+
> - Journal spill behavior is now locked down to prevent plaintext writes
12+
> - Fixed a bug where cipher_hmac_fast_kdf could write the page HMAC past the reserved area
13+
> - Improved error handling and reporting for rekey failures
14+
> - Fixed shared cache connections for encrypted databases
15+
> - Added PRAGMA cipher_selftest for verifying internal implementations
16+
> - **BREAKING CHANGES** - see [CHANGELOG.md](https://github.com/sqlcipher/sqlcipher/blob/beta/CHANGELOG.md#500-beta1---oct-2026---500-beta1-changes) and [release announcement](https://www.zetetic.net/blog/2026/10/22/sqlcipher-5.0.0-beta.1/)
1417

1518
### Compatibility
1619

@@ -129,7 +132,7 @@ There are two different compile-specific options available to alter the logging
129132
To manage the logging produced from SQLCipher core, please review the runtime configurations: [`PRAGMA cipher_log`](https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log),
130133
[`PRAGMA cipher_log_level`](https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log_level), and [`PRAGMA cipher_log_source`](https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log_source).
131134

132-
### Building
135+
### Building
133136

134137
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):
135138

0 commit comments

Comments
 (0)