Safe Haskell	None
Language	GHC2021

LibP2P.NAT.Relay

Contents

Types
Configuration
State management
Handlers
Stream bridging
Relay address helpers
Voucher constants

Description

Circuit Relay v2 server: manage reservations and bridge streams.

Protocols: libp2pcircuitrelay0.2.0/hop (client ↔ relay)

Provides: - Reservation management (with expiration and limits) - Stream bridging between source and target - Resource limits (max reservations, max circuits, data/duration limits)

Synopsis

data RelayConfig = RelayConfig {
- rcMaxReservations :: !Int
- rcMaxCircuits :: !Int
- rcReservationDuration :: !Word64
- rcDefaultDataLimit :: !Word64
- rcDefaultDurationLimit :: !Word32
}
data RelayState = RelayState {
- rsConfig :: !RelayConfig
- rsReservations :: !(TVar (Map PeerId ActiveReservation))
- rsCircuitCounts :: !(TVar (Map PeerId Int))
}
data ActiveReservation = ActiveReservation {
- arPeerId :: !PeerId
- arExpiration :: !Word64
}
data HopContext = HopContext {
- hcRelayId :: !PeerId
- hcRelayKey :: !KeyPair
- hcRelayAddrs :: ![Multiaddr]
- hcRemoteAddr :: !Multiaddr
}
defaultRelayConfig :: RelayConfig
newRelayState :: RelayConfig -> IO RelayState
handleReserve :: RelayState -> HopContext -> StreamIO -> PeerId -> IO ()
handleConnect :: RelayState -> HopContext -> StreamIO -> PeerId -> HopMessage -> (PeerId -> IO (Maybe StreamIO)) -> IO ()
bridgeStreams :: Maybe RelayLimit -> StreamIO -> StreamIO -> IO ()
buildRelayAddrBytes :: ByteString -> ByteString -> ByteString -> ByteString
isRelayedConnection :: ByteString -> Bool
isRelayedAddr :: Multiaddr -> Bool
relayRsvpDomain :: ByteString
relayRsvpPayloadType :: ByteString

Types

data RelayConfig Source #

Relay server configuration.

Constructors

RelayConfig
Fields rcMaxReservations :: !Int Max concurrent reservations rcMaxCircuits :: !Int Max concurrent relayed circuits rcReservationDuration :: !Word64 Reservation duration (seconds) rcDefaultDataLimit :: !Word64 Default data limit per circuit (bytes) rcDefaultDurationLimit :: !Word32 Default duration limit per circuit (seconds)

Instances

Instances details

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

data RelayState Source #

Mutable relay server state.

Constructors

RelayState
Fields rsConfig :: !RelayConfig rsReservations :: !(TVar (Map PeerId ActiveReservation)) rsCircuitCounts :: !(TVar (Map PeerId Int)) Active relayed circuits per peer (both initiator and target sides)

data ActiveReservation Source #

An active reservation for a peer.

Constructors

ActiveReservation
Fields arPeerId :: !PeerId arExpiration :: !Word64 Absolute expiration time (UTC Unix time, seconds)

Instances

Instances details

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

data HopContext Source #

Per-request context for the hop handlers: the relay's own identity (used to sign reservation vouchers), its public addresses (advertised in the reservation), and the address the requesting connection arrived over (used to refuse requests over already-relayed connections).

Constructors

HopContext
Fields hcRelayId :: !PeerId Relay's own peer ID hcRelayKey :: !KeyPair Relay identity key, signs vouchers hcRelayAddrs :: ![Multiaddr] Relay public addresses including the trailing `p2p<relay>` component but without `/p2p-circuit`, per circuit-v2 reservation addrs hcRemoteAddr :: !Multiaddr Address the request arrived over

Configuration

defaultRelayConfig :: RelayConfig Source #

Default relay configuration.

State management

newRelayState :: RelayConfig -> IO RelayState Source #

Create new relay state from configuration.

Handlers

handleReserve :: RelayState -> HopContext -> StreamIO -> PeerId -> IO () Source #

Handle a RESERVE request from a peer.

handleConnect :: RelayState -> HopContext -> StreamIO -> PeerId -> HopMessage -> (PeerId -> IO (Maybe StreamIO)) -> IO () Source #

Handle a CONNECT request from a peer. The openStopStream callback is used to open a stop stream to the target.

Stream bridging

bridgeStreams :: Maybe RelayLimit -> StreamIO -> StreamIO -> IO () Source #

Bridge two streams bidirectionally with optional data/duration limits. Terminates when either direction closes or limits are exceeded, then closes both streams so neither end is left with a half-open circuit.

Relay address helpers

buildRelayAddrBytes :: ByteString -> ByteString -> ByteString -> ByteString Source #

Build a relay multiaddr in binary format. Format: relayAddrp2prelayIdp2p-circuitp2p/targetId

isRelayedConnection :: ByteString -> Bool Source #

Check whether raw multiaddr bytes describe a relayed connection. Decodes the bytes structurally: the p2p-circuit byte pattern occurring inside another component (e.g. a peer ID) does not count, unlike the previous substring heuristic. Undecodable bytes are not relayed.

isRelayedAddr :: Multiaddr -> Bool Source #

Check whether a multiaddr contains a p2p-circuit component.

Voucher constants

relayRsvpDomain :: ByteString Source #

Domain separation string for reservation voucher envelopes (circuit-v2).

relayRsvpPayloadType :: ByteString Source #

Multicodec payload type for reservation vouchers (0x0302).