test/sqlcipher-pragmas.test

   1 # SQLCipher
   2 # codec.test developed by Stephen Lombardo (Zetetic LLC)
   3 # sjlombardo at zetetic dot net
   4 # http://zetetic.net
   5 #
   6 # Copyright (c) 2018, ZETETIC LLC
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions are met:
   9 #     * Redistributions of source code must retain the above copyright
  10 #       notice, this list of conditions and the following disclaimer.
  11 #     * Redistributions in binary form must reproduce the above copyright
  12 #       notice, this list of conditions and the following disclaimer in the
  13 #       documentation and/or other materials provided with the distribution.
  14 #     * Neither the name of the ZETETIC LLC nor the
  15 #       names of its contributors may be used to endorse or promote products
  16 #       derived from this software without specific prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY ZETETIC LLC ''AS IS'' AND ANY
  19 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21 # DISCLAIMED. IN NO EVENT SHALL ZETETIC LLC BE LIABLE FOR ANY
  22 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 #
  29 # This file implements regression tests for SQLite library.  The
  30 # focus of this script is testing code cipher features.
  31 #
  32 # NOTE: tester.tcl has overridden the definition of sqlite3 to
  33 # automatically pass in a key value. Thus tests in this file
  34 # should explicitly close and open db with sqlite_orig in order
  35 # to bypass default key assignment.
  36
  37 set testdir [file dirname $argv0]
  38 source $testdir/tester.tcl
  39 source $testdir/sqlcipher.tcl
  40
  41 # verify the pragma cipher_version
  42 # returns the currently configured
  43 # sqlcipher version
  44 do_test verify-pragma-cipher-version {
  45     sqlite_orig db test.db
  46     execsql {
  47         PRAGMA cipher_version;
  48     }
  49 } {{4.5.6 community}}
  50 db close
  51 file delete -force test.db
  52
  53 # verify the pragma cipher_use_hmac
  54 # is set to true be default
  55 do_test verify-pragma-cipher-use-hmac-default {
  56     sqlite_orig db test.db
  57     execsql {
  58         PRAGMA key = 'test';
  59         PRAGMA cipher_use_hmac;
  60     }
  61 } {ok 1}
  62 db close
  63 file delete -force test.db
  64
  65 # verify the pragma cipher_use_hmac
  66 # reports the flag turned off
  67 do_test verify-pragma-cipher-use-hmac-off {
  68     sqlite_orig db test.db
  69     execsql {
  70         PRAGMA key = 'test';
  71         PRAGMA cipher_use_hmac = off;
  72         PRAGMA cipher_use_hmac;
  73     }
  74 } {ok 0}
  75 db close
  76 file delete -force test.db
  77
  78 # verify the pragma default_cipher_use_hmac
  79 # is set to true by default
  80 do_test verify-pragma-cipher-default-use-hmac-default {
  81     sqlite_orig db test.db
  82     execsql {
  83         PRAGMA cipher_default_use_hmac;
  84     }
  85 } {1}
  86 db close
  87 file delete -force test.db
  88
  89 # verify the pragma default_cipher_use_hmac
  90 # reports the flag turned off
  91 do_test verify-pragma-cipher-default-use-hmac-off {
  92     sqlite_orig db test.db
  93     execsql {
  94         PRAGMA cipher_default_use_hmac = off;
  95         PRAGMA cipher_default_use_hmac;
  96         -- Be sure to turn cipher_default_use_hmac
  97         -- back on or it will break later tests
  98         -- (it's a global flag)
  99         PRAGMA cipher_default_use_hmac = ON;
 100     }
 101 } {0}
 102 db close
 103 file delete -force test.db
 104
 105 # verify the pragma default_cipher_kdf_iter
 106 # is set to 256000 by default
 107 do_test verify-pragma-cipher-default-kdf-iter-default {
 108     sqlite_orig db test.db
 109     execsql {
 110         PRAGMA cipher_default_kdf_iter;
 111     }
 112 } {256000}
 113 db close
 114 file delete -force test.db
 115
 116
 117 # verify the pragma default_cipher_kdf_ter
 118 # reports changes
 119 do_test verify-pragma-cipher-default-use-hmac-off {
 120     sqlite_orig db test.db
 121     execsql {
 122         PRAGMA cipher_default_kdf_iter = 1000;
 123         PRAGMA cipher_default_kdf_iter;
 124         PRAGMA cipher_default_kdf_iter = 256000;
 125     }
 126 } {1000}
 127 db close
 128 file delete -force test.db
 129
 130 # verify the pragma kdf_iter
 131 # reports the default value
 132 do_test verify-pragma-kdf-iter-reports-default {
 133     sqlite_orig db test.db
 134     execsql {
 135         PRAGMA key = 'test';
 136         PRAGMA kdf_iter;
 137     }
 138 } {ok 256000}
 139 db close
 140 file delete -force test.db
 141
 142 # verify the pragma kdf_iter
 143 # reports value changed
 144 do_test verify-pragma-kdf-iter-reports-value-changed {
 145     sqlite_orig db test.db
 146     execsql {
 147         PRAGMA key = 'test';
 148         PRAGMA kdf_iter = 8000;
 149         PRAGMA kdf_iter;
 150     }
 151  } {ok 8000}
 152 db close
 153 file delete -force test.db
 154
 155 # verify the pragma fast_kdf_iter
 156 # reports the default value
 157 do_test verify-pragma-fast-kdf-iter-reports-default {
 158     sqlite_orig db test.db
 159     execsql {
 160         PRAGMA key = 'test';
 161         PRAGMA fast_kdf_iter;
 162     }
 163 } {ok 2}
 164 db close
 165 file delete -force test.db
 166
 167 # verify the pragma fast_kdf_iter
 168 # reports value changed
 169 do_test verify-pragma-kdf-iter-reports-value-changed {
 170     sqlite_orig db test.db
 171     execsql {
 172         PRAGMA key = 'test';
 173         PRAGMA fast_kdf_iter = 4000;
 174         PRAGMA fast_kdf_iter;
 175     }
 176 } {ok {PRAGMA fast_kdf_iter is deprecated, please remove from use} 4000}
 177 db close
 178 file delete -force test.db
 179
 180 # verify the pragma cipher_page_size
 181 # reports default value
 182 do_test verify-pragma-cipher-page-size-default {
 183     sqlite_orig db test.db
 184     execsql {
 185         PRAGMA key = 'test';
 186         PRAGMA cipher_page_size;
 187     }
 188 } {ok 4096}
 189 db close
 190 file delete -force test.db
 191
 192 # verify the pragma cipher_page_size
 193 # reports change in value
 194 do_test verify-pragma-cipher-page-size-changed {
 195     sqlite_orig db test.db
 196     execsql {
 197         PRAGMA key = 'test';
 198         PRAGMA cipher_page_size = 8192;
 199         PRAGMA cipher_page_size;
 200     }
 201 } {ok 8192}
 202 db close
 203 file delete -force test.db
 204
 205 # verify setting cipher_store_pass before key
 206 # does not cause segfault
 207 do_test verify-cipher-store-pass-before-key-does-not-segfault {
 208     sqlite_orig db test.db
 209     execsql {
 210         PRAGMA cipher_store_pass = 1;
 211         PRAGMA key = 'test';
 212     }
 213 } {ok}
 214 db close
 215 file delete -force test.db
 216
 217 # verify setting cipher_store_pass results in deprecation warning
 218 do_test verify-cipher-store-pass-deprecated {
 219     sqlite_orig db test.db
 220     execsql {
 221         PRAGMA key = 'test';
 222         PRAGMA cipher_store_pass = 1;
 223     }
 224 } {ok {PRAGMA cipher_store_pass is deprecated, please remove from use}}
 225 db close
 226 file delete -force test.db
 227
 228 # verify the pragma cipher
 229 # reports the default value
 230 if_built_with_openssl verify-pragma-cipher-default {
 231     sqlite_orig db test.db
 232     execsql {
 233         PRAGMA key = 'test';
 234         PRAGMA cipher;
 235     }
 236 } {ok AES-256-CBC}
 237 db close
 238 file delete -force test.db
 239
 240 # verify the pragma cipher_hmac_salt_mask reports default
 241 do_test verify-pragma-hmac-salt-mask-reports-default {
 242     sqlite_orig db test.db
 243     execsql {
 244         PRAGMA key = 'test';
 245         PRAGMA cipher_hmac_salt_mask;
 246     }
 247 } {ok 3a}
 248 db close
 249 file delete -force test.db
 250
 251 # verify the pragma cipher_hmac_salt_mask reports
 252 # reports value changed
 253 do_test verify-pragma-hmac-salt-mask-reports-value-changed {
 254     sqlite_orig db test.db
 255     execsql {
 256         PRAGMA key = 'test';
 257         PRAGMA cipher_hmac_salt_mask = "x'11'";
 258         PRAGMA cipher_hmac_salt_mask;
 259         PRAGMA cipher_hmac_salt_mask = "x'3a'";
 260     }
 261 } {ok {PRAGMA cipher_hmac_salt_mask is deprecated, please remove from use} 11 {PRAGMA cipher_hmac_salt_mask is deprecated, please remove from use}}
 262 db close
 263 file delete -force test.db
 264
 265 # verify the pragma cipher_hmac_pgno reports default
 266 do_test verify-pragma-hmac-pgno-reports-default {
 267     sqlite_orig db test.db
 268     execsql {
 269         PRAGMA key = 'test';
 270         PRAGMA cipher_hmac_pgno;
 271     }
 272 } {ok le}
 273 db close
 274 file delete -force test.db
 275
 276 # verify the pragma cipher_hmac_pgno
 277 # reports value changed
 278 do_test verify-pragma-hmac-pgno-reports-value-changed {
 279     sqlite_orig db test.db
 280     execsql {
 281         PRAGMA key = 'test';
 282         PRAGMA cipher_hmac_pgno = be;
 283         PRAGMA cipher_hmac_pgno;
 284         PRAGMA cipher_hmac_pgno = native;
 285         PRAGMA cipher_hmac_pgno;
 286         PRAGMA cipher_hmac_pgno = le;
 287         PRAGMA cipher_hmac_pgno;
 288     }
 289 } {ok {PRAGMA cipher_hmac_pgno is deprecated, please remove from use} be {PRAGMA cipher_hmac_pgno is deprecated, please remove from use} native {PRAGMA cipher_hmac_pgno is deprecated, please remove from use} le}
 290 db close
 291 file delete -force test.db
 292
 293 # verify the pragma cipher_hmac_algorithm works properly
 294 do_test verify-pragma-cipher-hmac-algorithm-reports-default {
 295     sqlite_orig db test.db
 296     execsql {
 297         PRAGMA key = 'test';
 298         PRAGMA cipher_hmac_algorithm;
 299     }
 300 } {ok HMAC_SHA512}
 301 db close
 302 file delete -force test.db
 303
 304 do_test verify-pragma-cipher-hmac-algorithm-reports-value-changed {
 305     sqlite_orig db test.db
 306     execsql {
 307         PRAGMA key = 'test';
 308         PRAGMA cipher_hmac_algorithm = HMAC_SHA1;
 309         PRAGMA cipher_hmac_algorithm;
 310     }
 311 } {ok HMAC_SHA1}
 312 db close
 313 file delete -force test.db
 314
 315 do_test verify-pragma-cipher-default-hmac-algorithm {
 316     sqlite_orig db test.db
 317     execsql {
 318         PRAGMA cipher_default_hmac_algorithm;
 319         PRAGMA cipher_default_hmac_algorithm = HMAC_SHA1;
 320         PRAGMA cipher_default_hmac_algorithm;
 321         PRAGMA cipher_default_hmac_algorithm = HMAC_SHA512;
 322     }
 323 } {HMAC_SHA512 HMAC_SHA1}
 324 db close
 325 file delete -force test.db
 326
 327 # verify the pragma cipher_kdf_algorithm works properly
 328 do_test verify-pragma-cipher-kdf-algorithm-reports-default {
 329     sqlite_orig db test.db
 330     execsql {
 331         PRAGMA key = 'test';
 332         PRAGMA cipher_kdf_algorithm;
 333     }
 334 } {ok PBKDF2_HMAC_SHA512}
 335 db close
 336 file delete -force test.db
 337
 338 do_test verify-pragma-cipher-kdf-algorithm-reports-value-changed {
 339     sqlite_orig db test.db
 340     execsql {
 341         PRAGMA key = 'test';
 342         PRAGMA cipher_kdf_algorithm = PBKDF2_HMAC_SHA1;
 343         PRAGMA cipher_kdf_algorithm;
 344     }
 345 } {ok PBKDF2_HMAC_SHA1}
 346 db close
 347 file delete -force test.db
 348
 349 do_test verify-pragma-cipher-default-kdf-algorithm {
 350     sqlite_orig db test.db
 351     execsql {
 352         PRAGMA cipher_default_kdf_algorithm;
 353         PRAGMA cipher_default_kdf_algorithm = PBKDF2_HMAC_SHA1;
 354         PRAGMA cipher_default_kdf_algorithm;
 355         PRAGMA cipher_default_kdf_algorithm = PBKDF2_HMAC_SHA512;
 356     }
 357 } {PBKDF2_HMAC_SHA512 PBKDF2_HMAC_SHA1}
 358 db close
 359 file delete -force test.db
 360
 361 if_built_with_openssl verify-default-cipher {
 362     sqlite_orig db test.db
 363     execsql {
 364         PRAGMA key='test';
 365         PRAGMA cipher;
 366     }
 367 } {ok AES-256-CBC}
 368 db close
 369 file delete -force test.db
 370
 371 if_built_with_libtomcrypt verify-default-cipher {
 372     sqlite_orig db test.db
 373     execsql {
 374         PRAGMA key='test';
 375         PRAGMA cipher;
 376     }
 377 } {ok aes-256-cbc}
 378 db close
 379 file delete -force test.db
 380
 381 if_built_with_commoncrypto verify-default-cipher {
 382     sqlite_orig db test.db
 383     execsql {
 384         PRAGMA key='test';
 385         PRAGMA cipher;
 386     }
 387 } {ok aes-256-cbc}
 388 db close
 389 file delete -force test.db
 390
 391 if_built_with_nss verify-default-cipher {
 392     sqlite_orig db test.db
 393     execsql {
 394         PRAGMA key='test';
 395         PRAGMA cipher;
 396     }
 397 } {ok aes-256-cbc}
 398 db close
 399 file delete -force test.db
 400
 401 do_test verify-cipher_settings_default {
 402     sqlite_orig db test.db
 403     execsql {
 404         PRAGMA key = 'test';
 405         PRAGMA cipher_settings;
 406     }
 407 } {ok {PRAGMA kdf_iter = 256000;} {PRAGMA cipher_page_size = 4096;} {PRAGMA cipher_use_hmac = 1;} {PRAGMA cipher_plaintext_header_size = 0;} {PRAGMA cipher_hmac_algorithm = HMAC_SHA512;} {PRAGMA cipher_kdf_algorithm = PBKDF2_HMAC_SHA512;}}
 408 db close
 409 file delete -force test.db
 410
 411 do_test verify-cipher_settings_v1 {
 412     sqlite_orig db test.db
 413     execsql {
 414         PRAGMA key = 'test';
 415         PRAGMA cipher_compatibility = 1;
 416         PRAGMA cipher_settings;
 417     }
 418 } {ok {PRAGMA kdf_iter = 4000;} {PRAGMA cipher_page_size = 1024;} {PRAGMA cipher_use_hmac = 0;} {PRAGMA cipher_plaintext_header_size = 0;} {PRAGMA cipher_hmac_algorithm = HMAC_SHA1;} {PRAGMA cipher_kdf_algorithm = PBKDF2_HMAC_SHA1;}}
 419 db close
 420 file delete -force test.db
 421
 422 do_test verify-cipher_default_settings_v1 {
 423     sqlite_orig db test.db
 424     execsql {
 425         PRAGMA cipher_default_compatibility = 1;
 426         PRAGMA cipher_default_settings;
 427         PRAGMA cipher_default_compatibility = 4;
 428     }
 429 } {{PRAGMA cipher_default_kdf_iter = 4000;} {PRAGMA cipher_default_page_size = 1024;} {PRAGMA cipher_default_use_hmac = 0;} {PRAGMA cipher_default_plaintext_header_size = 0;} {PRAGMA cipher_default_hmac_algorithm = HMAC_SHA1;} {PRAGMA cipher_default_kdf_algorithm = PBKDF2_HMAC_SHA1;}}
 430 db close
 431 file delete -force test.db
 432
 433 do_test verify-cipher_default_settings_default {
 434     sqlite_orig db test.db
 435     execsql {
 436         PRAGMA cipher_default_settings;
 437     }
 438 } {{PRAGMA cipher_default_kdf_iter = 256000;} {PRAGMA cipher_default_page_size = 4096;} {PRAGMA cipher_default_use_hmac = 1;} {PRAGMA cipher_default_plaintext_header_size = 0;} {PRAGMA cipher_default_hmac_algorithm = HMAC_SHA512;} {PRAGMA cipher_default_kdf_algorithm = PBKDF2_HMAC_SHA512;}}
 439 db close
 440 file delete -force test.db
 441
 442
 443
 444 finish_test