Merge ffa3b4c25c into a16f12ba86

whisper/whisperv6/libp2p_glue.go

@@ -0,0 +1,87 @@
+// Copyright 2018 The go-ethereum Authors
+// This file is part of the go-ethereum library.
+//
+// The go-ethereum library is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// The go-ethereum library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
+
+package whisperv6
+
+import (
+	"bufio"
+	"bytes"
+	"fmt"
+	"github.com/ethereum/go-ethereum/rlp"
+	"io/ioutil"
+	"time"
+
+	"github.com/ethereum/go-ethereum/p2p"
+	inet "github.com/libp2p/go-libp2p-net"
+)
+
+// LibP2PStream is a wrapper used to implement the MsgReadWriter
+// interface for libp2p's streams.
+type LibP2PStream struct {
+	stream inet.Stream
+}
+
+// serializableP2PMsg is the serializable version of p2p.Msg
+type serializableP2PMsg struct {
+	Code       uint64
+	Size       uint32
+	Payload    []byte
+	ReceivedAt time.Time
+}
+
+// ReadMsg implements the MsgReadWriter interface to read messages
+// from lilbp2p streams.
+func (stream *LibP2PStream) ReadMsg() (p2p.Msg, error) {
+	var m serializableP2PMsg
+	raw, err := rlp.NewStream(bufio.NewReader(stream.stream), 0).Raw()
+	if err != nil {
+		return p2p.Msg{}, fmt.Errorf("Error during RLP decoding of message: %v", err)
+	}
+	err = rlp.DecodeBytes(raw, &m)
+	msg := p2p.Msg{
+		Code:       m.Code,
+		Size:       m.Size,
+		Payload:    bytes.NewReader(m.Payload),
+		ReceivedAt: m.ReceivedAt,
+	}
+	return msg, err
+}
+
+// WriteMsg implements the MsgReadWriter interface to write messages
+// to lilbp2p streams.
+func (stream *LibP2PStream) WriteMsg(msg p2p.Msg) error {
+	payload, err := ioutil.ReadAll(msg.Payload)
+	if err != nil {
+		return fmt.Errorf("Error reading payload: %v", err)
+	}
+	m := serializableP2PMsg{msg.Code, msg.Size, payload, msg.ReceivedAt}
+
+	data, err := rlp.EncodeToBytes(m)
+	if err != nil {
+		return fmt.Errorf("Error encoding to RLP: %v", err)
+	}
+
+	nbytes, err := stream.stream.Write(data)
+	if err != nil {
+		return err
+	}
+
+	if nbytes != len(data) {
+		return fmt.Errorf("Invalid size written in libp2p stream: wrote %d bytes, was expecting %d bytes", nbytes, msg.Size)
+	}
+
+	return nil
+}

whisper/whisperv6/libp2p_glue_test.go

