status-go/mailserver/mailserver_test.go

// Copyright 2017 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 mailserver

import (
	"crypto/ecdsa"
	"encoding/binary"
	"errors"
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"testing"
	"time"

	"github.com/ethereum/go-ethereum/common"
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/rlp"
	whisper "github.com/ethereum/go-ethereum/whisper/whisperv6"
	"github.com/status-im/status-go/params"
	"github.com/stretchr/testify/suite"
)

const powRequirement = 0.00001

var keyID string
var seed = time.Now().Unix()
var testPayload = []byte("test payload")

type ServerTestParams struct {
	topic whisper.TopicType
	birth uint32
	low   uint32
	upp   uint32
	limit uint32
	key   *ecdsa.PrivateKey
}

func TestMailserverSuite(t *testing.T) {
	suite.Run(t, new(MailserverSuite))
}

type MailserverSuite struct {
	suite.Suite
	server  *WMailServer
	shh     *whisper.Whisper
	config  *params.WhisperConfig
	dataDir string
}

func (s *MailserverSuite) SetupTest() {
	s.server = &WMailServer{}
	s.shh = whisper.New(&whisper.DefaultConfig)
	s.shh.RegisterServer(s.server)

	tmpDir, err := ioutil.TempDir("", "mailserver-test")
	s.Require().NoError(err)
	s.dataDir = tmpDir

	// required files to validate mail server decryption method
	asymKeyFile := filepath.Join(tmpDir, "asymkey")
	passwordFile := filepath.Join(tmpDir, "password")
	privateKey, err := crypto.GenerateKey()
	s.Require().NoError(err)
	err = crypto.SaveECDSA(asymKeyFile, privateKey)
	s.Require().NoError(err)
	err = ioutil.WriteFile(passwordFile, []byte("testpassword"), os.ModePerm)
	s.Require().NoError(err)

	s.config = &params.WhisperConfig{
		DataDir:                tmpDir,
		MailServerAsymKeyFile:  asymKeyFile,
		MailServerPasswordFile: passwordFile,
	}
}

func (s *MailserverSuite) TearDownTest() {
	s.Require().NoError(os.RemoveAll(s.config.DataDir))
}

func (s *MailserverSuite) TestInit() {
	asymKey, err := crypto.GenerateKey()
	s.Require().NoError(err)

	testCases := []struct {
		config        params.WhisperConfig
		expectedError error
		info          string
	}{
		{
			config:        params.WhisperConfig{DataDir: ""},
			expectedError: errDirectoryNotProvided,
			info:          "config with empty DataDir",
		},
		{
			config: params.WhisperConfig{
				DataDir:            "/invalid-path",
				MailServerPassword: "pwd",
			},
			expectedError: errors.New("open DB: mkdir /invalid-path: permission denied"),
			info:          "config with an unexisting DataDir",
		},
		{
			config: params.WhisperConfig{
				DataDir:            s.config.DataDir,
				MailServerPassword: "",
				MailServerAsymKey:  nil,
			},
			expectedError: errDecryptionMethodNotProvided,
			info:          "config with an empty password and empty asym key",
		},
		{
			config: params.WhisperConfig{
				DataDir:            s.config.DataDir,
				MailServerPassword: "pwd",
			},
			expectedError: nil,
			info:          "config with correct DataDir and Password",
		},
		{
			config: params.WhisperConfig{
				DataDir:           s.config.DataDir,
				MailServerAsymKey: asymKey,
			},
			expectedError: nil,
			info:          "config with correct DataDir and AsymKey",
		},
		{
			config: params.WhisperConfig{
				DataDir:            s.config.DataDir,
				MailServerAsymKey:  asymKey,
				MailServerPassword: "pwd",
			},
			expectedError: nil,
			info:          "config with both asym key and password",
		},
		{
			config: params.WhisperConfig{
				DataDir:             s.config.DataDir,
				MailServerPassword:  "pwd",
				MailServerRateLimit: 5,
			},
			expectedError: nil,
			info:          "config with rate limit",
		},
	}

	for _, tc := range testCases {
		s.T().Run(tc.info, func(*testing.T) {
			mailServer := &WMailServer{}
			shh := whisper.New(&whisper.DefaultConfig)
			shh.RegisterServer(mailServer)

			err := mailServer.Init(shh, &tc.config)
			s.Equal(tc.expectedError, err)
			defer mailServer.Close()

			// db should be open only if there was no error
			if tc.expectedError == nil {
				s.NotNil(mailServer.db)
			} else {
				s.Nil(mailServer.db)
			}

			if tc.config.MailServerRateLimit > 0 {
				s.NotNil(mailServer.limiter)
			}
		})
	}
}

