1 /* 2 ** 2003 January 11 3 ** 4 ** The author disclaims copyright to this source code. In place of 5 ** a legal notice, here is a blessing: 6 ** 7 ** May you do good and not evil. 8 ** May you find forgiveness for yourself and forgive others. 9 ** May you share freely, never taking more than you give. 10 ** 11 ************************************************************************* 12 ** This file contains code used to implement the sqlite3_set_authorizer() 13 ** API. This facility is an optional feature of the library. Embedded 14 ** systems that do not need this facility may omit it by recompiling 15 ** the library with -DSQLITE_OMIT_AUTHORIZATION=1 16 ** 17 ** $Id: auth.c,v 1.27 2007/08/21 19:33:56 drh Exp $ 18 */ 19 #include "sqliteInt.h" 20 21 /* 22 ** All of the code in this file may be omitted by defining a single 23 ** macro. 24 */ 25 #ifndef SQLITE_OMIT_AUTHORIZATION 26 27 /* 28 ** Set or clear the access authorization function. 29 ** 30 ** The access authorization function is be called during the compilation 31 ** phase to verify that the user has read and/or write access permission on 32 ** various fields of the database. The first argument to the auth function 33 ** is a copy of the 3rd argument to this routine. The second argument 34 ** to the auth function is one of these constants: 35 ** 36 ** SQLITE_CREATE_INDEX 37 ** SQLITE_CREATE_TABLE 38 ** SQLITE_CREATE_TEMP_INDEX 39 ** SQLITE_CREATE_TEMP_TABLE 40 ** SQLITE_CREATE_TEMP_TRIGGER 41 ** SQLITE_CREATE_TEMP_VIEW 42 ** SQLITE_CREATE_TRIGGER 43 ** SQLITE_CREATE_VIEW 44 ** SQLITE_DELETE 45 ** SQLITE_DROP_INDEX 46 ** SQLITE_DROP_TABLE 47 ** SQLITE_DROP_TEMP_INDEX 48 ** SQLITE_DROP_TEMP_TABLE 49 ** SQLITE_DROP_TEMP_TRIGGER 50 ** SQLITE_DROP_TEMP_VIEW 51 ** SQLITE_DROP_TRIGGER 52 ** SQLITE_DROP_VIEW 53 ** SQLITE_INSERT 54 ** SQLITE_PRAGMA 55 ** SQLITE_READ 56 ** SQLITE_SELECT 57 ** SQLITE_TRANSACTION 58 ** SQLITE_UPDATE 59 ** 60 ** The third and fourth arguments to the auth function are the name of 61 ** the table and the column that are being accessed. The auth function 62 ** should return either SQLITE_OK, SQLITE_DENY, or SQLITE_IGNORE. If 63 ** SQLITE_OK is returned, it means that access is allowed. SQLITE_DENY 64 ** means that the SQL statement will never-run - the sqlite3_exec() call 65 ** will return with an error. SQLITE_IGNORE means that the SQL statement 66 ** should run but attempts to read the specified column will return NULL 67 ** and attempts to write the column will be ignored. 68 ** 69 ** Setting the auth function to NULL disables this hook. The default 70 ** setting of the auth function is NULL. 71 */ 72 int sqlite3_set_authorizer( 73 sqlite3 *db, 74 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), 75 void *pArg 76 ){ 77 sqlite3_mutex_enter(db->mutex); 78 db->xAuth = xAuth; 79 db->pAuthArg = pArg; 80 sqlite3ExpirePreparedStatements(db); 81 sqlite3_mutex_leave(db->mutex); 82 return SQLITE_OK; 83 } 84 85 /* 86 ** Write an error message into pParse->zErrMsg that explains that the 87 ** user-supplied authorization function returned an illegal value. 88 */ 89 static void sqliteAuthBadReturnCode(Parse *pParse, int rc){ 90 sqlite3ErrorMsg(pParse, "illegal return value (%d) from the " 91 "authorization function - should be SQLITE_OK, SQLITE_IGNORE, " 92 "or SQLITE_DENY", rc); 93 pParse->rc = SQLITE_ERROR; 94 } 95 96 /* 97 ** The pExpr should be a TK_COLUMN expression. The table referred to 98 ** is in pTabList or else it is the NEW or OLD table of a trigger. 99 ** Check to see if it is OK to read this particular column. 100 ** 101 ** If the auth function returns SQLITE_IGNORE, change the TK_COLUMN 102 ** instruction into a TK_NULL. If the auth function returns SQLITE_DENY, 103 ** then generate an error. 104 */ 105 void sqlite3AuthRead( 106 Parse *pParse, /* The parser context */ 107 Expr *pExpr, /* The expression to check authorization on */ 108 SrcList *pTabList /* All table that pExpr might refer to */ 109 ){ 110 sqlite3 *db = pParse->db; 111 int rc; 112 Table *pTab; /* The table being read */ 113 const char *zCol; /* Name of the column of the table */ 114 int iSrc; /* Index in pTabList->a[] of table being read */ 115 const char *zDBase; /* Name of database being accessed */ 116 TriggerStack *pStack; /* The stack of current triggers */ 117 int iDb; /* The index of the database the expression refers to */ 118 119 if( db->xAuth==0 ) return; 120 if( pExpr->op!=TK_COLUMN ) return; 121 iDb = sqlite3SchemaToIndex(pParse->db, pExpr->pSchema); 122 if( iDb<0 ){ 123 /* An attempt to read a column out of a subquery or other 124 ** temporary table. */ 125 return; 126 } 127 for(iSrc=0; pTabList && iSrc<pTabList->nSrc; iSrc++){ 128 if( pExpr->iTable==pTabList->a[iSrc].iCursor ) break; 129 } 130 if( iSrc>=0 && pTabList && iSrc<pTabList->nSrc ){ 131 pTab = pTabList->a[iSrc].pTab; 132 }else if( (pStack = pParse->trigStack)!=0 ){ 133 /* This must be an attempt to read the NEW or OLD pseudo-tables 134 ** of a trigger. 135 */ 136 assert( pExpr->iTable==pStack->newIdx || pExpr->iTable==pStack->oldIdx ); 137 pTab = pStack->pTab; 138 }else{ 139 return; 140 } 141 if( pTab==0 ) return; 142 if( pExpr->iColumn>=0 ){ 143 assert( pExpr->iColumn<pTab->nCol ); 144 zCol = pTab->aCol[pExpr->iColumn].zName; 145 }else if( pTab->iPKey>=0 ){ 146 assert( pTab->iPKey<pTab->nCol ); 147 zCol = pTab->aCol[pTab->iPKey].zName; 148 }else{ 149 zCol = "ROWID"; 150 } 151 assert( iDb>=0 && iDb<db->nDb ); 152 zDBase = db->aDb[iDb].zName; 153 rc = db->xAuth(db->pAuthArg, SQLITE_READ, pTab->zName, zCol, zDBase, 154 pParse->zAuthContext); 155 if( rc==SQLITE_IGNORE ){ 156 pExpr->op = TK_NULL; 157 }else if( rc==SQLITE_DENY ){ 158 if( db->nDb>2 || iDb!=0 ){ 159 sqlite3ErrorMsg(pParse, "access to %s.%s.%s is prohibited", 160 zDBase, pTab->zName, zCol); 161 }else{ 162 sqlite3ErrorMsg(pParse, "access to %s.%s is prohibited",pTab->zName,zCol); 163 } 164 pParse->rc = SQLITE_AUTH; 165 }else if( rc!=SQLITE_OK ){ 166 sqliteAuthBadReturnCode(pParse, rc); 167 } 168 } 169 170 /* 171 ** Do an authorization check using the code and arguments given. Return 172 ** either SQLITE_OK (zero) or SQLITE_IGNORE or SQLITE_DENY. If SQLITE_DENY 173 ** is returned, then the error count and error message in pParse are 174 ** modified appropriately. 175 */ 176 int sqlite3AuthCheck( 177 Parse *pParse, 178 int code, 179 const char *zArg1, 180 const char *zArg2, 181 const char *zArg3 182 ){ 183 sqlite3 *db = pParse->db; 184 int rc; 185 186 /* Don't do any authorization checks if the database is initialising 187 ** or if the parser is being invoked from within sqlite3_declare_vtab. 188 */ 189 if( db->init.busy || IN_DECLARE_VTAB ){ 190 return SQLITE_OK; 191 } 192 193 if( db->xAuth==0 ){ 194 return SQLITE_OK; 195 } 196 rc = db->xAuth(db->pAuthArg, code, zArg1, zArg2, zArg3, pParse->zAuthContext); 197 if( rc==SQLITE_DENY ){ 198 sqlite3ErrorMsg(pParse, "not authorized"); 199 pParse->rc = SQLITE_AUTH; 200 }else if( rc!=SQLITE_OK && rc!=SQLITE_IGNORE ){ 201 rc = SQLITE_DENY; 202 sqliteAuthBadReturnCode(pParse, rc); 203 } 204 return rc; 205 } 206 207 /* 208 ** Push an authorization context. After this routine is called, the 209 ** zArg3 argument to authorization callbacks will be zContext until 210 ** popped. Or if pParse==0, this routine is a no-op. 211 */ 212 void sqlite3AuthContextPush( 213 Parse *pParse, 214 AuthContext *pContext, 215 const char *zContext 216 ){ 217 pContext->pParse = pParse; 218 if( pParse ){ 219 pContext->zAuthContext = pParse->zAuthContext; 220 pParse->zAuthContext = zContext; 221 } 222 } 223 224 /* 225 ** Pop an authorization context that was previously pushed 226 ** by sqlite3AuthContextPush 227 */ 228 void sqlite3AuthContextPop(AuthContext *pContext){ 229 if( pContext->pParse ){ 230 pContext->pParse->zAuthContext = pContext->zAuthContext; 231 pContext->pParse = 0; 232 } 233 } 234 235 #endif /* SQLITE_OMIT_AUTHORIZATION */ 236