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 #include "sqliteInt.h"
20 ** All of the code in this file may be omitted by defining a single
23 #ifndef SQLITE_OMIT_AUTHORIZATION
26 ** Set or clear the access authorization function.
28 ** The access authorization function is be called during the compilation
29 ** phase to verify that the user has read and/or write access permission on
30 ** various fields of the database. The first argument to the auth function
31 ** is a copy of the 3rd argument to this routine. The second argument
32 ** to the auth function is one of these constants:
34 ** SQLITE_CREATE_INDEX
35 ** SQLITE_CREATE_TABLE
36 ** SQLITE_CREATE_TEMP_INDEX
37 ** SQLITE_CREATE_TEMP_TABLE
38 ** SQLITE_CREATE_TEMP_TRIGGER
39 ** SQLITE_CREATE_TEMP_VIEW
40 ** SQLITE_CREATE_TRIGGER
45 ** SQLITE_DROP_TEMP_INDEX
46 ** SQLITE_DROP_TEMP_TABLE
47 ** SQLITE_DROP_TEMP_TRIGGER
48 ** SQLITE_DROP_TEMP_VIEW
49 ** SQLITE_DROP_TRIGGER
58 ** The third and fourth arguments to the auth function are the name of
59 ** the table and the column that are being accessed. The auth function
60 ** should return either SQLITE_OK, SQLITE_DENY, or SQLITE_IGNORE. If
61 ** SQLITE_OK is returned, it means that access is allowed. SQLITE_DENY
62 ** means that the SQL statement will never-run - the sqlite3_exec() call
63 ** will return with an error. SQLITE_IGNORE means that the SQL statement
64 ** should run but attempts to read the specified column will return NULL
65 ** and attempts to write the column will be ignored.
67 ** Setting the auth function to NULL disables this hook. The default
68 ** setting of the auth function is NULL.
70 int sqlite3_set_authorizer(
72 int (*xAuth
)(void*,int,const char*,const char*,const char*,const char*),
75 sqlite3_mutex_enter(db
->mutex
);
76 db
->xAuth
= (sqlite3_xauth
)xAuth
;
78 sqlite3ExpirePreparedStatements(db
);
79 sqlite3_mutex_leave(db
->mutex
);
84 ** Write an error message into pParse->zErrMsg that explains that the
85 ** user-supplied authorization function returned an illegal value.
87 static void sqliteAuthBadReturnCode(Parse
*pParse
){
88 sqlite3ErrorMsg(pParse
, "authorizer malfunction");
89 pParse
->rc
= SQLITE_ERROR
;
93 ** Invoke the authorization callback for permission to read column zCol from
94 ** table zTab in database zDb. This function assumes that an authorization
95 ** callback has been registered (i.e. that sqlite3.xAuth is not NULL).
97 ** If SQLITE_IGNORE is returned and pExpr is not NULL, then pExpr is changed
98 ** to an SQL NULL expression. Otherwise, if pExpr is NULL, then SQLITE_IGNORE
99 ** is treated as SQLITE_DENY. In this case an error is left in pParse.
101 int sqlite3AuthReadCol(
102 Parse
*pParse
, /* The parser context */
103 const char *zTab
, /* Table name */
104 const char *zCol
, /* Column name */
105 int iDb
/* Index of containing database. */
107 sqlite3
*db
= pParse
->db
; /* Database handle */
108 char *zDb
= db
->aDb
[iDb
].zName
; /* Name of attached database */
109 int rc
; /* Auth callback return code */
111 rc
= db
->xAuth(db
->pAuthArg
, SQLITE_READ
, zTab
,zCol
,zDb
,pParse
->zAuthContext
112 #ifdef SQLITE_USER_AUTHENTICATION
116 if( rc
==SQLITE_DENY
){
117 if( db
->nDb
>2 || iDb
!=0 ){
118 sqlite3ErrorMsg(pParse
, "access to %s.%s.%s is prohibited",zDb
,zTab
,zCol
);
120 sqlite3ErrorMsg(pParse
, "access to %s.%s is prohibited", zTab
, zCol
);
122 pParse
->rc
= SQLITE_AUTH
;
123 }else if( rc
!=SQLITE_IGNORE
&& rc
!=SQLITE_OK
){
124 sqliteAuthBadReturnCode(pParse
);
130 ** The pExpr should be a TK_COLUMN expression. The table referred to
131 ** is in pTabList or else it is the NEW or OLD table of a trigger.
132 ** Check to see if it is OK to read this particular column.
134 ** If the auth function returns SQLITE_IGNORE, change the TK_COLUMN
135 ** instruction into a TK_NULL. If the auth function returns SQLITE_DENY,
136 ** then generate an error.
138 void sqlite3AuthRead(
139 Parse
*pParse
, /* The parser context */
140 Expr
*pExpr
, /* The expression to check authorization on */
141 Schema
*pSchema
, /* The schema of the expression */
142 SrcList
*pTabList
/* All table that pExpr might refer to */
144 sqlite3
*db
= pParse
->db
;
145 Table
*pTab
= 0; /* The table being read */
146 const char *zCol
; /* Name of the column of the table */
147 int iSrc
; /* Index in pTabList->a[] of table being read */
148 int iDb
; /* The index of the database the expression refers to */
149 int iCol
; /* Index of column in table */
151 if( db
->xAuth
==0 ) return;
152 iDb
= sqlite3SchemaToIndex(pParse
->db
, pSchema
);
154 /* An attempt to read a column out of a subquery or other
155 ** temporary table. */
159 assert( pExpr
->op
==TK_COLUMN
|| pExpr
->op
==TK_TRIGGER
);
160 if( pExpr
->op
==TK_TRIGGER
){
161 pTab
= pParse
->pTriggerTab
;
164 for(iSrc
=0; ALWAYS(iSrc
<pTabList
->nSrc
); iSrc
++){
165 if( pExpr
->iTable
==pTabList
->a
[iSrc
].iCursor
){
166 pTab
= pTabList
->a
[iSrc
].pTab
;
171 iCol
= pExpr
->iColumn
;
172 if( NEVER(pTab
==0) ) return;
175 assert( iCol
<pTab
->nCol
);
176 zCol
= pTab
->aCol
[iCol
].zName
;
177 }else if( pTab
->iPKey
>=0 ){
178 assert( pTab
->iPKey
<pTab
->nCol
);
179 zCol
= pTab
->aCol
[pTab
->iPKey
].zName
;
183 assert( iDb
>=0 && iDb
<db
->nDb
);
184 if( SQLITE_IGNORE
==sqlite3AuthReadCol(pParse
, pTab
->zName
, zCol
, iDb
) ){
190 ** Do an authorization check using the code and arguments given. Return
191 ** either SQLITE_OK (zero) or SQLITE_IGNORE or SQLITE_DENY. If SQLITE_DENY
192 ** is returned, then the error count and error message in pParse are
193 ** modified appropriately.
195 int sqlite3AuthCheck(
202 sqlite3
*db
= pParse
->db
;
205 /* Don't do any authorization checks if the database is initialising
206 ** or if the parser is being invoked from within sqlite3_declare_vtab.
208 if( db
->init
.busy
|| IN_DECLARE_VTAB
){
215 rc
= db
->xAuth(db
->pAuthArg
, code
, zArg1
, zArg2
, zArg3
, pParse
->zAuthContext
216 #ifdef SQLITE_USER_AUTHENTICATION
220 if( rc
==SQLITE_DENY
){
221 sqlite3ErrorMsg(pParse
, "not authorized");
222 pParse
->rc
= SQLITE_AUTH
;
223 }else if( rc
!=SQLITE_OK
&& rc
!=SQLITE_IGNORE
){
225 sqliteAuthBadReturnCode(pParse
);
231 ** Push an authorization context. After this routine is called, the
232 ** zArg3 argument to authorization callbacks will be zContext until
233 ** popped. Or if pParse==0, this routine is a no-op.
235 void sqlite3AuthContextPush(
237 AuthContext
*pContext
,
241 pContext
->pParse
= pParse
;
242 pContext
->zAuthContext
= pParse
->zAuthContext
;
243 pParse
->zAuthContext
= zContext
;
247 ** Pop an authorization context that was previously pushed
248 ** by sqlite3AuthContextPush
250 void sqlite3AuthContextPop(AuthContext
*pContext
){
251 if( pContext
->pParse
){
252 pContext
->pParse
->zAuthContext
= pContext
->zAuthContext
;
253 pContext
->pParse
= 0;
257 #endif /* SQLITE_OMIT_AUTHORIZATION */