File: observeSensitiveCommands.yml

package info (click to toggle)
golang-mongodb-mongo-driver 1.8.4%2Bds1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bookworm-backports
  • size: 18,520 kB
  • sloc: perl: 533; ansic: 491; python: 432; makefile: 187; sh: 72
file content (249 lines) | stat: -rw-r--r-- 8,886 bytes parent folder | download | duplicates (2)
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
description: "observeSensitiveCommands"

schemaVersion: "1.5"

runOnRequirements:
  - auth: false

createEntities:
  - client:
      id: &clientObserveSensitiveCommands client0
      observeEvents:
        - commandStartedEvent
        - commandSucceededEvent
      observeSensitiveCommands: true
  - client:
      id: &clientDoNotObserveSensitiveCommands client1
      observeEvents:
        - commandStartedEvent
        - commandSucceededEvent
      observeSensitiveCommands: false
  - client:
      id: &clientDoNotObserveSensitiveCommandsByDefault client2
      observeEvents:
        - commandStartedEvent
        - commandSucceededEvent
  - database:
      id: &databaseObserveSensitiveCommands database0
      client: *clientObserveSensitiveCommands
      databaseName: &databaseName observeSensitiveCommands
  - database:
      id: &databaseDoNotObserveSensitiveCommands database1
      client: *clientDoNotObserveSensitiveCommands
      databaseName: *databaseName
  - database:
      id: &databaseDoNotObserveSensitiveCommandsByDefault database2
      client: *clientDoNotObserveSensitiveCommandsByDefault
      databaseName: *databaseName

tests:
  - description: "getnonce is observed with observeSensitiveCommands=true"
    operations:
      - name: runCommand
        object: *databaseObserveSensitiveCommands
        arguments:
          commandName: getnonce
          command: { getnonce: 1 }
    expectEvents:
      - client: *clientObserveSensitiveCommands
        events:
          - commandStartedEvent:
              commandName: getnonce
              command: { getnonce: { $$exists: false } }
          - commandSucceededEvent:
              commandName: getnonce
              reply:
                ok: { $$exists: false }
                nonce: { $$exists: false }

  - description: "getnonce is not observed with observeSensitiveCommands=false"
    operations:
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommands
        arguments:
          commandName: getnonce
          command: { getnonce: 1 }
    expectEvents:
      - client: *clientDoNotObserveSensitiveCommands
        events: []

  - description: "getnonce is not observed by default"
    operations:
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommandsByDefault
        arguments:
          commandName: getnonce
          command: { getnonce: 1 }
    expectEvents:
      - client: *clientDoNotObserveSensitiveCommandsByDefault
        events: []

  - description: "hello with speculativeAuthenticate"
    runOnRequirements:
      - minServerVersion: "4.9"
    operations:
      - name: runCommand
        object: *databaseObserveSensitiveCommands
        arguments: &helloArgs
          commandName: hello
          command:
            hello: 1
            speculativeAuthenticate: { saslStart: 1 }
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommands
        arguments: *helloArgs
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommandsByDefault
        arguments: *helloArgs
    expectEvents:
      - client: *clientObserveSensitiveCommands
        events:
          - commandStartedEvent:
              commandName: hello
              command:
                # Assert that all fields in command are redacted
                hello: { $$exists: false }
                speculativeAuthenticate: { $$exists: false }
          - commandSucceededEvent:
              commandName: hello
              reply:
                # Assert that all fields in reply are redacted
                isWritablePrimary: { $$exists: false }
                speculativeAuthenticate: { $$exists: false }
      - client: *clientDoNotObserveSensitiveCommands
        events: []
      - client: *clientDoNotObserveSensitiveCommandsByDefault
        events: []

  - description: "hello without speculativeAuthenticate is always observed"
    runOnRequirements:
      - minServerVersion: "4.9"
    operations:
      - name: runCommand
        object: *databaseObserveSensitiveCommands
        arguments: &helloArgs
          commandName: hello
          command: { hello: 1 }
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommands
        arguments: *helloArgs
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommandsByDefault
        arguments: *helloArgs
    expectEvents:
      - client: *clientObserveSensitiveCommands
        events: &helloEvents
          - commandStartedEvent:
              commandName: hello
              command: { hello: 1 }
          - commandSucceededEvent:
              commandName: hello
              reply: { isWritablePrimary: { $$exists: true } }
      - client: *clientDoNotObserveSensitiveCommands
        events: *helloEvents
      - client: *clientDoNotObserveSensitiveCommandsByDefault
        events: *helloEvents

  - description: "legacy hello with speculativeAuthenticate"
    operations:
      - name: runCommand
        object: *databaseObserveSensitiveCommands
        arguments: &ismasterArgs
          commandName: ismaster
          command:
            ismaster: 1
            speculativeAuthenticate: { saslStart: 1 }
      - name: runCommand
        object: *databaseObserveSensitiveCommands
        arguments: &isMasterArgs
          commandName: isMaster
          command:
            isMaster: 1
            speculativeAuthenticate: { saslStart: 1 }
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommands
        arguments: *ismasterArgs
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommands
        arguments: *isMasterArgs
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommandsByDefault
        arguments: *ismasterArgs
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommandsByDefault
        arguments: *isMasterArgs
    expectEvents:
      - client: *clientObserveSensitiveCommands
        events:
          - commandStartedEvent:
              commandName: ismaster
              command:
                # Assert that all fields in command are redacted
                ismaster: { $$exists: false }
                speculativeAuthenticate: { $$exists: false }
          - commandSucceededEvent:
              commandName: ismaster
              reply:
                # Assert that all fields in reply are redacted
                ismaster: { $$exists: false }
                speculativeAuthenticate: { $$exists: false }
          - commandStartedEvent:
              commandName: isMaster
              command:
                # Assert that all fields in command are redacted
                isMaster: { $$exists: false }
                speculativeAuthenticate: { $$exists: false }
          - commandSucceededEvent:
              commandName: isMaster
              reply:
                # Assert that all fields in reply are redacted
                ismaster: { $$exists: false }
                speculativeAuthenticate: { $$exists: false }
      - client: *clientDoNotObserveSensitiveCommands
        events: []
      - client: *clientDoNotObserveSensitiveCommandsByDefault
        events: []

  - description: "legacy hello without speculativeAuthenticate is always observed"
    operations:
      - name: runCommand
        object: *databaseObserveSensitiveCommands
        arguments: &ismasterArgs
          commandName: ismaster
          command: { ismaster: 1 }
      - name: runCommand
        object: *databaseObserveSensitiveCommands
        arguments: &isMasterArgs
          commandName: isMaster
          command: { isMaster: 1 }
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommands
        arguments: *ismasterArgs
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommands
        arguments: *isMasterArgs
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommandsByDefault
        arguments: *ismasterArgs
      - name: runCommand
        object: *databaseDoNotObserveSensitiveCommandsByDefault
        arguments: *isMasterArgs
    expectEvents:
      - client: *clientObserveSensitiveCommands
        events: &ismasterAndisMasterEvents
          - commandStartedEvent:
              commandName: ismaster
              command: { ismaster: 1 }
          - commandSucceededEvent:
              commandName: ismaster
              reply: { ismaster: { $$exists: true } }
          - commandStartedEvent:
              commandName: isMaster
              command: { isMaster: 1 }
          - commandSucceededEvent:
              commandName: isMaster
              reply: { ismaster: { $$exists: true } }
      - client: *clientDoNotObserveSensitiveCommands
        events: *ismasterAndisMasterEvents
      - client: *clientDoNotObserveSensitiveCommandsByDefault
        events: *ismasterAndisMasterEvents