func (s *MailserverSuite) TestSetupRequestMessageDecryptor() {
	// without configured Password and AsymKey
	config := *s.config
	s.Error(errDecryptionMethodNotProvided, s.server.Init(s.shh, &config))

	// Password should work ok
	config = *s.config
	s.NoError(config.ReadMailServerPasswordFile())
	s.NoError(s.server.Init(s.shh, &config))
	s.Require().NotNil(s.server.symFilter)
	s.NotNil(s.server.symFilter.KeySym)
	s.Nil(s.server.asymFilter)
	s.server.Close()

	// AsymKey can also be used
	config = *s.config
	s.NoError(config.ReadMailServerAsymKeyFile())
	s.NoError(s.server.Init(s.shh, &config))
	s.Nil(s.server.symFilter) // important: symmetric filter should be nil
	s.Require().NotNil(s.server.asymFilter)
	s.Equal(config.MailServerAsymKey, s.server.asymFilter.KeyAsym)
	s.server.Close()

	// when Password and AsymKey are set, both are supported
	config = *s.config
	s.NoError(config.ReadMailServerPasswordFile())
	s.NoError(config.ReadMailServerAsymKeyFile())
	s.NoError(s.server.Init(s.shh, &config))
	s.Require().NotNil(s.server.symFilter)
	s.NotNil(s.server.symFilter.KeySym)
	s.NotNil(s.server.asymFilter.KeyAsym)
	s.server.Close()
}

func (s *MailserverSuite) TestOpenEnvelopeWithSymKey() {
	// Setup the server with a sym key
	config := *s.config
	s.NoError(config.ReadMailServerPasswordFile())
	s.NoError(s.server.Init(s.shh, &config))

	// Prepare a valid envelope
	s.Require().NotNil(s.server.symFilter)
	symKey := s.server.symFilter.KeySym
	env, err := generateEnvelopeWithKeys(time.Now(), symKey, nil)
	s.Require().NoError(err)

	// Test openEnvelope with a valid envelope
	d := s.server.openEnvelope(env)
	s.NotNil(d)
	s.Equal(testPayload, d.Payload)
	s.server.Close()
}

func (s *MailserverSuite) TestOpenEnvelopeWithAsymKey() {
	// Setup the server with an asymetric key
	config := *s.config
	s.NoError(config.ReadMailServerAsymKeyFile())
	s.NoError(s.server.Init(s.shh, &config))

	// Prepare a valid envelope
	s.Require().NotNil(s.server.asymFilter)
	pubKey := s.server.asymFilter.KeyAsym.PublicKey
	env, err := generateEnvelopeWithKeys(time.Now(), nil, &pubKey)
	s.Require().NoError(err)

	// Test openEnvelope with a valid asymetric key
	d := s.server.openEnvelope(env)
	s.NotNil(d)
	s.Equal(testPayload, d.Payload)
	s.server.Close()
}

