2019-08-27 21:46:12 +00:00
|
|
|
## Nim-LibP2P
|
2019-09-24 17:48:23 +00:00
|
|
|
## Copyright (c) 2019 Status Research & Development GmbH
|
2019-08-27 21:46:12 +00:00
|
|
|
## Licensed under either of
|
|
|
|
## * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
|
|
|
|
## * MIT license ([LICENSE-MIT](LICENSE-MIT))
|
|
|
|
## at your option.
|
|
|
|
## This file may not be copied, modified, or distributed except according to
|
|
|
|
## those terms.
|
|
|
|
|
2020-06-24 15:08:44 +00:00
|
|
|
import tables,
|
|
|
|
sequtils,
|
|
|
|
options,
|
|
|
|
sets,
|
2020-07-08 00:33:05 +00:00
|
|
|
oids
|
2020-06-24 15:08:44 +00:00
|
|
|
|
|
|
|
import chronos,
|
|
|
|
chronicles,
|
|
|
|
metrics
|
|
|
|
|
2020-06-19 17:29:43 +00:00
|
|
|
import stream/connection,
|
2019-09-11 19:03:30 +00:00
|
|
|
transports/transport,
|
|
|
|
multistream,
|
2020-06-17 04:14:02 +00:00
|
|
|
multiaddress,
|
2019-09-06 07:13:47 +00:00
|
|
|
protocols/protocol,
|
2019-09-14 13:55:52 +00:00
|
|
|
protocols/secure/secure,
|
2019-09-11 19:03:30 +00:00
|
|
|
peerinfo,
|
|
|
|
protocols/identify,
|
2019-09-06 07:13:47 +00:00
|
|
|
muxers/muxer,
|
2020-07-17 15:36:48 +00:00
|
|
|
connmanager,
|
2020-07-24 19:24:31 +00:00
|
|
|
peerid,
|
|
|
|
errors
|
2019-08-28 19:12:15 +00:00
|
|
|
|
2020-08-12 00:05:49 +00:00
|
|
|
chronicles.formatIt(PeerInfo): $it
|
|
|
|
chronicles.formatIt(PeerID): $it
|
|
|
|
|
2019-09-12 02:10:38 +00:00
|
|
|
logScope:
|
2020-06-10 08:48:01 +00:00
|
|
|
topics = "switch"
|
2019-09-12 02:10:38 +00:00
|
|
|
|
2019-12-04 04:44:54 +00:00
|
|
|
#TODO: General note - use a finite state machine to manage the different
|
2019-12-08 21:06:58 +00:00
|
|
|
# steps of connections establishing and upgrading. This makes everything
|
|
|
|
# more robust and less prone to ordering attacks - i.e. muxing can come if
|
|
|
|
# and only if the channel has been secured (i.e. if a secure manager has been
|
2019-12-04 04:44:54 +00:00
|
|
|
# previously provided)
|
|
|
|
|
2020-06-11 14:45:59 +00:00
|
|
|
declareCounter(libp2p_dialed_peers, "dialed peers")
|
|
|
|
declareCounter(libp2p_failed_dials, "failed dials")
|
|
|
|
declareCounter(libp2p_failed_upgrade, "peers failed upgrade")
|
|
|
|
|
2019-08-28 19:12:15 +00:00
|
|
|
type
|
2020-06-24 15:08:44 +00:00
|
|
|
NoPubSubException* = object of CatchableError
|
2019-09-11 19:03:30 +00:00
|
|
|
|
2020-08-08 06:52:20 +00:00
|
|
|
ConnEventKind* {.pure.} = enum
|
|
|
|
Connected, # A connection was made and securely upgraded - there may be
|
|
|
|
# more than one concurrent connection thus more than one upgrade
|
|
|
|
# event per peer.
|
|
|
|
Disconnected # Peer disconnected - this event is fired once per upgrade
|
|
|
|
# when the associated connection is terminated.
|
|
|
|
|
|
|
|
ConnEvent* = object
|
|
|
|
case kind*: ConnEventKind
|
|
|
|
of ConnEventKind.Connected:
|
|
|
|
incoming*: bool
|
|
|
|
else:
|
|
|
|
discard
|
|
|
|
|
|
|
|
ConnEventHandler* =
|
|
|
|
proc(peerId: PeerID, event: ConnEvent): Future[void] {.gcsafe.}
|
2020-07-24 19:24:31 +00:00
|
|
|
|
2019-08-28 19:12:15 +00:00
|
|
|
Switch* = ref object of RootObj
|
2019-08-30 05:17:07 +00:00
|
|
|
peerInfo*: PeerInfo
|
2020-07-17 15:36:48 +00:00
|
|
|
connManager: ConnManager
|
2019-08-30 05:17:07 +00:00
|
|
|
transports*: seq[Transport]
|
|
|
|
protocols*: seq[LPProtocol]
|
2019-09-04 22:00:39 +00:00
|
|
|
muxers*: Table[string, MuxerProvider]
|
2020-02-04 16:16:21 +00:00
|
|
|
ms*: MultistreamSelect
|
2019-09-04 01:50:17 +00:00
|
|
|
identity*: Identify
|
2019-09-06 07:13:47 +00:00
|
|
|
streamHandler*: StreamHandler
|
2020-06-01 17:49:25 +00:00
|
|
|
secureManagers*: seq[Secure]
|
2020-08-06 18:14:40 +00:00
|
|
|
dialLock: Table[PeerID, AsyncLock]
|
2020-08-08 06:52:20 +00:00
|
|
|
ConnEvents: Table[ConnEventKind, HashSet[ConnEventHandler]]
|
2019-08-27 21:46:12 +00:00
|
|
|
|
2020-08-08 06:52:20 +00:00
|
|
|
proc addConnEventHandler*(s: Switch,
|
|
|
|
handler: ConnEventHandler, kind: ConnEventKind) =
|
|
|
|
## Add peer event handler - handlers must not raise exceptions!
|
|
|
|
if isNil(handler): return
|
|
|
|
s.ConnEvents.mgetOrPut(kind, initHashSet[ConnEventHandler]()).incl(handler)
|
2020-07-24 19:24:31 +00:00
|
|
|
|
2020-08-08 06:52:20 +00:00
|
|
|
proc removeConnEventHandler*(s: Switch,
|
|
|
|
handler: ConnEventHandler, kind: ConnEventKind) =
|
|
|
|
s.ConnEvents.withValue(kind, handlers) do:
|
|
|
|
handlers[].excl(handler)
|
2020-07-24 19:24:31 +00:00
|
|
|
|
2020-08-08 06:52:20 +00:00
|
|
|
proc triggerConnEvent(s: Switch, peerId: PeerID, event: ConnEvent) {.async, gcsafe.} =
|
2020-07-24 19:24:31 +00:00
|
|
|
try:
|
2020-08-08 06:52:20 +00:00
|
|
|
if event.kind in s.ConnEvents:
|
|
|
|
var ConnEvents: seq[Future[void]]
|
|
|
|
for h in s.ConnEvents[event.kind]:
|
|
|
|
ConnEvents.add(h(peerId, event))
|
2020-07-24 19:24:31 +00:00
|
|
|
|
2020-08-08 06:52:20 +00:00
|
|
|
checkFutures(await allFinished(ConnEvents))
|
2020-07-24 19:24:31 +00:00
|
|
|
except CancelledError as exc:
|
|
|
|
raise exc
|
2020-08-08 06:52:20 +00:00
|
|
|
except CatchableError as exc: # handlers should not raise!
|
|
|
|
warn "exception in trigger ConnEvents", exc = exc.msg
|
2020-07-24 19:24:31 +00:00
|
|
|
|
2020-08-06 07:29:27 +00:00
|
|
|
proc disconnect*(s: Switch, peerId: PeerID) {.async, gcsafe.}
|
2020-06-24 15:08:44 +00:00
|
|
|
|
2020-08-06 07:29:27 +00:00
|
|
|
proc isConnected*(s: Switch, peerId: PeerID): bool =
|
2020-07-17 18:44:41 +00:00
|
|
|
## returns true if the peer has one or more
|
|
|
|
## associated connections (sockets)
|
|
|
|
##
|
|
|
|
|
2020-08-06 07:29:27 +00:00
|
|
|
peerId in s.connManager
|
2020-07-08 00:33:05 +00:00
|
|
|
|
2019-12-08 21:06:58 +00:00
|
|
|
proc secure(s: Switch, conn: Connection): Future[Connection] {.async, gcsafe.} =
|
2020-06-01 17:49:25 +00:00
|
|
|
if s.secureManagers.len <= 0:
|
2019-09-09 23:17:45 +00:00
|
|
|
raise newException(CatchableError, "No secure managers registered!")
|
|
|
|
|
2020-06-01 17:49:25 +00:00
|
|
|
let manager = await s.ms.select(conn, s.secureManagers.mapIt(it.codec))
|
2020-06-22 21:38:48 +00:00
|
|
|
if manager.len == 0:
|
2019-09-06 07:13:47 +00:00
|
|
|
raise newException(CatchableError, "Unable to negotiate a secure channel!")
|
2019-09-09 23:17:45 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
trace "securing connection", codec = manager
|
2020-06-20 10:56:55 +00:00
|
|
|
let secureProtocol = s.secureManagers.filterIt(it.codec == manager)
|
2020-07-17 15:36:48 +00:00
|
|
|
|
2020-06-20 10:56:55 +00:00
|
|
|
# ms.select should deal with the correctness of this
|
|
|
|
# let's avoid duplicating checks but detect if it fails to do it properly
|
2020-06-21 09:14:19 +00:00
|
|
|
doAssert(secureProtocol.len > 0)
|
2020-07-17 15:36:48 +00:00
|
|
|
|
2020-06-20 10:56:55 +00:00
|
|
|
result = await secureProtocol[0].secure(conn, true)
|
2019-08-31 17:58:49 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
proc identify(s: Switch, conn: Connection) {.async, gcsafe.} =
|
2019-09-04 01:50:17 +00:00
|
|
|
## identify the connection
|
2019-09-28 19:54:32 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
if (await s.ms.select(conn, s.identity.codec)):
|
|
|
|
let info = await s.identity.identify(conn, conn.peerInfo)
|
2019-12-07 16:36:39 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
if info.pubKey.isNone and isNil(conn):
|
|
|
|
raise newException(CatchableError,
|
|
|
|
"no public key provided and no existing peer identity found")
|
2019-12-10 20:50:35 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
if isNil(conn.peerInfo):
|
|
|
|
conn.peerInfo = PeerInfo.init(info.pubKey.get())
|
2019-12-04 04:44:54 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
if info.addrs.len > 0:
|
|
|
|
conn.peerInfo.addrs = info.addrs
|
2019-12-04 04:44:54 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
if info.agentVersion.isSome:
|
|
|
|
conn.peerInfo.agentVersion = info.agentVersion.get()
|
2020-06-09 18:42:52 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
if info.protoVersion.isSome:
|
|
|
|
conn.peerInfo.protoVersion = info.protoVersion.get()
|
2020-06-09 18:42:52 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
if info.protos.len > 0:
|
|
|
|
conn.peerInfo.protocols = info.protos
|
2020-06-11 14:45:59 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
trace "identify: identified remote peer", peer = $conn.peerInfo
|
2019-09-06 07:13:47 +00:00
|
|
|
|
2020-08-17 11:29:45 +00:00
|
|
|
proc identify(s: Switch, muxer: Muxer) {.async, gcsafe.} =
|
|
|
|
# new stream for identify
|
|
|
|
var stream = await muxer.newStream()
|
|
|
|
|
|
|
|
defer:
|
|
|
|
if not(isNil(stream)):
|
|
|
|
await stream.close() # close identify stream
|
|
|
|
|
|
|
|
# do identify first, so that we have a
|
|
|
|
# PeerInfo in case we didn't before
|
|
|
|
await s.identify(stream)
|
|
|
|
|
|
|
|
proc mux(s: Switch, conn: Connection): Future[Muxer] {.async, gcsafe.} =
|
2019-09-04 01:50:17 +00:00
|
|
|
## mux incoming connection
|
2019-09-28 19:54:32 +00:00
|
|
|
|
2020-06-21 09:14:19 +00:00
|
|
|
trace "muxing connection", peer = $conn
|
2020-08-02 10:22:49 +00:00
|
|
|
if s.muxers.len == 0:
|
2019-09-23 21:51:28 +00:00
|
|
|
warn "no muxers registered, skipping upgrade flow"
|
2019-09-13 20:04:46 +00:00
|
|
|
return
|
|
|
|
|
2020-08-02 10:22:49 +00:00
|
|
|
let muxerName = await s.ms.select(conn, toSeq(s.muxers.keys()))
|
2019-09-06 07:13:47 +00:00
|
|
|
if muxerName.len == 0 or muxerName == "na":
|
2020-06-21 09:14:19 +00:00
|
|
|
debug "no muxer available, early exit", peer = $conn
|
2019-09-04 22:00:39 +00:00
|
|
|
return
|
|
|
|
|
2019-09-14 15:55:58 +00:00
|
|
|
# create new muxer for connection
|
2019-09-04 22:00:39 +00:00
|
|
|
let muxer = s.muxers[muxerName].newMuxer(conn)
|
2020-06-20 10:56:55 +00:00
|
|
|
|
2019-09-04 22:00:39 +00:00
|
|
|
# install stream handler
|
2019-09-06 07:13:47 +00:00
|
|
|
muxer.streamHandler = s.streamHandler
|
2019-09-04 22:00:39 +00:00
|
|
|
|
2020-08-17 11:29:45 +00:00
|
|
|
s.connManager.storeOutgoing(muxer.connection)
|
|
|
|
s.connManager.storeMuxer(muxer)
|
2020-06-29 15:15:31 +00:00
|
|
|
|
2020-08-17 11:29:45 +00:00
|
|
|
trace "found a muxer", name = muxerName, peer = $conn
|
2020-06-29 15:15:31 +00:00
|
|
|
|
2020-08-17 11:29:45 +00:00
|
|
|
# start muxer read loop - the future will complete when loop ends
|
2020-08-01 20:50:40 +00:00
|
|
|
let handlerFut = muxer.handle()
|
2019-09-08 07:43:33 +00:00
|
|
|
|
2019-09-05 15:19:39 +00:00
|
|
|
# store it in muxed connections if we have a peer for it
|
2020-06-24 15:08:44 +00:00
|
|
|
trace "adding muxer for peer", peer = conn.peerInfo.id
|
2020-07-17 15:36:48 +00:00
|
|
|
s.connManager.storeMuxer(muxer, handlerFut) # update muxer with handler
|
2020-05-23 17:12:28 +00:00
|
|
|
|
2020-08-17 11:29:45 +00:00
|
|
|
return muxer
|
|
|
|
|
2020-08-06 07:29:27 +00:00
|
|
|
proc disconnect*(s: Switch, peerId: PeerID): Future[void] {.gcsafe.} =
|
|
|
|
s.connManager.dropPeer(peerId)
|
2019-09-28 19:54:32 +00:00
|
|
|
|
2019-09-12 12:02:25 +00:00
|
|
|
proc upgradeOutgoing(s: Switch, conn: Connection): Future[Connection] {.async, gcsafe.} =
|
2020-06-24 15:08:44 +00:00
|
|
|
let sconn = await s.secure(conn) # secure the connection
|
|
|
|
if isNil(sconn):
|
2020-06-29 15:15:31 +00:00
|
|
|
raise newException(CatchableError,
|
|
|
|
"unable to secure connection, stopping upgrade")
|
2019-12-04 04:44:54 +00:00
|
|
|
|
2020-08-17 11:29:45 +00:00
|
|
|
if sconn.peerInfo.isNil:
|
|
|
|
raise newException(CatchableError,
|
|
|
|
"current version of nim-libp2p requires that secure protocol negotiates peerid")
|
|
|
|
|
2020-09-04 18:30:26 +00:00
|
|
|
trace "upgrading connection", conn = $sconn, uoid = $conn.oid
|
2020-08-17 11:29:45 +00:00
|
|
|
let muxer = await s.mux(sconn) # mux it if possible
|
2020-08-17 11:32:02 +00:00
|
|
|
if muxer == nil:
|
|
|
|
# TODO this might be relaxed in the future
|
|
|
|
raise newException(CatchableError,
|
|
|
|
"a muxer is required for outgoing connections")
|
2020-08-17 11:29:45 +00:00
|
|
|
|
2020-09-04 18:30:26 +00:00
|
|
|
try:
|
|
|
|
await s.identify(muxer)
|
|
|
|
except CatchableError as exc:
|
|
|
|
# Identify is non-essential, though if it fails, it might indicate that
|
|
|
|
# the connection was closed already - this will be picked up by the read
|
|
|
|
# loop
|
|
|
|
debug "Could not identify connection",
|
|
|
|
err = exc.msg, conn = $conn, uoid = $conn.oid
|
2020-08-17 11:29:45 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
if isNil(sconn.peerInfo):
|
2020-06-24 15:08:44 +00:00
|
|
|
await sconn.close()
|
2020-06-29 15:15:31 +00:00
|
|
|
raise newException(CatchableError,
|
2020-07-24 19:24:31 +00:00
|
|
|
"unable to identify connection, stopping upgrade")
|
|
|
|
|
2020-09-04 18:30:26 +00:00
|
|
|
trace "successfully upgraded outgoing connection",
|
|
|
|
conn = $sconn, uoid = $conn.oid, oid = $sconn.oid
|
2019-12-13 15:25:07 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
return sconn
|
2019-09-04 22:00:39 +00:00
|
|
|
|
2019-12-08 21:06:58 +00:00
|
|
|
proc upgradeIncoming(s: Switch, conn: Connection) {.async, gcsafe.} =
|
2020-08-03 05:20:11 +00:00
|
|
|
trace "upgrading incoming connection", conn = $conn, oid = $conn.oid
|
2019-09-28 19:54:32 +00:00
|
|
|
let ms = newMultistream()
|
2019-09-04 01:50:17 +00:00
|
|
|
|
2019-09-28 19:54:32 +00:00
|
|
|
# secure incoming connections
|
|
|
|
proc securedHandler (conn: Connection,
|
|
|
|
proto: string)
|
|
|
|
{.async, gcsafe, closure.} =
|
2020-06-29 15:15:31 +00:00
|
|
|
|
|
|
|
var sconn: Connection
|
2020-08-03 05:20:11 +00:00
|
|
|
trace "Securing connection", oid = $conn.oid
|
2020-06-29 15:15:31 +00:00
|
|
|
let secure = s.secureManagers.filterIt(it.codec == proto)[0]
|
|
|
|
|
2020-05-15 03:56:56 +00:00
|
|
|
try:
|
2020-06-29 15:15:31 +00:00
|
|
|
sconn = await secure.secure(conn, false)
|
|
|
|
if isNil(sconn):
|
2020-05-15 03:56:56 +00:00
|
|
|
return
|
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
defer:
|
|
|
|
await sconn.close()
|
|
|
|
|
2019-09-28 19:54:32 +00:00
|
|
|
# add the muxer
|
|
|
|
for muxer in s.muxers.values:
|
|
|
|
ms.addHandler(muxer.codec, muxer)
|
|
|
|
|
2020-07-28 14:03:22 +00:00
|
|
|
# handle subsequent secure requests
|
2020-06-29 15:15:31 +00:00
|
|
|
await ms.handle(sconn)
|
2020-05-23 17:12:28 +00:00
|
|
|
|
2020-05-15 03:56:56 +00:00
|
|
|
except CancelledError as exc:
|
|
|
|
raise exc
|
|
|
|
except CatchableError as exc:
|
2020-09-04 18:30:26 +00:00
|
|
|
debug "ending secured handler",
|
|
|
|
err = exc.msg, conn = $conn, oid = $conn.oid
|
2019-09-28 19:54:32 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
if (await ms.select(conn)): # just handshake
|
|
|
|
# add the secure handlers
|
|
|
|
for k in s.secureManagers:
|
|
|
|
ms.addHandler(k.codec, securedHandler)
|
2019-09-11 19:03:30 +00:00
|
|
|
|
2020-07-28 14:03:22 +00:00
|
|
|
# handle un-secured connections
|
|
|
|
# we handshaked above, set this ms handler as active
|
|
|
|
await ms.handle(conn, active = true)
|
2020-02-21 01:14:39 +00:00
|
|
|
|
2020-02-25 22:13:05 +00:00
|
|
|
proc internalConnect(s: Switch,
|
2020-08-06 07:29:27 +00:00
|
|
|
peerId: PeerID,
|
|
|
|
addrs: seq[MultiAddress]): Future[Connection] {.async.} =
|
|
|
|
if s.peerInfo.peerId == peerId:
|
2020-06-24 15:08:44 +00:00
|
|
|
raise newException(CatchableError, "can't dial self!")
|
|
|
|
|
2020-08-08 06:52:20 +00:00
|
|
|
var conn: Connection
|
|
|
|
# Ensure there's only one in-flight attempt per peer
|
2020-08-06 18:14:40 +00:00
|
|
|
let lock = s.dialLock.mgetOrPut(peerId, newAsyncLock())
|
2020-07-17 15:36:48 +00:00
|
|
|
try:
|
|
|
|
await lock.acquire()
|
2020-08-08 06:52:20 +00:00
|
|
|
|
|
|
|
# Check if we have a connection already and try to reuse it
|
|
|
|
conn = s.connManager.selectConn(peerId)
|
|
|
|
if conn != nil:
|
|
|
|
if conn.atEof or conn.closed:
|
|
|
|
# This connection should already have been removed from the connection
|
|
|
|
# manager - it's essentially a bug that we end up here - we'll fail
|
|
|
|
# for now, hoping that this will clean themselves up later...
|
2020-09-04 18:30:26 +00:00
|
|
|
warn "dead connection in connection manager", peer = $peerId
|
2020-08-08 06:52:20 +00:00
|
|
|
await conn.close()
|
|
|
|
raise newException(CatchableError, "Zombie connection encountered")
|
|
|
|
|
2020-09-04 18:30:26 +00:00
|
|
|
trace "Reusing existing connection",
|
|
|
|
oid = $conn.oid, direction = $conn.dir, peer = $peerId
|
2020-08-08 06:52:20 +00:00
|
|
|
|
|
|
|
return conn
|
|
|
|
|
|
|
|
trace "Dialing peer"
|
2020-08-06 07:29:27 +00:00
|
|
|
for t in s.transports: # for each transport
|
|
|
|
for a in addrs: # for each address
|
|
|
|
if t.handles(a): # check if it can dial it
|
2020-08-08 06:52:20 +00:00
|
|
|
trace "Dialing address", address = $a
|
|
|
|
let dialed = try:
|
|
|
|
await t.dial(a)
|
|
|
|
except CancelledError as exc:
|
2020-09-04 18:30:26 +00:00
|
|
|
trace "dialing canceled", exc = exc.msg, peer = $peerId
|
2020-08-08 06:52:20 +00:00
|
|
|
raise exc
|
|
|
|
except CatchableError as exc:
|
2020-09-04 18:30:26 +00:00
|
|
|
trace "dialing failed", exc = exc.msg, peer = $peerId
|
2020-08-08 06:52:20 +00:00
|
|
|
libp2p_failed_dials.inc()
|
|
|
|
continue # Try the next address
|
|
|
|
|
|
|
|
# make sure to assign the peer to the connection
|
|
|
|
dialed.peerInfo = PeerInfo.init(peerId, addrs)
|
|
|
|
|
|
|
|
libp2p_dialed_peers.inc()
|
|
|
|
|
|
|
|
let upgraded = try:
|
|
|
|
await s.upgradeOutgoing(dialed)
|
|
|
|
except CatchableError as exc:
|
|
|
|
# If we failed to establish the connection through one transport,
|
|
|
|
# we won't succeeed through another - no use in trying again
|
|
|
|
await dialed.close()
|
|
|
|
debug "upgrade failed", exc = exc.msg
|
|
|
|
if exc isnot CancelledError:
|
|
|
|
libp2p_failed_upgrade.inc()
|
|
|
|
raise exc
|
|
|
|
|
2020-08-12 00:05:49 +00:00
|
|
|
doAssert not isNil(upgraded), "connection died after upgradeOutgoing"
|
2020-08-08 06:52:20 +00:00
|
|
|
|
2020-08-08 07:31:37 +00:00
|
|
|
conn = upgraded
|
2020-08-08 06:52:20 +00:00
|
|
|
trace "dial successful",
|
2020-09-04 18:30:26 +00:00
|
|
|
peer = $peerId,
|
2020-08-12 00:05:49 +00:00
|
|
|
oid = $upgraded.oid,
|
2020-08-08 06:52:20 +00:00
|
|
|
peerInfo = shortLog(upgraded.peerInfo)
|
2020-08-06 07:29:27 +00:00
|
|
|
break
|
2020-07-17 15:36:48 +00:00
|
|
|
finally:
|
2020-06-24 15:08:44 +00:00
|
|
|
if lock.locked():
|
|
|
|
lock.release()
|
2019-12-08 21:06:58 +00:00
|
|
|
|
2020-08-08 06:52:20 +00:00
|
|
|
if isNil(conn): # None of the addresses connected
|
2020-08-06 07:29:27 +00:00
|
|
|
raise newException(CatchableError, "Unable to establish outgoing link")
|
2020-06-29 15:15:31 +00:00
|
|
|
|
2020-09-04 18:30:26 +00:00
|
|
|
if conn.closed():
|
|
|
|
# This can happen if one of the peer event handlers deems the peer
|
|
|
|
# unworthy and disconnects it
|
|
|
|
raise newLPStreamClosedError()
|
|
|
|
|
|
|
|
await s.triggerConnEvent(
|
|
|
|
peerId, ConnEvent(kind: ConnEventKind.Connected, incoming: false))
|
|
|
|
|
2020-09-04 16:30:45 +00:00
|
|
|
proc peerCleanup() {.async.} =
|
|
|
|
try:
|
|
|
|
await conn.closeEvent.wait()
|
|
|
|
await s.triggerConnEvent(peerId,
|
|
|
|
ConnEvent(kind: ConnEventKind.Disconnected))
|
|
|
|
except CancelledError:
|
|
|
|
# This is top-level procedure which will work as separate task, so it
|
|
|
|
# do not need to propogate CancelledError.
|
2020-09-04 18:30:26 +00:00
|
|
|
trace "Unexpected cancellation in switch peer connect cleanup",
|
|
|
|
peer = $peerId
|
2020-09-04 16:30:45 +00:00
|
|
|
except CatchableError as exc:
|
|
|
|
trace "Unexpected exception in switch peer connect cleanup",
|
2020-09-04 18:30:26 +00:00
|
|
|
errMsg = exc.msg, peer = $peerId
|
2020-09-04 16:30:45 +00:00
|
|
|
|
|
|
|
# All the errors are handled inside `cleanup()` procedure.
|
|
|
|
asyncSpawn peerCleanup()
|
2020-06-29 15:15:31 +00:00
|
|
|
|
2020-07-08 00:33:05 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
return conn
|
2020-02-25 22:13:05 +00:00
|
|
|
|
2020-08-06 07:29:27 +00:00
|
|
|
proc connect*(s: Switch, peerId: PeerID, addrs: seq[MultiAddress]) {.async.} =
|
|
|
|
discard await s.internalConnect(peerId, addrs)
|
2020-02-25 22:13:05 +00:00
|
|
|
|
2020-08-12 00:05:49 +00:00
|
|
|
proc negotiateStream(s: Switch, stream: Connection, proto: string): Future[Connection] {.async.} =
|
|
|
|
trace "Attempting to select remote", proto = proto,
|
|
|
|
streamOid = $stream.oid,
|
|
|
|
oid = $stream.oid
|
|
|
|
|
|
|
|
if not await s.ms.select(stream, proto):
|
|
|
|
await stream.close()
|
|
|
|
raise newException(CatchableError, "Unable to select sub-protocol" & proto)
|
|
|
|
|
|
|
|
return stream
|
|
|
|
|
|
|
|
proc dial*(s: Switch,
|
|
|
|
peerId: PeerID,
|
|
|
|
proto: string): Future[Connection] {.async.} =
|
|
|
|
let stream = await s.connmanager.getMuxedStream(peerId)
|
|
|
|
if stream.isNil:
|
|
|
|
raise newException(CatchableError, "Couldn't get muxed stream")
|
|
|
|
|
|
|
|
return await s.negotiateStream(stream, proto)
|
|
|
|
|
2020-02-25 22:13:05 +00:00
|
|
|
proc dial*(s: Switch,
|
2020-08-06 07:29:27 +00:00
|
|
|
peerId: PeerID,
|
|
|
|
addrs: seq[MultiAddress],
|
2020-02-25 22:13:05 +00:00
|
|
|
proto: string):
|
|
|
|
Future[Connection] {.async.} =
|
2020-08-06 07:29:27 +00:00
|
|
|
let conn = await s.internalConnect(peerId, addrs)
|
2020-07-17 15:36:48 +00:00
|
|
|
let stream = await s.connManager.getMuxedStream(conn)
|
2019-12-08 21:06:58 +00:00
|
|
|
|
2020-07-08 00:33:05 +00:00
|
|
|
proc cleanup() {.async.} =
|
|
|
|
if not(isNil(stream)):
|
|
|
|
await stream.close()
|
|
|
|
|
|
|
|
if not(isNil(conn)):
|
|
|
|
await conn.close()
|
|
|
|
|
|
|
|
try:
|
|
|
|
if isNil(stream):
|
|
|
|
await conn.close()
|
|
|
|
raise newException(CatchableError, "Couldn't get muxed stream")
|
2020-02-21 01:14:39 +00:00
|
|
|
|
2020-08-12 00:05:49 +00:00
|
|
|
return await s.negotiateStream(stream, proto)
|
2020-07-08 00:33:05 +00:00
|
|
|
except CancelledError as exc:
|
|
|
|
trace "dial canceled"
|
|
|
|
await cleanup()
|
|
|
|
raise exc
|
|
|
|
except CatchableError as exc:
|
2020-07-27 19:33:51 +00:00
|
|
|
trace "error dialing", exc = exc.msg
|
2020-07-08 00:33:05 +00:00
|
|
|
await cleanup()
|
|
|
|
raise exc
|
2020-06-29 15:15:31 +00:00
|
|
|
|
2019-12-08 21:06:58 +00:00
|
|
|
proc mount*[T: LPProtocol](s: Switch, proto: T) {.gcsafe.} =
|
2019-08-31 17:58:49 +00:00
|
|
|
if isNil(proto.handler):
|
2019-12-04 04:44:54 +00:00
|
|
|
raise newException(CatchableError,
|
2020-06-27 17:33:34 +00:00
|
|
|
"Protocol has to define a handle method or proc")
|
2019-08-27 21:46:12 +00:00
|
|
|
|
2019-09-06 07:13:47 +00:00
|
|
|
if proto.codec.len == 0:
|
2019-12-04 04:44:54 +00:00
|
|
|
raise newException(CatchableError,
|
2020-06-27 17:33:34 +00:00
|
|
|
"Protocol has to define a codec string")
|
2019-08-31 18:52:56 +00:00
|
|
|
|
2019-08-31 17:58:49 +00:00
|
|
|
s.ms.addHandler(proto.codec, proto)
|
2019-08-28 02:30:53 +00:00
|
|
|
|
2020-05-05 15:55:02 +00:00
|
|
|
proc start*(s: Switch): Future[seq[Future[void]]] {.async, gcsafe.} =
|
2020-06-09 18:42:52 +00:00
|
|
|
trace "starting switch for peer", peerInfo = shortLog(s.peerInfo)
|
2019-12-04 04:44:54 +00:00
|
|
|
|
2019-08-31 18:52:56 +00:00
|
|
|
proc handle(conn: Connection): Future[void] {.async, closure, gcsafe.} =
|
2019-09-04 22:00:39 +00:00
|
|
|
try:
|
2020-06-29 15:15:31 +00:00
|
|
|
await s.upgradeIncoming(conn) # perform upgrade on incoming connection
|
2020-05-15 03:56:56 +00:00
|
|
|
except CancelledError as exc:
|
|
|
|
raise exc
|
2019-12-04 04:44:54 +00:00
|
|
|
except CatchableError as exc:
|
2020-03-27 14:25:52 +00:00
|
|
|
trace "Exception occurred in Switch.start", exc = exc.msg
|
2020-07-17 15:36:48 +00:00
|
|
|
finally:
|
|
|
|
await conn.close()
|
2020-02-25 22:13:05 +00:00
|
|
|
|
2019-09-12 00:15:04 +00:00
|
|
|
var startFuts: seq[Future[void]]
|
2019-08-28 02:30:53 +00:00
|
|
|
for t in s.transports: # for each transport
|
2019-09-28 19:54:32 +00:00
|
|
|
for i, a in s.peerInfo.addrs:
|
2019-08-28 02:30:53 +00:00
|
|
|
if t.handles(a): # check if it handles the multiaddr
|
2020-05-05 15:55:02 +00:00
|
|
|
var server = await t.listen(a, handle)
|
2019-09-28 19:54:32 +00:00
|
|
|
s.peerInfo.addrs[i] = t.ma # update peer's address
|
2019-09-12 00:15:04 +00:00
|
|
|
startFuts.add(server)
|
2019-12-08 21:06:58 +00:00
|
|
|
|
2020-08-03 05:20:11 +00:00
|
|
|
debug "started libp2p node", peer = $s.peerInfo, addrs = s.peerInfo.addrs
|
2019-09-12 00:15:04 +00:00
|
|
|
result = startFuts # listen for incoming connections
|
2019-08-27 21:46:12 +00:00
|
|
|
|
2019-12-08 21:06:58 +00:00
|
|
|
proc stop*(s: Switch) {.async.} =
|
2020-06-29 15:15:31 +00:00
|
|
|
trace "stopping switch"
|
|
|
|
|
2020-07-17 15:36:48 +00:00
|
|
|
# close and cleanup all connections
|
|
|
|
await s.connManager.close()
|
2019-09-06 07:13:47 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
for t in s.transports:
|
|
|
|
try:
|
|
|
|
await t.close()
|
|
|
|
except CancelledError as exc:
|
|
|
|
raise exc
|
|
|
|
except CatchableError as exc:
|
|
|
|
warn "error cleaning up transports"
|
|
|
|
|
|
|
|
trace "switch stopped"
|
2020-04-21 01:24:42 +00:00
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
proc muxerHandler(s: Switch, muxer: Muxer) {.async, gcsafe.} =
|
2020-08-17 11:29:45 +00:00
|
|
|
if muxer.connection.peerInfo.isNil:
|
|
|
|
warn "This version of nim-libp2p requires secure protocol to negotiate peerid"
|
|
|
|
await muxer.close()
|
|
|
|
return
|
2020-06-29 15:15:31 +00:00
|
|
|
|
2020-08-17 11:29:45 +00:00
|
|
|
# store incoming connection
|
|
|
|
s.connManager.storeIncoming(muxer.connection)
|
2020-06-29 15:15:31 +00:00
|
|
|
|
2020-08-17 11:29:45 +00:00
|
|
|
# store muxer and muxed connection
|
|
|
|
s.connManager.storeMuxer(muxer)
|
2020-06-29 15:15:31 +00:00
|
|
|
|
2020-08-17 11:29:45 +00:00
|
|
|
try:
|
|
|
|
await s.identify(muxer)
|
2020-09-04 18:30:26 +00:00
|
|
|
except CatchableError as exc:
|
|
|
|
# Identify is non-essential, though if it fails, it might indicate that
|
|
|
|
# the connection was closed already - this will be picked up by the read
|
|
|
|
# loop
|
|
|
|
debug "Could not identify connection", err = exc.msg
|
2020-08-08 06:52:20 +00:00
|
|
|
|
2020-09-04 18:30:26 +00:00
|
|
|
try:
|
2020-08-17 11:29:45 +00:00
|
|
|
let peerId = muxer.connection.peerInfo.peerId
|
2020-08-08 06:52:20 +00:00
|
|
|
|
2020-09-04 16:30:45 +00:00
|
|
|
proc peerCleanup() {.async.} =
|
|
|
|
try:
|
|
|
|
await muxer.connection.closeEvent.wait()
|
|
|
|
await s.triggerConnEvent(peerId,
|
|
|
|
ConnEvent(kind: ConnEventKind.Disconnected))
|
|
|
|
except CancelledError:
|
|
|
|
# This is top-level procedure which will work as separate task, so it
|
|
|
|
# do not need to propogate CancelledError.
|
2020-09-04 18:30:26 +00:00
|
|
|
debug "Unexpected cancellation in switch muxer cleanup"
|
2020-09-04 16:30:45 +00:00
|
|
|
except CatchableError as exc:
|
2020-09-04 18:30:26 +00:00
|
|
|
debug "Unexpected exception in switch muxer cleanup",
|
2020-09-04 16:30:45 +00:00
|
|
|
errMsg = exc.msg
|
|
|
|
|
|
|
|
proc peerStartup() {.async.} =
|
|
|
|
try:
|
|
|
|
await s.triggerConnEvent(peerId,
|
|
|
|
ConnEvent(kind: ConnEventKind.Connected,
|
|
|
|
incoming: true))
|
|
|
|
except CancelledError:
|
|
|
|
# This is top-level procedure which will work as separate task, so it
|
|
|
|
# do not need to propogate CancelledError.
|
2020-09-04 18:30:26 +00:00
|
|
|
debug "Unexpected cancellation in switch muxer startup"
|
2020-09-04 16:30:45 +00:00
|
|
|
except CatchableError as exc:
|
2020-09-04 18:30:26 +00:00
|
|
|
debug "Unexpected exception in switch muxer startup",
|
2020-09-04 16:30:45 +00:00
|
|
|
errMsg = exc.msg
|
|
|
|
|
|
|
|
# All the errors are handled inside `peerStartup()` procedure.
|
|
|
|
asyncSpawn peerStartup()
|
2020-07-08 00:33:05 +00:00
|
|
|
|
2020-09-04 18:30:26 +00:00
|
|
|
# All the errors are handled inside `peerCleanup()` procedure.
|
|
|
|
asyncSpawn peerCleanup()
|
|
|
|
|
2020-06-29 15:15:31 +00:00
|
|
|
except CancelledError as exc:
|
|
|
|
await muxer.close()
|
|
|
|
raise exc
|
|
|
|
except CatchableError as exc:
|
|
|
|
await muxer.close()
|
|
|
|
libp2p_failed_upgrade.inc()
|
|
|
|
trace "exception in muxer handler", exc = exc.msg
|
|
|
|
|
2019-09-06 07:13:47 +00:00
|
|
|
proc newSwitch*(peerInfo: PeerInfo,
|
|
|
|
transports: seq[Transport],
|
|
|
|
identity: Identify,
|
2019-09-09 17:33:32 +00:00
|
|
|
muxers: Table[string, MuxerProvider],
|
2020-08-12 00:05:49 +00:00
|
|
|
secureManagers: openarray[Secure] = []): Switch =
|
2020-07-07 11:14:11 +00:00
|
|
|
if secureManagers.len == 0:
|
|
|
|
raise (ref CatchableError)(msg: "Provide at least one secure manager")
|
|
|
|
|
|
|
|
result = Switch(
|
|
|
|
peerInfo: peerInfo,
|
|
|
|
ms: newMultistream(),
|
|
|
|
transports: transports,
|
2020-07-17 15:36:48 +00:00
|
|
|
connManager: ConnManager.init(),
|
2020-07-07 11:14:11 +00:00
|
|
|
identity: identity,
|
|
|
|
muxers: muxers,
|
|
|
|
secureManagers: @secureManagers,
|
|
|
|
)
|
2019-09-06 07:13:47 +00:00
|
|
|
|
|
|
|
let s = result # can't capture result
|
2019-12-08 21:06:58 +00:00
|
|
|
result.streamHandler = proc(stream: Connection) {.async, gcsafe.} =
|
2020-05-23 19:25:53 +00:00
|
|
|
try:
|
2020-06-09 18:42:52 +00:00
|
|
|
trace "handling connection for", peerInfo = $stream
|
2020-06-29 15:15:31 +00:00
|
|
|
defer:
|
|
|
|
if not(isNil(stream)):
|
2020-05-23 19:25:53 +00:00
|
|
|
await stream.close()
|
2020-06-29 15:15:31 +00:00
|
|
|
await s.ms.handle(stream) # handle incoming connection
|
|
|
|
except CancelledError as exc:
|
|
|
|
raise exc
|
2020-05-23 19:25:53 +00:00
|
|
|
except CatchableError as exc:
|
2020-06-02 17:32:42 +00:00
|
|
|
trace "exception in stream handler", exc = exc.msg
|
2019-09-06 07:13:47 +00:00
|
|
|
|
|
|
|
result.mount(identity)
|
|
|
|
for key, val in muxers:
|
|
|
|
val.streamHandler = result.streamHandler
|
2020-06-29 15:15:31 +00:00
|
|
|
val.muxerHandler = proc(muxer: Muxer): Future[void] =
|
|
|
|
s.muxerHandler(muxer)
|
2020-05-21 17:33:48 +00:00
|
|
|
|
2020-08-12 00:05:49 +00:00
|
|
|
proc isConnected*(s: Switch, peerInfo: PeerInfo): bool
|
|
|
|
{.deprecated: "Use PeerID version".} =
|
2020-08-06 07:29:27 +00:00
|
|
|
not isNil(peerInfo) and isConnected(s, peerInfo.peerId)
|
|
|
|
|
2020-08-12 00:05:49 +00:00
|
|
|
proc disconnect*(s: Switch, peerInfo: PeerInfo): Future[void]
|
|
|
|
{.deprecated: "Use PeerID version", gcsafe.} =
|
2020-08-06 07:29:27 +00:00
|
|
|
disconnect(s, peerInfo.peerId)
|
|
|
|
|
2020-08-12 00:05:49 +00:00
|
|
|
proc connect*(s: Switch, peerInfo: PeerInfo): Future[void]
|
|
|
|
{.deprecated: "Use PeerID version".} =
|
2020-08-06 07:29:27 +00:00
|
|
|
connect(s, peerInfo.peerId, peerInfo.addrs)
|
|
|
|
|
|
|
|
proc dial*(s: Switch,
|
|
|
|
peerInfo: PeerInfo,
|
|
|
|
proto: string):
|
2020-08-12 00:05:49 +00:00
|
|
|
Future[Connection]
|
|
|
|
{.deprecated: "Use PeerID version".} =
|
2020-08-06 07:29:27 +00:00
|
|
|
dial(s, peerInfo.peerId, peerInfo.addrs, proto)
|