luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Backport of Remove warning for consul 1.17 deprecation into release/1.16.x (#19904) 

backport of commit 8d43647ed95f04ed0e8a27dd45d680aa7f6e7339

Co-authored-by: Ronald Ekambi <ronekambi@gmail.com>
This commit is contained in:
hc-github-team-consul-core 2023-12-12 08:43:23 -06:00 committed by GitHub
parent 5126fe18d4
commit b83af6b165
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
agent/http.go
View File

@ -377,7 +377,7 @@ func (s *HTTPHandlers) wrap(handler endpoint, methods []string) http.HandlerFunc
logURL = strings.Replace(logURL, token, "<hidden>", -1) logURL = strings.Replace(logURL, token, "<hidden>", -1)
} }
httpLogger.Warn("This request used the token query parameter "+ httpLogger.Warn("This request used the token query parameter "+
"which is deprecated and will be removed in Consul 1.17", "which is deprecated and will be removed in a future Consul version",
"logUrl", logURL) "logUrl", logURL)
} }
logURL = aclEndpointRE.ReplaceAllString(logURL, "$1<hidden>$4") logURL = aclEndpointRE.ReplaceAllString(logURL, "$1<hidden>$4")

2
website/content/api-docs/api-structure.mdx
View File

@ -42,7 +42,7 @@ $ curl \
**Security Note:** Though you could pass the token through the `?token=` query parameter, **Security Note:** Though you could pass the token through the `?token=` query parameter,
this method is highly discouraged because the token can show up in access logs as part of the URL. this method is highly discouraged because the token can show up in access logs as part of the URL.
The `?token=` query parameter is deprecated and will be removed in Consul 1.17. The `?token=` query parameter is deprecated and will be removed in a future Consul version.
To learn more about the ACL system read the [documentation](/consul/docs/security/acl). To learn more about the ACL system read the [documentation](/consul/docs/security/acl).

4
website/content/docs/upgrading/upgrade-specific.mdx
View File

@ -75,13 +75,13 @@ The `connect.enable_serverless_plugin` configuration option was removed. Lambda
#### Deprecating authentication via token query parameter #### Deprecating authentication via token query parameter
Providing a Consul ACL token in API requests using the `token` query parameter is deprecated and will be removed in Consul 1.17. Providing a Consul ACL token in API requests using the `token` query parameter is deprecated and will be removed in a future Consul version.
Instead, you should provide the token through the `X-Consul-Token` header or with the Bearer scheme in the authorization header as described in the [API authentication documentation](/consul/api-docs/api-structure#authentication). Instead, you should provide the token through the `X-Consul-Token` header or with the Bearer scheme in the authorization header as described in the [API authentication documentation](/consul/api-docs/api-structure#authentication).
Check whether you are using a `token` query parameter by searching your Consul agent logs for the message: Check whether you are using a `token` query parameter by searching your Consul agent logs for the message:
```shell-session hideClipboard ```shell-session hideClipboard
$ This request used the token query parameter which is deprecated and will be removed in Consul 1.17 $ This request used the token query parameter which is deprecated and will be removed in a future Consul version
``` ```
Deprecated authentication using the `token` query parameter: Deprecated authentication using the `token` query parameter: