src/sqlcipher.h

   1 /*
   2 ** SQLCipher
   3 ** sqlcipher.h developed by Stephen Lombardo (Zetetic LLC)
   4 ** sjlombardo at zetetic dot net
   5 ** http://zetetic.net
   6 **
   7 ** Copyright (c) 2008, ZETETIC LLC
   8 ** All rights reserved.
   9 **
  10 ** Redistribution and use in source and binary forms, with or without
  11 ** modification, are permitted provided that the following conditions are met:
  12 **     * Redistributions of source code must retain the above copyright
  13 **       notice, this list of conditions and the following disclaimer.
  14 **     * Redistributions in binary form must reproduce the above copyright
  15 **       notice, this list of conditions and the following disclaimer in the
  16 **       documentation and/or other materials provided with the distribution.
  17 **     * Neither the name of the ZETETIC LLC nor the
  18 **       names of its contributors may be used to endorse or promote products
  19 **       derived from this software without specific prior written permission.
  20 **
  21 ** THIS SOFTWARE IS PROVIDED BY ZETETIC LLC ''AS IS'' AND ANY
  22 ** EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  23 ** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24 ** DISCLAIMED. IN NO EVENT SHALL ZETETIC LLC BE LIABLE FOR ANY
  25 ** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26 ** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 ** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  28 ** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30 ** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 **
  32 */
  33 /* BEGIN SQLCIPHER */
  34 #ifdef SQLITE_HAS_CODEC
  35 #ifndef SQLCIPHER_H
  36 #define SQLCIPHER_H
  37
  38 #include "sqlite3.h"
  39
  40 #define SQLCIPHER_HMAC_SHA1 0
  41 #define SQLCIPHER_HMAC_SHA1_LABEL "HMAC_SHA1"
  42 #define SQLCIPHER_HMAC_SHA256 1
  43 #define SQLCIPHER_HMAC_SHA256_LABEL "HMAC_SHA256"
  44 #define SQLCIPHER_HMAC_SHA512 2
  45 #define SQLCIPHER_HMAC_SHA512_LABEL "HMAC_SHA512"
  46
  47
  48 #define SQLCIPHER_PBKDF2_HMAC_SHA1 0
  49 #define SQLCIPHER_PBKDF2_HMAC_SHA1_LABEL "PBKDF2_HMAC_SHA1"
  50 #define SQLCIPHER_PBKDF2_HMAC_SHA256 1
  51 #define SQLCIPHER_PBKDF2_HMAC_SHA256_LABEL "PBKDF2_HMAC_SHA256"
  52 #define SQLCIPHER_PBKDF2_HMAC_SHA512 2
  53 #define SQLCIPHER_PBKDF2_HMAC_SHA512_LABEL "PBKDF2_HMAC_SHA512"
  54
  55 typedef struct {
  56   int (*activate)(void *ctx);
  57   int (*deactivate)(void *ctx);
  58   const char* (*get_provider_name)(void *ctx);
  59   int (*add_random)(void *ctx, void *buffer, int length);
  60   int (*random)(void *ctx, void *buffer, int length);
  61   int (*hmac)(void *ctx, int algorithm, unsigned char *hmac_key, int key_sz, unsigned char *in, int in_sz, unsigned char *in2, int in2_sz, unsigned char *out);
  62   int (*kdf)(void *ctx, int algorithm, const unsigned char *pass, int pass_sz, unsigned char* salt, int salt_sz, int workfactor, int key_sz, unsigned char *key);
  63   int (*cipher)(void *ctx, int mode, unsigned char *key, int key_sz, unsigned char *iv, unsigned char *in, int in_sz, unsigned char *out);
  64   const char* (*get_cipher)(void *ctx);
  65   int (*get_key_sz)(void *ctx);
  66   int (*get_iv_sz)(void *ctx);
  67   int (*get_block_sz)(void *ctx);
  68   int (*get_hmac_sz)(void *ctx, int algorithm);
  69   int (*ctx_init)(void **ctx);
  70   int (*ctx_free)(void **ctx);
  71   int (*fips_status)(void *ctx);
  72   const char* (*get_provider_version)(void *ctx);
  73 } sqlcipher_provider;
  74
  75 /* public interfaces called externally */
  76 void sqlcipher_init_memmethods(void);
  77 int sqlcipher_codec_pragma(sqlite3*, int, Parse*, const char *, const char*);
  78 int sqlcipherCodecAttach(sqlite3*, int, const void *, int);
  79 void sqlcipherCodecGetKey(sqlite3*, int, void**, int*);
  80 void sqlcipher_exportFunc(sqlite3_context *, int, sqlite3_value **);
  81 int sqlcipher_find_db_index(sqlite3 *, const char *);
  82
  83 /* utility functions */
  84 void* sqlcipher_malloc(sqlite_uint64);
  85 void* sqlcipher_memset(void *, unsigned char, sqlite_uint64);
  86 int sqlcipher_ismemset(const void *, unsigned char, sqlite_uint64);
  87 int sqlcipher_memcmp(const void *, const void *, int);
  88 void sqlcipher_free(void *, sqlite_uint64);
  89 char* sqlcipher_version();
  90
  91 /* provider interfaces */
  92 int sqlcipher_register_provider(sqlcipher_provider *);
  93 sqlcipher_provider* sqlcipher_get_provider(void);
  94
  95 #define SQLCIPHER_MUTEX_PROVIDER          0
  96 #define SQLCIPHER_MUTEX_PROVIDER_ACTIVATE 1
  97 #define SQLCIPHER_MUTEX_PROVIDER_RAND     2
  98 #define SQLCIPHER_MUTEX_RESERVED1         3
  99 #define SQLCIPHER_MUTEX_RESERVED2         4
 100 #define SQLCIPHER_MUTEX_RESERVED3         5
 101 #define SQLCIPHER_MUTEX_COUNT             6
 102
 103 sqlite3_mutex* sqlcipher_mutex(int);
 104
 105 #define SQLCIPHER_LOG_NONE          0
 106 #define SQLCIPHER_LOG_ANY           0xffffffff
 107
 108 #define SQLCIPHER_LOG_ERROR         (1<<0)
 109 #define SQLCIPHER_LOG_WARN          (1<<1)
 110 #define SQLCIPHER_LOG_INFO          (1<<2)
 111 #define SQLCIPHER_LOG_DEBUG         (1<<3)
 112 #define SQLCIPHER_LOG_TRACE         (1<<4)
 113
 114 #define SQLCIPHER_LOG_CORE          (1<<0)
 115 #define SQLCIPHER_LOG_MEMORY        (1<<1)
 116 #define SQLCIPHER_LOG_MUTEX         (1<<2)
 117 #define SQLCIPHER_LOG_PROVIDER      (1<<3)
 118
 119 #ifdef SQLCIPHER_OMIT_LOG
 120 #define sqlcipher_log(level, source, message, ...)
 121 #else
 122 void sqlcipher_log(unsigned int level, unsigned int source, const char *message, ...);
 123 #endif
 124
 125 #ifdef CODEC_DEBUG_PAGEDATA
 126 #define CODEC_HEXDUMP(DESC,BUFFER,LEN)  \
 127   { \
 128     int __pctr; \
 129     printf(DESC); \
 130     for(__pctr=0; __pctr < LEN; __pctr++) { \
 131       if(__pctr % 16 == 0) printf("\n%05x: ",__pctr); \
 132       printf("%02x ",((unsigned char*) BUFFER)[__pctr]); \
 133     } \
 134     printf("\n"); \
 135     fflush(stdout); \
 136   }
 137 #else
 138 #define CODEC_HEXDUMP(DESC,BUFFER,LEN)
 139 #endif
 140
 141 #endif
 142 #endif
 143 /* END SQLCIPHER */
 144