OSX/utilities/src/SecDb.h

   1 /*
   2  * Copyright (c) 2012-2016 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 #ifndef _UTILITIES_SECDB_H_
  26 #define _UTILITIES_SECDB_H_
  27
  28 #include <CoreFoundation/CoreFoundation.h>
  29 #include <sqlite3.h>
  30
  31 __BEGIN_DECLS
  32
  33 // MARK: SecDbRef and SecDbConnectionRef forward declarations
  34 typedef struct __OpaqueSecDb *SecDbRef;
  35 typedef struct __OpaqueSecDbConnection *SecDbConnectionRef;
  36 typedef struct __OpaqueSecDbStatement *SecDbStatementRef;
  37 struct SOSDigestVector;
  38
  39 // MARK: Configuration values, not used by clients directly.
  40 // TODO: Move this section to a private header
  41 enum {
  42     kSecDbMaxReaders = 4,
  43     kSecDbMaxWriters = 1,
  44     kSecDbMaxIdleHandles = 3,
  45 };
  46
  47 // MARK: SecDbTransactionType
  48 enum {
  49     kSecDbNoneTransactionType = 0,
  50     kSecDbImmediateTransactionType,
  51     kSecDbExclusiveTransactionType,
  52     kSecDbNormalTransactionType,
  53     kSecDbExclusiveRemoteTransactionType,
  54 };
  55 typedef CFOptionFlags SecDbTransactionType;
  56
  57 enum SecDbTransactionPhase {
  58     kSecDbTransactionDidRollback = 0,       // A transaction just got rolled back
  59     kSecDbTransactionWillCommit,        // A transaction is about to commit.
  60     kSecDbTransactionDidCommit,         // A transnaction sucessfully committed.
  61 };
  62 typedef CFOptionFlags SecDbTransactionPhase;
  63
  64 enum SecDbTransactionSource {
  65     kSecDbSOSTransaction,        // A remotely initated transaction.
  66     kSecDbAPITransaction,        // A user initated transaction.
  67     kSecDbInvalidTransaction,    // An invalid transaction source (used for initialization)
  68 };
  69 typedef CFOptionFlags SecDbTransactionSource;
  70
  71 // MARK: --
  72 // MARK: Error creation helpers.
  73
  74 // SQLITE3 errors are in this domain
  75 extern CFStringRef kSecDbErrorDomain;
  76
  77 typedef CFTypeRef SecDbEntryRef;
  78
  79 bool SecDbError(int sql_code, CFErrorRef *error, CFStringRef format, ...);
  80 bool SecDbErrorWithDb(int sql_code, sqlite3 *db, CFErrorRef *error, CFStringRef format, ...);
  81 bool SecDbErrorWithStmt(int sql_code, sqlite3_stmt *stmt, CFErrorRef *error, CFStringRef format, ...);
  82
  83 // MARK: mark -
  84 // MARK: mark SecDbRef
  85
  86 typedef CFTypeRef SecDbEventRef;
  87
  88 SecDbEventRef SecDbEventCreateWithComponents(CFTypeRef deleted, CFTypeRef inserted);
  89
  90 // Return deleted and inserted for a given changes entry, both are optional
  91 bool SecDbEventGetComponents(SecDbEventRef event, CFTypeRef *deleted, CFTypeRef *inserted, CFErrorRef *error);
  92
  93 // changes is an array of SecDbEventRef
  94 typedef void (^SecDBNotifyBlock)(SecDbConnectionRef dbconn, SecDbTransactionPhase phase, SecDbTransactionSource source, CFArrayRef changes);
  95
  96 CFTypeID SecDbGetTypeID(void);
  97
  98 // Database creation
  99 SecDbRef SecDbCreateWithOptions(CFStringRef dbName, mode_t mode, bool readWrite, bool allowRepair, bool useWAL, bool (^opened)(SecDbConnectionRef dbconn, bool didCreate, bool *callMeAgainForNextConnection, CFErrorRef *error));
 100
 101 SecDbRef SecDbCreate(CFStringRef dbName, bool (^opened)(SecDbConnectionRef dbconn, bool didCreate, bool *callMeAgainForNextConnection, CFErrorRef *error));
 102
 103 void SecDbAddNotifyPhaseBlock(SecDbRef db, SecDBNotifyBlock notifyPhase);
 104
 105 // Read only connections go to the end of the queue, writeable
 106 // connections go to the start of the queue.  Use SecDbPerformRead() and SecDbPerformWrite() if you
 107 // can to avoid leaks.
 108 SecDbConnectionRef SecDbConnectionAcquire(SecDbRef db, bool readOnly, CFErrorRef *error);
 109 void SecDbConnectionRelease(SecDbConnectionRef dbconn);
 110
 111 // Perform a database read operation,
 112 bool SecDbPerformRead(SecDbRef db, CFErrorRef *error, void (^perform)(SecDbConnectionRef dbconn));
 113 bool SecDbPerformWrite(SecDbRef db, CFErrorRef *error, void (^perform)(SecDbConnectionRef dbconn));
 114
 115 // TODO: DEBUG only -> Private header
 116 CFIndex SecDbIdleConnectionCount(SecDbRef db);
 117
 118 CFStringRef SecDbGetPath(SecDbRef db);
 119
 120 // MARK: -
 121 // MARK: SecDbConectionRef
 122
 123 CFTypeID SecDbConnectionGetTypeID(void);
 124
 125 bool SecDbPrepare(SecDbConnectionRef dbconn, CFStringRef sql, CFErrorRef *error, void(^exec)(sqlite3_stmt *stmt));
 126
 127 bool SecDbStep(SecDbConnectionRef dbconn, sqlite3_stmt *stmt, CFErrorRef *error, void (^row)(bool *stop));
 128
 129 bool SecDbExec(SecDbConnectionRef dbconn, CFStringRef sql, CFErrorRef *error);
 130
 131 bool SecDbCheckpoint(SecDbConnectionRef dbconn, CFErrorRef *error);
 132
 133 bool SecDbTransaction(SecDbConnectionRef dbconn, SecDbTransactionType ttype, CFErrorRef *error,
 134                       void (^transaction)(bool *commit));
 135
 136 sqlite3 *SecDbHandle(SecDbConnectionRef dbconn);
 137
 138 // Do not call this unless you are SecDbItem!
 139 void SecDbRecordChange(SecDbConnectionRef dbconn, CFTypeRef deleted, CFTypeRef inserted);
 140
 141 void SecDbPerformOnCommitQueue(SecDbConnectionRef dbconn, bool barrier, dispatch_block_t perform);
 142
 143 // MARK: -
 144 // MARK: Bind helpers
 145
 146 #if 0
 147 bool SecDbBindNull(sqlite3_stmt *stmt, int param, CFErrorRef *error);
 148 #endif
 149 bool SecDbBindBlob(sqlite3_stmt *stmt, int param, const void *zData, size_t n, void(*xDel)(void*), CFErrorRef *error);
 150 bool SecDbBindText(sqlite3_stmt *stmt, int param, const char *zData, size_t n, void(*xDel)(void*), CFErrorRef *error);
 151 bool SecDbBindDouble(sqlite3_stmt *stmt, int param, double value, CFErrorRef *error);
 152 bool SecDbBindInt(sqlite3_stmt *stmt, int param, int value, CFErrorRef *error);
 153 bool SecDbBindInt64(sqlite3_stmt *stmt, int param, sqlite3_int64 value, CFErrorRef *error);
 154 bool SecDbBindObject(sqlite3_stmt *stmt, int param, CFTypeRef value, CFErrorRef *error);
 155
 156 // MARK: -
 157 // MARK: SecDbStatementRef
 158
 159 bool SecDbReset(sqlite3_stmt *stmt, CFErrorRef *error);
 160 bool SecDbClearBindings(sqlite3_stmt *stmt, CFErrorRef *error);
 161 bool SecDbFinalize(sqlite3_stmt *stmt, CFErrorRef *error);
 162 sqlite3_stmt *SecDbPrepareV2(SecDbConnectionRef dbconn, const char *sql, size_t sqlLen, const char **sqlTail, CFErrorRef *error);
 163 sqlite3_stmt *SecDbCopyStmt(SecDbConnectionRef dbconn, CFStringRef sql, CFStringRef *tail, CFErrorRef *error);
 164 bool SecDbReleaseCachedStmt(SecDbConnectionRef dbconn, CFStringRef sql, sqlite3_stmt *stmt, CFErrorRef *error);
 165 bool SecDbWithSQL(SecDbConnectionRef dbconn, CFStringRef sql, CFErrorRef *error, bool(^perform)(sqlite3_stmt *stmt));
 166 bool SecDbForEach(SecDbConnectionRef dbconn, sqlite3_stmt *stmt, CFErrorRef *error, bool(^row)(int row_index));
 167
 168 // Mark the database as corrupted.
 169 void SecDbCorrupt(SecDbConnectionRef dbconn, CFErrorRef error);
 170
 171 __END_DECLS
 172
 173 #endif /* !_UTILITIES_SECDB_H_ */