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
|
# Copyright (C) 2021-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#
# List describing the ActionTypes that should be created.
# Please note that the order of the elements is not guaranteed to be the same across versions.
# This means that the integer value assigned to each ActionType and used internally in ActionSet
# also may change between versions.
#
# Actions marked "ID only" are not used for permission checks, but to identify events in logs.
global:
cpp_namespace: "mongo"
imports:
- "mongo/db/basic_types.idl"
enums:
ActionType:
description: "test"
type: string
values:
addShard : "addShard"
advanceClusterTime : "advanceClusterTime"
allCollectionStats: "allCollectionStats"
analyze : "analyze"
analyzeShardKey : "analyzeShardKey"
anyAction : "anyAction" # Special ActionType that represents *all* actions
appendOplogNote : "appendOplogNote"
applicationMessage : "applicationMessage"
auditConfigure : "auditConfigure"
auditLogRotate : "auditLogRotate" # ID only
authCheck : "authCheck" # ID only
authenticate : "authenticate" # ID only
authSchemaUpgrade : "authSchemaUpgrade"
bypassDocumentValidation : "bypassDocumentValidation"
bypassWriteBlockingMode : "bypassWriteBlockingMode"
changeCustomData : "changeCustomData"
changePassword : "changePassword"
changeOwnPassword : "changeOwnPassword"
changeOwnCustomData : "changeOwnCustomData"
changeStream : "changeStream"
checkFreeMonitoringStatus : "checkFreeMonitoringStatus"
checkMetadataConsistency : "checkMetadataConsistency"
cleanupOrphaned : "cleanupOrphaned"
clearJumboFlag : "clearJumboFlag"
cleanupStructuredEncryptionData: "cleanupStructuredEncryptionData"
closeAllDatabases : "closeAllDatabases" # Deprecated (backwards compatibility)
collMod : "collMod"
collStats : "collStats"
compact : "compact"
compactStructuredEncryptionData: "compactStructuredEncryptionData"
configureQueryAnalyzer : "configureQueryAnalyzer"
connPoolStats : "connPoolStats"
connPoolSync : "connPoolSync"
convertToCapped : "convertToCapped"
cpuProfiler : "cpuProfiler"
createCollection : "createCollection"
createDatabase : "createDatabase" # ID only
createIndex : "createIndex" # ID only
createRole : "createRole"
createSearchIndexes : "createSearchIndexes"
createUser : "createUser"
dbCheck : "dbCheck"
dbHash : "dbHash"
dbStats : "dbStats"
dropAllRolesFromDatabase : "dropAllRolesFromDatabase" # ID only
dropAllUsersFromDatabase : "dropAllUsersFromDatabase" # ID only
dropCollection : "dropCollection"
dropConnections : "dropConnections"
dropDatabase : "dropDatabase"
dropIndex : "dropIndex"
dropRole : "dropRole"
dropSearchIndex : "dropSearchIndex"
dropUser : "dropUser"
emptycapped : "emptycapped"
enableProfiler : "enableProfiler"
enableSharding : "enableSharding"
exportCollection : "exportCollection"
find : "find"
flushRouterConfig : "flushRouterConfig"
forceUUID : "forceUUID"
fsync : "fsync"
getClusterParameter: "getClusterParameter"
getDatabaseVersion : "getDatabaseVersion"
getDefaultRWConcern : "getDefaultRWConcern"
getCmdLineOpts : "getCmdLineOpts"
getLog : "getLog"
getParameter : "getParameter"
getShardMap : "getShardMap"
getShardVersion : "getShardVersion"
grantRole : "grantRole"
grantPrivilegesToRole : "grantPrivilegesToRole" # ID only
grantRolesToRole : "grantRolesToRole" # ID only
grantRolesToUser : "grantRolesToUser" # ID only
hostInfo : "hostInfo"
impersonate : "impersonate"
importCollection : "importCollection"
indexStats : "indexStats"
inprog : "inprog"
insert : "insert"
internal : "internal" # Special action type that represents internal actions
invalidateUserCache : "invalidateUserCache"
issueDirectShardOperations: "issueDirectShardOperations"
killAnyCursor : "killAnyCursor"
killAnySession : "killAnySession"
killCursors : "killCursors" # Deprecated in favor of killAnyCursor
killop : "killop"
listCachedAndActiveUsers : "listCachedAndActiveUsers"
listCollections : "listCollections"
listCursors : "listCursors"
listDatabases : "listDatabases"
listIndexes : "listIndexes"
listSampledQueries : "listSampledQueries"
listSearchIndexes : "listSearchIndexes"
listSessions : "listSessions"
listShards : "listShards"
logRotate : "logRotate"
updateSearchIndex : "updateSearchIndex"
moveChunk : "moveChunk"
netstat : "netstat"
oidcListKeys : "oidcListKeys"
oidcRefreshKeys : "oidcRefreshKeys"
oidReset : "oidReset" # machine ID reset via the features command
operationMetrics : "operationMetrics"
planCacheIndexFilter : "planCacheIndexFilter" # view/update index filters
planCacheRead : "planCacheRead" # view contents of plan cache
planCacheWrite : "planCacheWrite" # clear cache, drop cache entry, pin/unpin/shun plans
queryStatsRead: "queryStatsRead" # view contents of queryStats store
refineCollectionShardKey : "refineCollectionShardKey"
reIndex : "reIndex"
remove : "remove"
removeShard : "removeShard"
renameCollection : "renameCollection" # ID only
renameCollectionSameDB : "renameCollectionSameDB"
repairDatabase : "repairDatabase" # Deprecated (backwards compatibility)
replSetConfigure : "replSetConfigure"
replSetGetConfig : "replSetGetConfig"
replSetGetStatus : "replSetGetStatus"
replSetHeartbeat : "replSetHeartbeat"
replSetReconfig : "replSetReconfig" # ID only
replSetResizeOplog : "replSetResizeOplog"
replSetStateChange : "replSetStateChange"
reshardCollection : "reshardCollection"
resync : "resync"
revokeRole : "revokeRole"
revokePrivilegesFromRole : "revokePrivilegesFromRole" # ID only
revokeRolesFromRole : "revokeRolesFromRole" # ID only
revokeRolesFromUser : "revokeRolesFromUser" # ID only
rotateCertificates : "rotateCertificates"
runAsLessPrivilegedUser : "runAsLessPrivilegedUser"
runTenantMigration : "runTenantMigration"
serverStatus : "serverStatus"
setAuthenticationRestriction : "setAuthenticationRestriction"
setClusterParameter: "setClusterParameter"
setDefaultRWConcern : "setDefaultRWConcern"
setFeatureCompatibilityVersion : "setFeatureCompatibilityVersion"
setFreeMonitoring : "setFreeMonitoring"
setParameter : "setParameter"
setUserWriteBlockMode: "setUserWriteBlockMode"
shardCollection : "shardCollection" # ID only
shardedDataDistribution : "shardedDataDistribution"
shardingState : "shardingState"
shutdown : "shutdown"
splitChunk : "splitChunk"
splitVector : "splitVector"
storageDetails : "storageDetails"
top : "top"
touch : "touch"
trafficRecord : "trafficRecord"
transitionFromDedicatedConfigServer : "transitionFromDedicatedConfigServer"
transitionToDedicatedConfigServer : "transitionToDedicatedConfigServer"
unlock : "unlock"
useTenant : "useTenant"
useUUID : "useUUID"
update : "update"
updateRole : "updateRole" # ID only
updateUser : "updateUser" # ID only
validate : "validate"
viewRole : "viewRole"
viewUser : "viewUser"
applyOps : "applyOps"
setChangeStreamState: "setChangeStreamState"
getChangeStreamState: "getChangeStreamState"
# In 'MatchType' the extra_data field "serverlessActionTypes" is used
# by the AuthorizationSession while in multitenancy mode to determine
# whether or not an action is reasonable to be performed by a user
# who has been authorized via security token.
# See:
MatchType:
description: Resource Match Types used in describing privilege grants.
type: string
values:
kMatchNever:
description: Bottom type for resource matches, matches nothing.
value: "never"
extra_data:
serverlessActionTypes: [] # Explicitly listing no action types valid.
# resource: { cluster: true }
kMatchClusterResource:
description: Matches if the resource is the cluster resource.
value: "cluster"
extra_data:
serverlessActionTypes:
- applyOps
- killAnyCursor
- killAnySession
- killCursors
- killop
- listDatabases
# resource: { db: '', collection: 'exact' }
kMatchCollectionName:
description: Matches if the resource's collection is a particular name.
value: "collection"
extra_data:
serverlessActionTypes: &actionsValidOnCollection
- analyze
- bypassDocumentValidation
- changeStream
- cleanupStructuredEncryptionData
- collMod
- collStats
- compact
- compactStructuredEncryptionData
- convertToCapped
- createCollection
- createIndex
- createSearchIndexes
- dbCheck
- dbHash
- dbStats
- dropCollection
- dropIndex
- dropSearchIndex
- enableProfiler
- exportCollection
- find
- importCollection
- insert
- killAnyCursor
- killCursors
- listCollections
- listIndexes
- listSearchIndexes
- updateSearchIndex
- planCacheIndexFilter
- planCacheRead
- planCacheWrite
- reIndex
- remove
- renameCollection
- renameCollectionSameDB
- storageDetails
- update
- validate
# resource: { db: 'exact', collection: '' }
kMatchDatabaseName:
description: Matches if the resource's database is a particular name.
value: "database"
extra_data:
serverlessActionTypes: &actionsValidOnDatabase
# Actions common to collection patterns.
# YAML doesn't support extending list aliases.
# Make changes above, then copy here.
- analyze
- bypassDocumentValidation
- changeStream
- cleanupStructuredEncryptionData
- collMod
- collStats
- compact
- compactStructuredEncryptionData
- configureQueryAnalyzer # TODO (SERVER-75656): remove from serverlessActionTypes.
- convertToCapped
- createCollection
- createIndex
- createSearchIndexes
- dbCheck
- dbHash
- dbStats
- dropCollection
- dropIndex
- dropSearchIndex
- enableProfiler
- exportCollection
- find
- importCollection
- insert
- killAnyCursor
- killCursors
- listCollections
- listIndexes
- listSearchIndexes
- updateSearchIndex
- planCacheIndexFilter
- planCacheRead
- planCacheWrite
- reIndex
- remove
- renameCollection
- renameCollectionSameDB
- storageDetails
- update
- validate
# Actions specific to the database match types.
- applicationMessage
- dropDatabase
- viewRole
- viewUser
# resource: { db: 'exact', collection: 'exact' }
kMatchExactNamespace:
description: Matches if the resource is an exact namespace.
value: "exact_namespace"
extra_data:
serverlessActionTypes: *actionsValidOnCollection
# resource: { db: '', collection: '' }
kMatchAnyNormalResource:
description: Matches all databases and non-system collections.
value: "any_normal"
extra_data:
serverlessActionTypes: *actionsValidOnDatabase
# resource: { anyResource: true }
kMatchAnyResource:
description: Matches absolutely anything.
value: "any"
extra_data:
serverlessActionTypes: *actionsValidOnDatabase
# resource: { db: 'exact', system_buckets: 'exact' }
kMatchExactSystemBucketResource:
description: Matches a collection named "<db>.system.buckets.<collection>"
value: "system_buckets"
extra_data:
serverlessActionTypes: &actionsValidOnSystemBuckets
- analyze
- bypassDocumentValidation
- changeStream
- cleanupStructuredEncryptionData
- collMod
- collStats
- compact
- compactStructuredEncryptionData
- configureQueryAnalyzer # TODO (SERVER-75656): remove from serverlessActionTypes.
- convertToCapped
- createCollection
- createIndex
- createSearchIndexes
- dbCheck
- dbHash
- dbStats
- dropCollection
- dropDatabase
- dropIndex
- dropSearchIndex
- enableProfiler
- exportCollection
- find
- importCollection
- insert
- killAnyCursor
- killCursors
- listCollections
- listIndexes
- listSearchIndexes
- updateSearchIndex
- planCacheIndexFilter
- planCacheRead
- planCacheWrite
- reIndex
- remove
- renameCollection
- renameCollectionSameDB
- storageDetails
- update
- validate
# resource: { db: '', system_buckets: 'exact' }
kMatchSystemBucketInAnyDBResource:
description: Matches a collection named "system.buckets.<collection>" in any db
value: "system_buckets_in_any_db"
extra_data:
serverlessActionTypes: *actionsValidOnSystemBuckets
# resource: { db: 'exact', system_buckets: '' }
kMatchAnySystemBucketInDBResource:
description: Matches any collection with a prefix of "system.buckets." in a specific db
value: "any_system_buckets_in_db"
extra_data:
serverlessActionTypes: *actionsValidOnSystemBuckets
# resource: { db: '', system_buckets: '' }
kMatchAnySystemBucketResource:
description: Matches any collection with a prefix of "system.buckets." in any db
value: "any_system_buckets"
extra_data:
serverlessActionTypes: *actionsValidOnSystemBuckets
structs:
MatchTypeExtraData:
description: Extra data defined in the MatchType enum
fields:
serverlessActionTypes:
description: Permitted action types for the match type when in serverless mode
type: array<string>
|
