/
wrapper.go
398 lines (362 loc) · 11.2 KB
/
wrapper.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
package protocol
import (
"bytes"
"errors"
"fmt"
"io"
"math/rand"
"runtime"
"time"
"github.com/libp2p/go-libp2p/core"
"github.com/33cn/chain33/common/log/log15"
"github.com/33cn/chain33/queue"
types2 "github.com/33cn/chain33/system/p2p/dht/types"
"github.com/33cn/chain33/types"
"github.com/libp2p/go-libp2p/core/crypto"
"github.com/libp2p/go-libp2p/core/network"
"github.com/libp2p/go-msgio"
)
var log = log15.New("module", "p2p.protocol")
func init() {
rand.Seed(time.Now().UnixNano())
}
const messageHeaderLen = 17
var (
messageHeader = headerSafe([]byte("/protobuf/msgio"))
)
// ReadStream reads message from stream.
func ReadStream(data types.Message, stream network.Stream) error {
// 兼容历史版本header数据,需要优先读取
var header [messageHeaderLen]byte
_, err := io.ReadFull(stream, header[:])
if err != nil || !bytes.Equal(header[:], messageHeader) {
log.Error("ReadStream", "pid", stream.Conn().RemotePeer().Pretty(), "protocolID", stream.Protocol(), "read header err", err)
return err
}
reader := msgio.NewReaderSize(stream, types.MaxBlockSize)
msg, err := reader.ReadMsg()
// 内部使用了内存池, 回收内存
defer reader.ReleaseMsg(msg)
if err != nil {
log.Error("ReadStream", "pid", stream.Conn().RemotePeer().Pretty(), "protocolID", stream.Protocol(), "read msg err", err)
return err
}
err = types.Decode(msg, data)
if err != nil {
log.Error("ReadStream", "pid", stream.Conn().RemotePeer().Pretty(), "protocolID", stream.Protocol(), "decode err", err)
return err
}
return nil
}
// WriteStream writes message to stream.
func WriteStream(data types.Message, stream network.Stream) error {
_, err := stream.Write(messageHeader)
if err != nil {
log.Error("WriteStream", "pid", stream.Conn().RemotePeer().Pretty(), "protocolID", stream.Protocol(), "write header err", err)
return err
}
msg := types.Encode(data)
writer := msgio.NewWriter(stream)
err = writer.WriteMsg(msg)
if err != nil {
log.Error("WriteStream", "pid", stream.Conn().RemotePeer().Pretty(), "protocolID", stream.Protocol(), "write msg err", err)
return err
}
return nil
}
// CloseStream closes the stream after writing, and waits for the EOF.
func CloseStream(stream network.Stream) {
if stream == nil {
return
}
_ = stream.CloseWrite()
_ = stream.CloseRead()
go func() {
err := AwaitEOF(stream)
if err != nil {
//just log it because it dose not matter
log.Debug("CloseStream", "err", err, "protocol ID", stream.Protocol())
}
}()
}
// AuthenticateMessage authenticates p2p message.
func AuthenticateMessage(message types.Message, stream network.Stream) bool {
var sign, bin []byte
// store a temp ref to signature and remove it from message data
// sign is a string to allow easy reset to zero-value (empty string)
switch t := message.(type) {
case *types.P2PRequest:
sign = t.Headers.Sign
t.Headers.Sign = nil
// marshall data without the signature to protobuf3 binary format
bin = types.Encode(t)
// restore sig in message data (for possible future use)
t.Headers.Sign = sign
case *types.P2PResponse:
sign = t.Headers.Sign
t.Headers.Sign = nil
// marshall data without the signature to protobuf3 binary format
bin = types.Encode(t)
// restore sig in message data (for possible future use)
t.Headers.Sign = sign
default:
return false
}
// verify the data was authored by the signing peer identified by the public key
// and signature included in the message
return verifyData(bin, sign, stream.Conn().RemotePublicKey())
}
// Verify incoming p2p message data integrity
// data: data to verify
// signature: author signature provided in the message payload
// pubKey: public key of remote peer
func verifyData(data []byte, signature []byte, pubKey crypto.PubKey) bool {
res, err := pubKey.Verify(data, signature)
if err != nil {
log.Error("Error authenticating data", "err", err)
return false
}
return res
}
// ReadStreamAndAuthenticate verifies the message after reading it from the stream.
func ReadStreamAndAuthenticate(message types.Message, stream network.Stream) error {
if err := ReadStream(message, stream); err != nil {
return err
}
if !AuthenticateMessage(message, stream) {
return types2.ErrWrongSignature
}
return nil
}
// signProtoMessage signs an outgoing p2p message payload.
func signProtoMessage(message types.Message, pk crypto.PrivKey) ([]byte, error) {
if pk == nil {
log.Error("signProtoMessage", "err msg", "prikey is nil")
return nil, types.ErrInvalidParam
}
return pk.Sign(types.Encode(message))
}
// SignAndWriteStream signs the message before writing it to the stream.
func SignAndWriteStream(message types.Message, stream network.Stream, pk crypto.PrivKey) error {
switch t := message.(type) {
case *types.P2PRequest:
t.Headers = &types.P2PMessageHeaders{
Version: types2.Version,
Timestamp: time.Now().Unix(),
Id: rand.Int63(),
}
sign, err := signProtoMessage(t, pk)
if err != nil {
return err
}
t.Headers.Sign = sign
case *types.P2PResponse:
t.Headers = &types.P2PMessageHeaders{
Version: types2.Version,
Timestamp: time.Now().Unix(),
Id: rand.Int63(),
}
sign, err := signProtoMessage(t, pk)
if err != nil {
return err
}
t.Headers.Sign = sign
default:
log.Error("SignAndWriteStream wrong message type")
return types2.ErrInvalidMessageType
}
return WriteStream(message, stream)
}
// HandlerWithClose wraps handler with closing stream and recovering from panic.
func HandlerWithClose(f network.StreamHandler) network.StreamHandler {
return func(stream network.Stream) {
defer func() {
if r := recover(); r != nil {
log.Error("handle stream", "panic error", r)
fmt.Println(string(panicTrace(4)))
_ = stream.Reset()
}
}()
f(stream)
CloseStream(stream)
}
}
// HandlerWithWrite wraps handler with writing, closing stream and recovering from panic.
func HandlerWithWrite(f func(resp *types.P2PResponse) error) network.StreamHandler {
return func(stream network.Stream) {
var res types.P2PResponse
err := f(&res)
if err != nil {
res.Response = nil
res.Error = err.Error()
}
res.Headers = &types.P2PMessageHeaders{
Version: types2.Version,
Timestamp: time.Now().Unix(),
Id: rand.Int63(),
}
if err := WriteStream(&res, stream); err != nil {
log.Error("HandlerWithWrite", "write stream error", err)
return
}
}
}
// HandlerWithRead wraps handler with reading, closing stream and recovering from panic.
func HandlerWithRead(f func(request *types.P2PRequest)) network.StreamHandler {
return func(stream network.Stream) {
var req types.P2PRequest
if err := ReadStream(&req, stream); err != nil {
log.Error("HandlerWithRead", "read stream error", err)
return
}
f(&req)
}
}
// HandlerWithAuth wraps HandlerWithRead with authenticating.
func HandlerWithAuth(f func(request *types.P2PRequest)) network.StreamHandler {
return func(stream network.Stream) {
var req types.P2PRequest
if err := ReadStream(&req, stream); err != nil {
log.Error("HandlerWithAuthAndSign", "read stream error", err)
return
}
if !AuthenticateMessage(&req, stream) {
return
}
f(&req)
}
}
// HandlerWithRW wraps handler with reading, writing, closing stream and recovering from panic.
func HandlerWithRW(f func(request *types.P2PRequest, response *types.P2PResponse) error) network.StreamHandler {
return func(stream network.Stream) {
var req types.P2PRequest
if err := ReadStream(&req, stream); err != nil {
log.Error("HandlerWithRW", "read stream error", err)
return
}
var res types.P2PResponse
err := f(&req, &res)
if err != nil {
res.Response = nil
res.Error = err.Error()
}
res.Headers = &types.P2PMessageHeaders{
Version: types2.Version,
Timestamp: time.Now().Unix(),
Id: rand.Int63(),
}
if err := WriteStream(&res, stream); err != nil {
log.Error("HandlerWithAuthAndSign", "write stream error", err)
return
}
}
}
// HandlerWithAuthAndSign wraps HandlerWithRW with signing and authenticating.
func HandlerWithAuthAndSign(h core.Host, f func(request *types.P2PRequest, response *types.P2PResponse) error) network.StreamHandler {
return func(stream network.Stream) {
var req types.P2PRequest
if err := ReadStream(&req, stream); err != nil {
log.Error("HandlerWithAuthAndSign", "read stream error", err)
return
}
if !AuthenticateMessage(&req, stream) {
return
}
var res types.P2PResponse
err := f(&req, &res)
if err != nil {
res.Response = nil
res.Error = err.Error()
}
res.Headers = &types.P2PMessageHeaders{
Version: types2.Version,
Timestamp: time.Now().Unix(),
Id: rand.Int63(),
}
sign, err := signProtoMessage(&res, h.Peerstore().PrivKey(h.ID()))
if err != nil {
log.Error("HandlerWithAuthAndSign", "signProtoMessage error", err)
return
}
res.Headers.Sign = sign
if err := WriteStream(&res, stream); err != nil {
log.Error("HandlerWithAuthAndSign", "write stream error", err)
return
}
}
}
//TODO
// Any developer can define his own stream handler wrapper.
// EventHandlerWithRecover warps the event handler with recover for catching the panic while processing message.
func EventHandlerWithRecover(f func(m *queue.Message)) func(m *queue.Message) {
return func(m *queue.Message) {
defer func() {
if r := recover(); r != nil {
log.Error("handle event", "panic error", r)
fmt.Println(string(panicTrace(4)))
}
}()
f(m)
}
}
//TODO
// Any developer can define his own event handler wrapper.
// panicTrace traces panic stack info.
func panicTrace(kb int) []byte {
s := []byte("/src/runtime/panic.go")
e := []byte("\ngoroutine ")
line := []byte("\n")
stack := make([]byte, kb<<10) //4KB
length := runtime.Stack(stack, true)
start := bytes.Index(stack, s)
stack = stack[start:length]
start = bytes.Index(stack, line) + 1
stack = stack[start:]
end := bytes.LastIndex(stack, line)
if end != -1 {
stack = stack[:end]
}
end = bytes.Index(stack, e)
if end != -1 {
stack = stack[:end]
}
stack = bytes.TrimRight(stack, "\n")
return stack
}
// EOFTimeout is the maximum amount of time to wait to successfully observe an
// EOF on the stream. Defaults to 60 seconds.
var EOFTimeout = time.Second * 60
// ErrExpectedEOF is returned when we read data while expecting an EOF.
var ErrExpectedEOF = errors.New("read data when expecting EOF")
// AwaitEOF waits for an EOF on the given stream, returning an error if that
// fails. It waits at most EOFTimeout (defaults to 1 minute) after which it
// resets the stream.
func AwaitEOF(s network.Stream) error {
// So we don't wait forever
_ = s.SetDeadline(time.Now().Add(EOFTimeout))
// We *have* to observe the EOF. Otherwise, we leak the stream.
// Now, technically, we should do this *before*
// returning from SendMessage as the message
// hasn't really been sent yet until we see the
// EOF but we don't actually *know* what
// protocol the other side is speaking.
n, err := s.Read([]byte{0})
if n > 0 || err == nil {
_ = s.Reset()
return ErrExpectedEOF
}
if err != io.EOF {
_ = s.Reset()
return err
}
return s.Close()
}
// migrated from github.com/multiformats/go-multicodec@v0.1.6: header.go
func headerSafe(path []byte) []byte {
l := len(path) + 1 // + \n
buf := make([]byte, l+1)
buf[0] = byte(l)
copy(buf[1:], path)
buf[l] = '\n'
return buf
}