4
** The author disclaims copyright to this source code. In place of
5
** a legal notice, here is a blessing:
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.
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
17
** $Id: auth.c 410099 2005-05-06 17:52:07Z staniek $
19
#include "sqliteInt.h"
22
** All of the code in this file may be omitted by defining a single
25
#ifndef SQLITE_OMIT_AUTHORIZATION
28
** Set or clear the access authorization function.
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:
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
47
** SQLITE_DROP_TEMP_INDEX
48
** SQLITE_DROP_TEMP_TABLE
49
** SQLITE_DROP_TEMP_TRIGGER
50
** SQLITE_DROP_TEMP_VIEW
51
** SQLITE_DROP_TRIGGER
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.
69
** Setting the auth function to NULL disables this hook. The default
70
** setting of the auth function is NULL.
72
int sqlite3_set_authorizer(
74
int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
83
** Write an error message into pParse->zErrMsg that explains that the
84
** user-supplied authorization function returned an illegal value.
86
static void sqliteAuthBadReturnCode(Parse *pParse, int rc){
87
sqlite3ErrorMsg(pParse, "illegal return value (%d) from the "
88
"authorization function - should be SQLITE_OK, SQLITE_IGNORE, "
89
"or SQLITE_DENY", rc);
90
pParse->rc = SQLITE_MISUSE;
94
** The pExpr should be a TK_COLUMN expression. The table referred to
95
** is in pTabList or else it is the NEW or OLD table of a trigger.
96
** Check to see if it is OK to read this particular column.
98
** If the auth function returns SQLITE_IGNORE, change the TK_COLUMN
99
** instruction into a TK_NULL. If the auth function returns SQLITE_DENY,
100
** then generate an error.
102
void sqlite3AuthRead(
103
Parse *pParse, /* The parser context */
104
Expr *pExpr, /* The expression to check authorization on */
105
SrcList *pTabList /* All table that pExpr might refer to */
107
sqlite3 *db = pParse->db;
109
Table *pTab; /* The table being read */
110
const char *zCol; /* Name of the column of the table */
111
int iSrc; /* Index in pTabList->a[] of table being read */
112
const char *zDBase; /* Name of database being accessed */
113
TriggerStack *pStack; /* The stack of current triggers */
115
if( db->xAuth==0 ) return;
116
assert( pExpr->op==TK_COLUMN );
117
for(iSrc=0; iSrc<pTabList->nSrc; iSrc++){
118
if( pExpr->iTable==pTabList->a[iSrc].iCursor ) break;
120
if( iSrc>=0 && iSrc<pTabList->nSrc ){
121
pTab = pTabList->a[iSrc].pTab;
122
}else if( (pStack = pParse->trigStack)!=0 ){
123
/* This must be an attempt to read the NEW or OLD pseudo-tables
126
assert( pExpr->iTable==pStack->newIdx || pExpr->iTable==pStack->oldIdx );
131
if( pTab==0 ) return;
132
if( pExpr->iColumn>=0 ){
133
assert( pExpr->iColumn<pTab->nCol );
134
zCol = pTab->aCol[pExpr->iColumn].zName;
135
}else if( pTab->iPKey>=0 ){
136
assert( pTab->iPKey<pTab->nCol );
137
zCol = pTab->aCol[pTab->iPKey].zName;
141
assert( pExpr->iDb<db->nDb );
142
zDBase = db->aDb[pExpr->iDb].zName;
143
rc = db->xAuth(db->pAuthArg, SQLITE_READ, pTab->zName, zCol, zDBase,
144
pParse->zAuthContext);
145
if( rc==SQLITE_IGNORE ){
147
}else if( rc==SQLITE_DENY ){
148
if( db->nDb>2 || pExpr->iDb!=0 ){
149
sqlite3ErrorMsg(pParse, "access to %s.%s.%s is prohibited",
150
zDBase, pTab->zName, zCol);
152
sqlite3ErrorMsg(pParse, "access to %s.%s is prohibited",pTab->zName,zCol);
154
pParse->rc = SQLITE_AUTH;
155
}else if( rc!=SQLITE_OK ){
156
sqliteAuthBadReturnCode(pParse, rc);
161
** Do an authorization check using the code and arguments given. Return
162
** either SQLITE_OK (zero) or SQLITE_IGNORE or SQLITE_DENY. If SQLITE_DENY
163
** is returned, then the error count and error message in pParse are
164
** modified appropriately.
166
int sqlite3AuthCheck(
173
sqlite3 *db = pParse->db;
176
/* Don't do any authorization checks if the database is initialising. */
184
rc = db->xAuth(db->pAuthArg, code, zArg1, zArg2, zArg3, pParse->zAuthContext);
185
if( rc==SQLITE_DENY ){
186
sqlite3ErrorMsg(pParse, "not authorized");
187
pParse->rc = SQLITE_AUTH;
188
}else if( rc!=SQLITE_OK && rc!=SQLITE_IGNORE ){
190
sqliteAuthBadReturnCode(pParse, rc);
196
** Push an authorization context. After this routine is called, the
197
** zArg3 argument to authorization callbacks will be zContext until
198
** popped. Or if pParse==0, this routine is a no-op.
200
void sqlite3AuthContextPush(
202
AuthContext *pContext,
205
pContext->pParse = pParse;
207
pContext->zAuthContext = pParse->zAuthContext;
208
pParse->zAuthContext = zContext;
213
** Pop an authorization context that was previously pushed
214
** by sqlite3AuthContextPush
216
void sqlite3AuthContextPop(AuthContext *pContext){
217
if( pContext->pParse ){
218
pContext->pParse->zAuthContext = pContext->zAuthContext;
219
pContext->pParse = 0;
223
#endif /* SQLITE_OMIT_AUTHORIZATION */