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
use crate::error::ValidationErrorType;
use crate::traverser::OpenApiTraverser;
use crate::types::Operation;
use crate::validator::Validator;
use crate::SECURITY_FIELD;
use jsonschema::ValidationOptions;
use serde_json::Value;
use std::collections::HashSet;
pub(crate) struct RequestScopeValidator<'validator> {
request_instance: &'validator Vec<String>,
}
impl<'validator> RequestScopeValidator<'validator> {
pub(crate) fn new<'node>(request_instance: &'node Vec<String>) -> Self
where
'node: 'validator,
{
Self { request_instance }
}
fn validate_scopes_using_schema(
security_definitions: &Value,
request_scopes: &HashSet<&str>,
operation_id: &str,
) -> Result<(), ValidationErrorType> {
let security_defs = match OpenApiTraverser::require_array(security_definitions) {
Ok(security_defs) => security_defs,
Err(e) => {
return Err(ValidationErrorType::traversal_failed(
e,
&format!(
"Failed to parse security definitions as a vector in operation '{}'",
operation_id
),
));
}
};
if security_defs.is_empty() {
log::debug!("Definition is empty, scopes automatically pass");
return Ok(());
}
for security_definition in security_defs {
let security_def = match OpenApiTraverser::require_object(security_definition) {
Ok(security_def) => security_def,
Err(e) => {
return Err(ValidationErrorType::traversal_failed(
e,
&format!(
"Failed to parse security definition as a map in operation '{}'",
operation_id
),
));
}
};
for (schema_name, scope_list) in security_def {
let scope_list = match OpenApiTraverser::require_array(scope_list) {
Ok(scope_list) => scope_list,
Err(e) => {
return Err(ValidationErrorType::traversal_failed(
e,
&format!(
"Failed to parse scope list as a list in operation '{}'",
operation_id
),
));
}
};
let mut scopes_match_schema = true;
'scope_match: for scope in scope_list {
let scope = match OpenApiTraverser::require_str(scope) {
Ok(scope) => scope,
Err(e) => {
return Err(ValidationErrorType::traversal_failed(
e,
&format!(
"Failed to parse scope as a string in operation '{}'",
operation_id
),
));
}
};
if !request_scopes.contains(scope) {
scopes_match_schema = false;
break 'scope_match;
}
}
if scopes_match_schema {
log::debug!("Scopes match {schema_name}");
return Ok(());
}
}
}
Err(ValidationErrorType::assertion_failed(&format!(
"Request scopes {} did not match any security definition in operation '{}'",
request_scopes
.iter()
.map(|s| s.to_string())
.collect::<Vec<String>>()
.join(", "),
operation_id
)))
}
}
impl Validator for RequestScopeValidator<'_> {
fn validate(
&self,
traverser: &OpenApiTraverser,
op: &Operation,
_validation_options: &ValidationOptions,
) -> Result<(), ValidationErrorType> {
let op = &op.data;
let operation_id = OpenApiTraverser::get_as_str(&op, "operationId")
.unwrap_or_else(|_| "default_operation_id");
let scopes: HashSet<&str> = self.request_instance.iter().map(|s| s.as_str()).collect();
let security_defs = match traverser.get_optional(op, SECURITY_FIELD) {
Ok(security_defs) => security_defs,
Err(e) => {
return Err(ValidationErrorType::traversal_failed(
e,
&format!("Failed to get 'security' from operation '{}'", operation_id),
));
}
};
if let Some(security_defs) = security_defs {
return Self::validate_scopes_using_schema(
security_defs.value(),
&scopes,
&operation_id,
);
}
let global_security_defs =
match traverser.get_optional(traverser.specification(), SECURITY_FIELD) {
Ok(global_security_defs) => global_security_defs,
Err(e) => {
return Err(ValidationErrorType::traversal_failed(
e,
"Failed to get global 'security' from specification",
));
}
};
if let Some(security_definitions) = global_security_defs {
return Self::validate_scopes_using_schema(
security_definitions.value(),
&scopes,
&operation_id,
);
}
Ok(())
}
}
#[cfg(test)]
mod test {
use crate::types::json_path::JsonPath;
use crate::types::Operation;
use crate::validator::OpenApiPayloadValidator;
use serde_json::{json, Value};
fn create_operation_with_security(security_requirements: Value) -> Operation {
let mut path = JsonPath::new();
path.add("paths").add("/test").add("get");
let operation_data = json!({
"security": security_requirements
});
Operation {
data: operation_data,
path,
}
}
// Helper function to create a validator with specific security definitions
fn create_validator_with_security_definitions(definitions: Value) -> OpenApiPayloadValidator {
let spec = json!({
"openapi": "3.0.0",
"info": {
"title": "Test API",
"version": "1.0.0"
},
"paths": {
"/test": {
"get": {
"security": [
{ "oauth2": ["read", "write"] }
]
}
}
},
"components": {
"securitySchemes": definitions
}
});
OpenApiPayloadValidator::new(spec).unwrap()
}
#[test]
fn test_validate_request_scopes_success() {
let validator = create_validator_with_security_definitions(json!({
"oauth2": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "https://example.com/auth",
"scopes": {
"read": "Read access",
"write": "Write access"
}
}
}
}
}));
let operation = validator
.traverser()
.get_operation_from_path_and_method("/test", "get")
.unwrap();
let scopes = vec!["read".to_string(), "write".to_string()];
let result = validator.validate_request_scopes(&operation, &scopes);
assert!(result.is_ok());
}
#[test]
fn test_validate_request_scopes_success_with_extra_scopes() {
let validator = create_validator_with_security_definitions(json!({
"oauth2": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "https://example.com/auth",
"scopes": {
"read": "Read access",
"write": "Write access",
"admin": "Admin access"
}
}
}
}
}));
let operation = validator
.traverser()
.get_operation_from_path_and_method("/test", "get")
.unwrap();
let scopes = vec!["read".to_string(), "write".to_string(), "admin".to_string()];
let result = validator.validate_request_scopes(&operation, &scopes);
assert!(result.is_ok());
}
#[test]
fn test_validate_request_scopes_missing_required_scope() {
let validator = create_validator_with_security_definitions(json!({
"oauth2": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "https://example.com/auth",
"scopes": {
"read": "Read access",
"write": "Write access"
}
}
}
}
}));
let operation = validator
.traverser()
.get_operation_from_path_and_method("/test", "get")
.unwrap();
let scopes = vec!["read".to_string()];
let result = validator.validate_request_scopes(&operation, &scopes);
assert!(result.is_err());
}
#[test]
fn test_validate_request_scopes_empty_scopes() {
let validator = create_validator_with_security_definitions(json!({
"oauth2": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "https://example.com/auth",
"scopes": {
"read": "Read access",
"write": "Write access"
}
}
}
}
}));
let operation = validator
.traverser()
.get_operation_from_path_and_method("/test", "get")
.unwrap();
let scopes = vec![];
let result = validator.validate_request_scopes(&operation, &scopes);
assert!(result.is_err());
}
#[test]
fn test_validate_request_scopes_multiple_security_requirements_one_satisfied() {
let validator = create_validator_with_security_definitions(json!({
"oauth2": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "https://example.com/auth",
"scopes": {
"read": "Read access",
"write": "Write access"
}
}
}
},
"apiKey": {
"type": "apiKey",
"name": "api_key",
"in": "header"
}
}));
let operation = create_operation_with_security(json!([
{ "oauth2": ["read", "write"] },
{ "apiKey": [] }
]));
let scopes = vec!["read".to_string(), "write".to_string()];
let result = validator.validate_request_scopes(&operation, &scopes);
assert!(result.is_ok());
}
// #[test]
// fn test_validate_request_scopes_multiple_security_requirements_none_satisfied() {
// // Create a validator with multiple security definitions
// let validator = create_validator_with_security_definitions(json!({
// "oauth2": {
// "type": "oauth2",
// "flows": {
// "implicit": {
// "authorizationUrl": "https://example.com/auth",
// "scopes": {
// "read": "Read access",
// "write": "Write access"
// }
// }
// }
// },
// "apiKey": {
// "type": "apiKey",
// "name": "api_key",
// "in": "header"
// }
// }));
//
// // Create an operation with alternative security requirements
// let operation = create_operation_with_security(json!([
// { "oauth2": ["read", "write"] },
// { "apiKey": [] }
// ]));
//
// // Test with not satisfying any requirement
// let scopes = vec!["admin".to_string()];
// let result = validator.validate_request_scopes(&operation, &scopes);
//
// assert!(result.is_err());
// }
#[test]
fn test_validate_request_scopes_no_security_requirement() {
let validator = create_validator_with_security_definitions(json!({}));
let operation = create_operation_with_security(json!([]));
let scopes = vec!["read".to_string(), "write".to_string()];
let result = validator.validate_request_scopes(&operation, &scopes);
assert!(result.is_ok());
}
// #[test]
// fn test_validate_request_scopes_with_invalid_security_scheme() {
// // Create a validator with an invalid security scheme
// let validator = create_validator_with_security_definitions(json!({
// "nonexistent": {
// "type": "oauth2",
// "flows": {
// "implicit": {
// "authorizationUrl": "https://example.com/auth",
// "scopes": {
// "read": "Read access"
// }
// }
// }
// }
// }));
//
// // Create an operation requiring a different security scheme
// let operation = create_operation_with_security(json!([
// { "oauth2": ["read"] }
// ]));
//
// // Test with scopes for a scheme that doesn't exist in the security definitions
// let scopes = vec!["read".to_string()];
// let result = validator.validate_request_scopes(&operation, &scopes);
//
// assert!(result.is_err());
// }
#[test]
fn test_validate_request_scopes_with_malformed_security_requirement() {
let validator = create_validator_with_security_definitions(json!({
"oauth2": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "https://example.com/auth",
"scopes": {
"read": "Read access",
"write": "Write access"
}
}
}
}
}));
let operation = create_operation_with_security(json!("malformed"));
let scopes = vec!["read".to_string(), "write".to_string()];
let result = validator.validate_request_scopes(&operation, &scopes);
assert!(result.is_err());
}
#[test]
fn test_validate_request_scopes_with_security_scheme_without_scopes() {
let validator = create_validator_with_security_definitions(json!({
"apiKey": {
"type": "apiKey",
"name": "api_key",
"in": "header"
}
}));
let operation = create_operation_with_security(json!([
{ "apiKey": [] }
]));
let scopes = vec![];
let result = validator.validate_request_scopes(&operation, &scopes);
assert!(result.is_ok());
}
}