Skip to content

Default behavior for additionalProperties has changed in OAS3.1 #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Default behavior for additionalProperties has changed in OAS3.1 #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e363c0
what to do about additionalProperties
philsturgeon Dec 31, 2022
f8c5e7b
how about this, additionalProperties must be defined, either false or…
philsturgeon Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions src/ruleset.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,16 +677,16 @@ export default {
*/
"owasp:api6:2019-no-additionalProperties": {
message:
"If the additionalProperties keyword is used it must be set to false.",
"additionalProperties is enabled by default in OAS3.0, and should be disabled.",
description:
"By default JSON Schema allows additional properties, which can potentially lead to mass assignment issues, where unspecified fields are passed to the API without validation. Disable them with `additionalProperties: false` or add `maxProperties`.",
"Additional properties are enabled by default in modern OpenAPI and JSON Schema as it helps keep your API forwards compatible, but it can potentially lead to mass assignment issues, where unspecified fields are passed to the API without validation. Disable additional properties explicitly with `additionalProperties: false`.",
severity: DiagnosticSeverity.Warning,
formats: [oas3],
given: '$..[?(@ && @.type=="object" && @.additionalProperties)]',
given: '$..[?(@ && @.type=="object")]',
then: [
{
field: "additionalProperties",
function: falsy,
function: defined,
},
],
},
Expand All @@ -698,15 +698,29 @@ export default {
"owasp:api6:2019-constrained-additionalProperties": {
message: "Objects should not allow unconstrained additionalProperties.",
description:
"By default JSON Schema allows additional properties, which can potentially lead to mass assignment issues, where unspecified fields are passed to the API without validation. Disable them with `additionalProperties: false` or add `maxProperties`",
"Additional properties are enabled by default in modern OpenAPI and JSON Schema as it helps keep your API forwards compatible, but it can potentially lead to mass assignment issues, where unspecified fields are passed to the API without validation. Disable additional properties explicitly with `additionalProperties: false`, or constrain the additional properties by providing a schema for their validation: `additionalProperties: { type: ... } }`.",
Copy link
Contributor

@DavidBiesack DavidBiesack Jan 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or additionalProperties: { '$ref: .... }

Copy link
Contributor

@DavidBiesack DavidBiesack Jan 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

double } } should be just } at the end of the sentence

severity: DiagnosticSeverity.Warning,
formats: [oas3],
given:
'$..[?(@ && @.type=="object" && @.additionalProperties && @.additionalProperties!=true && @.additionalProperties!=false )]',
given: '$..[?(@ && @.type=="object" && @.additionalProperties )]',
then: [
{
field: "maxProperties",
function: defined,
function: schema,
schema: {
oneOf: [
// either additionalProperties is disabled
{
additionalProperties: {
const: false,
},
},
// or it is constrained with a sub-schema
{
additionalProperties: {
type: "object",
},
},
],
},
},
],
},
Expand Down