379 lines
12 KiB
Go
379 lines
12 KiB
Go
// Copyright (c) 2013-2014 Conformal Systems LLC.
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package btcwire_test
|
|
|
|
import (
|
|
"bytes"
|
|
"github.com/conformal/btcwire"
|
|
"github.com/davecgh/go-spew/spew"
|
|
"io"
|
|
"net"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
)
|
|
|
|
// TestVersion tests the MsgVersion API.
|
|
func TestVersion(t *testing.T) {
|
|
pver := btcwire.ProtocolVersion
|
|
|
|
// Create version message data.
|
|
userAgent := "/btcdtest:0.0.1/"
|
|
lastBlock := int32(234234)
|
|
tcpAddrMe := &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 8333}
|
|
me, err := btcwire.NewNetAddress(tcpAddrMe, btcwire.SFNodeNetwork)
|
|
if err != nil {
|
|
t.Errorf("NewNetAddress: %v", err)
|
|
}
|
|
tcpAddrYou := &net.TCPAddr{IP: net.ParseIP("192.168.0.1"), Port: 8333}
|
|
you, err := btcwire.NewNetAddress(tcpAddrYou, btcwire.SFNodeNetwork)
|
|
if err != nil {
|
|
t.Errorf("NewNetAddress: %v", err)
|
|
}
|
|
nonce, err := btcwire.RandomUint64()
|
|
if err != nil {
|
|
t.Errorf("RandomUint64: error generating nonce: %v", err)
|
|
}
|
|
|
|
// Ensure we get the correct data back out.
|
|
msg := btcwire.NewMsgVersion(me, you, nonce, userAgent, lastBlock)
|
|
if msg.ProtocolVersion != int32(pver) {
|
|
t.Errorf("NewMsgVersion: wrong protocol version - got %v, want %v",
|
|
msg.ProtocolVersion, pver)
|
|
}
|
|
if !reflect.DeepEqual(&msg.AddrMe, me) {
|
|
t.Errorf("NewMsgVersion: wrong me address - got %v, want %v",
|
|
spew.Sdump(&msg.AddrMe), spew.Sdump(me))
|
|
}
|
|
if !reflect.DeepEqual(&msg.AddrYou, you) {
|
|
t.Errorf("NewMsgVersion: wrong you address - got %v, want %v",
|
|
spew.Sdump(&msg.AddrYou), spew.Sdump(you))
|
|
}
|
|
if msg.Nonce != nonce {
|
|
t.Errorf("NewMsgVersion: wrong nonce - got %v, want %v",
|
|
msg.Nonce, nonce)
|
|
}
|
|
if msg.UserAgent != userAgent {
|
|
t.Errorf("NewMsgVersion: wrong user agent - got %v, want %v",
|
|
msg.UserAgent, userAgent)
|
|
}
|
|
if msg.LastBlock != lastBlock {
|
|
t.Errorf("NewMsgVersion: wrong last block - got %v, want %v",
|
|
msg.LastBlock, lastBlock)
|
|
}
|
|
|
|
// Version message should not have any services set by default.
|
|
if msg.Services != 0 {
|
|
t.Errorf("NewMsgVersion: wrong default services - got %v, want %v",
|
|
msg.Services, 0)
|
|
|
|
}
|
|
if msg.HasService(btcwire.SFNodeNetwork) {
|
|
t.Errorf("HasService: SFNodeNetwork service is set")
|
|
}
|
|
|
|
// Ensure the command is expected value.
|
|
wantCmd := "version"
|
|
if cmd := msg.Command(); cmd != wantCmd {
|
|
t.Errorf("NewMsgVersion: wrong command - got %v want %v",
|
|
cmd, wantCmd)
|
|
}
|
|
|
|
// Ensure max payload is expected value.
|
|
// Protocol version 4 bytes + services 8 bytes + timestamp 8 bytes +
|
|
// remote and local net addresses + nonce 8 bytes + length of user agent
|
|
// (varInt) + max allowed user agent length + last block 4 bytes.
|
|
wantPayload := uint32(2101)
|
|
maxPayload := msg.MaxPayloadLength(pver)
|
|
if maxPayload != wantPayload {
|
|
t.Errorf("MaxPayloadLength: wrong max payload length for "+
|
|
"protocol version %d - got %v, want %v", pver,
|
|
maxPayload, wantPayload)
|
|
}
|
|
|
|
// Ensure adding the full service node flag works.
|
|
msg.AddService(btcwire.SFNodeNetwork)
|
|
if msg.Services != btcwire.SFNodeNetwork {
|
|
t.Errorf("AddService: wrong services - got %v, want %v",
|
|
msg.Services, btcwire.SFNodeNetwork)
|
|
}
|
|
if !msg.HasService(btcwire.SFNodeNetwork) {
|
|
t.Errorf("HasService: SFNodeNetwork service not set")
|
|
}
|
|
|
|
// Use a fake connection.
|
|
conn := &fakeConn{localAddr: tcpAddrMe, remoteAddr: tcpAddrYou}
|
|
msg, err = btcwire.NewMsgVersionFromConn(conn, nonce, userAgent, lastBlock)
|
|
if err != nil {
|
|
t.Errorf("NewMsgVersionFromConn: %v", err)
|
|
}
|
|
|
|
// Ensure we get the correct connection data back out.
|
|
if !msg.AddrMe.IP.Equal(tcpAddrMe.IP) {
|
|
t.Errorf("NewMsgVersionFromConn: wrong me ip - got %v, want %v",
|
|
msg.AddrMe.IP, tcpAddrMe.IP)
|
|
}
|
|
if !msg.AddrYou.IP.Equal(tcpAddrYou.IP) {
|
|
t.Errorf("NewMsgVersionFromConn: wrong you ip - got %v, want %v",
|
|
msg.AddrYou.IP, tcpAddrYou.IP)
|
|
}
|
|
|
|
// Use a fake connection with local UDP addresses to force a failure.
|
|
conn = &fakeConn{
|
|
localAddr: &net.UDPAddr{IP: net.ParseIP("127.0.0.1"), Port: 8333},
|
|
remoteAddr: tcpAddrYou,
|
|
}
|
|
msg, err = btcwire.NewMsgVersionFromConn(conn, nonce, userAgent, lastBlock)
|
|
if err != btcwire.ErrInvalidNetAddr {
|
|
t.Errorf("NewMsgVersionFromConn: expected error not received "+
|
|
"- got %v, want %v", err, btcwire.ErrInvalidNetAddr)
|
|
}
|
|
|
|
// Use a fake connection with remote UDP addresses to force a failure.
|
|
conn = &fakeConn{
|
|
localAddr: tcpAddrMe,
|
|
remoteAddr: &net.UDPAddr{IP: net.ParseIP("192.168.0.1"), Port: 8333},
|
|
}
|
|
msg, err = btcwire.NewMsgVersionFromConn(conn, nonce, userAgent, lastBlock)
|
|
if err != btcwire.ErrInvalidNetAddr {
|
|
t.Errorf("NewMsgVersionFromConn: expected error not received "+
|
|
"- got %v, want %v", err, btcwire.ErrInvalidNetAddr)
|
|
}
|
|
|
|
return
|
|
}
|
|
|
|
// TestAlertWire tests the MsgAlert wire encode and decode for various protocol
|
|
// versions.
|
|
func TestVersionWire(t *testing.T) {
|
|
tests := []struct {
|
|
in *btcwire.MsgVersion // Message to encode
|
|
out *btcwire.MsgVersion // Expected decoded message
|
|
buf []byte // Wire encoding
|
|
pver uint32 // Protocol version for wire encoding
|
|
}{
|
|
// Latest protocol version.
|
|
{
|
|
baseVersion,
|
|
baseVersion,
|
|
baseVersionEncoded,
|
|
btcwire.ProtocolVersion,
|
|
},
|
|
|
|
// Protocol version BIP0035Version.
|
|
{
|
|
baseVersion,
|
|
baseVersion,
|
|
baseVersionEncoded,
|
|
btcwire.BIP0035Version,
|
|
},
|
|
|
|
// Protocol version BIP0031Version.
|
|
{
|
|
baseVersion,
|
|
baseVersion,
|
|
baseVersionEncoded,
|
|
btcwire.BIP0031Version,
|
|
},
|
|
|
|
// Protocol version NetAddressTimeVersion.
|
|
{
|
|
baseVersion,
|
|
baseVersion,
|
|
baseVersionEncoded,
|
|
btcwire.NetAddressTimeVersion,
|
|
},
|
|
|
|
// Protocol version MultipleAddressVersion.
|
|
{
|
|
baseVersion,
|
|
baseVersion,
|
|
baseVersionEncoded,
|
|
btcwire.MultipleAddressVersion,
|
|
},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
// Encode the message to wire format.
|
|
var buf bytes.Buffer
|
|
err := test.in.BtcEncode(&buf, test.pver)
|
|
if err != nil {
|
|
t.Errorf("BtcEncode #%d error %v", i, err)
|
|
continue
|
|
}
|
|
if !bytes.Equal(buf.Bytes(), test.buf) {
|
|
t.Errorf("BtcEncode #%d\n got: %s want: %s", i,
|
|
spew.Sdump(buf.Bytes()), spew.Sdump(test.buf))
|
|
continue
|
|
}
|
|
|
|
// Decode the message from wire format.
|
|
var msg btcwire.MsgVersion
|
|
rbuf := bytes.NewBuffer(test.buf)
|
|
err = msg.BtcDecode(rbuf, test.pver)
|
|
if err != nil {
|
|
t.Errorf("BtcDecode #%d error %v", i, err)
|
|
continue
|
|
}
|
|
if !reflect.DeepEqual(&msg, test.out) {
|
|
t.Errorf("BtcDecode #%d\n got: %s want: %s", i,
|
|
spew.Sdump(msg), spew.Sdump(test.out))
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestVersionWireErrors performs negative tests against wire encode and
|
|
// decode of MsgGetHeaders to confirm error paths work correctly.
|
|
func TestVersionWireErrors(t *testing.T) {
|
|
// Use protocol version 60002 specifically here instead of the latest
|
|
// because the test data is using bytes encoded with that protocol
|
|
// version.
|
|
pver := uint32(60002)
|
|
btcwireErr := &btcwire.MessageError{}
|
|
|
|
// Copy the base version and change the user agent to exceed max limits.
|
|
bvc := *baseVersion
|
|
exceedUAVer := &bvc
|
|
newUA := "/" + strings.Repeat("t", btcwire.MaxUserAgentLen-8+1) + ":0.0.1/"
|
|
exceedUAVer.UserAgent = newUA
|
|
|
|
// Encode the new UA length as a varint.
|
|
var newUAVarIntBuf bytes.Buffer
|
|
err := btcwire.TstWriteVarInt(&newUAVarIntBuf, pver, uint64(len(newUA)))
|
|
if err != nil {
|
|
t.Errorf("writeVarInt: error %v", err)
|
|
}
|
|
|
|
// Make a new buffer big enough to hold the base version plus the new
|
|
// bytes for the bigger varint to hold the new size of the user agent
|
|
// and the new user agent string. Then stich it all together.
|
|
newLen := len(baseVersionEncoded) - len(baseVersion.UserAgent)
|
|
newLen = newLen + len(newUAVarIntBuf.Bytes()) - 1 + len(newUA)
|
|
exceedUAVerEncoded := make([]byte, newLen)
|
|
copy(exceedUAVerEncoded, baseVersionEncoded[0:80])
|
|
copy(exceedUAVerEncoded[80:], newUAVarIntBuf.Bytes())
|
|
copy(exceedUAVerEncoded[83:], []byte(newUA))
|
|
copy(exceedUAVerEncoded[83+len(newUA):], baseVersionEncoded[97:100])
|
|
|
|
tests := []struct {
|
|
in *btcwire.MsgVersion // Value to encode
|
|
buf []byte // Wire encoding
|
|
pver uint32 // Protocol version for wire encoding
|
|
max int // Max size of fixed buffer to induce errors
|
|
writeErr error // Expected write error
|
|
readErr error // Expected read error
|
|
}{
|
|
// Force error in protocol version.
|
|
{baseVersion, baseVersionEncoded, pver, 0, io.ErrShortWrite, io.EOF},
|
|
// Force error in services.
|
|
{baseVersion, baseVersionEncoded, pver, 4, io.ErrShortWrite, io.EOF},
|
|
// Force error in timestamp.
|
|
{baseVersion, baseVersionEncoded, pver, 12, io.ErrShortWrite, io.EOF},
|
|
// Force error in remote address.
|
|
{baseVersion, baseVersionEncoded, pver, 20, io.ErrShortWrite, io.EOF},
|
|
// Force error in local address.
|
|
{baseVersion, baseVersionEncoded, pver, 46, io.ErrShortWrite, io.EOF},
|
|
// Force error in nonce.
|
|
{baseVersion, baseVersionEncoded, pver, 72, io.ErrShortWrite, io.EOF},
|
|
// Force error in user agent length.
|
|
{baseVersion, baseVersionEncoded, pver, 80, io.ErrShortWrite, io.EOF},
|
|
// Force error in user agent.
|
|
{baseVersion, baseVersionEncoded, pver, 81, io.ErrShortWrite, io.EOF},
|
|
// Force error in last block.
|
|
{baseVersion, baseVersionEncoded, pver, 97, io.ErrShortWrite, io.EOF},
|
|
// Force error due to user agent too big.
|
|
{exceedUAVer, exceedUAVerEncoded, pver, newLen, btcwireErr, btcwireErr},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
// Encode to wire format.
|
|
w := newFixedWriter(test.max)
|
|
err := test.in.BtcEncode(w, test.pver)
|
|
if reflect.TypeOf(err) != reflect.TypeOf(test.writeErr) {
|
|
t.Errorf("BtcEncode #%d wrong error got: %v, want: %v",
|
|
i, err, test.writeErr)
|
|
continue
|
|
}
|
|
|
|
// For errors which are not of type btcwire.MessageError, check
|
|
// them for equality.
|
|
if _, ok := err.(*btcwire.MessageError); !ok {
|
|
if err != test.writeErr {
|
|
t.Errorf("BtcEncode #%d wrong error got: %v, "+
|
|
"want: %v", i, err, test.writeErr)
|
|
continue
|
|
}
|
|
}
|
|
|
|
// Decode from wire format.
|
|
var msg btcwire.MsgVersion
|
|
r := newFixedReader(test.max, test.buf)
|
|
err = msg.BtcDecode(r, test.pver)
|
|
if reflect.TypeOf(err) != reflect.TypeOf(test.readErr) {
|
|
t.Errorf("BtcDecode #%d wrong error got: %v, want: %v",
|
|
i, err, test.readErr)
|
|
continue
|
|
}
|
|
|
|
// For errors which are not of type btcwire.MessageError, check
|
|
// them for equality.
|
|
if _, ok := err.(*btcwire.MessageError); !ok {
|
|
if err != test.readErr {
|
|
t.Errorf("BtcDecode #%d wrong error got: %v, "+
|
|
"want: %v", i, err, test.readErr)
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// baseVersion is used in the various tests as a baseline MsgVersion.
|
|
var baseVersion = &btcwire.MsgVersion{
|
|
ProtocolVersion: 60002,
|
|
Services: btcwire.SFNodeNetwork,
|
|
Timestamp: time.Unix(0x495fab29, 0), // 2009-01-03 12:15:05 -0600 CST)
|
|
AddrYou: btcwire.NetAddress{
|
|
Timestamp: time.Time{}, // Zero value -- no timestamp in version
|
|
Services: btcwire.SFNodeNetwork,
|
|
IP: net.ParseIP("192.168.0.1"),
|
|
Port: 8333,
|
|
},
|
|
AddrMe: btcwire.NetAddress{
|
|
Timestamp: time.Time{}, // Zero value -- no timestamp in version
|
|
Services: btcwire.SFNodeNetwork,
|
|
IP: net.ParseIP("127.0.0.1"),
|
|
Port: 8333,
|
|
},
|
|
Nonce: 123123, // 0x1e0f3
|
|
UserAgent: "/btcdtest:0.0.1/",
|
|
LastBlock: 234234, // 0x392fa
|
|
}
|
|
|
|
// baseVersionEncoded is the wire encoded bytes for baseVersion using protocol
|
|
// version 60002 and is used in the various tests.
|
|
var baseVersionEncoded = []byte{
|
|
0x62, 0xea, 0x00, 0x00, // Protocol version 60002
|
|
0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // SFNodeNetwork
|
|
0x29, 0xab, 0x5f, 0x49, 0x00, 0x00, 0x00, 0x00, // 64-bit Timestamp
|
|
// AddrYou -- No timestamp for NetAddress in version message
|
|
0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // SFNodeNetwork
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0xff, 0xff, 0xc0, 0xa8, 0x00, 0x01, // IP 192.168.0.1
|
|
0x20, 0x8d, // Port 8333 in big-endian
|
|
// AddrMe -- No timestamp for NetAddress in version message
|
|
0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // SFNodeNetwork
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0xff, 0xff, 0x7f, 0x00, 0x00, 0x01, // IP 127.0.0.1
|
|
0x20, 0x8d, // Port 8333 in big-endian
|
|
0xf3, 0xe0, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, // Nonce
|
|
0x10, // Varint for user agent length
|
|
0x2f, 0x62, 0x74, 0x63, 0x64, 0x74, 0x65, 0x73,
|
|
0x74, 0x3a, 0x30, 0x2e, 0x30, 0x2e, 0x31, 0x2f, // User agent
|
|
0xfa, 0x92, 0x03, 0x00, // Last block
|
|
}
|