echo.go 4.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
package main

import (
	"bufio"
	"context"
	"fmt"
	"log"

	inet "gx/ipfs/QmbD5yKbXahNvoMqzeuNyKQA9vAs9fUvJg2GXeWU1fVqY5/go-libp2p-net"

Aviv Eyal's avatar
Aviv Eyal committed
11
	p2p "github.com/avive/go-libp2p/examples/multipro/pb"
12
	uuid "github.com/google/uuid"
Aviv Eyal's avatar
Aviv Eyal committed
13
	assert "github.com/ipfs/go-ipfs/thirdparty/assert"
14
	protobufCodec "github.com/multiformats/go-multicodec/protobuf"
Aviv Eyal's avatar
Aviv Eyal committed
15
	"gx/ipfs/QmRS46AyqtpJBsf1zmQdeizSDEzo1qkWR7rdEuPFAv8237/go-libp2p-host"
16
17
18
19
20
21
22
)

// pattern: /protocol-name/request-or-response-message/version
const echoRequest = "/echo/echoreq/0.0.1"
const echoResponse = "/echo/echoresp/0.0.1"

type EchoProtocol struct {
Aviv Eyal's avatar
Aviv Eyal committed
23
	node     *Node                       // local host
Aviv Eyal's avatar
Aviv Eyal committed
24
	requests map[string]*p2p.EchoRequest // used to access request data from response handlers
25
26
27
	done     chan bool                   // only for demo purposes to hold main from terminating
}

Aviv Eyal's avatar
Aviv Eyal committed
28
29
30
31
func NewEchoProtocol(node *Node, done chan bool) *EchoProtocol {
	e := EchoProtocol{node: node, requests: make(map[string]*p2p.EchoRequest), done: done}
	node.SetStreamHandler(echoRequest, e.onEchoRequest)
	node.SetStreamHandler(echoResponse, e.onEchoResponse)
Aviv Eyal's avatar
Aviv Eyal committed
32
33
34
35

	// design note: to implement fire-and-forget style messages you may just skip specifying a response callback.
	// a fire-and-forget message will just include a request and not specify a response object

36
37
38
39
	return &e
}

// remote peer requests handler
40
func (e *EchoProtocol) onEchoRequest(s inet.Stream) {
41
42
43
44
45
	// get request data
	data := &p2p.EchoRequest{}
	decoder := protobufCodec.Multicodec(nil).Decoder(bufio.NewReader(s))
	err := decoder.Decode(data)
	if err != nil {
Aviv Eyal's avatar
Aviv Eyal committed
46
		log.Println(err)
47
48
49
50
51
		return
	}

	log.Printf("%s: Received echo request from %s. Message: %s", s.Conn().LocalPeer(), s.Conn().RemotePeer(), data.Message)

52
53
54
	valid := e.node.authenticateMessage(data, data.MessageData)

	if !valid {
Aviv Eyal's avatar
Aviv Eyal committed
55
		log.Println("Failed to authenticate message")
56
57
58
		return
	}

59
	log.Printf("%s: Sending echo response to %s. Message id: %s...", s.Conn().LocalPeer(), s.Conn().RemotePeer(), data.MessageData.Id)
Aviv Eyal's avatar
Aviv Eyal committed
60

61
	// send response to the request using the message string he provided
Aviv Eyal's avatar
Aviv Eyal committed
62

63
	resp := &p2p.EchoResponse{
Aviv Eyal's avatar
Aviv Eyal committed
64
		MessageData: e.node.NewMessageData(data.MessageData.Id, false),
65
66
		Message:     data.Message}

Aviv Eyal's avatar
Aviv Eyal committed
67
68
69
	// sign the data
	signature, err := e.node.signProtoMessage(resp)
	if err != nil {
Aviv Eyal's avatar
Aviv Eyal committed
70
		log.Println("failed to sign response")
Aviv Eyal's avatar
Aviv Eyal committed
71
72
73
74
75
76
		return
	}

	// add the signature to the message
	resp.MessageData.Sign = string(signature)

Aviv Eyal's avatar
Aviv Eyal committed
77
	s, respErr := e.node.NewStream(context.Background(), s.Conn().RemotePeer(), echoResponse)
78
	if respErr != nil {
Aviv Eyal's avatar
Aviv Eyal committed
79
		log.Println(respErr)
80
81
82
		return
	}

Aviv Eyal's avatar
Aviv Eyal committed
83
	ok := sendProtoMessage(resp, s)
84
85
86
87
88
89
90

	if ok {
		log.Printf("%s: Echo response to %s sent.", s.Conn().LocalPeer().String(), s.Conn().RemotePeer().String())
	}
}

