libp2p / libp2p/rust-libp2p

`/dnsaddr` can not be properly used with secure WebSocket transport

Open
#5,529 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
5.6k
Forks
1.3k
Avg merge
8h 47m
Merged PRs (30d)
19

Description

Description

Currently there is no way to properly pass /dnsaddr to WSS transport and work as expected:

  1. If you wrap libp2p::websocket::WsConfig with libp2p::dns::Transport then you break secure WebSocket because DNS transport will resolve /dns4 to /ip4.
  2. If you wrap libp2p::dns::Transport with libp2p::websocket::WsConfig then you break /dnsaddr because it will never fetch the multiaddresses from DNS.

Currently 2 is the recommended way (link).

Motivation

I want to be able to use /dnsaddr with secure WebSocket.

Requirements

I want to be able to wrap libp2p::websocket::WsConfig with libp2p::dns::Transport which will resolve only /dnsaddr before it passing the multiaddr to WebSocket transport.

For example:

let inner_tcp_transport =
    dns::tokio::Transport::system(tcp::tokio::Transport::new(tcp::Config::default()))
        .unwrap();

let wss_transport = websocket::WsConfig::new(inner_tcp_transport);

let mut dns_opts = dns::ResolverOpts::default();
dns_opts.resolve_dnsaddr_only = true;

let transport =
    dns::tokio::Transport::custom(wss_transport, dns::ResolverConfig::default(), dns_opts);

In case of /dnsaddr the above transport should have the following flow:

  1. User dials to /dnsaddr/da-bridge-1.celestia-arabica-11.com/p2p/12D3KooWGqwzdEqM54Dce6LXzfFr97Bnhvm6rN7KM7MFwdomfm4S
  2. DNS transport resolves multiaddr to /dns/da-bridge-1.celestia-arabica-11.com/tcp/2122/tls/ws/p2p/12D3KooWGqwzdEqM54Dce6LXzfFr97Bnhvm6rN7KM7MFwdomfm4S
  3. DNS transport passes the /dns multiaddr to WebSocket transport.
  4. WebSocket transport initializes TLS based on /dns multiaddr and passes multiaddr to TCP transport.
  5. TCP transport resolves /dns multiaddr to /ip4 multiaddr and establishes the connection.

In case of /dns the above transport should have the following flow:

  1. User dials to /dns/da-bridge-1.celestia-arabica-11.com/tcp/2122/tls/ws/p2p/12D3KooWGqwzdEqM54Dce6LXzfFr97Bnhvm6rN7KM7MFwdomfm4S
  2. DNS transport passes the /dns multiaddr to WebSocket transport.
  3. WebSocket transport initializes TLS based on /dns multiaddr and passes multiaddr to TCP transport.
  4. TCP transport resolves /dns multiaddr to /ip4 multiaddr and establishes the connection.
Open questions

It would be hard to implement this kind of transport combination in SwarmBuilder.

Are you planning to do it yourself in a pull request ?

Maybe

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.

Research direction

Start with transports/websocket/src/lib.rs, especially the documented transport wrapping order, then inspect the DNS and WebSocket transport entry points. Confirm the composition preserves /dnsaddr and /dns for secure WebSocket while leaving TCP resolution intact; done means both example flows work.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
networking
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.