Wire TlsConfig into ConnectionBuilder and Config
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 52/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- rust
- Domain
- backend-api-design, security
Research direction
Start by reading hyperdb-api-core/src/config.rs and hyperdb-api/src/connection_builder.rs, then trace the existing Client::connect call and lower-layer TlsConfig usage. Run the existing TLS tests before adding high-level integration coverage; done means TLS is exposed through the sync and async builders, demonstrated in hyperdb-api/examples/, and documented on ConnectionBuilder.
Written by the indexing model from the issue text.
Description
Summary
TlsConfig exists in hyperdb-api-core but is not reachable through the public Connection / AsyncConnection / ConnectionBuilder surface. There is no with_tls() / tls() method on any of them. TLS code is built and tested at the lower layer but has no on-ramp from the high-level API.
Current state
$ grep -rn "fn with_tls\|fn tls\|TlsConfig\|tls_config" \
hyperdb-api/src/connection_builder.rs \
hyperdb-api-core/src/config.rs
# (no output)
The original gap analysis (§7 of docs/RUST_API_GAP_ANALYSIS.md in the predecessor repo) called this out:
TlsConfigexists with a full builder. But the module doc says "TODO: with_tls not yet on Config" — i.e. there is no way to pass aTlsConfigtoClient::connect(&Config).Confighas no tls field/method. TLS code exists but isn't reachable through the publicConnection/AsyncConnectionorConnectionBuilder.
Proposed work
- Add a
tls(TlsConfig) -> Selfmethod onConfiginhyperdb-api-core(or whichever structConnectionconsumes for its TLS settings). - Add a
tls(TlsConfig) -> Selfmethod onConnectionBuilderand its async counterparts. - Wire the field through to the actual
Client::connectcall so it has effect. - Add an integration test that connects to a TLS-enabled Hyper endpoint via the high-level API.
- Add an example under
hyperdb-api/examples/demonstrating TLS configuration. - Update the rustdoc on
ConnectionBuilderto mention TLS.
Backwards compatibility
Purely additive — new methods, no changes to existing signatures.
Note on cert verification
Whatever default TlsConfig produces today should remain the default. This issue is about exposing TLS, not redesigning the security defaults.
- Dominant language
- Rust
- Stars
- 2
- Forks
- 2
- Avg merge
- 12h 2m
- Merged PRs (30d)
- 60
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from tableau/hyper-api-rust
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
tableau/hyper-api-rust#294 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
tableau/hyper-api-rust#311 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
tableau/hyper-api-rust#305 ·
-
Windows Named Pipe: verify DACL denies other users, and measure read-path perf for MCP workloads Open
Difficulty 4/5 3-5 days Newbie friendliness 38/100
tableau/hyper-api-rust#302 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 72/100
tableau/hyper-api-rust#300 ·
All issues in tableau/hyper-api-rust
Similar issues
-
risk:low runtime status:in-progress type:test
Difficulty 1/5 Under an hour Newbie friendliness 92/100
zeroclaw-labs/zeroclaw#11023 ·
-
good first issue refactor
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
kwakseongjae/auto-hwp#319 ·
-
area:cli bug filter-quality good first issue priority:medium
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bevyengine/bevy#25861 ·