@@ -0,0 +1,234 @@
+// Copyright 2018 The go-ethereum Authors
+// This file is part of the go-ethereum library.
+//
+// The go-ethereum library is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// The go-ethereum library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
+
+package whisperv6
+
+import (
+	"bytes"
+	"context"
+	"math"
+	"math/rand"
+	"testing"
+
+	"github.com/ethereum/go-ethereum/p2p"
+	host "github.com/libp2p/go-libp2p-host"
+	inet "github.com/libp2p/go-libp2p-net"
+	mocknet "github.com/libp2p/go-libp2p/p2p/net/mock"
+	testutil "github.com/libp2p/go-testutil"
+)
+
+const (
+	testProtocolID = "/whispertesting/6.1"
+)
+
+func newTestMsg(t *testing.T, size int) p2p.Msg {
+	code := rand.Uint64()
+	payload := make([]byte, size)
+	n, err := rand.Read(payload)
+	if err != nil || n != size {
+		t.Fatalf("Read %d random bytes instead of the expected %d, err: %v", n, size, err)
+	}
+
+	return p2p.Msg{
+		Code:    code,
+		Size:    math.MaxInt32 + 1,
+		Payload: bytes.NewReader(payload),
+	}
+}
+
+// Create a network with n mock hosts. Each host in the array is linked to
+// all hosts preceding it, and has dialed them.
+func createTestNetwork(ctx context.Context, t *testing.T, n int) []host.Host {
+	net := make([]host.Host, n)
+	mn := mocknet.New(ctx)
+
+	for i := 0; i < n; i++ {
+		a := testutil.RandLocalTCPAddress()
+		sk, _, err := testutil.RandTestKeyPair(512)
+		if err != nil {
+			t.Fatal(err)
+		}
+		h, err := mn.AddPeer(sk, a)
+		if err != nil {
+			t.Fatal(err)
+		}
+		n := h.Network()
+
+		net[i] = h
+
+		// Link to all previous hosts
+		for j := 0; j < i; j++ {
+			_, err = mn.LinkPeers(net[j].ID(), h.ID())
+			if err != nil {
+				t.Fatal(err)
+			}
+			if _, err := n.DialPeer(ctx, net[j].ID()); err != nil {
+				t.Error(err)
+			}
+		}
+	}
+
+	return net
+}
+
+func TestSimpleCode(t *testing.T) {
+	ctx := context.Background()
+	hosts := createTestNetwork(ctx, t, 2)
+
+	code := uint64(0xdeadbeef)
+	size := uint32(5)
+	payload := []byte{0xca, 0xfe, 0xde, 0xca, 0xf}
+
+	hosts[0].SetStreamHandler(testProtocolID, func(s inet.Stream) {
+		defer s.Close()
+
+		ref := []byte{205, 132, 222, 173, 190, 239, 5, 133, 202, 254, 222, 202, 15, 192}
+		raw := make([]byte, 14)
+		n, err := s.Read(raw)
+
+		if len(ref) != n || err != nil {
+			t.Fatalf("Error reading output of encoding (%d/%d bytes) %s", n, len(raw), err)
+		}
+
+		if !bytes.Equal(raw, ref) {
+			t.Fatalf("Error reading output of encoding read: %v, reference: %v", raw, ref)
+		}
+	})
+	stream, err := hosts[1].NewStream(ctx, hosts[0].ID(), testProtocolID)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	msg := p2p.Msg{
+		Code:    code,
+		Size:    size,
+		Payload: bytes.NewReader(payload),
+	}
+
+	lps := LibP2PStream{
+		stream: stream,
+	}
+
+	err = lps.WriteMsg(msg)
+
+	if err != nil {
+		t.Fatalf("Error encoding a message to the stream: %s", err)
+	}
+
+	stream.Close()
+}
+
+func TestSimpleDecode(t *testing.T) {
+	coded := []byte{230, 132, 222, 173, 190, 239, 30, 158, 29, 114, 149, 102, 199, 77, 16, 3, 124, 77, 123, 187, 4, 7, 209, 226, 198, 73, 129, 133, 90, 216, 104, 29, 13, 134, 209, 233, 30, 0, 192}
+
+	ctx := context.Background()
+	hosts := createTestNetwork(ctx, t, 2)
+
+	hosts[0].SetStreamHandler(testProtocolID, func(s inet.Stream) {
+		defer s.Close()
+
+		lps := LibP2PStream{
+			stream: s,
+		}
+
+		msg, err := lps.ReadMsg()
+		if err != nil {
+			t.Fatalf("Error decoding message: %s", err)
+		}
+
+		if msg.Code != 0xdeadbeef {
+			t.Fatalf("Error decoding message code %d instead of %d", msg.Code, 0xdeadbeef)
+		}
+		if msg.Size != 30 {
+			t.Fatalf("Error decoding message size %d instead of %d", msg.Size, 30)
+		}
+	})
+
+	stream, err := hosts[1].NewStream(ctx, hosts[0].ID(), testProtocolID)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	n, err := stream.Write(coded)
+	if err != nil || n != len(coded) {
+		t.Fatalf("Error writing %d bytes to stream: %s, %d bytes written", len(coded), err, n)
+	}
+
+	stream.Close()
+}
+
+func TestSimpleCodeDecode(t *testing.T) {
+	ctx := context.Background()
+	hosts := createTestNetwork(ctx, t, 2)
+
+	code := rand.Uint64()
+	size := rand.Uint32() % 512
+	payload := make([]byte, size)
+	n, err := rand.Read(payload)
+	if err != nil || uint32(n) != size {
+		t.Fatalf("Read %d random bytes instead of the expected %d, err: %v", n, size, err)
+	}
+
+	hosts[0].SetStreamHandler(testProtocolID, func(s inet.Stream) {
+		defer s.Close()
+
+		lps := LibP2PStream{
+			stream: s,
+		}
+
+		msg, err := lps.ReadMsg()
+		if err != nil {
+			t.Fatalf("Error decoding message: %s", err)
+		}
+
+		if msg.Code != code {
+			t.Fatalf("Error decoding message code %d instead of %d", msg.Code, code)
+		}
+		if int(msg.Size) != len(payload) {
+			t.Fatalf("Error decoding message size %d instead of %d", msg.Size, len(payload))
+		}
+
+		readPayload := make([]byte, len(payload))
+		sizeRead, err := msg.Payload.Read(readPayload)
+		if err != nil || sizeRead != len(payload) {
+			t.Fatalf("Error reading payload from source: %s (%d bytes read for %d expected)", err, sizeRead, len(payload))
+		} else if !bytes.Equal(payload, readPayload) {
+			t.Fatal("Encoded payload differ from source")
+		}
+	})
+	stream, err := hosts[1].NewStream(ctx, hosts[0].ID(), testProtocolID)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	msg := p2p.Msg{
+		Code:    code,
+		Size:    size,
+		Payload: bytes.NewReader(payload),
+	}
+
+	lps := LibP2PStream{
+		stream: stream,
+	}
+
+	err = lps.WriteMsg(msg)
+
+	if err != nil {
+		t.Fatalf("Error encoding a message to the stream: %s", err)
+	}
+
+	stream.Close()
+}