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] Add docs for verifying CA fingerprint #81279

Merged

Conversation

lockewritesdocs
Copy link
Contributor

@lockewritesdocs lockewritesdocs commented Dec 2, 2021

Adds a section in the installation docs for how clients can verify the fingerprint of the Elasticsearch security certificate.

Preview link: https://elasticsearch_81279.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/targz.html#_connect_clients_to_elasticsearch

Relates to elastic/clients-team#423

@lockewritesdocs lockewritesdocs added >docs General docs changes :Security/Client Security in clients (Transport, Rest) v8.0.0 auto-backport-and-merge Automatically create backport pull requests and merge when ready v8.1.0 labels Dec 2, 2021
@lockewritesdocs lockewritesdocs self-assigned this Dec 2, 2021
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Dec 2, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine elasticmachine added the Team:Security Meta label for security team label Dec 2, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

@mostlyjason
Copy link

@lockewritesdocs thanks for writing this up! I wonder if its common for third party clients to provide a way to validate fingerprints to treat a CA as trusted? I know for the go client code we have in Beats there is no way to do it, so we are building our own logic. Perhaps we could add a section saying that if their library doesn't support that feature, "we also store the actual CA certificate on disk in PEM format, so any client can copy this over and use it as a trust anchor as it would do today." (Quoting @jkakavas since I am not an expert at how to do this).

@lockewritesdocs
Copy link
Contributor Author

Perhaps we could add a section saying that if their library doesn't support that feature, "we also store the actual CA certificate on disk in PEM format, so any client can copy this over and use it as a trust anchor as it would do today." (Quoting @jkakavas since I am not an expert at how to do this).

@mostlyjason, I added a section describing this scenario in 7513339. Let me know if there's further clarification needed!

Copy link
Member

@jkakavas jkakavas left a comment

Choose a reason for hiding this comment

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

I would suggest that we add to subsections:

Using the CA fingerprint
Using the CA certificate

That makes it clearer in my view that these are equivalent, that the latter is not problematic in any way or a "only do this if the above failed, or if you can't make it work" but a proper way to configure the trust relationship with the elasticsearch cluster too

docs/reference/setup/install/get-fingerprint.asciidoc Outdated Show resolved Hide resolved
Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>
@lockewritesdocs
Copy link
Contributor Author

I would suggest that we add to subsections:

++ I'm going to add separate sections in my next commit 👍

@lockewritesdocs
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs skiplinkcheck

@lockewritesdocs
Copy link
Contributor Author

@elasticmachine update branch

@lockewritesdocs
Copy link
Contributor Author

@elasticmachine update branch

@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.0

lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Dec 15, 2021
* [DOCS] Add docs for verifying CA fingerprint

* Update openssl command and explanatory text

* Explain copying CA cert if fingerprint validation isn't possible

* Incorporate new section into the main security config page

* Clarify how cert is used

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>

* Split into two, separate sections

* Rename file and update text based on feedback

* Update ref to use new filename

* Remove extra word

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
elasticsearchmachine pushed a commit that referenced this pull request Dec 15, 2021
* [DOCS] Add docs for verifying CA fingerprint

* Update openssl command and explanatory text

* Explain copying CA cert if fingerprint validation isn't possible

* Incorporate new section into the main security config page

* Clarify how cert is used

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>

* Split into two, separate sections

* Rename file and update text based on feedback

* Update ref to use new filename

* Remove extra word

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport-and-merge Automatically create backport pull requests and merge when ready >docs General docs changes :Security/Client Security in clients (Transport, Rest) Team:Docs Meta label for docs team Team:Security Meta label for security team v8.0.0-rc1 v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants