nim-libp2p/libp2p/protocols/identify.nim

153 lines
4.6 KiB
Nim
Raw Normal View History

2019-08-28 02:30:53 +00:00
## Nim-LibP2P
2019-09-24 17:48:23 +00:00
## Copyright (c) 2019 Status Research & Development GmbH
2019-08-28 02:30:53 +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.
import options
2019-09-09 17:33:32 +00:00
import chronos, chronicles
2019-09-08 07:43:33 +00:00
import ../protobuf/minprotobuf,
../peerinfo,
../connection,
../peer,
../crypto/crypto,
../multiaddress,
2019-09-09 17:33:32 +00:00
../protocols/protocol
2019-08-28 02:30:53 +00:00
2019-09-10 02:15:52 +00:00
logScope:
topic = "identify"
2019-10-04 16:04:21 +00:00
const
IdentifyCodec* = "/ipfs/id/1.0.0"
IdentifyPushCodec* = "/ipfs/id/push/1.0.0"
ProtoVersion* = "ipfs/0.1.0"
AgentVersion* = "nim-libp2p/0.0.1"
2019-08-28 02:30:53 +00:00
2019-08-30 15:28:07 +00:00
#TODO: implment push identify, leaving out for now as it is not essential
2019-08-28 02:30:53 +00:00
type
IdentityNoMatchError* = object of CatchableError
IdentityInvalidMsgError* = object of CatchableError
2019-08-28 02:30:53 +00:00
2019-08-30 05:16:30 +00:00
IdentifyInfo* = object
2019-09-11 16:14:20 +00:00
pubKey*: Option[PublicKey]
2019-08-30 05:16:30 +00:00
addrs*: seq[MultiAddress]
2019-09-11 16:14:20 +00:00
observedAddr*: Option[MultiAddress]
protoVersion*: Option[string]
agentVersion*: Option[string]
protos*: seq[string]
2019-08-28 02:30:53 +00:00
2019-08-30 05:16:30 +00:00
Identify* = ref object of LPProtocol
2019-09-03 20:39:28 +00:00
peerInfo*: PeerInfo
2019-08-28 02:30:53 +00:00
2019-08-30 05:16:30 +00:00
proc encodeMsg*(peerInfo: PeerInfo, observedAddrs: Multiaddress): ProtoBuffer =
result = initProtoBuffer()
2019-09-11 16:14:20 +00:00
if peerInfo.peerId.isSome:
result.write(initProtoField(1, peerInfo.peerId.get().publicKey.get().getBytes()))
2019-09-11 16:14:20 +00:00
2019-08-30 05:16:30 +00:00
for ma in peerInfo.addrs:
result.write(initProtoField(2, ma.data.buffer))
for proto in peerInfo.protocols:
result.write(initProtoField(3, proto))
result.write(initProtoField(4, observedAddrs.data.buffer))
let protoVersion = ProtoVersion
result.write(initProtoField(5, protoVersion))
let agentVersion = AgentVersion
result.write(initProtoField(6, agentVersion))
result.finish()
2019-08-30 05:16:30 +00:00
proc decodeMsg*(buf: seq[byte]): IdentifyInfo =
var pb = initProtoBuffer(buf)
2019-09-11 16:14:20 +00:00
result.pubKey = none(PublicKey)
var pubKey: PublicKey
if pb.getValue(1, pubKey) > 0:
trace "read public key from message", pubKey = pubKey
2019-09-11 16:14:20 +00:00
result.pubKey = some(pubKey)
2019-08-30 05:16:30 +00:00
result.addrs = newSeq[MultiAddress]()
var address = newSeq[byte]()
2019-09-10 02:15:52 +00:00
while pb.getBytes(2, address) > 0:
if len(address) != 0:
var copyaddr = address
var ma = MultiAddress.init(copyaddr)
result.addrs.add(ma)
trace "read address bytes from message", address = ma
address.setLen(0)
var proto = ""
while pb.getString(3, proto) > 0:
trace "read proto from message", proto = proto
result.protos.add(proto)
2019-09-01 21:52:02 +00:00
proto = ""
2019-08-30 05:16:30 +00:00
var observableAddr = newSeq[byte]()
if pb.getBytes(4, observableAddr) > 0: # attempt to read the observed addr
var ma = MultiAddress.init(observableAddr)
trace "read observedAddr from message", address = ma
result.observedAddr = some(ma)
2019-09-11 16:14:20 +00:00
var protoVersion = ""
if pb.getString(5, protoVersion) > 0:
trace "read protoVersion from message", protoVersion = protoVersion
2019-09-11 16:14:20 +00:00
result.protoVersion = some(protoVersion)
2019-09-11 16:14:20 +00:00
var agentVersion = ""
if pb.getString(6, agentVersion) > 0:
trace "read agentVersion from message", agentVersion = agentVersion
2019-09-11 16:14:20 +00:00
result.agentVersion = some(protoVersion)
2019-09-03 20:39:28 +00:00
proc newIdentify*(peerInfo: PeerInfo): Identify =
new result
result.peerInfo = peerInfo
result.init()
2019-08-30 23:45:57 +00:00
method init*(p: Identify) =
2019-09-02 20:45:52 +00:00
proc handle(conn: Connection, proto: string) {.async, gcsafe, closure.} =
trace "handling identify request"
2019-08-30 23:45:57 +00:00
var pb = encodeMsg(p.peerInfo, await conn.getObservedAddrs())
await conn.writeLp(pb.buffer)
# await conn.close() #TODO: investigate why this breaks
2019-08-30 23:45:57 +00:00
p.handler = handle
p.codec = IdentifyCodec
2019-08-30 23:45:57 +00:00
proc identify*(p: Identify,
conn: Connection,
remotePeerInfo: PeerInfo): Future[IdentifyInfo] {.async, gcsafe.} =
var message = await conn.readLp()
if len(message) == 0:
trace "identify: Invalid or empty message received!"
raise newException(IdentityInvalidMsgError,
"Invalid or empty message received!")
2019-08-30 05:16:30 +00:00
result = decodeMsg(message)
2019-09-11 16:14:20 +00:00
if remotePeerInfo.peerId.isSome and result.pubKey.isSome:
let peer = PeerID.init(result.pubKey.get())
# do a string comaprison of the ids,
# because that is the only thing we have in most cases
2019-10-08 20:39:45 +00:00
if peer != remotePeerInfo.peerId.get():
trace "Peer ids don't match",
remote = peer.pretty(),
local = remotePeerInfo.id
raise newException(IdentityNoMatchError,
"Peer ids don't match")
trace "Identify for remote peer succeded"
2019-08-30 05:16:30 +00:00
proc push*(p: Identify, conn: Connection) {.async.} =
await conn.write(IdentifyPushCodec)
var pb = encodeMsg(p.peerInfo, await conn.getObservedAddrs())
await conn.writeLp(pb.buffer)