func (s *MailserverSuite) TestArchive() {
	err := s.config.ReadMailServerPasswordFile()
	s.Require().NoError(err)

	err = s.server.Init(s.shh, s.config)
	s.Require().NoError(err)
	defer s.server.Close()

	env, err := generateEnvelope(time.Now())
	s.NoError(err)
	rawEnvelope, err := rlp.EncodeToBytes(env)
	s.NoError(err)

	s.server.Archive(env)
	key := NewDbKey(env.Expiry-env.TTL, env.Hash())
	archivedEnvelope, err := s.server.db.Get(key.raw, nil)
	s.NoError(err)

	s.Equal(rawEnvelope, archivedEnvelope)
}

func (s *MailserverSuite) TestManageLimits() {
	s.server.limiter = newLimiter(time.Duration(5) * time.Millisecond)
	s.False(s.server.exceedsPeerRequests([]byte("peerID")))
	s.Equal(1, len(s.server.limiter.db))
	firstSaved := s.server.limiter.db["peerID"]

	// second call when limit is not accomplished does not store a new limit
	s.True(s.server.exceedsPeerRequests([]byte("peerID")))
	s.Equal(1, len(s.server.limiter.db))
	s.Equal(firstSaved, s.server.limiter.db["peerID"])
}

func (s *MailserverSuite) TestDBKey() {
	var h common.Hash
	i := uint32(time.Now().Unix())
	k := NewDbKey(i, h)
	s.Equal(len(k.raw), common.HashLength+4, "wrong DB key length")
	s.Equal(byte(i%0x100), k.raw[3], "raw representation should be big endian")
	s.Equal(byte(i/0x1000000), k.raw[0], "big endian expected")
}

func (s *MailserverSuite) TestRequestPaginationLimit() {
	s.setupServer(s.server)
	defer s.server.Close()

	var (
		sentEnvelopes     []*whisper.Envelope
		reverseSentHashes []common.Hash
		receivedHashes    []common.Hash
		archiveKeys       []string
	)

	now := time.Now()
	count := uint32(10)

	for i := count; i > 0; i-- {
		sentTime := now.Add(time.Duration(-i) * time.Second)
		env, err := generateEnvelope(sentTime)
		s.NoError(err)
		s.server.Archive(env)
		key := NewDbKey(env.Expiry-env.TTL, env.Hash())
		archiveKeys = append(archiveKeys, fmt.Sprintf("%x", key.raw))
		sentEnvelopes = append(sentEnvelopes, env)
		reverseSentHashes = append([]common.Hash{env.Hash()}, reverseSentHashes...)
	}

	params := s.defaultServerParams(sentEnvelopes[0])
	params.low = uint32(now.Add(time.Duration(-count) * time.Second).Unix())
	params.upp = uint32(now.Unix())
	params.limit = 6
	request := s.createRequest(params)
	src := crypto.FromECDSAPub(&params.key.PublicKey)
	ok, lower, upper, bloom, limit, cursor := s.server.validateRequest(src, request)
	s.True(ok)
	s.Nil(cursor)
	s.Equal(params.limit, limit)

	envelopes, _, cursor, err := s.server.processRequest(nil, lower, upper, bloom, limit, nil)
	s.NoError(err)
	for _, env := range envelopes {
		receivedHashes = append(receivedHashes, env.Hash())
	}

	// 10 envelopes sent
	s.Equal(count, uint32(len(sentEnvelopes)))
	// 6 envelopes received
	s.Equal(limit, uint32(len(receivedHashes)))
	// the 6 envelopes received should be in descending order
	s.Equal(reverseSentHashes[:limit], receivedHashes)
	// cursor should be the key of the first envelope of the next page
	s.Equal(archiveKeys[count-limit], fmt.Sprintf("%x", cursor))

	// second page
	receivedHashes = []common.Hash{}
	envelopes, _, cursor, err = s.server.processRequest(nil, lower, upper, bloom, limit, cursor)
	s.NoError(err)
	for _, env := range envelopes {
		receivedHashes = append(receivedHashes, env.Hash())
	}

	// 4 envelopes received
	s.Equal(count-limit, uint32(len(receivedHashes)))
	// cursor is nil because there are no other pages
	s.Nil(cursor)
}

