Skip to content

docs: drop verify: false from CA fingerprint example - #3079

Draft
JoshMock wants to merge 1 commit into
mainfrom
docs-ca-fingerprint-verification
Draft

JoshMock wants to merge 1 commit into
mainfrom
docs-ca-fingerprint-verification

Conversation

@JoshMock

@JoshMock JoshMock commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

Summary

Removes transport_options: { ssl: { verify: false } } from the CA fingerprint example in the connecting guide. It also documents what ca_fingerprint actually verifies: the matching certificate is the only trusted certificate, chain, expiry and host name are still validated, and this applies to every connection. If the host name doesn't match the certificate, users must either fix the host name or explicitly opt out with ssl: { verify: false }. This follows the JS client precedent.

Intention

The current example tells users to turn off TLS verification whenever they use a fingerprint, which drops hostname, expiry and chain checks. Pinning should add to TLS verification, not replace it.

Related

Notes

Important

Merge after the elastic-transport-ruby change is released. With the current transport, the updated example would fail verification against self-signed certificates.


authored by Pi Coding Agent (claude-opus-5-5)

ca_fingerprint now pins the matching certificate as the only trust
anchor and still validates chain, expiry and host name, so disabling
verification is no longer needed. Document the pinning behavior and
the explicit opt-out.

Refs elastic/security#6842

Assisted-by: Pi Coding Agent (claude-opus-5-5)
@github-actions

github-actions Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

🔍 Preview links for changed docs

@github-actions

Copy link
Copy Markdown

Elastic Docs Style Checker (Vale)

Summary: 1 suggestion found

💡 Suggestions (1): Optional style improvements. Apply when helpful.
File Line Rule Message
docs/reference/connecting.md 129 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

This branch was successfully deployed

1 active deployment
docs-preview — 3296ee0b Deployed Oct 30, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant