-
Notifications
You must be signed in to change notification settings - Fork 0
/
handshaker.go
292 lines (261 loc) · 8.47 KB
/
handshaker.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
package connections
import (
"context"
"strings"
"time"
"github.com/bloxapp/ssv/network/peers"
"github.com/bloxapp/ssv/network/records"
"github.com/bloxapp/ssv/network/streams"
forksprotocol "github.com/bloxapp/ssv/protocol/forks"
libp2pnetwork "github.com/libp2p/go-libp2p/core/network"
"github.com/libp2p/go-libp2p/core/peer"
"github.com/libp2p/go-libp2p/core/peerstore"
"github.com/libp2p/go-libp2p/p2p/protocol/identify"
ma "github.com/multiformats/go-multiaddr"
"github.com/pkg/errors"
"github.com/stakestar/startracker/db"
"github.com/stakestar/startracker/geodata"
"go.uber.org/zap"
)
const (
// userAgentKey is the key used by libp2p to save user agent
userAgentKey = "AgentVersion"
)
// errHandshakeInProcess is thrown when and handshake process for that peer is already running
var errHandshakeInProcess = errors.New("handshake already in process")
// errUnknownUserAgent is thrown when a peer has an unknown user agent
var errUnknownUserAgent = errors.New("user agent is unknown")
// HandshakeFilter can be used to filter nodes once we handshaked with them
type HandshakeFilter func(info *records.NodeInfo) (bool, error)
// Handshaker is the interface for handshaking with peers.
// it uses node info protocol to exchange information with other nodes and decide whether we want to connect.
//
// NOTE: due to compatibility with v0,
// we accept nodes with user agent as a fallback when the new protocol is not supported.
type Handshaker interface {
Handshake(logger *zap.Logger, conn libp2pnetwork.Conn) error
Handler(logger *zap.Logger) libp2pnetwork.StreamHandler
}
type handshaker struct {
ctx context.Context
logger *zap.Logger
streams streams.StreamController
nodeInfoIdx peers.NodeInfoIndex
states peers.NodeStates
connIdx peers.ConnectionIndex
ids identify.IDService
net libp2pnetwork.Network
db *db.BoltDB
geodata *geodata.GeoIP2DB
}
// HandshakerCfg is the configuration for creating an handshaker instance
type HandshakerCfg struct {
Logger *zap.Logger
Network libp2pnetwork.Network
Streams streams.StreamController
NodeInfoIdx peers.NodeInfoIndex
States peers.NodeStates
ConnIdx peers.ConnectionIndex
IDService identify.IDService
}
// NewHandshaker creates a new instance of handshaker
func NewHandshaker(ctx context.Context, cfg *HandshakerCfg, db *db.BoltDB, geoData *geodata.GeoIP2DB) Handshaker {
h := &handshaker{
ctx: ctx,
logger: cfg.Logger.With(zap.String("where", "Handshaker")),
streams: cfg.Streams,
nodeInfoIdx: cfg.NodeInfoIdx,
connIdx: cfg.ConnIdx,
ids: cfg.IDService,
states: cfg.States,
net: cfg.Network,
db: db,
geodata: geoData,
}
return h
}
// Handler returns the handshake handler
func (h *handshaker) Handler(logger *zap.Logger) libp2pnetwork.StreamHandler {
return func(stream libp2pnetwork.Stream) {
// start by marking the peer as pending
pid := stream.Conn().RemotePeer()
maddr := stream.Conn().RemoteMultiaddr()
pidStr := pid.String()
req, res, done, err := h.streams.HandleStream(logger, stream)
defer done()
if err != nil {
return
}
logger := h.logger.With(zap.String("otherPeer", pidStr))
var ni records.NodeInfo
err = ni.Consume(req)
if err != nil {
logger.Warn("could not consume node info request", zap.Error(err))
return
}
// process the node info in a new goroutine so we won't block the stream
go func() {
h.processIncomingNodeInfo(maddr, ni)
}()
self, err := h.nodeInfoIdx.SelfSealed()
if err != nil {
logger.Warn("could not seal self node info", zap.Error(err))
return
}
if err := res(self); err != nil {
logger.Warn("could not send self node info", zap.Error(err))
return
}
}
}
func (h *handshaker) processIncomingNodeInfo(maddr ma.Multiaddr, ni records.NodeInfo) {
ip, err := h.getIPAddressFromMultiaddr(maddr)
if err != nil {
h.logger.Warn("could not get ip address from multiaddr", zap.Error(err))
}
ipGeoData, err := h.geodata.GetGeoDataFromIPAddress(ip)
if err != nil {
h.logger.Warn("could not get geo data from ip address", zap.Error(err))
}
geoData := &db.GeoData{
City: ipGeoData.City.Names["en"],
CountryName: ipGeoData.Country.Names["en"],
CountryCode: ipGeoData.Country.IsoCode,
Latitude: ipGeoData.Location.Latitude,
Longitude: ipGeoData.Location.Longitude,
AccuracyRadius: ipGeoData.Location.AccuracyRadius,
}
if ni.Metadata.OperatorID != "" {
nodeData := &db.NodeData{
IPAddress: ip,
GeoData: *geoData,
NodeVersion: ni.Metadata.NodeVersion,
OperatorID: ni.Metadata.OperatorID,
}
h.logger.Info("Node Data", zap.Any("data", nodeData))
h.db.StoreNodeData(nodeData)
}
}
// preHandshake makes sure that we didn't reach peers limit and have exchanged framework information (libp2p)
// with the peer on the other side of the connection.
// it should enable us to know the supported protocols of peers we connect to
func (h *handshaker) preHandshake(conn libp2pnetwork.Conn) error {
ctx, cancel := context.WithTimeout(h.ctx, time.Second*15)
defer cancel()
select {
case <-ctx.Done():
return errors.New("identity protocol (libp2p) timeout")
case <-h.ids.IdentifyWait(conn):
}
return nil
}
// Handshake initiates handshake with the given conn
func (h *handshaker) Handshake(logger *zap.Logger, conn libp2pnetwork.Conn) error {
pid := conn.RemotePeer()
maddr := conn.RemoteMultiaddr()
// check if the peer is known before we continue
ni, err := h.getNodeInfo(pid)
if err != nil || ni != nil {
return err
}
if err := h.preHandshake(conn); err != nil {
return errors.Wrap(err, "could not perform pre-handshake")
}
ni, err = h.nodeInfoFromStream(logger, conn)
if err != nil {
// fallbacks to user agent
ni, err = h.nodeInfoFromUserAgent(logger, conn)
if err != nil {
return err
}
}
if ni == nil {
return errors.New("empty node info")
}
h.processIncomingNodeInfo(maddr, *ni)
return nil
}
func (h *handshaker) getNodeInfo(pid peer.ID) (*records.NodeInfo, error) {
ni, err := h.nodeInfoIdx.GetNodeInfo(pid)
if err != nil && err != peers.ErrNotFound {
return nil, errors.Wrap(err, "could not read node info")
}
if ni != nil {
switch h.states.State(pid) {
case peers.StateIndexing:
return nil, errHandshakeInProcess
case peers.StatePruned:
return nil, errors.Errorf("pruned peer [%s]", pid.String())
case peers.StateReady:
return ni, nil
default: // unknown > continue the flow
}
}
return nil, nil
}
func (h *handshaker) nodeInfoFromStream(logger *zap.Logger, conn libp2pnetwork.Conn) (*records.NodeInfo, error) {
res, err := h.net.Peerstore().FirstSupportedProtocol(conn.RemotePeer(), peers.NodeInfoProtocol)
if err != nil {
return nil, errors.Wrapf(err, "could not check supported protocols of peer %s",
conn.RemotePeer().String())
}
data, err := h.nodeInfoIdx.SelfSealed()
if err != nil {
return nil, err
}
if len(res) == 0 {
return nil, errors.Errorf("peer [%s] doesn't supports handshake protocol", conn.RemotePeer().String())
}
resBytes, err := h.streams.Request(logger, conn.RemotePeer(), peers.NodeInfoProtocol, data)
if err != nil {
return nil, err
}
var ni records.NodeInfo
err = ni.Consume(resBytes)
if err != nil {
return nil, err
}
return &ni, nil
}
func (h *handshaker) nodeInfoFromUserAgent(logger *zap.Logger, conn libp2pnetwork.Conn) (*records.NodeInfo, error) {
pid := conn.RemotePeer()
uaRaw, err := h.net.Peerstore().Get(pid, userAgentKey)
if err != nil {
if err == peerstore.ErrNotFound {
// if user agent wasn't found, retry libp2p identify after 100ms
time.Sleep(time.Millisecond * 100)
if err := h.preHandshake(conn); err != nil {
return nil, err
}
uaRaw, err = h.net.Peerstore().Get(pid, userAgentKey)
if err != nil {
return nil, err
}
} else {
return nil, err
}
}
ua, ok := uaRaw.(string)
if !ok {
return nil, errors.New("could not cast ua to string")
}
parts := strings.Split(ua, ":")
if len(parts) < 2 { // too old or unknown
logger.Debug("user agent is unknown", zap.String("ua", ua))
return nil, errUnknownUserAgent
}
// TODO: don't assume network is the same
ni := records.NewNodeInfo(forksprotocol.GenesisForkVersion, h.nodeInfoIdx.Self().NetworkID)
ni.Metadata = &records.NodeMetadata{
NodeVersion: parts[1],
}
// extract operator id if exist
if len(parts) > 3 {
ni.Metadata.OperatorID = parts[3]
}
return ni, nil
}
func (h *handshaker) getIPAddressFromMultiaddr(maddr ma.Multiaddr) (string, error) {
ip, _ := ma.SplitFirst(maddr)
return ip.Value(), nil
}