You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This allows Security Requirement Objects to reference Security Scheme Objects by URI instead of implicit component name. Without this ability, it is difficult to share Security Schemes in a way that is consistent with re-usable component documents.
This approach provides parity with how the Discriminator Object's mapping field works.
Also add a note about the complexity of these rules to the Security Considerations section.
Copy file name to clipboardExpand all lines: src/oas.md
+18-4
Original file line number
Diff line number
Diff line change
@@ -4069,7 +4069,12 @@ flows:
4069
4069
#### Security Requirement Object
4070
4070
4071
4071
Lists the required security schemes to execute this operation.
4072
-
The name used for each property MUST correspond to a security scheme declared in the [Security Schemes](#security-scheme-object) under the [Components Object](#components-object).
4072
+
4073
+
The name used for each property MUST either correspond to a security scheme declared in the [Security Schemes](#security-scheme-object) under the [Components Object](#components-object), or be the URI of a Security Scheme Object.
4074
+
Property names that match the syntax of a component name under the Components Object MUST be treated as a component name.
4075
+
To reference a Security Scheme with a single-segment relative URI reference (e.g. `foo`) that collides with a component name (e.g. `#/components/securitySchemes/foo`), use the `.` path segment (e.g. `./foo`).
4076
+
4077
+
Using a Security Scheme component name that appears to be a URI is NOT RECOMMENDED, as the precedence of component-name-matching over URI resolution, which is necessary to maintain compatibility with prior OAS versions, is counter-intuitive. See also [Security Considerations](#security-considerations).
4073
4078
4074
4079
A Security Requirement Object MAY refer to multiple security schemes in which case all schemes MUST be satisfied for a request to be authorized.
4075
4080
This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.
@@ -4082,8 +4087,8 @@ An empty Security Requirement Object (`{}`) indicates anonymous access is suppor
4082
4087
##### Patterned Fields
4083
4088
4084
4089
| Field Pattern | Type | Description |
4085
-
| ---- | :----: | ---- |
4086
-
| <a name="security-requirements-name"></a>{name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#security-scheme-object) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. |
4090
+
| --- | :---: | --- |
4091
+
| <a name="securityRequirementsName"></a>{name} | [`string`] | Each name or URI MUST correspond to a security scheme as described above. If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. |
4087
4092
4088
4093
##### Security Requirement Object Examples
4089
4094
@@ -4103,6 +4108,8 @@ api_key: []
4103
4108
4104
4109
###### OAuth2 Security Requirement
4105
4110
4111
+
This example uses a component name for the Security Scheme.
4112
+
4106
4113
```json
4107
4114
{
4108
4115
"petstore_auth": ["write:pets", "read:pets"]
@@ -4117,14 +4124,16 @@ petstore_auth:
4117
4124
4118
4125
###### Optional OAuth2 Security
4119
4126
4127
+
This example uses a relative URI reference for the Security Scheme.
4128
+
4120
4129
Optional OAuth2 security as would be defined in an <a href="#openapi-object">OpenAPI Object</a> or an <a href="#operation-object">Operation Object</a>:
@@ -4186,6 +4195,11 @@ In addition, OpenAPI Descriptions are processed by a wide variety of tooling for
4186
4195
4187
4196
An OpenAPI Description describes the security schemes used to protect the resources it defines. The security schemes available offer varying degrees of protection. Factors such as the sensitivity of the data and the potential impact of a security breach should guide the selection of security schemes for the API resources. Some security schemes, such as basic auth and OAuth Implicit flow, are supported for compatibility with existing APIs. However, their inclusion in OpenAPI does not constitute an endorsement of their use, particularly for highly sensitive data or operations.
4188
4197
4198
+
The rules for connecting a [Security Requirement Object](#security-requirement-object) to a [Security Scheme Object](#security-scheme-object) under a [Components Object](#components-object) are ambiguous in a way that could be exploited. Specifically:
4199
+
4200
+
* It is implementation-defined whether a component name used by a Security Requirement Object in a referenced document is resolved from the entry document (RECOMMENDED) or the referenced document.
4201
+
* A Security Requirement Object that uses a URI to identify a Security Scheme Object can have the URI resolution hijacked by providing a Security Scheme component name identical to the URI, as the name lookup behavior takes precedence over URI resolution for compatibility with previous versions of the OAS.
4202
+
4189
4203
### Handling External Resources
4190
4204
4191
4205
OpenAPI Descriptions may contain references to external resources that may be dereferenced automatically by consuming tools. External resources may be hosted on different domains that may be untrusted.
0 commit comments