Fixes CORS headers needed by Elastic clients #85791
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates the default value for the `http.cors.allow-headers` setting to include headers used by Elastic client libraries. Also adds the `access-control-expose-headers` header to responses to CORS requests so that clients can successfully perform their product check.
swallez
added
>bug
:Core/Infra/REST API
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
elasticsearchmachine
added
v8.3.0
external-contributor
|
Hi @swallez, I've created a changelog YAML for you. |
tvernum
reviewed
Jun 20, 2022
| @@ -110,9 +110,16 @@ Which methods to allow. Defaults to `OPTIONS, HEAD, GET, POST, PUT, DELETE`. | |||
| // tag::http-cors-allow-headers-tag[] | |||
| `http.cors.allow-headers` {ess-icon}:: | |||
| (<<static-cluster-setting,Static>>) | |||
| Which headers to allow. Defaults to `X-Requested-With, Content-Type, Content-Length`. | |||
| Which headers to allow. Defaults to `X-Requested-With, Content-Type, Content-Length, Authorization, Accept, User-Agent, X-Elastic-Client-Meta`. | |||
There was a problem hiding this comment.
I find it strange that we default access-control-allow-headers to include Authorization but access-control-allow-credentials to false?
Is that intentional?
There was a problem hiding this comment.
Yes, it is intentional:
access-control-allow-headers, in a response to a preflight request, defines what headers (outside of the safelist) are allowed in CORS requests. Since clients set theAuthorizationheader in their requests, it has to be allowed by the server in preflight responses.- Defaulting
access-control-allow-credentialstofalseforbids the use of browser-level credentials by clients, and thus requires clients to be provided with credential information that is then set in theAuthorizationheader.
CORS is sometimes confusing 😅
|
@tvernum I'm reviving this old PR. Can you please have look at my reply to your comments? |
|
I don't have any thoughts here. |
💔 Backport failed
You can use sqren/backport to manually backport by running |
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
swallez
added a commit
to swallez/elasticsearch
that referenced
this pull request
Feb 9, 2023
* Fixes CORS headers needed by Elastic clients Updates the default value for the `http.cors.allow-headers` setting to include headers used by Elastic client libraries. Also adds the `access-control-expose-headers` header to responses to CORS requests so that clients can successfully perform their product check. (cherry picked from commit 484d3f4)
swallez
added a commit
that referenced
this pull request
Feb 9, 2023
* Fixes CORS headers needed by Elastic clients Updates the default value for the `http.cors.allow-headers` setting to include headers used by Elastic client libraries. Also adds the `access-control-expose-headers` header to responses to CORS requests so that clients can successfully perform their product check. (cherry picked from commit 484d3f4)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the default values for CORS headers so that Elasticsearch client libraries that can run in a web browser (e.g. JavaScript client, Go & Rust clients compiled to WebAssembly) work out of the box by just enabling
http.cors.enabled: trueand settinghttp.cors.allow-origin.It adds the following headers to
http.cors.allow-headers's default value:Authorizationfor webapp-level authentication,Accept, andUser-AgentandX-Elastic-Client-Metathat are useful for telemetry.Additionally, a new
http.cors.expose-headerssetting allows configuring headers that are exposed to the code in the browser, defaulting toX-elastic-productwhich allows clients to successfully run product checks.See also elastic/elasticsearch-rs#200