// remote echo response handler
91
func (e *EchoProtocol) onEchoResponse(s inet.Stream) {
92
93
94
95
96
97
98
	data := &p2p.EchoResponse{}
	decoder := protobufCodec.Multicodec(nil).Decoder(bufio.NewReader(s))
	err := decoder.Decode(data)
	if err != nil {
		return
	}

99
100
101
102
	// authenticate message content
	valid := e.node.authenticateMessage(data, data.MessageData)

	if !valid {
Aviv Eyal's avatar
Aviv Eyal committed
103
		log.Println("Failed to authenticate message")
104
105
106
		return
	}

107
108
109
110
111
112
	// locate request data and remove it if found
	req, ok := e.requests[data.MessageData.Id]
	if ok {
		// remove request from map as we have processed it here
		delete(e.requests, data.MessageData.Id)
	} else {
Aviv Eyal's avatar
Aviv Eyal committed
113
		log.Println("Failed to locate request data boject for response")
114
115
116
117
118
		return
	}

	assert.True(req.Message == data.Message, nil, "Expected echo to respond with request message")

Aviv Eyal's avatar
Aviv Eyal committed
119
	log.Printf("%s: Received echo response from %s. Message id:%s. Message: %s.", s.Conn().LocalPeer(), s.Conn().RemotePeer(), data.MessageData.Id, data.Message)
120
121
122
	e.done <- true
}

123
func (e *EchoProtocol) Echo(host host.Host) bool {
Aviv Eyal's avatar
Aviv Eyal committed
124
	log.Printf("%s: Sending echo to: %s....", e.node.ID(), host.ID())
125
126
127

	// create message data
	req := &p2p.EchoRequest{
Aviv Eyal's avatar
Aviv Eyal committed
128
		MessageData: e.node.NewMessageData(uuid.New().String(), false),
Aviv Eyal's avatar
Aviv Eyal committed
129
		Message:     fmt.Sprintf("Echo from %s", e.node.ID())}
130

Aviv Eyal's avatar
Aviv Eyal committed
131
132
	signature, err := e.node.signProtoMessage(req)
	if err != nil {
Aviv Eyal's avatar
Aviv Eyal committed
133
		log.Println("failed to sign message")
Aviv Eyal's avatar
Aviv Eyal committed
134
135
136
137
138
139
140
		return false
	}

	// add the signature to the message
	req.MessageData.Sign = string(signature)

	s, err := e.node.NewStream(context.Background(), host.ID(), echoRequest)
141
	if err != nil {
Aviv Eyal's avatar
Aviv Eyal committed
142
		log.Println(err)
143
144
145
		return false
	}

Aviv Eyal's avatar
Aviv Eyal committed
146
	ok := sendProtoMessage(req, s)
147
148
149
150
151
152
153

	if !ok {
		return false
	}

	// store request so response handler has access to it
	e.requests[req.MessageData.Id] = req
Aviv Eyal's avatar
Aviv Eyal committed
154
	log.Printf("%s: Echo to: %s was sent. Message Id: %s, Message: %s", e.node.ID(), host.ID(), req.MessageData.Id, req.Message)
155
156
	return true
}