func (s *MailserverSuite) TestMailServer() {
	s.setupServer(s.server)
	defer s.server.Close()

	env, err := generateEnvelope(time.Now())
	s.NoError(err)

	s.server.Archive(env)

	testCases := []struct {
		params *ServerTestParams
		expect bool
		isOK   bool
		info   string
	}{
		{
			params: s.defaultServerParams(env),
			expect: true,
			isOK:   true,
			info:   "Processing a request where from and to are equal to an existing register, should provide results",
		},
		{
			params: func() *ServerTestParams {
				params := s.defaultServerParams(env)
				params.low = params.birth + 1
				params.upp = params.birth + 1

				return params
			}(),
			expect: false,
			isOK:   true,
			info:   "Processing a request where from and to are greater than any existing register, should not provide results",
		},
		{
			params: func() *ServerTestParams {
				params := s.defaultServerParams(env)
				params.upp = params.birth + 1
				params.topic[0] = 0xFF

				return params
			}(),
			expect: false,
			isOK:   true,
			info:   "Processing a request where to is greater than any existing register and with a specific topic, should not provide results",
		},
		{
			params: func() *ServerTestParams {
				params := s.defaultServerParams(env)
				params.low = params.birth
				params.upp = params.birth - 1

				return params
			}(),
			isOK: false,
			info: "Processing a request where to is lower than from should fail",
		},
		{
			params: func() *ServerTestParams {
				params := s.defaultServerParams(env)
				params.low = 0
				params.upp = params.birth + 24

				return params
			}(),
			isOK: false,
			info: "Processing a request where difference between from and to is > 24 should fail",
		},
	}
	for _, tc := range testCases {
		s.T().Run(tc.info, func(*testing.T) {
			request := s.createRequest(tc.params)
			src := crypto.FromECDSAPub(&tc.params.key.PublicKey)
			ok, lower, upper, bloom, limit, _ := s.server.validateRequest(src, request)
			s.Equal(tc.isOK, ok)
			if ok {
				s.Equal(tc.params.low, lower)
				s.Equal(tc.params.upp, upper)
				s.Equal(tc.params.limit, limit)
				s.Equal(whisper.TopicToBloom(tc.params.topic), bloom)
				s.Equal(tc.expect, s.messageExists(env, tc.params.low, tc.params.upp, bloom, tc.params.limit))

				src[0]++
				ok, _, _, _, _, _ = s.server.validateRequest(src, request)
				s.True(ok)
			}
		})
	}
}

func (s *MailserverSuite) messageExists(envelope *whisper.Envelope, low, upp uint32, bloom []byte, limit uint32) bool {
	var exist bool
	mail, _, _, err := s.server.processRequest(nil, low, upp, bloom, limit, nil)
	s.NoError(err)
	for _, msg := range mail {
		if msg.Hash() == envelope.Hash() {
			exist = true
			break
		}
	}
	return exist
}

func (s *MailserverSuite) TestBloomFromReceivedMessage() {
	testCases := []struct {
		msg           whisper.ReceivedMessage
		expectedBloom []byte
		expectedErr   error
		info          string
	}{
		{
			msg:           whisper.ReceivedMessage{},
			expectedBloom: []byte(nil),
			expectedErr:   errors.New("Undersized p2p request"),
			info:          "getting bloom filter for an empty whisper message should produce an error",
		},
		{
			msg:           whisper.ReceivedMessage{Payload: []byte("hohohohoho")},
			expectedBloom: []byte(nil),
			expectedErr:   errors.New("Undersized bloom filter in p2p request"),
			info:          "getting bloom filter for a malformed whisper message should produce an error",
		},
		{
			msg:           whisper.ReceivedMessage{Payload: []byte("12345678")},
			expectedBloom: whisper.MakeFullNodeBloom(),
			expectedErr:   nil,
			info:          "getting bloom filter for a valid whisper message should be successful",
		},
	}

	for _, tc := range testCases {
		s.T().Run(tc.info, func(*testing.T) {
			bloom, err := s.server.bloomFromReceivedMessage(&tc.msg)
			s.Equal(tc.expectedErr, err)
			s.Equal(tc.expectedBloom, bloom)
		})
	}
}

