Skip to content

Commit d1c06ef

Browse files
authored
Merge pull request #7022 from mickael-docker/docs-request-field
docs/plugins/authz: recommend default deny and clarify requesturi field
2 parents 7dd053b + 1aa0416 commit d1c06ef

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

docs/extend/plugins_authorization.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,10 @@ passed to the authorization plugins. For commands that return chunked HTTP
9191
response, such as `logs` and `events`, only the HTTP request is sent to the
9292
authorization plugins.
9393

94+
The Engine's authorization middleware fails closed: when a plugin returns an error or returns `Allow: false`,
95+
the request is denied and the error is surfaced to the client. Plugins should also fail closed: if the plugin
96+
cannot confidently evaluate a request, it should return an error or `Allow: false`.
97+
9498
### Response body size and partial buffering
9599

96100
The internal buffer that holds the response body between the daemon's HTTP
@@ -239,7 +243,7 @@ Name | Type | Description
239243
User | string | The user identification
240244
Authentication method | string | The authentication method used
241245
Request method | enum | The HTTP method (GET/DELETE/POST)
242-
Request URI | string | The HTTP request URI including API version (e.g., v.1.17/containers/json)
246+
Request URI | string | The HTTP request URI including API version, as sent by the client (e.g., v.1.17/containers/json)
243247
Request headers | map[string]string | Request headers as key value pairs (without the authorization header)
244248
Request body | []byte | Raw request body
245249

@@ -262,7 +266,7 @@ Name | Type | Description
262266
User | string | The user identification
263267
Authentication method | string | The authentication method used
264268
Request method | string | The HTTP method (GET/DELETE/POST)
265-
Request URI | string | The HTTP request URI including API version (e.g., v.1.17/containers/json)
269+
Request URI | string | The HTTP request URI including API version, as sent by the client (e.g., v.1.17/containers/json)
266270
Request headers | map[string]string | Request headers as key value pairs (without the authorization header)
267271
Request body | []byte | Raw request body
268272
Response status code | int | Status code from the Docker daemon

0 commit comments

Comments
 (0)