Thanks to visit codestin.com
Credit goes to chromium.googlesource.com

Google Git
Sign in
chromium / external / github.com / sqlite / sqlite / HEAD / . / src / auth.c
blob: 9ec2e7d046220dfc1ca2ae428395e308181d5076 [file] [log] [blame]
drhe6d01c32003-01-12 18:07:48[diff] [blame]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*************************************************************************
danielk197724b03fd2004-05-10 10:34:34[diff] [blame]12** This file contains code used to implement the sqlite3_set_authorizer()
drhe6d01c32003-01-12 18:07:48[diff] [blame]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
drhe6d01c32003-01-12 18:07:48[diff] [blame]16*/
17#include "sqliteInt.h"
18
19/*
20** All of the code in this file may be omitted by defining a single
21** macro.
22*/
23#ifndef SQLITE_OMIT_AUTHORIZATION
24
25/*
26** Set or clear the access authorization function.
27**
28** The access authorization function is be called during the compilation
drh5fe2d8c2003-05-10 03:36:53[diff] [blame]29** phase to verify that the user has read and/or write access permission on
drhe6d01c32003-01-12 18:07:48[diff] [blame]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:
33**
drh5fe2d8c2003-05-10 03:36:53[diff] [blame]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
41** SQLITE_CREATE_VIEW
42** SQLITE_DELETE
43** SQLITE_DROP_INDEX
44** SQLITE_DROP_TABLE
45** SQLITE_DROP_TEMP_INDEX
46** SQLITE_DROP_TEMP_TABLE
47** SQLITE_DROP_TEMP_TRIGGER
48** SQLITE_DROP_TEMP_VIEW
49** SQLITE_DROP_TRIGGER
50** SQLITE_DROP_VIEW
51** SQLITE_INSERT
52** SQLITE_PRAGMA
53** SQLITE_READ
54** SQLITE_SELECT
55** SQLITE_TRANSACTION
56** SQLITE_UPDATE
drhe6d01c32003-01-12 18:07:48[diff] [blame]57**
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
danielk197724b03fd2004-05-10 10:34:34[diff] [blame]62** means that the SQL statement will never-run - the sqlite3_exec() call
drhe6d01c32003-01-12 18:07:48[diff] [blame]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.
66**
67** Setting the auth function to NULL disables this hook. The default
68** setting of the auth function is NULL.
69*/
danielk197724b03fd2004-05-10 10:34:34[diff] [blame]70int sqlite3_set_authorizer(
drh9bb575f2004-09-06 17:24:11[diff] [blame]71 sqlite3 *db,
drhe22a3342003-04-22 20:30:37[diff] [blame]72 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe6d01c32003-01-12 18:07:48[diff] [blame]73 void *pArg
74){
drh9ca95732014-10-24 00:35:58[diff] [blame]75#ifdef SQLITE_ENABLE_API_ARMOR
76 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
77#endif
drhb21c8cd2007-08-21 19:33:56[diff] [blame]78 sqlite3_mutex_enter(db->mutex);
drh32c6a482014-09-11 13:44:52[diff] [blame]79 db->xAuth = (sqlite3_xauth)xAuth;
drhe6d01c32003-01-12 18:07:48[diff] [blame]80 db->pAuthArg = pArg;
drhd744ee02019-08-01 22:48:45[diff] [blame]81 if( db->xAuth ) sqlite3ExpirePreparedStatements(db, 1);
drhb21c8cd2007-08-21 19:33:56[diff] [blame]82 sqlite3_mutex_leave(db->mutex);
drhe6d01c32003-01-12 18:07:48[diff] [blame]83 return SQLITE_OK;
84}
85
86/*
87** Write an error message into pParse->zErrMsg that explains that the
88** user-supplied authorization function returned an illegal value.
89*/
drhce9b0152009-05-04 01:58:31[diff] [blame]90static void sqliteAuthBadReturnCode(Parse *pParse){
91 sqlite3ErrorMsg(pParse, "authorizer malfunction");
drhc60d0442004-09-30 13:43:13[diff] [blame]92 pParse->rc = SQLITE_ERROR;
drhe6d01c32003-01-12 18:07:48[diff] [blame]93}
94
95/*
dan47a06342009-10-02 14:23:41[diff] [blame]96** Invoke the authorization callback for permission to read column zCol from
97** table zTab in database zDb. This function assumes that an authorization
98** callback has been registered (i.e. that sqlite3.xAuth is not NULL).
99**
100** If SQLITE_IGNORE is returned and pExpr is not NULL, then pExpr is changed
101** to an SQL NULL expression. Otherwise, if pExpr is NULL, then SQLITE_IGNORE
102** is treated as SQLITE_DENY. In this case an error is left in pParse.
103*/
dan02470b22009-10-03 07:04:11[diff] [blame]104int sqlite3AuthReadCol(
dan47a06342009-10-02 14:23:41[diff] [blame]105 Parse *pParse, /* The parser context */
106 const char *zTab, /* Table name */
107 const char *zCol, /* Column name */
dan02470b22009-10-03 07:04:11[diff] [blame]108 int iDb /* Index of containing database. */
dan47a06342009-10-02 14:23:41[diff] [blame]109){
drh69c33822016-08-18 14:33:11[diff] [blame]110 sqlite3 *db = pParse->db; /* Database handle */
111 char *zDb = db->aDb[iDb].zDbSName; /* Schema name of attached database */
112 int rc; /* Auth callback return code */
dan47a06342009-10-02 14:23:41[diff] [blame]113
drha8914fa2016-07-28 18:38:13[diff] [blame]114 if( db->init.busy ) return SQLITE_OK;
drhbc4df602024-10-28 17:27:15[diff] [blame]115 rc = db->xAuth(db->pAuthArg, SQLITE_READ, zTab,zCol,zDb,pParse->zAuthContext);
dan02470b22009-10-03 07:04:11[diff] [blame]116 if( rc==SQLITE_DENY ){
drh6f7fbcf2017-08-17 18:54:27[diff] [blame]117 char *z = sqlite3_mprintf("%s.%s", zTab, zCol);
118 if( db->nDb>2 || iDb!=0 ) z = sqlite3_mprintf("%s.%z", zDb, z);
119 sqlite3ErrorMsg(pParse, "access to %z is prohibited", z);
dan47a06342009-10-02 14:23:41[diff] [blame]120 pParse->rc = SQLITE_AUTH;
dan02470b22009-10-03 07:04:11[diff] [blame]121 }else if( rc!=SQLITE_IGNORE && rc!=SQLITE_OK ){
122 sqliteAuthBadReturnCode(pParse);
dan47a06342009-10-02 14:23:41[diff] [blame]123 }
dan02470b22009-10-03 07:04:11[diff] [blame]124 return rc;
dan47a06342009-10-02 14:23:41[diff] [blame]125}
126
127/*
drhe6d01c32003-01-12 18:07:48[diff] [blame]128** The pExpr should be a TK_COLUMN expression. The table referred to
drh6a3ea0e2003-05-02 14:32:12[diff] [blame]129** is in pTabList or else it is the NEW or OLD table of a trigger.
130** Check to see if it is OK to read this particular column.
drhe6d01c32003-01-12 18:07:48[diff] [blame]131**
132** If the auth function returns SQLITE_IGNORE, change the TK_COLUMN
133** instruction into a TK_NULL. If the auth function returns SQLITE_DENY,
134** then generate an error.
135*/
danielk19774adee202004-05-08 08:23:19[diff] [blame]136void sqlite3AuthRead(
drhe6d01c32003-01-12 18:07:48[diff] [blame]137 Parse *pParse, /* The parser context */
138 Expr *pExpr, /* The expression to check authorization on */
drh728b5772007-09-18 15:55:07[diff] [blame]139 Schema *pSchema, /* The schema of the expression */
drh6a3ea0e2003-05-02 14:32:12[diff] [blame]140 SrcList *pTabList /* All table that pExpr might refer to */
drhe6d01c32003-01-12 18:07:48[diff] [blame]141){
danielk1977880c15b2007-09-01 18:24:55[diff] [blame]142 Table *pTab = 0; /* The table being read */
drh027850b2003-04-16 20:24:52[diff] [blame]143 const char *zCol; /* Name of the column of the table */
144 int iSrc; /* Index in pTabList->a[] of table being read */
danielk1977da184232006-01-05 11:34:32[diff] [blame]145 int iDb; /* The index of the database the expression refers to */
dan2bd93512009-08-31 08:22:46[diff] [blame]146 int iCol; /* Index of column in table */
drh027850b2003-04-16 20:24:52[diff] [blame]147
drh4344dbd2018-06-02 11:31:15[diff] [blame]148 assert( pExpr->op==TK_COLUMN || pExpr->op==TK_TRIGGER );
drh29f6a362021-02-05 17:34:47[diff] [blame]149 assert( !IN_RENAME_OBJECT );
150 assert( pParse->db->xAuth!=0 );
drh728b5772007-09-18 15:55:07[diff] [blame]151 iDb = sqlite3SchemaToIndex(pParse->db, pSchema);
drha3e4d962006-01-13 13:55:44[diff] [blame]152 if( iDb<0 ){
153 /* An attempt to read a column out of a subquery or other
154 ** temporary table. */
155 return;
156 }
dan2bd93512009-08-31 08:22:46[diff] [blame]157
dan2bd93512009-08-31 08:22:46[diff] [blame]158 if( pExpr->op==TK_TRIGGER ){
159 pTab = pParse->pTriggerTab;
160 }else{
161 assert( pTabList );
drh5f323782021-02-06 14:56:30[diff] [blame]162 for(iSrc=0; iSrc<pTabList->nSrc; iSrc++){
danielk197734acdc92009-07-02 18:40:34[diff] [blame]163 if( pExpr->iTable==pTabList->a[iSrc].iCursor ){
drhb204b6a2024-08-17 23:23:23[diff] [blame]164 pTab = pTabList->a[iSrc].pSTab;
dan2bd93512009-08-31 08:22:46[diff] [blame]165 break;
danielk197734acdc92009-07-02 18:40:34[diff] [blame]166 }
drheba661f2009-05-04 18:01:39[diff] [blame]167 }
danielk197734acdc92009-07-02 18:40:34[diff] [blame]168 }
dan2bd93512009-08-31 08:22:46[diff] [blame]169 iCol = pExpr->iColumn;
drh5f323782021-02-06 14:56:30[diff] [blame]170 if( pTab==0 ) return;
dan2bd93512009-08-31 08:22:46[diff] [blame]171
172 if( iCol>=0 ){
173 assert( iCol<pTab->nCol );
drhcf9d36d2021-08-02 18:03:43[diff] [blame]174 zCol = pTab->aCol[iCol].zCnName;
drhe6d01c32003-01-12 18:07:48[diff] [blame]175 }else if( pTab->iPKey>=0 ){
176 assert( pTab->iPKey<pTab->nCol );
drhcf9d36d2021-08-02 18:03:43[diff] [blame]177 zCol = pTab->aCol[pTab->iPKey].zCnName;
drhe6d01c32003-01-12 18:07:48[diff] [blame]178 }else{
179 zCol = "ROWID";
180 }
drh29f6a362021-02-05 17:34:47[diff] [blame]181 assert( iDb>=0 && iDb<pParse->db->nDb );
dan02470b22009-10-03 07:04:11[diff] [blame]182 if( SQLITE_IGNORE==sqlite3AuthReadCol(pParse, pTab->zName, zCol, iDb) ){
183 pExpr->op = TK_NULL;
184 }
drhe6d01c32003-01-12 18:07:48[diff] [blame]185}
186
187/*
drhe5f9c642003-01-13 23:27:31[diff] [blame]188** Do an authorization check using the code and arguments given. Return
189** either SQLITE_OK (zero) or SQLITE_IGNORE or SQLITE_DENY. If SQLITE_DENY
190** is returned, then the error count and error message in pParse are
191** modified appropriately.
drhe6d01c32003-01-12 18:07:48[diff] [blame]192*/
danielk19774adee202004-05-08 08:23:19[diff] [blame]193int sqlite3AuthCheck(
drhe5f9c642003-01-13 23:27:31[diff] [blame]194 Parse *pParse,
195 int code,
196 const char *zArg1,
drhe22a3342003-04-22 20:30:37[diff] [blame]197 const char *zArg2,
198 const char *zArg3
drhe5f9c642003-01-13 23:27:31[diff] [blame]199){
drh9bb575f2004-09-06 17:24:11[diff] [blame]200 sqlite3 *db = pParse->db;
drhe6d01c32003-01-12 18:07:48[diff] [blame]201 int rc;
drhe22a3342003-04-22 20:30:37[diff] [blame]202
larrybrbc917382023-06-07 08:40:31[diff] [blame]203 /* Don't do any authorization checks if the database is initializing
danielk1977f1a381e2006-06-16 08:01:02[diff] [blame]204 ** or if the parser is being invoked from within sqlite3_declare_vtab.
205 */
dan07052d52018-10-06 13:46:22[diff] [blame]206 assert( !IN_RENAME_OBJECT || db->xAuth==0 );
drh69e856a2021-01-01 16:43:26[diff] [blame]207 if( db->xAuth==0 || db->init.busy || IN_SPECIAL_PARSE ){
drhe6d01c32003-01-12 18:07:48[diff] [blame]208 return SQLITE_OK;
209 }
drh94189212017-05-11 13:43:57[diff] [blame]210
211 /* EVIDENCE-OF: R-43249-19882 The third through sixth parameters to the
212 ** callback are either NULL pointers or zero-terminated strings that
213 ** contain additional details about the action to be authorized.
214 **
215 ** The following testcase() macros show that any of the 3rd through 6th
216 ** parameters can be either NULL or a string. */
217 testcase( zArg1==0 );
218 testcase( zArg2==0 );
219 testcase( zArg3==0 );
220 testcase( pParse->zAuthContext==0 );
221
drhbc4df602024-10-28 17:27:15[diff] [blame]222 rc = db->xAuth(db->pAuthArg,code,zArg1,zArg2,zArg3,pParse->zAuthContext);
drhe5f9c642003-01-13 23:27:31[diff] [blame]223 if( rc==SQLITE_DENY ){
danielk19774adee202004-05-08 08:23:19[diff] [blame]224 sqlite3ErrorMsg(pParse, "not authorized");
drhdcd997e2003-01-31 17:21:49[diff] [blame]225 pParse->rc = SQLITE_AUTH;
drhe6d01c32003-01-12 18:07:48[diff] [blame]226 }else if( rc!=SQLITE_OK && rc!=SQLITE_IGNORE ){
227 rc = SQLITE_DENY;
drhce9b0152009-05-04 01:58:31[diff] [blame]228 sqliteAuthBadReturnCode(pParse);
drhe6d01c32003-01-12 18:07:48[diff] [blame]229 }
230 return rc;
231}
232
drh85e20962003-04-25 17:52:11[diff] [blame]233/*
234** Push an authorization context. After this routine is called, the
235** zArg3 argument to authorization callbacks will be zContext until
236** popped. Or if pParse==0, this routine is a no-op.
237*/
danielk19774adee202004-05-08 08:23:19[diff] [blame]238void sqlite3AuthContextPush(
drh85e20962003-04-25 17:52:11[diff] [blame]239 Parse *pParse,
240 AuthContext *pContext,
241 const char *zContext
242){
drheba661f2009-05-04 18:01:39[diff] [blame]243 assert( pParse );
drh85e20962003-04-25 17:52:11[diff] [blame]244 pContext->pParse = pParse;
drheba661f2009-05-04 18:01:39[diff] [blame]245 pContext->zAuthContext = pParse->zAuthContext;
246 pParse->zAuthContext = zContext;
drh85e20962003-04-25 17:52:11[diff] [blame]247}
248
249/*
250** Pop an authorization context that was previously pushed
danielk19774adee202004-05-08 08:23:19[diff] [blame]251** by sqlite3AuthContextPush
drh85e20962003-04-25 17:52:11[diff] [blame]252*/
danielk19774adee202004-05-08 08:23:19[diff] [blame]253void sqlite3AuthContextPop(AuthContext *pContext){
drh85e20962003-04-25 17:52:11[diff] [blame]254 if( pContext->pParse ){
255 pContext->pParse->zAuthContext = pContext->zAuthContext;
256 pContext->pParse = 0;
257 }
258}
259
drhe6d01c32003-01-12 18:07:48[diff] [blame]260#endif /* SQLITE_OMIT_AUTHORIZATION */