Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Fix default for http.compression setting #56899

Merged
merged 2 commits into from
May 20, 2020
Merged

Conversation

Leaf-Lin
Copy link
Contributor

Elasticsearch enables HTTP compression by default now. However, to mitigate potential security risks like the BREACH attack, X-Pack security disables compression if HTTPS is enabled. <-- This is not clear from the doc, hence adding some more details here.
See https://github.com/elastic/elasticsearch/blob/master/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/transport/SecurityHttpSettings.java#L19 and https://www.elastic.co/guide/en/x-pack/5.4/xpack-change-list.html#breaking-5.0.0 for more details.

Elasticsearch enables HTTP compression by default now. However, to mitigate potential security risks like the BREACH attack, X-Pack security disables compression if HTTPS is enabled. <-- This is not clear from the doc, hence adding some more details here.
See https://github.com/elastic/elasticsearch/blob/master/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/transport/SecurityHttpSettings.java#L19 and https://www.elastic.co/guide/en/x-pack/5.4/xpack-change-list.html#breaking-5.0.0 for more details.
Leaf-Lin added a commit to Leaf-Lin/logstash-output-elasticsearch that referenced this pull request May 18, 2020
See elastic/elasticsearch#56899, Elasticsearch disables compression if HTTPS is enabled.
@matriv matriv added the >docs General docs changes label May 19, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label May 19, 2020
Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Made some adjustments to reword and wrap the text.

docs/reference/modules/http.asciidoc Outdated Show resolved Hide resolved
@jrodewig jrodewig added :Distributed Coordination/Network Http and internode communication implementations v7.7.1 v7.8.1 v7.9.0 v8.0.0 labels May 20, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (:Distributed/Network)

@elasticmachine elasticmachine added the Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. label May 20, 2020
@jrodewig jrodewig requested a review from Tim-Brooks May 20, 2020 13:25
@jrodewig
Copy link
Contributor

@tbrooks8 Do you mind taking a look at this when convenient?

The logic in https://github.com/elastic/elasticsearch/blob/master/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/transport/SecurityHttpSettings.java#L19 seems clear to me, but it never hurts to double check.

I can merge and backport if you approve.

Copy link
Contributor

@Tim-Brooks Tim-Brooks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jrodewig jrodewig changed the title Update http.compression [DOCS] Fix default for http.compression setting May 20, 2020
@jrodewig jrodewig merged commit 7d15755 into 7.7 May 20, 2020
@jrodewig jrodewig deleted the Leaf-Lin-patch-2 branch May 20, 2020 15:53
jrodewig added a commit that referenced this pull request May 20, 2020
Elasticsearch enables HTTP compression by default. However, to mitigate
potential security risks like the BREACH attack, compression is disabled by
default if HTTPS is enabled.

This updates the `http.compression` setting definition accordingly and adds
additional context.

Co-authored-by: Leaf-Lin <[email protected]>
jrodewig added a commit that referenced this pull request May 20, 2020
Elasticsearch enables HTTP compression by default. However, to mitigate
potential security risks like the BREACH attack, compression is disabled by
default if HTTPS is enabled.

This updates the `http.compression` setting definition accordingly and adds
additional context.

Co-authored-by: Leaf-Lin <[email protected]>
jrodewig added a commit that referenced this pull request May 20, 2020
Elasticsearch enables HTTP compression by default. However, to mitigate
potential security risks like the BREACH attack, compression is disabled by
default if HTTPS is enabled.

This updates the `http.compression` setting definition accordingly and adds
additional context.

Co-authored-by: Leaf-Lin <[email protected]>
@jrodewig
Copy link
Contributor

Backport commits

master 1bfd7ef
7.x b7c6f0d
7.8 26f8115
7.7 7d15755

karenzone pushed a commit to logstash-plugins/logstash-output-elasticsearch that referenced this pull request Jul 30, 2020
See elastic/elasticsearch#56899, Elasticsearch disables compression if HTTPS is enabled.
@jakelandis jakelandis removed the v8.0.0 label Jul 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Network Http and internode communication implementations >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v7.7.1 v7.8.1 v7.9.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants