Skip to content

Commit

Permalink
Backport of Remove warning for consul 1.17 deprecation into release/1…
Browse files Browse the repository at this point in the history
….15.x (#19903)

backport of commit 8d43647

Co-authored-by: Ronald Ekambi <ronekambi@gmail.com>
  • Loading branch information
1 parent ff25f83 commit 2c6d620
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion agent/http.go
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ func (s *HTTPHandlers) wrap(handler endpoint, methods []string) http.HandlerFunc
logURL = strings.Replace(logURL, token, "<hidden>", -1)
}
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 = aclEndpointRE.ReplaceAllString(logURL, "$1<hidden>$4")
Expand Down
2 changes: 1 addition & 1 deletion website/content/api-docs/api-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ $ curl \

**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.
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).

Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/upgrading/upgrade-specific.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ The `connect.enable_serverless_plugin` configuration option was removed. Lambda

#### 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).

Check whether you are using a `token` query parameter by searching your Consul agent logs for the message:

```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:
Expand Down

0 comments on commit 2c6d620

Please sign in to comment.