func (s *MailserverSuite) setupServer(server *WMailServer) {
	const password = "password_for_this_test"

	s.shh = whisper.New(&whisper.DefaultConfig)
	s.shh.RegisterServer(server)

	err := server.Init(s.shh, &params.WhisperConfig{
		DataDir:            s.dataDir,
		MailServerPassword: password,
		MinimumPoW:         powRequirement,
	})
	if err != nil {
		s.T().Fatal(err)
	}

	keyID, err = s.shh.AddSymKeyFromPassword(password)
	if err != nil {
		s.T().Fatalf("failed to create symmetric key for mail request: %s", err)
	}
}

func (s *MailserverSuite) defaultServerParams(env *whisper.Envelope) *ServerTestParams {
	id, err := s.shh.NewKeyPair()
	if err != nil {
		s.T().Fatalf("failed to generate new key pair with seed %d: %s.", seed, err)
	}
	testPeerID, err := s.shh.GetPrivateKey(id)
	if err != nil {
		s.T().Fatalf("failed to retrieve new key pair with seed %d: %s.", seed, err)
	}
	birth := env.Expiry - env.TTL

	return &ServerTestParams{
		topic: env.Topic,
		birth: birth,
		low:   birth - 1,
		upp:   birth + 1,
		limit: 0,
		key:   testPeerID,
	}
}

func (s *MailserverSuite) createRequest(p *ServerTestParams) *whisper.Envelope {
	bloom := whisper.TopicToBloom(p.topic)
	data := make([]byte, 8)
	binary.BigEndian.PutUint32(data, p.low)
	binary.BigEndian.PutUint32(data[4:], p.upp)
	data = append(data, bloom...)

	if p.limit != 0 {
		limitData := make([]byte, 4)
		binary.BigEndian.PutUint32(limitData, p.limit)
		data = append(data, limitData...)
	}

	key, err := s.shh.GetSymKey(keyID)
	if err != nil {
		s.T().Fatalf("failed to retrieve sym key with seed %d: %s.", seed, err)
	}

	params := &whisper.MessageParams{
		KeySym:   key,
		Topic:    p.topic,
		Payload:  data,
		PoW:      powRequirement * 2,
		WorkTime: 2,
		Src:      p.key,
	}

	msg, err := whisper.NewSentMessage(params)
	if err != nil {
		s.T().Fatalf("failed to create new message with seed %d: %s.", seed, err)
	}
	env, err := msg.Wrap(params, time.Now())
	if err != nil {
		s.T().Fatalf("failed to wrap with seed %d: %s.", seed, err)
	}
	return env
}

func generateEnvelopeWithKeys(sentTime time.Time, keySym []byte, keyAsym *ecdsa.PublicKey) (*whisper.Envelope, error) {
	params := &whisper.MessageParams{
		Topic:    whisper.TopicType{0x1F, 0x7E, 0xA1, 0x7F},
		Payload:  testPayload,
		PoW:      powRequirement,
		WorkTime: 2,
	}

	if len(keySym) > 0 {
		params.KeySym = keySym
	} else if keyAsym != nil {
		params.Dst = keyAsym
	}

	msg, err := whisper.NewSentMessage(params)
	if err != nil {
		return nil, fmt.Errorf("failed to create new message with seed %d: %s", seed, err)
	}
	env, err := msg.Wrap(params, sentTime)
	if err != nil {
		return nil, fmt.Errorf("failed to wrap with seed %d: %s", seed, err)
	}

	return env, nil
}

func generateEnvelope(sentTime time.Time) (*whisper.Envelope, error) {
	h := crypto.Keccak256Hash([]byte("test sample data"))
	return generateEnvelopeWithKeys(sentTime, h[:], nil)
}