Safe Haskell	None
Language	GHC2021

Network.LibP2P.NAT.AutoNAT.AutoNAT

Contents

Types
Server
Client
NAT status aggregation

Description

AutoNAT v1 service: detect NAT status by asking remote peers to dial back.

Protocol: libp2pautonat/1.0.0 Flow: Client sends DIAL with addresses, server dials back, responds with result.

Security rules (from docs/10-nat-traversal.md): - Server MUST NOT dial addresses unless they match the requester's observed IP - Server MUST NOT accept dial requests over relayed connections

Synopsis

data NATStatus
- = NATPublic
- | NATPrivate
- | NATUnknown
data AutoNATConfig = AutoNATConfig {
- natThreshold :: !Int
- natDialBack :: !(PeerId -> [Multiaddr] -> IO (Either String ()))
}
handleAutoNAT :: AutoNATConfig -> StreamIO -> PeerId -> Multiaddr -> IO ()
requestAutoNAT :: StreamIO -> PeerId -> [Multiaddr] -> IO (Either String AutoNATDialResponse)
probeNATStatusPure :: Int -> [Either String AutoNATDialResponse] -> NATStatus

Types

data NATStatus Source #

Detected NAT status.

Constructors

NATPublic
NATPrivate
NATUnknown

Instances

Instances details

Show NATStatus Source #
Instance details Defined in Network.LibP2P.NAT.AutoNAT.AutoNAT Methods showsPrec :: Int -> NATStatus -> ShowS # show :: NATStatus -> String # showList :: [NATStatus] -> ShowS #
Eq NATStatus Source #
Instance details Defined in Network.LibP2P.NAT.AutoNAT.AutoNAT Methods (==) :: NATStatus -> NATStatus -> Bool # (/=) :: NATStatus -> NATStatus -> Bool #

data AutoNATConfig Source #

AutoNAT configuration.

Constructors

AutoNATConfig
Fields natThreshold :: !Int Number of peers that must agree for a definitive result natDialBack :: !(PeerId -> [Multiaddr] -> IO (Either String ())) Injectable dial-back function (for testing)

Server

handleAutoNAT :: AutoNATConfig -> StreamIO -> PeerId -> Multiaddr -> IO () Source #

Server handler: receive DIAL, validate, dial back, respond.

Security: - Rejects requests from relayed connections (P2PCircuit in observed addr) - Filters dial-back addresses to match observed IP

Client

requestAutoNAT :: StreamIO -> PeerId -> [Multiaddr] -> IO (Either String AutoNATDialResponse) Source #

Client: send DIAL with local addresses, receive response.

NAT status aggregation

probeNATStatusPure :: Int -> [Either String AutoNATDialResponse] -> NATStatus Source #

Pure aggregation of AutoNAT results into a NAT status. Counts OK responses as "public" votes, all other results as "private" votes.