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.22 2005/07/29 15:36:15 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 db->xAuth = xAuth; 78 db->pAuthArg = pArg; 79 sqlite3ExpirePreparedStatements(db); 80 return SQLITE_OK; 81 } 82 83 /* 84 ** Write an error message into pParse->zErrMsg that explains that the 85 ** user-supplied authorization function returned an illegal value. 86 */ 87 static void sqliteAuthBadReturnCode(Parse *pParse, int rc){ 88 sqlite3ErrorMsg(pParse, "illegal return value (%d) from the " 89 "authorization function - should be SQLITE_OK, SQLITE_IGNORE, " 90 "or SQLITE_DENY", rc); 91 pParse->rc = SQLITE_ERROR; 92 } 93 94 /* 95 ** The pExpr should be a TK_COLUMN expression. The table referred to 96 ** is in pTabList or else it is the NEW or OLD table of a trigger. 97 ** Check to see if it is OK to read this particular column. 98 ** 99 ** If the auth function returns SQLITE_IGNORE, change the TK_COLUMN 100 ** instruction into a TK_NULL. If the auth function returns SQLITE_DENY, 101 ** then generate an error. 102 */ 103 void sqlite3AuthRead( 104 Parse *pParse, /* The parser context */ 105 Expr *pExpr, /* The expression to check authorization on */ 106 SrcList *pTabList /* All table that pExpr might refer to */ 107 ){ 108 sqlite3 *db = pParse->db; 109 int rc; 110 Table *pTab; /* The table being read */ 111 const char *zCol; /* Name of the column of the table */ 112 int iSrc; /* Index in pTabList->a[] of table being read */ 113 const char *zDBase; /* Name of database being accessed */ 114 TriggerStack *pStack; /* The stack of current triggers */ 115 116 if( db->xAuth==0 ) return; 117 if( pExpr->op==TK_AS ) return; 118 assert( pExpr->op==TK_COLUMN ); 119 for(iSrc=0; pTabList && iSrc<pTabList->nSrc; iSrc++){ 120 if( pExpr->iTable==pTabList->a[iSrc].iCursor ) break; 121 } 122 if( iSrc>=0 && pTabList && iSrc<pTabList->nSrc ){ 123 pTab = pTabList->a[iSrc].pTab; 124 }else if( (pStack = pParse->trigStack)!=0 ){ 125 /* This must be an attempt to read the NEW or OLD pseudo-tables 126 ** of a trigger. 127 */ 128 assert( pExpr->iTable==pStack->newIdx || pExpr->iTable==pStack->oldIdx ); 129 pTab = pStack->pTab; 130 }else{ 131 return; 132 } 133 if( pTab==0 ) return; 134 if( pExpr->iColumn>=0 ){ 135 assert( pExpr->iColumn<pTab->nCol ); 136 zCol = pTab->aCol[pExpr->iColumn].zName; 137 }else if( pTab->iPKey>=0 ){ 138 assert( pTab->iPKey<pTab->nCol ); 139 zCol = pTab->aCol[pTab->iPKey].zName; 140 }else{ 141 zCol = "ROWID"; 142 } 143 assert( pExpr->iDb<db->nDb ); 144 zDBase = db->aDb[pExpr->iDb].zName; 145 rc = db->xAuth(db->pAuthArg, SQLITE_READ, pTab->zName, zCol, zDBase, 146 pParse->zAuthContext); 147 if( rc==SQLITE_IGNORE ){ 148 pExpr->op = TK_NULL; 149 }else if( rc==SQLITE_DENY ){ 150 if( db->nDb>2 || pExpr->iDb!=0 ){ 151 sqlite3ErrorMsg(pParse, "access to %s.%s.%s is prohibited", 152 zDBase, pTab->zName, zCol); 153 }else{ 154 sqlite3ErrorMsg(pParse, "access to %s.%s is prohibited",pTab->zName,zCol); 155 } 156 pParse->rc = SQLITE_AUTH; 157 }else if( rc!=SQLITE_OK ){ 158 sqliteAuthBadReturnCode(pParse, rc); 159 } 160 } 161 162 /* 163 ** Do an authorization check using the code and arguments given. Return 164 ** either SQLITE_OK (zero) or SQLITE_IGNORE or SQLITE_DENY. If SQLITE_DENY 165 ** is returned, then the error count and error message in pParse are 166 ** modified appropriately. 167 */ 168 int sqlite3AuthCheck( 169 Parse *pParse, 170 int code, 171 const char *zArg1, 172 const char *zArg2, 173 const char *zArg3 174 ){ 175 sqlite3 *db = pParse->db; 176 int rc; 177 178 /* Don't do any authorization checks if the database is initialising. */ 179 if( db->init.busy ){ 180 return SQLITE_OK; 181 } 182 183 if( db->xAuth==0 ){ 184 return SQLITE_OK; 185 } 186 rc = db->xAuth(db->pAuthArg, code, zArg1, zArg2, zArg3, pParse->zAuthContext); 187 if( rc==SQLITE_DENY ){ 188 sqlite3ErrorMsg(pParse, "not authorized"); 189 pParse->rc = SQLITE_AUTH; 190 }else if( rc!=SQLITE_OK && rc!=SQLITE_IGNORE ){ 191 rc = SQLITE_DENY; 192 sqliteAuthBadReturnCode(pParse, rc); 193 } 194 return rc; 195 } 196 197 /* 198 ** Push an authorization context. After this routine is called, the 199 ** zArg3 argument to authorization callbacks will be zContext until 200 ** popped. Or if pParse==0, this routine is a no-op. 201 */ 202 void sqlite3AuthContextPush( 203 Parse *pParse, 204 AuthContext *pContext, 205 const char *zContext 206 ){ 207 pContext->pParse = pParse; 208 if( pParse ){ 209 pContext->zAuthContext = pParse->zAuthContext; 210 pParse->zAuthContext = zContext; 211 } 212 } 213 214 /* 215 ** Pop an authorization context that was previously pushed 216 ** by sqlite3AuthContextPush 217 */ 218 void sqlite3AuthContextPop(AuthContext *pContext){ 219 if( pContext->pParse ){ 220 pContext->pParse->zAuthContext = pContext->zAuthContext; 221 pContext->pParse = 0; 222 } 223 } 224 225 #endif /* SQLITE_OMIT_AUTHORIZATION */ 226