Skip to content

Modernize the SSL documentation for creating certificates#473

Merged
esabol merged 1 commit into
gearman:masterfrom
esabol:update-ssl-docs
Jul 18, 2026
Merged

Modernize the SSL documentation for creating certificates#473
esabol merged 1 commit into
gearman:masterfrom
esabol:update-ssl-docs

Conversation

@esabol

@esabol esabol commented Jul 15, 2026

Copy link
Copy Markdown
Member

This PR updates the SSL documentation for creating CA, server, and client/worker certificates to modern usage with support for Subject Alternative Names (SAN).

@p-alik p-alik left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Docs-only change, low risk, technically sound. The switch to genpkey, -CAcreateserial, and especially the SAN extension block for the server cert are solid improvements — SAN support is genuinely needed since modern TLS clients reject CN-only hostname verification.

A few optional polish items for a follow-up, none blocking:

  • The -nodes flag on the CA req -x509 -new -nodes -key gearmand-ca.key ... command is a no-op since -key supplies an already-unencrypted existing key (-nodes only matters when req generates a new key itself).
  • Could mention that -CAcreateserial will auto-create gearmand-ca.srl on first use, since the doc no longer explains where the serial file comes from.
  • Client/worker cert intentionally skips the SAN/extfile step (reasonable, since clients aren't hostname-verified) — a short clause noting why would avoid confusion given the doc otherwise stresses SAN as required.

Approving as-is.

@esabol
esabol force-pushed the update-ssl-docs branch from bf07fca to 9e61bbd Compare July 18, 2026 05:27
@esabol

esabol commented Jul 18, 2026

Copy link
Copy Markdown
Member Author

Good feedback. I'm glad I waited to merge. I've removed -nodes and added notes regarding -CAcreateserial and SAN not being needed for clients/workers.

@esabol
esabol merged commit 59b0922 into gearman:master Jul 18, 2026
19 checks passed
@esabol
esabol deleted the update-ssl-docs branch July 18, 2026 05:41
@esabol

esabol commented Jul 18, 2026

Copy link
Copy Markdown
Member Author

Merged. The new documentation is visible at https://gearman.org/gearmand/gearmand/ssl/.

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.

2 participants