Wire TlsConfig into ConnectionBuilder and Config

Open
#66 0 comments 0 reactions 0 assignees View on GitHub

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

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

enhancement

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:

TlsConfig exists with a full builder. But the module doc says "TODO: with_tls not yet on Config" — i.e. there is no way to pass a TlsConfig to Client::connect(&Config). Config has no tls field/method. TLS code exists but isn't reachable through the public Connection/AsyncConnection or ConnectionBuilder.

Proposed work

  • Add a tls(TlsConfig) -> Self method on Config in hyperdb-api-core (or whichever struct Connection consumes for its TLS settings).
  • Add a tls(TlsConfig) -> Self method on ConnectionBuilder and its async counterparts.
  • Wire the field through to the actual Client::connect call 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 ConnectionBuilder to 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tableau/hyper-api-rust

All issues in tableau/hyper-api-rust

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.