KRPC 协议是由 bencode 编码组成的一个简单的 r
PC 结构,他使用 UDP 报文发送。一个独立的请求包被发出去然后一个独立的包被回复。
这个协议没有重发。它包含 3 种消息:请求,回复和错误。对DHT协议而言,这里有 4 种请求:ping
,find_node
,get_peers
和 announce_peer
。
一条 KRPC 消息由一个独立的字典组成,其中有 2 个关键字是所有的消息都包含的,其余的附加关键字取决于消息类型。
关键字`t`:它是一个代表了 transaction ID 的字符串类型。
transaction ID 由请求节点产生,并且回复中要包含回显该字段,所以回复可能对应一个节点的多个请求。transaction ID 应当被编码为一个短的二进制字符串,比如 2 个字节,这样就可以对应 2^16 个请求。
关键字 `y`:它由一个字节组成,表明这个消息的类型。
y
对应的值有三种情况:
q
表示请求
r
表示回复
e
表示错误。
联系信息编码 Contact Encoding
Peers 的联系信息被编码为 6 字节的字符串。又被称为 "Compact IP-address/port info"。 其中前 4 个字节是网络字节序的 IP 地址,后 2 个字节是网络字节序的端口。
节点的联系信息被编码为 26 字节的字符串。又被称为 "Compact node info",其中前 20 字节是网络字节序的节点 ID,后面 6 个字节是 peers 的 "Compact IP-address/port info"。
请求 Queries
请求,对应于 KPRC 消息字典中的 y
关键字的值是 q
,它包含 2 个附加的关键字 q
和 a
:
关键字 q
是字符串类型,包含了请求的方法名字。
关键字 a
一个字典类型包含了请求所附加的参数。
# 定义请求方法名称和请求参数
request_method = 'find_node' # 请求方法名
request_params = {
'id': '1234567890abcdef', # 发起请求的节点ID
'target': '0123456789abcdef', # 目标节点ID
'tid': 'unique123' # 事务ID
}
# 构建KRPC请求消息
krpc_request = {
b'y': 'q', # y关键字表示这是一个请求
b'q': request_method, # q关键字包含请求的方法名字
b'a': request_params # a关键字包含请求的参数,这里是一个字典类型
}
# 输出构建好的KRPC请求字典
print(krpc_request)
回复 responses
回复,对应于 KPRC 消息字典中的 y
关键字的值是 r
,包含了一个附加的关键字 r
。关键字 r
是字典类型,包含了返回的值。发送回复消息是在正确解析了请求消息的基础上完成的。
# 假设这是DHT查询的响应数据
dht_response = {
b'id': '1234567890abcdef', # 节点ID
b'nodes': '1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t1u2v3w4x5y6z', # 其他节点信息
b'token': 'abc123', # 认证令牌
b'values': ['value1', 'value2'] # 查询结果
}
# 构建KRPC回复消息
krpc_reply = {
b'y': 'r', # y关键字表示这是一个回复
b'r': dht_response # r关键字包含实际的回复数据,这里是一个字典类型
}
# 输出构建好的KRPC回复字典
print(krpc_reply)
错误 Errors
错误,对应于 KPRC 消息字典中的 y
关键字的值是 e,包含一个附加的关键字 e。关键字 e 是列表类型。
第一个元素是数字类型,表明了错误码。
第二个元素是字符串类型,表明了错误信息。
当一个请求不能解析或出错时,错误包将被发送。下表描述了可能出现的错误码:
201 一般错误 202 服务错误 203 协议错误,比如不规范的包,无效的参数,或者错误的 toke 204 未知方法
错误包例子:
generic error = {"t":"aa", "y":"e", "e":[201, "A Generic Error Ocurred"]}
bencoded = d1:eli201e23:A Generic Error Ocurrede1:t2:aa1:y1:ee
DHT 请求 DHT Queries
所有的请求都包含一个关键字 id,它包含了请求节点的节点 ID。所有的回复也包含关键字id,它包含了回复节点的节点 ID。
ping:
最基础的请求就是 ping。这时 KPRC 协议中的 "q" = "ping"。Ping 请求包含一个参数 id,它是一个 20 字节的字符串包含了发送者网络字节序的节点 ID。对应的 ping 回复也包含一个参数 id,包含了回复者的节点 ID。
参数: {"id" : "
报文包例子:
ping_Query = {"t":"aa", "y":"q", "q":"ping", "a":{"id":"abcdefghij0123456789"}}
bencoded = d1:ad2:id20:abcdefghij0123456789e1:q4:ping1:t2:aa1:y1:qe
Response = {"t":"aa", "y":"r", "r": {"id":"mnopqrstuvwxyz123456"}}
bencoded = d1:rd2:id20:mnopqrstuvwxyz123456e1:t2:aa1:y1:re
find_node
find_node 被用来查找给定 ID 的节点的联系信息。这时 KPRC 协议中的 "q" == "find_node"。 find_node 请求包含 2 个参数:
第一个参数是 id,包含了请求节点的ID。
第二个参数是 target,包含了请求者正在查找的节点的 ID。
当一个节点接收到了 find_node 的请求,他应该给出对应的回复,回复中包含 2 个关键字 id 和 nodes,nodes 是字符串类型,包含了被请求节点的路由表中最接近目标节点的 K(8) 个最接近的节点的联系信息。
参数: {"id" : "<querying nodes id>", "target" : "<id of target node>"}
回复: {"id" : "<queried nodes id>", "nodes" : "<compact node info>"}
报文包例子:
find_node Query = {"t":"aa", "y":"q", "q":"find_node", "a": {"id":"abcdefghij0123456789", "target":"mnopqrstuvwxyz123456"}}
bencoded = d1:ad2:id20:abcdefghij01234567896:target20:mnopqrstuvwxyz123456e1:q9:find_node1:t2:aa1:y1:qe
Response = {"t":"aa", "y":"r", "r": {"id":"0123456789abcdefghij", "nodes": "def456..."}}
bencoded = d1:rd2:id20:0123456789abcdefghij5:nodes9:def456...e1:t2:aa1:y1:re
get_peers
get_peers 与 torrent 文件的 infohash 有关。这时 KPRC 协议中的 "q" = "get_peers"。 get_peers 请求包含 2 个参数:
第一个参数是 id,包含了请求节点的 ID。
第二个参数是 info_hash,它代表 torrent 文件的 infohash。
如果被请求的节点有对应 info_hash 的 peers,他将返回一个关键字 values,这是一个列表类型的字符串。每一个字符串包含了 "Compact IP-address/portinfo" 格式的 peers 信息。 如果被请求的节点没有这个 infohash 的 peers,那么他将返回关键字 nodes,这个关键字包含了被请求节点的路由表中离 info_hash 最近的 K 个节点,使用 "Compactnodeinfo" 格式回复。 在这两种情况下,关键字 token 都将被返回。token 关键字在今后的 annouce_peer 请求中必须要携带。token 是一个短的二进制字符串。
参数: {"id" : "
get_peers Query = {"t":"aa", "y":"q", "q":"get_peers", "a": {"id":"abcdefghij0123456789", "info_hash":"mnopqrstuvwxyz123456"}}
bencoded = d1:ad2:id20:abcdefghij01234567899:info_hash20:mnopqrstuvwxyz123456e1:q9:get_peers1:t2:aa1:y1:qe
Response with peers = {"t":"aa", "y":"r", "r": {"id":"abcdefghij0123456789", "token":"aoeusnth", "values": ["axje.u", "idhtnm"]}}
bencoded = d1:rd2:id20:abcdefghij01234567895:token8:aoeusnth6:valuesl6:axje.u6:idhtnmee1:t2:aa1:y1:re
Response with closest nodes = {"t":"aa", "y":"r", "r": {"id":"abcdefghij0123456789", "token":"aoeusnth", "nodes": "def456..."}}
bencoded = d1:rd2:id20:abcdefghij01234567895:nodes9:def456...5:token8:aoeusnthe1:t2:aa1:y1:re
announce_peer
这个请求用来表明发出 announce_peer 请求的节点,正在某个端口下载 torrent 文件。 announce_peer 包含 4 个参数:
第一个参数是 id,包含了请求节点的 ID;
第二个参数是 info_hash,包含了 torrent 文件的 infohash;
第三个参数是 port 包含了整型的端口号,表明 peer 在哪个端口下载;
第四个参数数是 token,这是在之前的 get_peers 请求中收到的回复中包含的。
收到 announce_peer 请求的节点必须检查这个 token 与之前我们回复给这个节点 get_peers 的 token 是否相同。如果相同,那么被请求的节点将记录发送 announce_peer 节点的 IP 和请求中包含的 port 端口号在 peer 联系信息中对应的 infohash 下。
参数: {"id" : "<querying nodes id>", "implied_port": <0 or 1>, "info_hash" : "<20-byte infohash of target torrent>", "port" : <port number>, "token" : "<opaque token>"}
回复: {"id" : "<queried nodes id>"}
报文包例子:
announce_peers Query = {"t":"aa", "y":"q", "q":"announce_peer", "a": {"id":"abcdefghij0123456789", "implied_port": 1, "info_hash":"mnopqrstuvwxyz123456", "port": 6881, "token": "aoeusnth"}}
bencoded = d1:ad2:id20:abcdefghij01234567899:info_hash20:<br /> mnopqrstuvwxyz1234564:porti6881e5:token8:aoeusnthe1:q13:announce_peer1:t2:aa1:y1:qe
Response = {"t":"aa", "y":"r", "r": {"id":"mnopqrstuvwxyz123456"}}
bencoded = d1:rd2:id20:mnopqrstuvwxyz123456e1:t2:aa1:y1:re