CHANGELOG.md

   1 # SQLCipher Change Log
   2 All notable changes to this project will be documented in this file.
   3
   4 ## [4.4.2] - (November 2020 - [4.4.2 changes])
   5 - Improve error handling to resolve potential corruption if an encryption operation failed while operating in WAL mode
   6 - Changes to OpenSSL library cryptographic provider to reduce initialization complexity
   7 - Adjust cipher_integrity_check to skip locking page to avoid a spurious error report for very large databases
   8 - Miscellaneous code and comment cleanup
   9
  10 ## [4.4.1] - (October 2020 - [4.4.1 changes])
  11 - Updates baseline to upstream SQLite 3.33.0
  12 - Fixes double-free bug in cipher_default_plaintext_header_size
  13 - Changes SQLCipher tests to use suite runner
  14 - Improvement to cipher_integrity_check tests to minimize false negatives
  15 - Deprecates PRAGMA cipher_store_pass
  16
  17 ## [4.4.0] - (May 2020 - [4.4.0 changes])
  18 - Updates baseline to upstream SQLite 3.31.0
  19 - Adjusts shell to report SQLCipher version alongside SQLite version
  20 - Fixes various build warnings under several compilers
  21 - Removes unused id and status functions from provider interface
  22
  23 ## [4.3.0] - (November 2019 - [4.3.0 changes])
  24 - Updates baseline to upstream SQLite 3.30.1
  25 - PRAGMA key now returns text result value "ok" after execution
  26 - Adjusts backup API so that encrypted to encrypted backups are permitted
  27 - Adds NSS crypto provider implementation
  28 - Fixes OpenSSL provider compatibility with BoringSSL
  29 - Separates memory related traces to reduce verbosity of logging
  30 - Fixes output of PRAGMA cipher_integrity_check on big endian platforms
  31 - Cryptograpic provider interface cleanup
  32 - Rework of mutex allocation and management
  33 - Resolves miscellaneous build warnings
  34 - Force error state at database pager level if SQLCipher initialization fails
  35
  36 ## [4.2.0] - (May 2019 - [4.2.0 changes])
  37 - Adds PRAGMA cipher_integrity_check to perform independent verification of page HMACs
  38 - Updates baseline to upstream SQLite 3.28.0
  39 - Improves PRAGMA cipher_migrate to handle keys containing non-terminating zero bytes
  40
  41 ## [4.1.0] - (March 2019 - [4.1.0 changes])
  42 - Defer reading salt from header until key derivation is triggered
  43 - Clarify usage of sqlite3_rekey for plaintext databases in header
  44 - Normalize attach behavior when key is not yet derived
  45 - Adds PRAGMA cipher_settings to query current database codec settings
  46 - Adds PRAGMA cipher_default_settings to query current default SQLCipher options
  47 - PRAGMA cipher_hmac_pgno is now deprecated
  48 - PRAGMA cipher_hmac_salt_mask is now deprecated
  49 - PRAGMA fast_kdf_iter is now deprecated
  50 - Improve sqlcipher_export routine and restore all database flags
  51 - Clear codec data buffers if a crypographic provider operation fails
  52 - Disable backup API for encrypted databases (this was previously documented as not-working and non-supported, but will now explicitly error out on initialization)
  53 - Updates baseline to upstream SQLite 3.27.2
  54
  55 ## [4.0.1] - (December 2018 - [4.0.1 changes])
  56 - Based on upstream SQLite 3.26.0 (addresses SQLite “Magellan” issue)
  57 - Adds PRAGMA cipher_compatibility and cipher_default_compatibility which take automatcially configure appropriate compatibility settings for the specified SQLCipher major version number
  58 - Filters attach statements with KEY parameters from readline history
  59 - Fixes crash in command line shell with empty input (i.e. ^D)
  60 - Fixes warnings when compiled with strict-prototypes
  61
  62 ## [4.0.0] - (November 2018 - [4.0.0 changes])
  63 ### Changed
  64 - Default page size for databases increased to 4096 bytes (up from 1024) *
  65 - Default PBKDF2 iterations increased to 256,000 (up from 64,000) *
  66 - Default KDF algorithm is now PBKDF2-HMAC-SHA512 (from PBKDF2-HMAC-SHA1) *
  67 - Default HMAC algorithm is now HMAC-SHA512 (from HMAC-SHA1) *
  68 - PRAGMA cipher is now disabled and no longer supported (after multi-year deprecation) *
  69 - PRAGMA rekey_cipher is now disabled and no longer supported *
  70 - PRAGMA rekey_kdf_iter is now disabled and no longer supported *
  71 - By default all memory allocated internally by SQLite before the memory is wiped before it is freed
  72 - PRAGMA cipher_memory_security: allows full memory wiping to be disabled for performance when the feature is not required
  73 - PRAGMA cipher_kdf_algorithm, cipher_default_kdf_algorithm to control KDF algorithm selection between PBKDF2-HMAC-SHA1, PBKDF2-HMAC-SHA256 and PBKDF2-HMAC-SHA512
  74 - PRAGMA cipher_hmac_algorithm, cipher_default_hmac_algorithm to control HMAC algorithm selection between HMAC-SHA1, HMAC-SHA256 and PBKDF2-HMAC-SHA512
  75 - Based on upstream SQLite 3.25.2
  76 - When compiled with readline support, PRAGMA key and rekey lines will no longer be
  77   saved to history
  78 - Adds second optional parameter to sqlcipher_export to specify source database to
  79   support bidirectional exports
  80 - Fixes compatibility with LibreSSL 2.7.0+
  81 - Fixes compatibility with OpenSSL 1.1.x
  82 - Simplified and improved performance for PRAGMA cipher_migrate when migrating older database versions
  83 - Refactoring of SQLCipher tests into separate files by test type
  84 - PRAGMA cipher_plaintext_header_size and cipher_default_plaintext_header_size: allocates a portion of the database header which will not be encrypted to allow identification as a SQLite database
  85 - PRAGMA cipher_salt: retrieve or set the salt value for the database
  86 - Adds Podspec for using tagged versions of SQLCipher
  87 - Define SQLCIPHER_PROFILE_USE_FOPEN for WinXP support
  88 - Improved error handling for cryptographic providers
  89 - Improved memory handling for PRAGMA commands that return values
  90 - Improved version reporting to assist with identification of distribution
  91 - Major rewrite and simplification of internal codec and pager extension
  92 - Fixes compilation with --disable-amalgamation
  93 - Removes sqlcipher.xcodeproj build support
  94
  95 ## [3.4.2] - (December 2017 - [3.4.2 changes])
  96 ### Added
  97 - Added support for building with LibreSSL
  98
  99 ### Changed
 100 - Merge upstream SQLite 3.20.1
 101 - Text strings for `SQLITE_ERROR` and `SQLITE_NOTADB` changed to match upstream SQLite
 102 - Remove static modifier for codec password functions
 103 - Page alignment for `mlock`
 104 - Fix segfault in `sqlcipher_cipher_ctx_cmp` during rekey operation
 105 - Fix `sqlcipher_export` and `cipher_migrate` when tracing API in use
 106 - Validate codec page size when setting
 107 - Guard OpenSSL initialization and cleanup routines
 108 - Allow additional linker options to be passed via command line for Windows platforms
 109
 110 ## [3.4.1] - (December 2016 - [3.4.1 changes])
 111 ### Added
 112 - Added support for OpenSSL 1.1.0
 113
 114 ### Changed
 115 - Merged upstream SQLite 3.15.2
 116
 117 ## [3.4.0] - (April 2016 - [3.4.0 changes])
 118 ### Added
 119 - Added `PRAGMA cipher_provider_version`
 120
 121 ### Changed
 122 - Merged upstream SQLite 3.11.0
 123
 124 ### Deprecated
 125 - Deprecated `PRAGMA cipher` command
 126
 127 ## [3.3.1] - (July 2015 - [3.3.1 changes])
 128 ### Changed
 129 - Merge upstream SQLite 3.8.10.2
 130 - Fixed segfault when provided an invalid cipher name
 131 - Check for codec context when performing `PRAGMA cipher_store_pass`
 132 - Remove extraneous null check in `PRAGMA cipher_migrate`
 133
 134 ## [3.3.0] - (March 2015 - [3.3.0 changes])
 135 ### Added
 136 - Added FIPS API calls within the OpenSSL crypto provider
 137 - `PRAGMA cipher_default_page_size` - support for attaching non-default page sizes
 138
 139 ### Changed
 140 - Merged upstream SQLite 3.8.8.3
 141
 142 ## [3.2.0] - (September 2014 - [3.2.0 changes])
 143 ### Added
 144 - Added `PRAGMA cipher_store_pass`
 145
 146 ### Changed
 147 - Merged upstream SQLite 3.8.6
 148 - Renmed README to README.md
 149
 150 ## [3.1.0] - (April 2014 - [3.1.0 changes])
 151 ### Added
 152 - Added `PRAGMA cipher_profile`
 153
 154 ### Changed
 155 - Merged upstream SQLite 3.8.4.3
 156
 157 ## [3.0.1] - (December 2013 - [3.0.1 changes])
 158 ### Added
 159 - Added `PRAGMA cipher_add_random` to source external entropy
 160
 161 ### Changed
 162 - Fix `PRAGMA cipher_migrate` to handle passphrases longer than 64 characters & raw keys
 163 - Improvements to the libtomcrypt provider
 164
 165 ## [3.0.0] - (November 2013 - [3.0.0 changes])
 166 ### Added
 167 - Added `PRAGMA cipher_migrate` to migrate older database file formats
 168
 169 ### Changed
 170 - Merged upstream SQLite 3.8.0.2
 171 - Remove usage of VirtualLock/Unlock on WinRT and Windows Phone
 172 - Ignore HMAC read during Btree file copy
 173 - Fix lib naming for pkg-config
 174 - Use _v2 version of `sqlite3_key` and `sqlite3_rekey`
 175 - Update xcodeproj file
 176
 177 ### Security
 178 - Change KDF iteration length from 4,000 to 64,000
 179
 180 [unreleased]: https://github.com/sqlcipher/sqlcipher/compare/v4.4.2...prerelease
 181 [4.4.2]: https://github.com/sqlcipher/sqlcipher/tree/v4.4.2
 182 [4.4.2 changes]: https://github.com/sqlcipher/sqlcipher/compare/v4.4.0...v4.4.2
 183 [4.4.1]: https://github.com/sqlcipher/sqlcipher/tree/v4.4.1
 184 [4.4.1 changes]: https://github.com/sqlcipher/sqlcipher/compare/v4.4.0...v4.4.1
 185 [4.4.0]: https://github.com/sqlcipher/sqlcipher/tree/v4.4.0
 186 [4.4.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v4.3.0...v4.4.0
 187 [4.3.0]: https://github.com/sqlcipher/sqlcipher/tree/v4.3.0
 188 [4.3.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v4.2.0...v4.3.0
 189 [4.2.0]: https://github.com/sqlcipher/sqlcipher/tree/v4.2.0
 190 [4.2.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v4.1.0...v4.2.0
 191 [4.1.0]: https://github.com/sqlcipher/sqlcipher/tree/v4.1.0
 192 [4.1.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v4.0.1...v4.1.0
 193 [4.0.1]: https://github.com/sqlcipher/sqlcipher/tree/v4.0.1
 194 [4.0.1 changes]: https://github.com/sqlcipher/sqlcipher/compare/v4.0.0...v4.0.1
 195 [4.0.0]: https://github.com/sqlcipher/sqlcipher/tree/v4.0.0
 196 [4.0.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v3.4.2...v4.0.0
 197 [3.4.2]: https://github.com/sqlcipher/sqlcipher/tree/v3.4.2
 198 [3.4.2 changes]: https://github.com/sqlcipher/sqlcipher/compare/v3.4.1...v3.4.2
 199 [3.4.1]: https://github.com/sqlcipher/sqlcipher/tree/v3.4.1
 200 [3.4.1 changes]: https://github.com/sqlcipher/sqlcipher/compare/v3.4.0...v3.4.1
 201 [3.4.0]: https://github.com/sqlcipher/sqlcipher/tree/v3.4.0
 202 [3.4.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v3.3.1...v3.4.0
 203 [3.3.1]: https://github.com/sqlcipher/sqlcipher/tree/v3.3.1
 204 [3.3.1 changes]: https://github.com/sqlcipher/sqlcipher/compare/v3.3.0...v3.3.1
 205 [3.3.0]: https://github.com/sqlcipher/sqlcipher/tree/v3.3.0
 206 [3.3.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v3.2.0...v3.3.0
 207 [3.2.0]: https://github.com/sqlcipher/sqlcipher/tree/v3.2.0
 208 [3.2.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v3.1.0...v3.2.0
 209 [3.1.0]: https://github.com/sqlcipher/sqlcipher/tree/v3.1.0
 210 [3.1.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v3.0.1...v3.1.0
 211 [3.0.1]: https://github.com/sqlcipher/sqlcipher/tree/v3.0.1
 212 [3.0.1 changes]: https://github.com/sqlcipher/sqlcipher/compare/v3.0.0...v3.0.1
 213 [3.0.0]: https://github.com/sqlcipher/sqlcipher/tree/v3.0.0
 214 [3.0.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v2.2.0...v3.0.0
 215 [2.2.0]: https://github.com/sqlcipher/sqlcipher/tree/v2.2.0
 216 [2.2.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v2.1.1...v2.2.0
 217 [2.1.1]: https://github.com/sqlcipher/sqlcipher/tree/v2.1.1
 218 [2.1.1 changes]: https://github.com/sqlcipher/sqlcipher/compare/v2.1.0...v2.1.1
 219 [2.1.0]: https://github.com/sqlcipher/sqlcipher/tree/v2.1.0
 220 [2.1.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v2.0.6...v2.1.0
 221 [2.0.6]: https://github.com/sqlcipher/sqlcipher/tree/v2.0.6
 222 [2.0.6 changes]: https://github.com/sqlcipher/sqlcipher/compare/v2.0.5...v2.0.6
 223 [2.0.5]: https://github.com/sqlcipher/sqlcipher/tree/v2.0.5
 224 [2.0.5 changes]: https://github.com/sqlcipher/sqlcipher/compare/v2.0.3...v2.0.5
 225 [2.0.3]: https://github.com/sqlcipher/sqlcipher/tree/v2.0.3
 226 [2.0.3 changes]: https://github.com/sqlcipher/sqlcipher/compare/v2.0.0...v2.0.3
 227 [2.0.0]: https://github.com/sqlcipher/sqlcipher/tree/v2.0.0
 228 [2.0.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.10...v2.0.0
 229 [1.1.10]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.10
 230 [1.1.10 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.9...v1.1.10
 231 [1.1.9]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.9
 232 [1.1.9 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.8...v1.1.9
 233 [1.1.8]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.8
 234 [1.1.8 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.7...v1.1.8
 235 [1.1.7]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.7
 236 [1.1.7 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.6...v1.1.7
 237 [1.1.6]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.6
 238 [1.1.6 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.5...v1.1.6
 239 [1.1.5]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.5
 240 [1.1.5 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.4...v1.1.5
 241 [1.1.4]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.4
 242 [1.1.4 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.3...v1.1.4
 243 [1.1.3]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.3
 244 [1.1.3 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.2...v1.1.3
 245 [1.1.2]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.2
 246 [1.1.2 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.1...v1.1.1
 247 [1.1.1]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.1
 248 [1.1.1 changes]: https://github.com/sqlcipher/sqlcipher/compare/v1.1.0...v1.1.1
 249 [1.1.0]: https://github.com/sqlcipher/sqlcipher/tree/v1.1.0
 250 [1.1.0 changes]: https://github.com/sqlcipher/sqlcipher/compare/617ed01...v1.1.0