-
-
Notifications
You must be signed in to change notification settings - Fork 195
/
privileged_database_provider.go
515 lines (442 loc) · 19 KB
/
privileged_database_provider.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
// Copyright 2022 Dolthub, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package mysql_db
import (
"strings"
"time"
"github.com/dolthub/go-mysql-server/sql/fulltext"
"github.com/dolthub/go-mysql-server/sql"
)
// PrivilegedDatabaseProvider is a wrapper around a normal sql.DatabaseProvider that takes a context's client's
// privileges into consideration when returning a sql.Database. In addition, any returned databases are wrapped with
// PrivilegedDatabase.
type PrivilegedDatabaseProvider struct {
grantTables *MySQLDb
provider sql.DatabaseProvider
}
var _ sql.DatabaseProvider = PrivilegedDatabaseProvider{}
// NewPrivilegedDatabaseProvider returns a new PrivilegedDatabaseProvider. As a sql.DatabaseProvider may be added to an
// analyzer when Grant Tables are disabled (and Grant Tables may be enabled or disabled at any time), a new
// PrivilegedDatabaseProvider is returned whenever the sql.DatabaseProvider is needed (as long as Grant Tables are
// enabled) rather than wrapping a sql.DatabaseProvider when it is provided to the analyzer.
func NewPrivilegedDatabaseProvider(grantTables *MySQLDb, p sql.DatabaseProvider) sql.DatabaseProvider {
return PrivilegedDatabaseProvider{
grantTables: grantTables,
provider: p,
}
}
// Database implements the interface sql.DatabaseProvider.
func (pdp PrivilegedDatabaseProvider) Database(ctx *sql.Context, name string) (sql.Database, error) {
if strings.ToLower(name) == "mysql" {
return pdp.grantTables, nil
}
db, providerErr := pdp.provider.Database(ctx, name)
if sql.ErrDatabaseNotFound.Is(providerErr) {
// continue to priv check below, which will deny access or return not found as appropriate, before returning this
// original not found error
} else if providerErr != nil {
return nil, providerErr
}
checkName := name
if adb, ok := db.(sql.AliasedDatabase); ok {
checkName = adb.AliasedName()
}
privSet := pdp.grantTables.UserActivePrivilegeSet(ctx)
// If the user has no global static privileges or database-relevant privileges then the database is not accessible.
if privSet.Count() == 0 && !privSet.Database(checkName).HasPrivileges() {
return nil, sql.ErrDatabaseAccessDeniedForUser.New(pdp.usernameFromCtx(ctx), checkName)
}
if providerErr != nil {
return nil, providerErr
}
return NewPrivilegedDatabase(pdp.grantTables, db), nil
}
// HasDatabase implements the interface sql.DatabaseProvider.
func (pdp PrivilegedDatabaseProvider) HasDatabase(ctx *sql.Context, name string) bool {
db, err := pdp.provider.Database(ctx, name)
if sql.ErrDatabaseNotFound.Is(err) {
// continue to check below, which will deny access or return not found as appropriate
} else if err != nil {
return false
}
if adb, ok := db.(sql.AliasedDatabase); ok {
name = adb.AliasedName()
}
privSet := pdp.grantTables.UserActivePrivilegeSet(ctx)
// If the user has no global static privileges or database-relevant privileges then the database is not accessible.
if privSet.Count() == 0 && !privSet.Database(name).HasPrivileges() {
return false
}
return pdp.provider.HasDatabase(ctx, name)
}
// AllDatabases implements the interface sql.DatabaseProvider.
func (pdp PrivilegedDatabaseProvider) AllDatabases(ctx *sql.Context) []sql.Database {
privilegeSet := pdp.grantTables.UserActivePrivilegeSet(ctx)
privilegeSetCount := privilegeSet.Count()
var databasesWithAccess []sql.Database
allDatabases := pdp.provider.AllDatabases(ctx)
for _, db := range allDatabases {
// If the user has any global static privileges or database-relevant privileges then the database is accessible
checkName := db.Name()
if adb, ok := db.(sql.AliasedDatabase); ok {
checkName = adb.AliasedName()
}
if privilegeSetCount > 0 || privilegeSet.Database(checkName).HasPrivileges() {
databasesWithAccess = append(databasesWithAccess, NewPrivilegedDatabase(pdp.grantTables, db))
}
}
return databasesWithAccess
}
// usernameFromCtx returns the username from the context, properly formatted for returned errors.
func (pdp PrivilegedDatabaseProvider) usernameFromCtx(ctx *sql.Context) string {
client := ctx.Session.Client()
return User{User: client.User, Host: client.Address}.UserHostToString("'")
}
// PrivilegedDatabase is a wrapper around a normal sql.Database that takes a context's client's privileges into
// consideration when returning a sql.Table.
type PrivilegedDatabase struct {
grantTables *MySQLDb
db sql.Database
//TODO: this should also handle views as the relevant privilege exists
}
var _ sql.Database = PrivilegedDatabase{}
var _ sql.VersionedDatabase = PrivilegedDatabase{}
var _ sql.TableCreator = PrivilegedDatabase{}
var _ sql.TableDropper = PrivilegedDatabase{}
var _ sql.TableRenamer = PrivilegedDatabase{}
var _ sql.TriggerDatabase = PrivilegedDatabase{}
var _ sql.StoredProcedureDatabase = PrivilegedDatabase{}
var _ sql.EventDatabase = PrivilegedDatabase{}
var _ sql.TableCopierDatabase = PrivilegedDatabase{}
var _ sql.ReadOnlyDatabase = PrivilegedDatabase{}
var _ sql.TemporaryTableDatabase = PrivilegedDatabase{}
var _ sql.CollatedDatabase = PrivilegedDatabase{}
var _ sql.ViewDatabase = PrivilegedDatabase{}
var _ fulltext.Database = PrivilegedDatabase{}
// NewPrivilegedDatabase returns a new PrivilegedDatabase.
func NewPrivilegedDatabase(grantTables *MySQLDb, db sql.Database) sql.Database {
return PrivilegedDatabase{
grantTables: grantTables,
db: db,
}
}
// Name implements the interface sql.Database.
func (pdb PrivilegedDatabase) Name() string {
return pdb.db.Name()
}
// GetTableInsensitive implements the interface sql.Database.
func (pdb PrivilegedDatabase) GetTableInsensitive(ctx *sql.Context, tblName string) (sql.Table, bool, error) {
checkName := pdb.db.Name()
if adb, ok := pdb.db.(sql.AliasedDatabase); ok {
checkName = adb.AliasedName()
}
privSet := pdb.grantTables.UserActivePrivilegeSet(ctx)
dbSet := privSet.Database(checkName)
// If there are no usable privileges for this database then the table is inaccessible.
if privSet.Count() == 0 && !dbSet.HasPrivileges() {
return nil, false, sql.ErrDatabaseAccessDeniedForUser.New(pdb.usernameFromCtx(ctx), checkName)
}
tblSet := dbSet.Table(tblName)
// If the user has no global static privileges, database-level privileges, or table-relevant privileges then the
// table is not accessible.
if privSet.Count() == 0 && dbSet.Count() == 0 && !tblSet.HasPrivileges() {
return nil, false, sql.ErrTableAccessDeniedForUser.New(pdb.usernameFromCtx(ctx), tblName)
}
return pdb.db.GetTableInsensitive(ctx, tblName)
}
// GetTableNames implements the interface sql.Database.
func (pdb PrivilegedDatabase) GetTableNames(ctx *sql.Context) ([]string, error) {
var tablesWithAccess []string
var err error
privSet := pdb.grantTables.UserActivePrivilegeSet(ctx)
checkName := pdb.db.Name()
if adb, ok := pdb.db.(sql.AliasedDatabase); ok {
checkName = adb.AliasedName()
}
dbSet := privSet.Database(checkName)
// If there are no usable privileges for this database then no table is accessible.
privSetCount := privSet.Count()
if privSetCount == 0 && !dbSet.HasPrivileges() {
return nil, nil
}
tblNames, err := pdb.db.GetTableNames(ctx)
if err != nil {
return nil, err
}
dbSetCount := dbSet.Count()
for _, tblName := range tblNames {
// If the user has any global static privileges, database-level privileges, or table-relevant privileges then a
// table is accessible.
if privSetCount > 0 || dbSetCount > 0 || dbSet.Table(tblName).HasPrivileges() {
tablesWithAccess = append(tablesWithAccess, tblName)
}
}
return tablesWithAccess, nil
}
// GetTableInsensitiveAsOf returns a new sql.VersionedDatabase.
func (pdb PrivilegedDatabase) GetTableInsensitiveAsOf(ctx *sql.Context, tblName string, asOf interface{}) (sql.Table, bool, error) {
db, ok := pdb.db.(sql.VersionedDatabase)
if !ok {
return nil, false, sql.ErrAsOfNotSupported.New(pdb.db.Name())
}
privSet := pdb.grantTables.UserActivePrivilegeSet(ctx)
checkName := pdb.db.Name()
if adb, ok := pdb.db.(sql.AliasedDatabase); ok {
checkName = adb.AliasedName()
}
dbSet := privSet.Database(checkName)
// If there are no usable privileges for this database then the table is inaccessible.
if privSet.Count() == 0 && !dbSet.HasPrivileges() {
return nil, false, sql.ErrDatabaseAccessDeniedForUser.New(pdb.usernameFromCtx(ctx), checkName)
}
tblSet := dbSet.Table(tblName)
// If the user has no global static privileges, database-level privileges, or table-relevant privileges then the
// table is not accessible.
if privSet.Count() == 0 && dbSet.Count() == 0 && !tblSet.HasPrivileges() {
return nil, false, sql.ErrTableAccessDeniedForUser.New(pdb.usernameFromCtx(ctx), tblName)
}
return db.GetTableInsensitiveAsOf(ctx, tblName, asOf)
}
// GetTableNamesAsOf returns a new sql.VersionedDatabase.
func (pdb PrivilegedDatabase) GetTableNamesAsOf(ctx *sql.Context, asOf interface{}) ([]string, error) {
db, ok := pdb.db.(sql.VersionedDatabase)
if !ok {
return nil, nil
}
var tablesWithAccess []string
var err error
privSet := pdb.grantTables.UserActivePrivilegeSet(ctx)
checkName := pdb.db.Name()
if adb, ok := pdb.db.(sql.AliasedDatabase); ok {
checkName = adb.AliasedName()
}
dbSet := privSet.Database(checkName)
// If there are no usable privileges for this database then no table is accessible.
if privSet.Count() == 0 && !dbSet.HasPrivileges() {
return nil, nil
}
tblNames, err := db.GetTableNamesAsOf(ctx, asOf)
if err != nil {
return nil, err
}
privSetCount := privSet.Count()
dbSetCount := dbSet.Count()
for _, tblName := range tblNames {
// If the user has any global static privileges, database-level privileges, or table-relevant privileges then a
// table is accessible.
if privSetCount > 0 || dbSetCount > 0 && dbSet.Table(tblName).HasPrivileges() {
tablesWithAccess = append(tablesWithAccess, tblName)
}
}
return tablesWithAccess, nil
}
// CreateTable implements the interface sql.TableCreator.
func (pdb PrivilegedDatabase) CreateTable(ctx *sql.Context, name string, schema sql.PrimaryKeySchema, collation sql.CollationID, comment string) error {
if db, ok := pdb.db.(sql.TableCreator); ok {
return db.CreateTable(ctx, name, schema, collation, comment)
}
return sql.ErrCreateTableNotSupported.New(pdb.db.Name())
}
// DropTable implements the interface sql.TableDropper.
func (pdb PrivilegedDatabase) DropTable(ctx *sql.Context, name string) error {
if db, ok := pdb.db.(sql.TableDropper); ok {
return db.DropTable(ctx, name)
}
return sql.ErrDropTableNotSupported.New(pdb.db.Name())
}
// CreateFulltextTableNames implements the interface fulltext.Database.
func (pdb PrivilegedDatabase) CreateFulltextTableNames(ctx *sql.Context, parentTable string, parentIndexName string) (fulltext.IndexTableNames, error) {
if db, ok := pdb.db.(fulltext.Database); ok {
return db.CreateFulltextTableNames(ctx, parentTable, parentIndexName)
}
return fulltext.IndexTableNames{}, sql.ErrFullTextDatabaseNotSupported.New()
}
// RenameTable implements the interface sql.TableRenamer.
func (pdb PrivilegedDatabase) RenameTable(ctx *sql.Context, oldName, newName string) error {
if db, ok := pdb.db.(sql.TableRenamer); ok {
return db.RenameTable(ctx, oldName, newName)
}
return sql.ErrRenameTableNotSupported.New(pdb.db.Name())
}
// GetTriggers implements the interface sql.TriggerDatabase.
func (pdb PrivilegedDatabase) GetTriggers(ctx *sql.Context) ([]sql.TriggerDefinition, error) {
if db, ok := pdb.db.(sql.TriggerDatabase); ok {
return db.GetTriggers(ctx)
}
return nil, sql.ErrTriggersNotSupported.New(pdb.db.Name())
}
// CreateTrigger implements the interface sql.TriggerDatabase.
func (pdb PrivilegedDatabase) CreateTrigger(ctx *sql.Context, definition sql.TriggerDefinition) error {
if db, ok := pdb.db.(sql.TriggerDatabase); ok {
return db.CreateTrigger(ctx, definition)
}
return sql.ErrTriggersNotSupported.New(pdb.db.Name())
}
// DropTrigger implements the interface sql.TriggerDatabase.
func (pdb PrivilegedDatabase) DropTrigger(ctx *sql.Context, name string) error {
if db, ok := pdb.db.(sql.TriggerDatabase); ok {
return db.DropTrigger(ctx, name)
}
return sql.ErrTriggersNotSupported.New(pdb.db.Name())
}
// GetStoredProcedure implements the interface sql.StoredProcedureDatabase.
func (pdb PrivilegedDatabase) GetStoredProcedure(ctx *sql.Context, name string) (sql.StoredProcedureDetails, bool, error) {
if db, ok := pdb.db.(sql.StoredProcedureDatabase); ok {
return db.GetStoredProcedure(ctx, name)
}
return sql.StoredProcedureDetails{}, false, sql.ErrStoredProceduresNotSupported.New(pdb.db.Name())
}
// GetStoredProcedures implements the interface sql.StoredProcedureDatabase.
func (pdb PrivilegedDatabase) GetStoredProcedures(ctx *sql.Context) ([]sql.StoredProcedureDetails, error) {
if db, ok := pdb.db.(sql.StoredProcedureDatabase); ok {
return db.GetStoredProcedures(ctx)
}
return nil, sql.ErrStoredProceduresNotSupported.New(pdb.db.Name())
}
// SaveStoredProcedure implements the interface sql.StoredProcedureDatabase.
func (pdb PrivilegedDatabase) SaveStoredProcedure(ctx *sql.Context, spd sql.StoredProcedureDetails) error {
if db, ok := pdb.db.(sql.StoredProcedureDatabase); ok {
return db.SaveStoredProcedure(ctx, spd)
}
return sql.ErrStoredProceduresNotSupported.New(pdb.db.Name())
}
// DropStoredProcedure implements the interface sql.StoredProcedureDatabase.
func (pdb PrivilegedDatabase) DropStoredProcedure(ctx *sql.Context, name string) error {
if db, ok := pdb.db.(sql.StoredProcedureDatabase); ok {
return db.DropStoredProcedure(ctx, name)
}
return sql.ErrStoredProceduresNotSupported.New(pdb.db.Name())
}
// GetEvent implements sql.EventDatabase
func (pdb PrivilegedDatabase) GetEvent(ctx *sql.Context, name string) (sql.EventDefinition, bool, error) {
if db, ok := pdb.db.(sql.EventDatabase); ok {
return db.GetEvent(ctx, name)
}
return sql.EventDefinition{}, false, sql.ErrEventsNotSupported.New(pdb.db.Name())
}
// GetEvents implements sql.EventDatabase
func (pdb PrivilegedDatabase) GetEvents(ctx *sql.Context) ([]sql.EventDefinition, interface{}, error) {
if db, ok := pdb.db.(sql.EventDatabase); ok {
return db.GetEvents(ctx)
}
return nil, nil, sql.ErrEventsNotSupported.New(pdb.db.Name())
}
// SaveEvent implements sql.EventDatabase
func (pdb PrivilegedDatabase) SaveEvent(ctx *sql.Context, ed sql.EventDefinition) (bool, error) {
if db, ok := pdb.db.(sql.EventDatabase); ok {
return db.SaveEvent(ctx, ed)
}
return false, sql.ErrEventsNotSupported.New(pdb.db.Name())
}
// DropEvent implements sql.EventDatabase
func (pdb PrivilegedDatabase) DropEvent(ctx *sql.Context, name string) error {
if db, ok := pdb.db.(sql.EventDatabase); ok {
return db.DropEvent(ctx, name)
}
return sql.ErrEventsNotSupported.New(pdb.db.Name())
}
// UpdateEvent implements sql.EventDatabase
func (pdb PrivilegedDatabase) UpdateEvent(ctx *sql.Context, originalName string, ed sql.EventDefinition) (bool, error) {
if db, ok := pdb.db.(sql.EventDatabase); ok {
return db.UpdateEvent(ctx, originalName, ed)
}
return false, sql.ErrEventsNotSupported.New(pdb.db.Name())
}
// NeedsToReloadEvents implements sql.EventDatabase
func (pdb PrivilegedDatabase) NeedsToReloadEvents(ctx *sql.Context, token interface{}) (bool, error) {
if db, ok := pdb.db.(sql.EventDatabase); ok {
return db.NeedsToReloadEvents(ctx, token)
}
return false, sql.ErrEventsNotSupported.New(pdb.db.Name())
}
func (pdb PrivilegedDatabase) UpdateLastExecuted(ctx *sql.Context, eventName string, lastExecuted time.Time) error {
if db, ok := pdb.db.(sql.EventDatabase); ok {
return db.UpdateLastExecuted(ctx, eventName, lastExecuted)
}
return sql.ErrEventsNotSupported.New(pdb.db.Name())
}
// CreateView implements sql.ViewDatabase
func (pdb PrivilegedDatabase) CreateView(ctx *sql.Context, name string, selectStatement, createViewStmt string) error {
if db, ok := pdb.db.(sql.ViewDatabase); ok {
return db.CreateView(ctx, name, selectStatement, createViewStmt)
}
return sql.ErrViewsNotSupported.New(pdb.db.Name())
}
// DropView implements sql.ViewDatabase
func (pdb PrivilegedDatabase) DropView(ctx *sql.Context, name string) error {
if db, ok := pdb.db.(sql.ViewDatabase); ok {
return db.DropView(ctx, name)
}
return sql.ErrViewsNotSupported.New(pdb.db.Name())
}
// GetViewDefinition implements sql.ViewDatabase
func (pdb PrivilegedDatabase) GetViewDefinition(ctx *sql.Context, viewName string) (sql.ViewDefinition, bool, error) {
if db, ok := pdb.db.(sql.ViewDatabase); ok {
return db.GetViewDefinition(ctx, viewName)
}
return sql.ViewDefinition{}, false, sql.ErrViewsNotSupported.New(pdb.db.Name())
}
// AllViews implements sql.ViewDatabase
func (pdb PrivilegedDatabase) AllViews(ctx *sql.Context) ([]sql.ViewDefinition, error) {
if db, ok := pdb.db.(sql.ViewDatabase); ok {
return db.AllViews(ctx)
}
return nil, sql.ErrViewsNotSupported.New(pdb.db.Name())
}
// CopyTableData implements the interface sql.TableCopierDatabase.
func (pdb PrivilegedDatabase) CopyTableData(ctx *sql.Context, sourceTable string, destinationTable string) (uint64, error) {
if db, ok := pdb.db.(sql.TableCopierDatabase); ok {
// Privilege checking is handled in the analyzer
return db.CopyTableData(ctx, sourceTable, destinationTable)
}
return 0, sql.ErrTableCopyingNotSupported.New()
}
// IsReadOnly implements the interface sql.ReadOnlyDatabase.
func (pdb PrivilegedDatabase) IsReadOnly() bool {
if db, ok := pdb.db.(sql.ReadOnlyDatabase); ok {
return db.IsReadOnly()
}
return false
}
// GetAllTemporaryTables implements the interface sql.TemporaryTableDatabase.
func (pdb PrivilegedDatabase) GetAllTemporaryTables(ctx *sql.Context) ([]sql.Table, error) {
if db, ok := pdb.db.(sql.TemporaryTableDatabase); ok {
return db.GetAllTemporaryTables(ctx)
}
// All current temp table checks skip if not implemented, same is iterating over an empty slice
return nil, nil
}
// GetCollation implements the interface sql.CollatedDatabase.
func (pdb PrivilegedDatabase) GetCollation(ctx *sql.Context) sql.CollationID {
if db, ok := pdb.db.(sql.CollatedDatabase); ok {
return db.GetCollation(ctx)
}
return sql.Collation_Default
}
// SetCollation implements the interface sql.CollatedDatabase.
func (pdb PrivilegedDatabase) SetCollation(ctx *sql.Context, collation sql.CollationID) error {
if db, ok := pdb.db.(sql.CollatedDatabase); ok {
return db.SetCollation(ctx, collation)
}
return sql.ErrDatabaseCollationsNotSupported.New(pdb.db.Name())
}
// Unwrap returns the wrapped sql.Database.
func (pdb PrivilegedDatabase) Unwrap() sql.Database {
return pdb.db
}
// usernameFromCtx returns the username from the context, properly formatted for returned errors.
func (pdb PrivilegedDatabase) usernameFromCtx(ctx *sql.Context) string {
client := ctx.Session.Client()
return User{User: client.User, Host: client.Address}.UserHostToString("'")
}