[CALCITE-5896] Document TLS client certificate JDBC URL options - #324
Open
akashchamp wants to merge 1 commit into
Open
akashchamp wants to merge 1 commit into
akashchamp wants to merge 1 commit into
Conversation
Member
|
@akashchamp can you please request an account at https://issues.apache.org/ , so we can assign CALCITE-5896 to you? |
The client reference page documents truststore, truststore_password, and keystore_type, which cover server-certificate verification, but omits the keystore, keystore_password, and key_password JDBC URL properties. CommonsHttpClientPoolCache uses these three to load the client's own key material (loadKeyMaterial) for mutual TLS (mTLS) client certificate authentication, and BuiltInConnectionProperty has declared them since CALCITE-2285. Add entries for keystore, keystore_password, and key_password, mirroring the format of the existing truststore/keystore_type entries.
akashchamp
force-pushed
the
CALCITE-5896
branch
from
September 25, 2026 18:18
07d6c48 to
a72be77
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What
Documents the
keystore,keystore_password, andkey_passwordJDBC URLproperties on the client reference page.
Why
CALCITE-5896: the
client reference documents
truststore,truststore_password, andkeystore_type(used to verify the server's certificate), but neverdocumented
keystore,keystore_password, orkey_password(used tosupply the client's own certificate/private key for mutual TLS). These
three properties have existed in
BuiltInConnectionPropertysinceCALCITE-2285 and are consumed by
CommonsHttpClientPoolCache#loadKeyStoreviaSSLContextBuilder#loadKeyMaterial, but a user reading the reference pagehas no way to discover them.
Change
Adds three definition-list entries to
site/_docs/client_reference.md,placed right after the existing
keystore_typeentry (matching thedeclaration order in
BuiltInConnectionProperty) and mirroring thewording/format of the adjacent
truststore/truststore_passwordentries:
keystorekeystore_passwordkey_passwordNo code changes; this is a pure documentation addition (1 file changed,
31 insertions, 0 deletions).
Verification
BuiltInConnectionProperty.java,ConnectionConfig(Impl).java, andCommonsHttpClientPoolCache.java(wherekeystore/keystore_password/
key_passwordare actually consumed).kramdown(the markdown engine thisJekyll site uses, per
site/_config.yml) to confirm the new entriesproduce the same
<dt>/<dd>structure as their siblings, and that thenew anchors (
#keystore,#keystore_password,#key_password) areunique and resolve correctly.